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 and Description
static class	FilterContext.FilterContextBuilder<T>

Constructor Summary

Constructors

Constructor and Description
FilterContext(AsyncHandler<T> asyncHandler, Request request) Deprecated. use FilterContext.FilterContextBuilder instead
FilterContext(AsyncHandler<T> asyncHandler, Request request, boolean replayRequest) Deprecated. use FilterContext.FilterContextBuilder instead
FilterContext(AsyncHandler<T> asyncHandler, Request request, HttpResponseStatus responseStatus) Deprecated. use FilterContext.FilterContextBuilder instead
FilterContext(AsyncHandler<T> asyncHandler, Request request, IOException ioException) Deprecated. use FilterContext.FilterContextBuilder instead

Method Summary

Methods

Modifier and Type	Method and Description
AsyncHandler<T>	getAsyncHandler() Return the original or decorated AsyncHandler
IOException	getIOException() Return the IOException
Request	getRequest() Return the original or decorated Request
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

Constructor Detail

FilterContext

public FilterContext(AsyncHandler<T> asyncHandler,
             Request request)

Deprecated. use FilterContext.FilterContextBuilder instead

Create a new FilterContext

Parameters:

asyncHandler - an AsyncHandler

request - a Request

FilterContext

public FilterContext(AsyncHandler<T> asyncHandler,
             Request request,
             IOException ioException)

Deprecated. use FilterContext.FilterContextBuilder instead

Create a new FilterContext

Parameters:

asyncHandler - an AsyncHandler

request - a Request

ioException - an IOException

FilterContext

public FilterContext(AsyncHandler<T> asyncHandler,
             Request request,
             HttpResponseStatus responseStatus)

Deprecated. use FilterContext.FilterContextBuilder instead

Create a new FilterContext

Parameters:

asyncHandler - an AsyncHandler

request - a Request

responseStatus - a HttpResponseStatus

FilterContext

public FilterContext(AsyncHandler<T> asyncHandler,
             Request request,
             boolean replayRequest)

Deprecated. use FilterContext.FilterContextBuilder instead

Create a new FilterContext

Parameters:

asyncHandler - an AsyncHandler

request - a Request

replayRequest - true if the current response processing needs to be interrupted, and a new Request be processed.

Method Detail

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

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