Package com.ning.http.client.filter

Class FilterContext<T>

java.lang.Object

com.ning.http.client.filter.FilterContext<T>

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 invokation 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 AsyncHttpProvider will interrupt the processing and "replay" the associated Request instance.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
AsyncHandler<T>	getAsyncHandler()	Return the original or decorated AsyncHandler
IOException	getIOException()	Return the IOException
Request	getRequest()	Return the original or decorated Request
HttpResponseHeaders	getResponseHeaders()	Return the response HttpResponseHeaders
HttpResponseStatus	getResponseStatus()	Return the unprocessed response's HttpResponseStatus
boolean	replayRequest()	Return true if the current response's processing needs to be interrupted and a new Request be executed.

Methods inherited from class java.lang.Object

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

Method Details

getAsyncHandler

public AsyncHandler<T> getAsyncHandler()

Return the original or decorated AsyncHandler

Returns:

the original or decorated AsyncHandler

getRequest

public Request getRequest()

Return the original or decorated Request

Returns:

the original or decorated Request

getResponseStatus

public HttpResponseStatus getResponseStatus()

Return the unprocessed response's HttpResponseStatus

Returns:

the unprocessed response's HttpResponseStatus

getResponseHeaders

public HttpResponseHeaders getResponseHeaders()

Return the response HttpResponseHeaders

replayRequest

public boolean replayRequest()

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

Returns:

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

getIOException

public IOException getIOException()

Return the IOException

Returns:

the IOException