类的使用
com.dtflys.forest.http.ForestResponse

使用ForestResponse的程序包

程序包	说明
com.dtflys.forest
com.dtflys.forest.backend
com.dtflys.forest.backend.httpclient.request
com.dtflys.forest.backend.httpclient.response
com.dtflys.forest.backend.okhttp3.executor
com.dtflys.forest.backend.okhttp3.response
com.dtflys.forest.callback
com.dtflys.forest.exceptions
com.dtflys.forest.handler
com.dtflys.forest.http
com.dtflys.forest.interceptor
com.dtflys.forest.lifecycles
com.dtflys.forest.lifecycles.authorization
com.dtflys.forest.lifecycles.file
com.dtflys.forest.logging
com.dtflys.forest.reflection

com.dtflys.forest中ForestResponse的使用

返回变量类型为ForestResponse的类型的com.dtflys.forest中的方法

修饰符和类型	方法	说明
static List<ForestResponse>	Forest.await(ForestFuture... futures)	等待多个请求响应结果，并阻塞当前调用改方法的线程，只有当参数中所有请求结果都返回后才会继续执行
static List<ForestResponse>	Forest.await(Collection<ForestFuture> futures)	等待多个请求响应结果，并阻塞当前调用改方法的线程，只有当参数中所有请求结果都返回后才会继续执行

类型变量类型为ForestResponse的com.dtflys.forest中的方法参数

修饰符和类型	方法	说明
static void	Forest.await(Collection<ForestFuture> futures, Consumer<ForestResponse> callback)	等待多个请求响应结果，并阻塞当前调用改方法的线程，当参数中所有请求结果都返回后调用参数中的 callback 回调函数

com.dtflys.forest.backend中ForestResponse的使用

声明为ForestResponse的com.dtflys.forest.backend中的字段

修饰符和类型	字段	说明
protected ForestResponse	AbstractHttpExecutor.response

返回ForestResponse的com.dtflys.forest.backend中的方法

修饰符和类型	方法	说明
ForestResponse	AsyncHttpExecutor.AsyncTask.get()

参数类型为ForestResponse的com.dtflys.forest.backend中的方法

修饰符和类型	方法	说明
void	ResponseHandler.handleError(ForestResponse response, Throwable ex)
Object	ResponseHandler.handleSync(ForestResponse response, int statusCode, String msg)

com.dtflys.forest.backend.httpclient.request中ForestResponse的使用

参数类型为ForestResponse的com.dtflys.forest.backend.httpclient.request中的方法

修饰符和类型	方法	说明
void	SyncHttpclientRequestSender.logResponse(ForestResponse response)

com.dtflys.forest.backend.httpclient.response中ForestResponse的使用

com.dtflys.forest.backend.httpclient.response中ForestResponse的子类

修饰符和类型	类	说明
class	HttpclientForestResponse

返回ForestResponse的com.dtflys.forest.backend.httpclient.response中的方法

修饰符和类型	方法	说明
ForestResponse<?>	HttpclientForestResponseFactory.createResponse(ForestRequest<?> request, org.apache.http.HttpResponse httpResponse, LifeCycleHandler lifeCycleHandler, Throwable exception, Date requestTime)

参数类型为ForestResponse的com.dtflys.forest.backend.httpclient.response中的方法

修饰符和类型	方法	说明
void	HttpclientResponseHandler.handleSync(org.apache.http.HttpResponse httpResponse, ForestResponse response)

com.dtflys.forest.backend.okhttp3.executor中ForestResponse的使用

参数类型为ForestResponse的com.dtflys.forest.backend.okhttp3.executor中的方法

修饰符和类型	方法	说明
void	OkHttp3Executor.logResponse(ForestResponse response)

com.dtflys.forest.backend.okhttp3.response中ForestResponse的使用

com.dtflys.forest.backend.okhttp3.response中ForestResponse的子类

修饰符和类型	类	说明
class	OkHttp3ForestResponse

返回ForestResponse的com.dtflys.forest.backend.okhttp3.response中的方法

修饰符和类型	方法	说明
ForestResponse<?>	OkHttp3ForestResponseFactory.createResponse(ForestRequest<?> request, okhttp3.Response res, LifeCycleHandler lifeCycleHandler, Throwable exception, Date requestTime)

参数类型为ForestResponse的com.dtflys.forest.backend.okhttp3.response中的方法

修饰符和类型	方法	说明
Object	OkHttp3ResponseHandler.handleSync(okhttp3.Response okResponse, ForestResponse response)

com.dtflys.forest.callback中ForestResponse的使用

参数类型为ForestResponse的com.dtflys.forest.callback中的方法

