com.seeyon.client
接口 CTPRestClient

public interface CTPRestClient

REST Client，访问平台的REST服务。

从以下版本开始：

V5.1

作者：

wangwenyou

方法摘要

boolean	authenticate(java.lang.String userName, java.lang.String password) 登录校验。
<T> T	delete(java.lang.String path, java.lang.Object body, java.lang.Class<T> clazz)
<T> T	get(java.lang.String path, java.lang.Class<T> clazz) 调用REST服务的GET请求。
<T> T	get(java.lang.String path, java.lang.Class<T> clazz, java.lang.String accept) 调用REST服务的GET请求。
<T> java.util.List<T>	getList(java.lang.String path, java.lang.Class<T> clazz) 调用REST服务的GET请求获取结果为List的资源。
<T> T	post(java.lang.String path, java.lang.Object body, java.lang.Class<T> clazz)
<T> T	post(java.lang.String path, java.lang.Object body, java.lang.Class<T> clazz, java.lang.String accept)
<T> T	put(java.lang.String path, java.lang.Object body, java.lang.Class<T> clazz) 调用REST服务的PUT请求进行更新。
<T> T	put(java.lang.String path, java.lang.Object body, java.lang.Class<T> clazz, java.lang.String accept)
void	setSession(javax.servlet.http.HttpSession session)
void	setSession(java.lang.String sessionId)

方法详细信息

authenticate

boolean authenticate(java.lang.String userName,
                     java.lang.String password)

登录校验。

参数：

userName - 服务用户名

password - 服务用户密码

返回：

验证通过返回true。

get

<T> T get(java.lang.String path,
          java.lang.Class<T> clazz)

调用REST服务的GET请求。

参数：

path - 资源路径，不包含上下文，如member/?loginName=test

clazz - 期望的返回值类型，如V3xOrgMember.class。

返回：

get

<T> T get(java.lang.String path,
          java.lang.Class<T> clazz,
          java.lang.String accept)

调用REST服务的GET请求。

参数：

path - 资源路径，不包含上下文，如member/?loginName=test

clazz - 期望的返回值类型，如V3xOrgMember.class。

accept - REST内容协商，返回值的表现形式，缺省为application/json，我们部分接口返回XML，请使用application/xml。

返回：

getList

<T> java.util.List<T> getList(java.lang.String path,
                              java.lang.Class<T> clazz)

调用REST服务的GET请求获取结果为List的资源。

参数：

path - 资源路径，不包含上下文，如members/123456789

clazz - 期待的返回值类型

返回：

put

<T> T put(java.lang.String path,
          java.lang.Object body,
          java.lang.Class<T> clazz)

调用REST服务的PUT请求进行更新。

参数：

path - 资源路径，不包含上下文

body - 要更新的实体，可以是对象，通常使用Map或JSON String.

clazz - 期待的返回值类型

返回：

post

<T> T post(java.lang.String path,
           java.lang.Object body,
           java.lang.Class<T> clazz,
           java.lang.String accept)

参数：

path -

body -

clazz -

accept -

返回：

put

<T> T put(java.lang.String path,
          java.lang.Object body,
          java.lang.Class<T> clazz,
          java.lang.String accept)

参数：

path -

body -

clazz -

accept -

返回：

post

<T> T post(java.lang.String path,
           java.lang.Object body,
           java.lang.Class<T> clazz)

参数：

path -

body -

clazz -

返回：

delete

<T> T delete(java.lang.String path,
             java.lang.Object body,
             java.lang.Class<T> clazz)

参数：

path -

body -

clazz -

返回：

setSession

void setSession(java.lang.String sessionId)

setSession

void setSession(javax.servlet.http.HttpSession session)