com.github.tingyugetc520.ali.dingtalk.api.impl

类 BaseDtServiceImpl

java.lang.Object

com.github.tingyugetc520.ali.dingtalk.api.impl.BaseDtServiceImpl

所有已实现的接口:

BaseService, DtService

直接已知子类:

DtServiceOkHttpImpl

public abstract class BaseDtServiceImpl
extends Object
implements DtService

字段概要

字段

限定符和类型	字段和说明
protected DtConfigStorage	configStorage
protected Object	globalAccessTokenRefreshLock 全局的是否正在刷新access token的锁.

构造器概要

构造器

构造器和说明
BaseDtServiceImpl()

方法概要

限定符和类型	方法和说明
boolean	checkSignature(String signature, String timestamp, String nonce, String data) 验证推送过来的消息的正确性
<T,E> T	execute(RequestExecutor<T,E> executor, String uri, E data) 发送请求，在这里执行的策略是当发生access_token过期时才去刷新，然后重新执行请求，而不是全局定时请求.
protected <T,E> T	executeInternal(RequestExecutor<T,E> executor, String uri, E data)
String	get(String url, String queryParam) 当本Service没有实现某个API的时候，可以用这个，针对所有钉钉API中的GET请求.
String	getAccessToken() 获取access_token, 不强制刷新access_token
DtAgentService	getAgentService() agent service
DtCorpConversationMessageService	getCorpConversationMsgService()
DtDepartmentService	getDepartmentService() 获取部门相关接口的服务类对象
DtOAuth2Service	getOauth2Service() 获取Oauth2相关接口的服务类对象
protected abstract RequestExecutor<String,String>	getOkHttpSimpleGetRequestExecutor() okHttp get请求
protected abstract RequestExecutor<String,String>	getOkHttpSimplePostRequestExecutor() okHttp post请求
DtUserService	getUserService() 获取用户相关接口的服务类对象
String	post(String url, com.google.gson.JsonObject jsonObject) 当本Service没有实现某个API的时候，可以用这个，针对所有钉钉API中的POST请求.
String	post(String url, Object obj) 当本Service没有实现某个API的时候，可以用这个，针对所有钉钉API中的POST请求.
String	post(String url, String postData) 当本Service没有实现某个API的时候，可以用这个，针对所有钉钉API中的POST请求.
void	setDtConfigStorage(DtConfigStorage dtConfigStorage) 注入 DtConfigStorage 的实现

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

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

从接口继承的方法 com.github.tingyugetc520.ali.dingtalk.api.DtService

getAccessToken, getDtConfigStorage, initHttp

字段详细资料

globalAccessTokenRefreshLock

protected final Object globalAccessTokenRefreshLock

全局的是否正在刷新access token的锁.

configStorage

protected DtConfigStorage configStorage

构造器详细资料

BaseDtServiceImpl

public BaseDtServiceImpl()

方法详细资料

checkSignature

public boolean checkSignature(String signature,
                              String timestamp,
                              String nonce,
                              String data)

从接口复制的说明: DtService

 验证推送过来的消息的正确性
 

指定者:

checkSignature 在接口中 DtService

参数:

signature - 消息签名

timestamp - 时间戳

nonce - 随机数

data - 传输过来的数据

返回:

the boolean

getAccessToken

public String getAccessToken()
                      throws DtErrorException

从接口复制的说明: DtService

获取access_token, 不强制刷新access_token

指定者:

getAccessToken 在接口中 DtService

返回:

the access token

抛出:

DtErrorException - the error exception

另请参阅:

DtService.getAccessToken(boolean)

get

public String get(String url,
                  String queryParam)
           throws DtErrorException

从接口复制的说明: BaseService

当本Service没有实现某个API的时候，可以用这个，针对所有钉钉API中的GET请求.

指定者:

get 在接口中 BaseService

参数:

url - 请求接口地址

queryParam - 参数

返回:

接口响应字符串

抛出:

DtErrorException - 异常

post

public String post(String url,
                   String postData)
            throws DtErrorException

从接口复制的说明: BaseService

当本Service没有实现某个API的时候，可以用这个，针对所有钉钉API中的POST请求.

指定者:

post 在接口中 BaseService

参数:

url - 请求接口地址

postData - 请求参数json值

返回:

接口响应字符串

抛出:

DtErrorException - 异常

post

public String post(String url,
                   com.google.gson.JsonObject jsonObject)
            throws DtErrorException

从接口复制的说明: BaseService

当本Service没有实现某个API的时候，可以用这个，针对所有钉钉API中的POST请求.

指定者:

post 在接口中 BaseService

参数:

url - 请求接口地址

jsonObject - 请求对象

返回:

接口响应字符串

抛出:

DtErrorException - 异常

post

public String post(String url,
                   Object obj)
            throws DtErrorException

从接口复制的说明: BaseService

当本Service没有实现某个API的时候，可以用这个，针对所有钉钉API中的POST请求.

指定者:

post 在接口中 BaseService

参数:

url - 请求接口地址

obj - 请求对象

返回:

接口响应字符串

抛出:

DtErrorException - 异常

getOkHttpSimpleGetRequestExecutor

protected abstract RequestExecutor<String,String> getOkHttpSimpleGetRequestExecutor()

okHttp get请求

返回:

executor

getOkHttpSimplePostRequestExecutor

protected abstract RequestExecutor<String,String> getOkHttpSimplePostRequestExecutor()

okHttp post请求

返回:

executor

execute

public <T,E> T execute(RequestExecutor<T,E> executor,
                       String uri,
                       E data)
                throws DtErrorException

发送请求，在这里执行的策略是当发生access_token过期时才去刷新，然后重新执行请求，而不是全局定时请求.

指定者:

execute 在接口中 DtService

类型参数:

T - 请求值类型

E - 返回值类型

参数:

executor - 执行器

uri - 请求地址

data - 参数

返回:

the t

抛出:

DtErrorException - the error exception

executeInternal

protected <T,E> T executeInternal(RequestExecutor<T,E> executor,
                                  String uri,
                                  E data)
                           throws DtErrorException

抛出:

DtErrorException

setDtConfigStorage

public void setDtConfigStorage(DtConfigStorage dtConfigStorage)

从接口复制的说明: DtService

注入 DtConfigStorage 的实现

指定者:

setDtConfigStorage 在接口中 DtService

参数:

dtConfigStorage - 配置对象

getDepartmentService

public DtDepartmentService getDepartmentService()

从接口复制的说明: DtService

获取部门相关接口的服务类对象

指定者:

getDepartmentService 在接口中 DtService

返回:

department service

getOauth2Service

public DtOAuth2Service getOauth2Service()

从接口复制的说明: DtService

获取Oauth2相关接口的服务类对象

指定者:

getOauth2Service 在接口中 DtService

返回:

the oauth 2 service

getUserService

public DtUserService getUserService()

从接口复制的说明: DtService

获取用户相关接口的服务类对象

指定者:

getUserService 在接口中 DtService

返回:

the user service

getAgentService

public DtAgentService getAgentService()

从接口复制的说明: DtService

agent service

指定者:

getAgentService 在接口中 DtService

返回:

service

getCorpConversationMsgService

public DtCorpConversationMessageService getCorpConversationMsgService()

指定者:

getCorpConversationMsgService 在接口中 DtService