修饰符和类型	方法	说明
void	OnCanceled.onCanceled(ForestRequest req, ForestResponse res)	请求取消后调用该方法
void	OnError.onError(ForestRuntimeException ex, ForestRequest req, ForestResponse res)	请求失败后调用该方法
void	OnRedirection.onRedirection(ForestRequest<?> redirectReq, ForestRequest<?> prevReq, ForestResponse<?> prevRes)	回调函数:在请求重定向时触发
void	OnRetry.onRetry(ForestRequest req, ForestResponse res)	回调函数: 在触发请求重试时执行
void	OnSuccess.onSuccess(T data, ForestRequest req, ForestResponse res)	请求成功后调用该方法
boolean	DefaultRetryWhen.retryWhen(ForestRequest request, ForestResponse response)
boolean	RetryWhen.retryWhen(ForestRequest req, ForestResponse res)	回调函数: 是否触发重试
boolean	DefaultSuccessWhen.successWhen(ForestRequest req, ForestResponse res)
boolean	SuccessWhen.successWhen(ForestRequest req, ForestResponse res)	回调函数: 请求是否成功

com.dtflys.forest.exceptions中ForestResponse的使用

返回ForestResponse的com.dtflys.forest.exceptions中的方法

修饰符和类型	方法	说明
ForestResponse	ForestHandlerException.getResponse()
ForestResponse	ForestNetworkException.getResponse()

参数类型为ForestResponse的com.dtflys.forest.exceptions中的方法

修饰符和类型	方法	说明
void	ForestHandlerException.setResponse(ForestResponse response)

参数类型为ForestResponse的com.dtflys.forest.exceptions中的构造器

限定符	构造器	说明
	ForestHandlerException(String message, ForestRequest request, ForestResponse response)
	ForestHandlerException(String message, Throwable cause, ForestRequest request, ForestResponse response)
	ForestHandlerException(Throwable cause, ForestRequest request, ForestResponse response)
	ForestNetworkException(String message, Integer statusCode, ForestResponse response)

com.dtflys.forest.handler中ForestResponse的使用

参数类型为ForestResponse的com.dtflys.forest.handler中的方法

修饰符和类型	方法	说明
OAuth2Token	AutoOAuth2DefinitionHandler.getOAuth2Token(ForestResponse<String> response, Map map)
OAuth2Token	OAuth2DefinitionHandler.getOAuth2Token(ForestResponse<String> response, Map map)	处理认证响应实体
Object	ResultHandler.getResult(ForestRequest request, ForestResponse response, Class resultClass)	进行转换并获取结果
Object	ResultHandler.getResult(ForestRequest request, ForestResponse response, Type resultType)	进行转换并获取结果
Object	ResultHandler.getResult(ForestRequest request, ForestResponse response, Type resultType, Class resultClass)
void	LifeCycleHandler.handleCanceled(ForestRequest request, ForestResponse response)
Object	LifeCycleHandler.handleError(ForestRequest request, ForestResponse response)
Object	LifeCycleHandler.handleError(ForestRequest request, ForestResponse response, Throwable ex)
Object	LifeCycleHandler.handleResultType(ForestRequest request, ForestResponse response)
Object	LifeCycleHandler.handleResultType(ForestRequest request, ForestResponse response, Type resultType, Class resultClass)
void	LifeCycleHandler.handleSuccess(Object resultData, ForestRequest request, ForestResponse response)
Object	LifeCycleHandler.handleSync(ForestRequest request, ForestResponse response)
Object	LifeCycleHandler.handleSyncWithException(ForestRequest request, ForestResponse response, Throwable ex)
protected boolean	ResultHandler.isReceivedResponseData(ForestResponse response)

com.dtflys.forest.http中ForestResponse的使用

返回ForestResponse的com.dtflys.forest.http中的方法

修饰符和类型	方法	说明
ForestResponse<T>	ForestFuture.await()
ForestResponse<T>	ForestFuture.await(long timeout, TimeUnit unit)
ForestResponse<?>	ForestResponseFactory.createResponse(ForestRequest<?> request, R res, LifeCycleHandler lifeCycleHandler, Throwable exception, Date requestTime)
ForestResponse	ForestRequest.executeAsResponse()	执行请求发送过程，并获取响应类型结果
ForestResponse<?>	ForestRequest.getPrevResponse()	获取重定向的上一个响应
ForestResponse<T>	ForestFuture.getResponse()
protected ForestResponse	ForestResponse.getResponse()
protected abstract ForestResponse	ResultGetter.getResponse()

参数类型为ForestResponse的com.dtflys.forest.http中的方法

修饰符和类型	方法	说明
ForestRetryException	ForestRequest.canRetry(ForestResponse<?> response)	是否能够重试
final ForestRetryException	ForestRequest.canRetry(ForestResponse<?> response, ForestRetryException ex)	是否能重试

类型变量类型为ForestResponse的com.dtflys.forest.http中的构造器参数

限定符	构造器	说明
	ForestFuture(ForestRequest<T> request, Future<ForestResponse<T>> future)

com.dtflys.forest.interceptor中ForestResponse的使用

参数类型为ForestResponse的com.dtflys.forest.interceptor中的方法

