io.servicetalk.http.utils

Class RedirectingHttpRequesterFilter

Object

RedirectingHttpRequesterFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpClientFilterFactory, StreamingHttpConnectionFilterFactory

public final class RedirectingHttpRequesterFilter
extends Object
implements StreamingHttpClientFilterFactory, StreamingHttpConnectionFilterFactory, HttpExecutionStrategyInfluencer

A HTTP request filter that performs automatic redirects if StreamingHttpRequester.request(HttpExecutionStrategy, StreamingHttpRequest) method receives 3XX status code in the response.

Notes:

• This implementation will not parse a payload for 300 (Multiple Choices) response code, if a preferred choice's URI reference is not returned in the Location header.
• This implementation creates a redirect request internally with a request target in the origin-form and assumes that request target and host header are sufficient for a provided request-to-group-key function.
• Depending on its parameters and context: HttpClient or HttpConnection, this filter may be limited to automatically following relative redirects only.

Constructor Summary

Constructors

Constructor and Description
RedirectingHttpRequesterFilter() Create a new instance, only performing relative redirects.
RedirectingHttpRequesterFilter(boolean onlyRelativeClient) Create a new instance, performing relative redirects only for HttpConnection.
RedirectingHttpRequesterFilter(boolean onlyRelativeClient, boolean onlyRelativeConnection) Create a new instance.
RedirectingHttpRequesterFilter(boolean onlyRelativeClient, boolean onlyRelativeConnection, int maxRedirects) Create a new instance.
RedirectingHttpRequesterFilter(boolean onlyRelativeClient, int maxRedirects) Create a new instance, performing relative redirects only for HttpConnection.
RedirectingHttpRequesterFilter(int maxRedirects) Create a new instance, only performing relative redirects.

Method Summary

Modifier and Type	Method and Description
StreamingHttpClientFilter	create(FilterableStreamingHttpClient client)
StreamingHttpConnectionFilter	create(FilterableStreamingHttpConnection connection)
HttpExecutionStrategy	influenceStrategy(HttpExecutionStrategy strategy)

Methods inherited from class Object

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

Methods inherited from interface StreamingHttpClientFilterFactory

append, asMultiAddressClientFilter

Methods inherited from interface StreamingHttpConnectionFilterFactory

append

Methods inherited from interface HttpExecutionStrategyInfluencer

defaultStreamingInfluencer

Constructor Detail

RedirectingHttpRequesterFilter

public RedirectingHttpRequesterFilter()

Create a new instance, only performing relative redirects.

RedirectingHttpRequesterFilter

public RedirectingHttpRequesterFilter(int maxRedirects)

Create a new instance, only performing relative redirects.

Parameters:

maxRedirects - The maximum number of follow up redirects.

RedirectingHttpRequesterFilter

public RedirectingHttpRequesterFilter(boolean onlyRelativeClient)

Create a new instance, performing relative redirects only for HttpConnection.

Parameters:

onlyRelativeClient - Limits the redirects to relative paths for HttpClient filters.

RedirectingHttpRequesterFilter

public RedirectingHttpRequesterFilter(boolean onlyRelativeClient,
                                      int maxRedirects)

Create a new instance, performing relative redirects only for HttpConnection.

Parameters:

onlyRelativeClient - Limits the redirects to relative paths for HttpClient filters.

maxRedirects - The maximum number of follow up redirects.

RedirectingHttpRequesterFilter

public RedirectingHttpRequesterFilter(boolean onlyRelativeClient,
                                      boolean onlyRelativeConnection)

Create a new instance.

Parameters:

onlyRelativeClient - Limits the redirects to relative paths for HttpClient filters.

onlyRelativeConnection - Limits the redirects to relative paths for HttpConnection filters.

RedirectingHttpRequesterFilter

public RedirectingHttpRequesterFilter(boolean onlyRelativeClient,
                                      boolean onlyRelativeConnection,
                                      int maxRedirects)

Create a new instance.

Parameters:

onlyRelativeClient - Limits the redirects to relative paths for HttpClient filters.

onlyRelativeConnection - Limits the redirects to relative paths for HttpConnection filters.

maxRedirects - The maximum number of follow up redirects.

Method Detail

create

public StreamingHttpClientFilter create(FilterableStreamingHttpClient client)

Specified by:

create in interface StreamingHttpClientFilterFactory

create

public StreamingHttpConnectionFilter create(FilterableStreamingHttpConnection connection)

Specified by:

create in interface StreamingHttpConnectionFilterFactory

influenceStrategy

public HttpExecutionStrategy influenceStrategy(HttpExecutionStrategy strategy)

Specified by:

influenceStrategy in interface HttpExecutionStrategyInfluencer