org.asynchttpclient.filter

Interface ResponseFilter

public interface ResponseFilter

A Filter interface that gets invoked before making the processing of the response bytes. ResponseFilter are invoked before the actual response's status code get processed. That means authorization, proxy authentication and redirects processing hasn't occurred when ResponseFilter gets invoked.

Method Summary

Modifier and Type	Method and Description
<T> FilterContext<T>	filter(FilterContext<T> ctx) An AsyncHttpClient will invoke filter(org.asynchttpclient.filter.FilterContext<T>) and will use the returned FilterContext.replayRequest() and FilterContext.getAsyncHandler() to decide if the response processing can continue.

Method Detail

filter

<T> FilterContext<T> filter(FilterContext<T> ctx)
                     throws FilterException

An AsyncHttpClient will invoke filter(org.asynchttpclient.filter.FilterContext<T>) and will use the returned FilterContext.replayRequest() and FilterContext.getAsyncHandler() to decide if the response processing can continue. If FilterContext.replayRequest() return true, a new request will be made using FilterContext.getRequest() and the current response processing will be ignored.

Type Parameters:

T - the handler result type

Parameters:

ctx - a FilterContext

Returns:

FilterContext. The FilterContext instance may not the same as the original one.

Throws:

FilterException - to interrupt the filter processing.