修饰符和类型	方法	说明
default void	Interceptor.afterExecute(ForestRequest request, ForestResponse response)	默认回调函数: 请求完成后(成功/失败后) 调用该方法
void	InterceptorChain.afterExecute(ForestRequest request, ForestResponse response)
default void	Interceptor.onCanceled(ForestRequest req, ForestResponse res)	默认回调函数: 请求取消后调用该方法
void	InterceptorChain.onCanceled(ForestRequest request, ForestResponse response)
default void	Interceptor.onError(ForestRuntimeException ex, ForestRequest request, ForestResponse response)	默认回调函数: 请求失败后调用该方法
void	InterceptorChain.onError(ForestRuntimeException ex, ForestRequest request, ForestResponse response)
default void	Interceptor.onRedirection(ForestRequest<?> redirectReq, ForestRequest<?> prevReq, ForestResponse<?> prevRes)	默认回调函数:在请求重定向时触发
void	InterceptorChain.onRedirection(ForestRequest redirectReq, ForestRequest prevReq, ForestResponse prevRes)
default void	Interceptor.onRetry(ForestRequest request, ForestResponse response)	默认回调函数: 在触发请求重试时执行
void	InterceptorChain.onRetry(ForestRequest request, ForestResponse response)
default void	Interceptor.onSuccess(T data, ForestRequest request, ForestResponse response)	默认回调函数: 请求成功后调用该方法
void	InterceptorChain.onSuccess(Object data, ForestRequest request, ForestResponse response)

com.dtflys.forest.lifecycles中ForestResponse的使用

参数类型为ForestResponse的com.dtflys.forest.lifecycles中的方法

修饰符和类型	方法	说明
default void	BaseAnnotationLifeCycle.onError(ForestRuntimeException ex, ForestRequest request, ForestResponse response)
default void	MethodAnnotationLifeCycle.onError(ForestRuntimeException ex, ForestRequest request, ForestResponse response)
default void	ParameterAnnotationLifeCycle.onError(ForestRuntimeException ex, ForestRequest request, ForestResponse response)
default void	BaseAnnotationLifeCycle.onSuccess(I data, ForestRequest request, ForestResponse response)
default void	MethodAnnotationLifeCycle.onSuccess(I data, ForestRequest request, ForestResponse response)
default void	ParameterAnnotationLifeCycle.onSuccess(I data, ForestRequest request, ForestResponse response)

com.dtflys.forest.lifecycles.authorization中ForestResponse的使用

返回ForestResponse的com.dtflys.forest.lifecycles.authorization中的方法

修饰符和类型	方法	说明
ForestResponse<String>	OAuth2Client.token(String tokenUri, Map<String,Object> query, Map<String,Object> body)	获取 Token

com.dtflys.forest.lifecycles.file中ForestResponse的使用

参数类型为ForestResponse的com.dtflys.forest.lifecycles.file中的方法

修饰符和类型	方法	说明
void	DownloadLifeCycle.onSuccess(Object data, ForestRequest request, ForestResponse response)

com.dtflys.forest.logging中ForestResponse的使用

返回ForestResponse的com.dtflys.forest.logging中的方法

修饰符和类型	方法	说明
ForestResponse	ResponseLogMessage.getResponse()

参数类型为ForestResponse的com.dtflys.forest.logging中的构造器

限定符	构造器	说明
	ResponseLogMessage(ForestResponse response, int status)

com.dtflys.forest.reflection中ForestResponse的使用

返回ForestResponse的com.dtflys.forest.reflection中的方法

修饰符和类型	方法	说明
ForestResponse<T>	MethodLifeCycleHandler.getResponse()

参数类型为ForestResponse的com.dtflys.forest.reflection中的方法

修饰符和类型	方法	说明
void	MethodLifeCycleHandler.handleCanceled(ForestRequest request, ForestResponse response)
void	NoneLifeCycleHandler.handleCanceled(ForestRequest request, ForestResponse response)
Object	MethodLifeCycleHandler.handleError(ForestRequest request, ForestResponse response)
Object	MethodLifeCycleHandler.handleError(ForestRequest request, ForestResponse response, Throwable ex)
Object	NoneLifeCycleHandler.handleError(ForestRequest request, ForestResponse response)
Object	NoneLifeCycleHandler.handleError(ForestRequest request, ForestResponse response, Throwable ex)
Object	MethodLifeCycleHandler.handleResultType(ForestRequest request, ForestResponse response)
Object	MethodLifeCycleHandler.handleResultType(ForestRequest request, ForestResponse response, Type resultType, Class resultClass)
Object	NoneLifeCycleHandler.handleResultType(ForestRequest request, ForestResponse response)
Object	NoneLifeCycleHandler.handleResultType(ForestRequest request, ForestResponse response, Type resultType, Class resultClass)
void	MethodLifeCycleHandler.handleSuccess(Object resultData, ForestRequest request, ForestResponse response)
void	NoneLifeCycleHandler.handleSuccess(Object resultData, ForestRequest request, ForestResponse response)
Object	MethodLifeCycleHandler.handleSync(ForestRequest request, ForestResponse response)
Object	NoneLifeCycleHandler.handleSync(ForestRequest request, ForestResponse response)
Object	MethodLifeCycleHandler.handleSyncWithException(ForestRequest request, ForestResponse response, Throwable ex)
Object	NoneLifeCycleHandler.handleSyncWithException(ForestRequest request, ForestResponse response, Throwable ex)