com.seeyon.ctp.rest.resources

类 TokenResource

java.lang.Object

com.seeyon.ctp.rest.resources.BaseResource

com.seeyon.ctp.rest.resources.TokenResource

@Path(value="token")
public class TokenResource
extends BaseResource

构造器概要

构造器

构造器和说明
TokenResource()

方法概要

限定符和类型	方法和说明
javax.ws.rs.core.Response	bindUser(java.util.Map data) 为token绑定用户。
javax.ws.rs.core.Response	checkToken(java.lang.String token) 检查token是否有效
javax.ws.rs.core.Response	createTokenBySystemChannel(java.util.Map data) 新建信道的token
SystemChannelManager	getSystemChannelManager()
javax.ws.rs.core.Response	getToken(java.lang.String userName, java.lang.String password, java.lang.String loginName, java.lang.Long memberId, java.lang.String code, java.lang.String userAgentFrom, java.lang.String adminRoleCode, java.lang.Long adminAccountId) 获取Token。
javax.ws.rs.core.Response	getTokenByQueryParam(java.util.Map data) 获取Token。
javax.ws.rs.core.Response	getTokenString(java.lang.String userName, java.lang.String password, java.lang.String loginName, java.lang.Long memberId, java.lang.String code, java.lang.String userAgentFrom, java.lang.String adminRoleCode, java.lang.Long adminAccountId) 获取Token。
javax.ws.rs.core.Response	removeToken(java.lang.String token) 清除token，清除后token失效。
void	setSystemChannelManager(SystemChannelManager systemChannelManager)

从类继承的方法 com.seeyon.ctp.rest.resources.BaseResource

copyProperties, decode, error, fail, fail, getFlipInfo, getObjectMapper, getToken, judgeSortId, noContent, ok, required, required, setCurrentUser, setPagination, setVirtualUser, status, status, success, success, success, toJSON, toJSON

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

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

构造器详细资料

TokenResource

public TokenResource()

方法详细资料

setSystemChannelManager

public void setSystemChannelManager(SystemChannelManager systemChannelManager)

getSystemChannelManager

public SystemChannelManager getSystemChannelManager()

getToken

@GET
 @Path(value="{userName}/{password}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getToken(@PathParam(value="userName")
                                                                                                                                                 java.lang.String userName,
                                                                                                                                                 @PathParam(value="password")
                                                                                                                                                 java.lang.String password,
                                                                                                                                                 @QueryParam(value="loginName")
                                                                                                                                                 java.lang.String loginName,
                                                                                                                                                 @QueryParam(value="memberId")
                                                                                                                                                 java.lang.Long memberId,
                                                                                                                                                 @QueryParam(value="memberCode")
                                                                                                                                                 java.lang.String code,
                                                                                                                                                 @QueryParam(value="userAgentFrom")
                                                                                                                                                 java.lang.String userAgentFrom,
                                                                                                                                                 @QueryParam(value="adminRoleCode")
                                                                                                                                                 java.lang.String adminRoleCode,
                                                                                                                                                 @QueryParam(value="adminAccountId")
                                                                                                                                                 java.lang.Long adminAccountId)
                                                                                                                                          throws java.lang.Exception

获取Token。

参数:

userName - Rest用户登录名

password - Rest用户密码

loginName - 协同用户的登录名，非必填，指定要绑定的用户

memberId - 协同用户的Id，非必填，同时制定了loginName和memberId时，以memberId为准。

code - 协同用户的人员编码。

userAgentFrom - 请求的终端，如pc、weixin、iphone

返回:

Rest用户验证通过则返回合法token，否则返回-1。

抛出:

java.lang.Exception

getTokenByQueryParam

@POST
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response getTokenByQueryParam(java.util.Map data)
                                                                                                                throws java.lang.Exception

获取Token。

参数:

data - Map的Key支持以下参数：

userName - Rest用户登录名

password - Rest用户密码

loginName - 协同用户的登录名，非必填，指定要绑定的用户

memberId - 协同用户的Id，非必填，同时制定了loginName和memberId时，以memberId为准。

code - 协同用户的人员编码。

userAgentFrom - 请求的终端，如pc、weixin、iphone

返回:

Rest用户验证通过则返回合法token的JSON或XML表示，否则返回-1。

抛出:

java.lang.Exception

bindUser

@PUT
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response bindUser(java.util.Map data)
                                                                                                   throws java.lang.Exception

为token绑定用户。

参数:

data - [loginName:登录名,token:Token]

返回:

绑定后的Token

抛出:

java.lang.Exception

removeToken

@DELETE
 @Path(value="{token}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response removeToken(@PathParam(value="token")
                                                                                                                                         java.lang.String token)

清除token，清除后token失效。为了安全，登出等操作时必须调用

参数:

token - 要清除的token。

返回:

getTokenString

@GET
 @Path(value="{userName}/{password}")
 @Produces(value="text/plain")
public javax.ws.rs.core.Response getTokenString(@PathParam(value="userName")
                                                                                                                             java.lang.String userName,
                                                                                                                             @PathParam(value="password")
                                                                                                                             java.lang.String password,
                                                                                                                             @QueryParam(value="loginName")
                                                                                                                             java.lang.String loginName,
                                                                                                                             @QueryParam(value="memberId")
                                                                                                                             java.lang.Long memberId,
                                                                                                                             @QueryParam(value="code")
                                                                                                                             java.lang.String code,
                                                                                                                             @QueryParam(value="userAgentFrom")
                                                                                                                             java.lang.String userAgentFrom,
                                                                                                                             @QueryParam(value="adminRoleCode")
                                                                                                                             java.lang.String adminRoleCode,
                                                                                                                             @QueryParam(value="adminAccountId")
                                                                                                                             java.lang.Long adminAccountId)
                                                                                                                      throws java.lang.Exception

获取Token。

参数:

data - Map的Key支持以下参数：

userName - Rest用户登录名

password - Rest用户密码

loginName - 协同用户的登录名，非必填，指定要绑定的用户

memberId - 协同用户的Id，非必填，同时制定了loginName和memberId时，以memberId为准。

code - 协同用户的人员编码。

userAgentFrom - 请求的终端，如pc、weixin、iphone

返回:

Rest用户验证通过则返回合法token的String，否则返回-1。

抛出:

java.lang.Exception

checkToken

@GET
 @Path(value="check/{token}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response checkToken(@PathParam(value="token")
                                                                                                                                           java.lang.String token)
                                                                                                                                    throws java.lang.Exception

检查token是否有效

参数:

token - 待检查的token。

返回:

抛出:

java.lang.Exception

createTokenBySystemChannel

@POST
 @Path(value="channel")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response createTokenBySystemChannel(java.util.Map data)
                                                                                                                                               throws com.seeyon.ctp.common.exceptions.BusinessException,
                                                                                                                                                      java.io.IOException

新建信道的token

参数:

data -

返回:

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

java.io.IOException