cn.signit.sdk

类 SignitClient

java.lang.Object

cn.signit.sdk.SignitClient

public class SignitClient
extends Object

易企签快捷签署 Java SDK的基本操作类.

 2018-12-8
 将此Client扩展为易企签所有开放平台应用公共使用的Client
 
 2019-07-31
 将成员变量全部ThreadLocal化，支持单例使用SignitClient对象，保证线程安全
 

构造器概要

构造器

构造器和说明
SignitClient(Authentication auth) 默认为：快捷签署客户端.
SignitClient(Authentication auth, String envUrl) 已过时。
SignitClient(String appId, String secretKey, String appUrl) 应用客户端.
SignitClient(String appId, String secretKey, String appUrl, int connectTimeout, int readTimeout) 应用客户端.

方法概要

限定符和类型	方法和说明
<T extends AbstractSignitResponse> T	execute(AbstractSignitRequest<T> request)
<T extends AbstractSignitResponse> T	executePost(AbstractSignitRequest<T> request, Map<String,String> params)
<T extends AbstractSignitResponse> T	executePut(AbstractSignitRequest<T> request, Map<String,String> params)
<T extends AbstractSignitResponse> T	getData(Class<T> responseClass, Map<String,String> params)
OauthData	getOauthData(String apiKey, String secretKey, TokenType grantType, boolean autoSetRequestToken)
WebhookData	parseWebhookData(String webhook) 快捷签署webhook响应数据解析.
static WebhookResponse	parseWebhookResponse(String webhook) 解析webhook响应数据.
SignatureResponse	sendSignatureRequest(SignatureRequest request) 发送快捷签署请求.
SignitClient	setEnvironmentUrl(String url) 已过时。
SignitClient	setOauthUrl(String url) 设置授权请求路径.
SignitClient	setSignUrl(String url) 已过时。
static boolean	verify(String appId, String appSecretKey, byte[] body, javax.servlet.http.HttpServletRequest request) 客户端验证服务器的webhook响应数据
static boolean	verify(String signitSignature, String appId, HmacSignatureBuilder builder) 客户端验证服务器的webhook响应数据.

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

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

构造器详细资料

SignitClient

public SignitClient(Authentication auth)

默认为：快捷签署客户端.

参数:

auth - 授权信息

从以下版本开始:

1.0.0

SignitClient

@Deprecated
public SignitClient(Authentication auth,
                                 String envUrl)

已过时。

默认为：快捷签署客户端. 期望直接设置应用的请求路径，故而舍弃该方法

参数:

auth - 授权信息

envUrl - 应用环境

从以下版本开始:

1.0.0, 2.0.0 废弃

SignitClient

public SignitClient(String appId,
                    String secretKey,
                    String appUrl)

应用客户端.

参数:

appId - APP ID

secretKey - APP Secret

appUrl - 应用请求路径

从以下版本开始:

2.0.0

SignitClient

public SignitClient(String appId,
                    String secretKey,
                    String appUrl,
                    int connectTimeout,
                    int readTimeout)

应用客户端.

参数:

appId - APP ID

secretKey - APP Secret

appUrl - 应用请求路径

connectTimeout - 连接超时毫秒数

readTimeout - 传输超时毫秒数

从以下版本开始:

2.7.4

方法详细资料

setEnvironmentUrl

@Deprecated
public SignitClient setEnvironmentUrl(String url)

已过时。

不期望用户修改应用环境. 如有需要请直接在初始化时直接设置应用请求路径

参数:

url - 应用环境

返回:

修改应用环境后的快捷签署客户端

从以下版本开始:

1.0.0, 2.0.0 废弃

setOauthUrl

public SignitClient setOauthUrl(String url)

设置授权请求路径.

参数:

url - 授权请求路径

返回:

修改授权路径后的应用客户端

setSignUrl

@Deprecated
public SignitClient setSignUrl(String url)

已过时。

设置快捷签署请求路径. 期望在客戶端初始化时设置应用请求路径，故而废弃

参数:

url - 快捷签署请求路径

返回:

快捷签署客户端

从以下版本开始:

1.0.0, 2.0.0 废弃

sendSignatureRequest

public SignatureResponse sendSignatureRequest(SignatureRequest request)
                                       throws SignitException,
                                              IOException

发送快捷签署请求.

参数:

request - 快捷签署请求

返回:

快捷签署响应

抛出:

SignitException - 易企签自定义异常

IOException - 数据流异常

从以下版本开始:

1.0.0

getOauthData

public OauthData getOauthData(String apiKey,
                              String secretKey,
                              TokenType grantType,
                              boolean autoSetRequestToken)
                       throws SignitException

抛出:

SignitException

parseWebhookData

public WebhookData parseWebhookData(String webhook)

快捷签署webhook响应数据解析.

参数:

webhook - webhook Json格式数据字符串

返回:

推送给调用方的webhook事件数据

从以下版本开始:

1.0.0

parseWebhookResponse

public static WebhookResponse parseWebhookResponse(String webhook)

解析webhook响应数据.

参数:

webhook - webhook Json格式字符串

返回:

推送给调用方的webhook事件数据

从以下版本开始:

2.0.0

getData

public <T extends AbstractSignitResponse> T getData(Class<T> responseClass,
                                                    Map<String,String> params)
                                             throws SignitException

抛出:

SignitException

execute

public <T extends AbstractSignitResponse> T execute(AbstractSignitRequest<T> request)
                                             throws SignitException

抛出:

SignitException

executePost

public <T extends AbstractSignitResponse> T executePost(AbstractSignitRequest<T> request,
                                                        Map<String,String> params)
                                                 throws SignitException

抛出:

SignitException

executePut

public <T extends AbstractSignitResponse> T executePut(AbstractSignitRequest<T> request,
                                                       Map<String,String> params)
                                                throws SignitException

抛出:

SignitException

verify

public static boolean verify(String signitSignature,
                             String appId,
                             HmacSignatureBuilder builder)

客户端验证服务器的webhook响应数据.

参数:

signitSignature - webhook响应header中x-signit-signature数据。服务器构建的hmac，用于客户端验证服务器

appId - APP ID

builder - hmac签名建造器

返回:

验证结果： true-是服务器发送给客户端的数据；false-验证失败

从以下版本开始:

2.0.0

verify

public static boolean verify(String appId,
                             String appSecretKey,
                             byte[] body,
                             javax.servlet.http.HttpServletRequest request)
                      throws IOException

客户端验证服务器的webhook响应数据

参数:

appId - APP ID

appSecretKey - APP Secret

body - webhook响应具体数据。考虑到request中只能获取到body一次，故而需要在方法外获取并传递给此方法

request - 服务端向客户端发起的请求

返回:

验证结果： true-是服务器发送给客户端的数据；false-验证失败

抛出:

IOException - 数据流异常

从以下版本开始:

2.0.0