com.xforceplus.business.client.controller

类 ClientController

java.lang.Object

com.xforceplus.business.client.controller.ClientController

所有已实现的接口:

com.xforceplus.api.global.client.ClientApi

@Controller
public class ClientController
extends java.lang.Object
implements com.xforceplus.api.global.client.ClientApi

嵌套类概要

从接口继承的嵌套类/接口 com.xforceplus.api.global.client.ClientApi

com.xforceplus.api.global.client.ClientApi.Path

构造器概要

构造器

构造器和说明
ClientController(ClientSecretService clientService)

方法概要

限定符和类型	方法和说明
com.xforceplus.api.common.response.ResponseEntity<com.xforceplus.entity.Client>	bindUserId(java.lang.String clientId, @Min(value=1L,message="\u7528\u6237ID\u5fc5\u987b\u5927\u4e8e0") java.lang.Long userId) clientId绑定用户ID
com.xforceplus.api.common.response.ResponseEntity<com.xforceplus.entity.Client>	check(java.lang.String clientId, java.lang.String secret)
com.xforceplus.entity.Client	create(com.xforceplus.domain.client.ClientDto clientForm) 已过时。 use createV2(ClientDto) ()} } ()} instead.
com.xforceplus.api.common.response.ResponseEntity<com.xforceplus.entity.Client>	createV2(com.xforceplus.domain.client.ClientDto clientForm)
com.xforceplus.api.common.response.ResponseEntity<java.lang.String>	delete(java.lang.String clientId) 删除成功
com.xforceplus.domain.client.ClientDto	get(java.lang.String clientId) 已过时。 use getV2(String) ()} instead.
com.xforceplus.api.common.response.ResponseEntity<java.lang.String>	getSecret(java.lang.String clientId)
com.xforceplus.api.common.response.ResponseEntity<com.xforceplus.entity.Client>	getV2(java.lang.String clientId)
java.util.List<com.xforceplus.entity.Client>	list() 已过时。 use listV2() } ()} instead.
com.xforceplus.api.common.response.ResponseEntity<java.util.List<com.xforceplus.entity.Client>>	listV2()
com.xforceplus.api.common.response.ResponseEntity<org.springframework.data.domain.Page<com.xforceplus.entity.Client>>	page(com.xforceplus.api.model.ClientModel.Request.Query query, org.springframework.data.domain.Pageable pageable)
com.xforceplus.api.common.response.ResponseEntity<com.xforceplus.entity.Client>	unbindUserId(java.lang.String clientId)
com.xforceplus.entity.Client	update(java.lang.String clientId, com.xforceplus.domain.client.ClientDto clientForm) 已过时。 use updateV2(String, ClientDto) ()} } ()} instead.
com.xforceplus.api.common.response.ResponseEntity<com.xforceplus.entity.Client>	updateV2(java.lang.String clientId, com.xforceplus.domain.client.ClientDto clientForm)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ClientController

public ClientController(ClientSecretService clientService)

方法详细资料

page

@ResponseBody
 @GetMapping(name="client\u5206\u9875\u5217\u8868",
            value="${xforce.tenant.service.url.prefix:/api}/global${xforce.tenant.service.version:}/clients")
public com.xforceplus.api.common.response.ResponseEntity<org.springframework.data.domain.Page<com.xforceplus.entity.Client>> page(com.xforceplus.api.model.ClientModel.Request.Query query,
                                                                                                                                                                                                                                                                                                                     org.springframework.data.domain.Pageable pageable)

参数:

pageable -

返回:

list

@ResponseBody
 @GetMapping(name="client\u5217\u8868",
            value="${xforce.tenant.service.url.prefix:/api}/global${xforce.tenant.service.version:}/clients/list")
 @Deprecated
public java.util.List<com.xforceplus.entity.Client> list()

已过时。 use listV2() } ()} instead.

listV2

@ResponseBody
 @GetMapping(name="client\u5217\u8868",
            value="${xforce.tenant.service.url.prefix:/api}/global${xforce.tenant.service.version:}/clients/v2/list")
public com.xforceplus.api.common.response.ResponseEntity<java.util.List<com.xforceplus.entity.Client>> listV2()

get

@ResponseBody
 @GetMapping(name="\u83b7\u53d6client",
            value="${xforce.tenant.service.url.prefix:/api}/global${xforce.tenant.service.version:}/clients/{clientId}")
 @Deprecated
public com.xforceplus.domain.client.ClientDto get(@PathVariable(value="clientId")
                                                                                                                                                                                                                                                  java.lang.String clientId)

已过时。 use getV2(String) ()} instead.

getV2

