org.asynchttpclient.filter

Class FilterContext<T>

java.lang.Object

org.asynchttpclient.filter.FilterContext<T>

Type Parameters:

T - the handler result type

public class FilterContext<T>
extends Object

A FilterContext can be used to decorate Request and AsyncHandler from a list of RequestFilter. RequestFilter gets executed before the HTTP request is made to the remote server. Once the response bytes are received, a FilterContext is then passed to the list of ResponseFilter. ResponseFilter gets invoked before the response gets processed, e.g. before authorization, redirection and invocation of AsyncHandler gets processed.
Invoking getResponseStatus() returns an instance of HttpResponseStatus that can be used to decide if the response processing should continue or not. You can stop the current response processing and replay the request but creating a FilterContext. The AsyncHttpClient will interrupt the processing and "replay" the associated Request instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterContext.FilterContextBuilder<T>

Method Summary

Modifier and Type	Method and Description
AsyncHandler<T>	getAsyncHandler()
IOException	getIOException()
Request	getRequest()
HttpResponseHeaders	getResponseHeaders()
HttpResponseStatus	getResponseStatus()
boolean	replayRequest()

Methods inherited from class java.lang.Object

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

Method Detail

getAsyncHandler

public AsyncHandler<T> getAsyncHandler()

Returns:

the original or decorated AsyncHandler

getRequest

public Request getRequest()

Returns:

the original or decorated Request

getResponseStatus

public HttpResponseStatus getResponseStatus()

Returns:

the unprocessed response's HttpResponseStatus

getResponseHeaders

public HttpResponseHeaders getResponseHeaders()

Returns:

the response HttpResponseHeaders

replayRequest

public boolean replayRequest()

Returns:

true if the current response's processing needs to be interrupted and a new Request be executed.

getIOException

public IOException getIOException()

Returns:

the IOException