com.labbol.api.support.request

接口 APIRequest<T extends APIResponse>

所有已知子接口:

QueryAPIRequest<T>

所有已知实现类:

AbstractAPIRequest, AbstractQueryAPIRequest, AbstractUploadFileAPIRequest

public interface APIRequest<T extends APIResponse>

作者:

PengFei

字段概要

字段

限定符和类型	字段和说明
static String[]	COMMON_HEADER_PARAM_NAMES 公共的 header 参数 name

方法概要

限定符和类型	方法和说明
void	check() 验证请求
String	getApiMethodName() api 方法名称
String	getAuthToken() 已过时。 已去除token
org.yelong.http.request.HttpRequest	getHttpRequest() 获取 http 请求
Class<T>	getResponseClass() 获取响应的类型
String	getSchemaTag() 获取 scheam
String	getServerUrl() 获取服务的根url
Long	getTimestamp() 获取时间戳
void	setAuthToken(String authToken) 已过时。 已去除token
void	setSchemaTag(String schemaKey) 设置 schema
void	setServerUrl(String serverUrl) 设置服务的根url
void	setTimestamp(long timestamp) 设置时间戳

字段详细资料

COMMON_HEADER_PARAM_NAMES

static final String[] COMMON_HEADER_PARAM_NAMES

公共的 header 参数 name

方法详细资料

getApiMethodName

String getApiMethodName()

api 方法名称

返回:

setServerUrl

void setServerUrl(String serverUrl)

设置服务的根url

参数:

serverUrl -

getServerUrl

String getServerUrl()

获取服务的根url

返回:

getResponseClass

Class<T> getResponseClass()

获取响应的类型

返回:

check

void check()
    throws APIRuleException

验证请求

抛出:

APIRuleException

setAuthToken

@Deprecated
void setAuthToken(String authToken)

已过时。 已去除token

设置令牌

参数:

authToken -

getAuthToken

@Deprecated
String getAuthToken()

已过时。 已去除token

获取令牌

返回:

setSchemaTag

void setSchemaTag(String schemaKey)

设置 schema

参数:

schemaKey -

getSchemaTag

String getSchemaTag()

获取 scheam

返回:

getTimestamp

Long getTimestamp()

获取时间戳

返回:

setTimestamp

void setTimestamp(long timestamp)

设置时间戳

参数:

timestamp -

getHttpRequest

org.yelong.http.request.HttpRequest getHttpRequest()
                                            throws org.yelong.http.exception.HttpException,
                                                   APIException,
                                                   IOException

获取 http 请求

返回:

抛出:

org.yelong.http.exception.HttpException

APIException

IOException