com.labbol.api.support.request

类 AbstractAPIRequest<T extends APIResponse>

java.lang.Object

com.labbol.api.support.request.AbstractAPIRequest<T>

所有已实现的接口:

APIRequest<T>

直接已知子类:

AbstractQueryAPIRequest, AbstractUploadFileAPIRequest

public abstract class AbstractAPIRequest<T extends APIResponse>
extends Object
implements APIRequest<T>

作者:

PengFei

字段概要

字段

限定符和类型	字段和说明
protected com.google.gson.Gson	gson
protected org.yelong.http.request.HttpRequest	httpRequest
static String	SCHEMA_KEY
static String	X_AUTH_TOKEN 已过时。

从接口继承的字段 com.labbol.api.support.request.APIRequest

COMMON_HEADER_PARAM_NAMES

构造器概要

构造器

构造器和说明
AbstractAPIRequest(String apiMethodName, String method)

方法概要

限定符和类型	方法和说明
void	check() 验证请求
String	getApiMethodName() api 方法名称
String	getAuthToken() 获取令牌
org.yelong.http.request.HttpRequest	getHttpRequest() 获取 http 请求
String	getSchemaTag() 获取 scheam
String	getServerUrl() 获取服务的根url
Long	getTimestamp() 获取时间戳
void	setAuthToken(String authToken) 设置令牌
void	setSchemaTag(String schemaTag) 设置 schema
void	setServerUrl(String serverUrl) 设置服务的根url
void	setTimestamp(long timestamp) 设置时间戳

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

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

从接口继承的方法 com.labbol.api.support.request.APIRequest

getResponseClass

字段详细资料

X_AUTH_TOKEN

@Deprecated
public static final String X_AUTH_TOKEN

已过时。

另请参阅:

常量字段值

SCHEMA_KEY

public static final String SCHEMA_KEY

另请参阅:

常量字段值

gson

protected final com.google.gson.Gson gson

httpRequest

protected org.yelong.http.request.HttpRequest httpRequest

构造器详细资料

AbstractAPIRequest

public AbstractAPIRequest(String apiMethodName,
                          String method)

方法详细资料

getApiMethodName

public String getApiMethodName()

从接口复制的说明: APIRequest

api 方法名称

指定者:

getApiMethodName 在接口中 APIRequest<T extends APIResponse>

返回:

getServerUrl

public String getServerUrl()

从接口复制的说明: APIRequest

获取服务的根url

指定者:

getServerUrl 在接口中 APIRequest<T extends APIResponse>

返回:

setServerUrl

public void setServerUrl(String serverUrl)

从接口复制的说明: APIRequest

设置服务的根url

指定者:

setServerUrl 在接口中 APIRequest<T extends APIResponse>

setAuthToken

public void setAuthToken(String authToken)

从接口复制的说明: APIRequest

设置令牌

指定者:

setAuthToken 在接口中 APIRequest<T extends APIResponse>

getAuthToken

public String getAuthToken()

从接口复制的说明: APIRequest

获取令牌

指定者:

getAuthToken 在接口中 APIRequest<T extends APIResponse>

返回:

check

public void check()
           throws APIRuleException

从接口复制的说明: APIRequest

验证请求

指定者:

check 在接口中 APIRequest<T extends APIResponse>

抛出:

APIRuleException

getHttpRequest

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

从接口复制的说明: APIRequest

获取 http 请求

指定者:

getHttpRequest 在接口中 APIRequest<T extends APIResponse>

返回:

抛出:

org.yelong.http.exception.HttpException

APIException

IOException

setSchemaTag

public void setSchemaTag(String schemaTag)

从接口复制的说明: APIRequest

设置 schema

指定者:

setSchemaTag 在接口中 APIRequest<T extends APIResponse>

getSchemaTag

public String getSchemaTag()

从接口复制的说明: APIRequest

获取 scheam

指定者:

getSchemaTag 在接口中 APIRequest<T extends APIResponse>

返回:

getTimestamp

public Long getTimestamp()

从接口复制的说明: APIRequest

获取时间戳

指定者:

getTimestamp 在接口中 APIRequest<T extends APIResponse>

返回:

setTimestamp

public void setTimestamp(long timestamp)

从接口复制的说明: APIRequest

设置时间戳

指定者:

setTimestamp 在接口中 APIRequest<T extends APIResponse>