public com.xforceplus.api.common.response.ResponseEntity<com.xforceplus.entity.Client> getV2(@PathVariable(value="clientId")
                                                                                             java.lang.String clientId)

指定者:

getV2 在接口中 com.xforceplus.api.global.client.ClientApi

check

public com.xforceplus.api.common.response.ResponseEntity<com.xforceplus.entity.Client> check(java.lang.String clientId,
                                                                                             java.lang.String secret)

指定者:

check 在接口中 com.xforceplus.api.global.client.ClientApi

create

@ResponseBody
 @PostMapping(name="\u65b0\u589eclient",
             value="${xforce.tenant.service.url.prefix:/api}/global${xforce.tenant.service.version:}/clients")
 @Deprecated
public com.xforceplus.entity.Client create(@RequestBody
                                                                                                                                                                                                                                  com.xforceplus.domain.client.ClientDto clientForm)

已过时。 use createV2(ClientDto) ()} } ()} instead.

createV2

@ResponseBody
 @PostMapping(name="\u65b0\u589eclient",
             value="${xforce.tenant.service.url.prefix:/api}/global${xforce.tenant.service.version:}/clients/v2")
public com.xforceplus.api.common.response.ResponseEntity<com.xforceplus.entity.Client> createV2(@RequestBody
                                                                                                                                                                                                                                                                            com.xforceplus.domain.client.ClientDto clientForm)

update

@ResponseBody
 @PutMapping(name="\u66f4\u65b0client",
            value="${xforce.tenant.service.url.prefix:/api}/global${xforce.tenant.service.version:}/clients/{clientId}")
 @Deprecated
public com.xforceplus.entity.Client update(@PathVariable(value="clientId")
                                                                                                                                                                                                                                           java.lang.String clientId,
                                                                                                                                                                                                                                           @RequestBody
                                                                                                                                                                                                                                           com.xforceplus.domain.client.ClientDto clientForm)

已过时。 use updateV2(String, ClientDto) ()} } ()} instead.

updateV2

@ResponseBody
 @PutMapping(name="\u66f4\u65b0client",
            value="${xforce.tenant.service.url.prefix:/api}/global${xforce.tenant.service.version:}/clients/v2/{clientId}")
public com.xforceplus.api.common.response.ResponseEntity<com.xforceplus.entity.Client> updateV2(@PathVariable(value="clientId")
                                                                                                                                                                                                                                                                                     java.lang.String clientId,
                                                                                                                                                                                                                                                                                     @RequestBody
                                                                                                                                                                                                                                                                                     com.xforceplus.domain.client.ClientDto clientForm)

delete

@ResponseBody
 @DeleteMapping(name="\u5220\u9664client",
               value="${xforce.tenant.service.url.prefix:/api}/global${xforce.tenant.service.version:}/clients/{clientId}")
public com.xforceplus.api.common.response.ResponseEntity<java.lang.String> delete(@PathVariable(value="clientId")
                                                                                                                                                                                                                                                                          java.lang.String clientId)

删除成功

参数:

clientId - ClientId

返回:

ResponseEntity

bindUserId

@ResponseBody
 @PostMapping(name="clientId\u7ed1\u5b9a\u7528\u6237ID",
             value="${xforce.tenant.service.url.prefix:/api}/global${xforce.tenant.service.version:}/clients/{clientId}/bind")
public com.xforceplus.api.common.response.ResponseEntity<com.xforceplus.entity.Client> bindUserId(@PathVariable(value="clientId")
                                                                                                                                                                                                                                                                                                           java.lang.String clientId,
                                                                                                                                                                                                                                                                                                           @RequestParam(value="userId",required=true) @Min(value=1L,message="\u7528\u6237ID\u5fc5\u987b\u5927\u4e8e0")
                                                                                                                                                                                                                                                                                                           @Min(value=1L,message="\u7528\u6237ID\u5fc5\u987b\u5927\u4e8e0") java.lang.Long userId)

clientId绑定用户ID

参数:

clientId -

userId -

返回:

unbindUserId

@ResponseBody
 @PostMapping(name="clientId\u89e3\u7ed1\u7528\u6237",
             value="${xforce.tenant.service.url.prefix:/api}/global${xforce.tenant.service.version:}/clients/{clientId}/unbind")
public com.xforceplus.api.common.response.ResponseEntity<com.xforceplus.entity.Client> unbindUserId(@PathVariable(value="clientId")
                                                                                                                                                                                                                                                                                                             java.lang.String clientId)

getSecret

public com.xforceplus.api.common.response.ResponseEntity<java.lang.String> getSecret(java.lang.String clientId)

指定者:

getSecret 在接口中 com.xforceplus.api.global.client.ClientApi