Package io.servicetalk.http.utils

Class RedirectingHttpRequesterFilter

java.lang.Object

io.servicetalk.http.utils.RedirectingHttpRequesterFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpClientFilterFactory, StreamingHttpConnectionFilterFactory

public final class RedirectingHttpRequesterFilter
extends java.lang.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	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	Description
StreamingHttpClientFilter	create(FilterableStreamingHttpClient client)	Creates a StreamingHttpClientFilter using the provided StreamingHttpClientFilter.
StreamingHttpConnectionFilter	create(FilterableStreamingHttpConnection connection)	Create a StreamingHttpConnectionFilter using the provided FilterableStreamingHttpConnection.
HttpExecutionStrategy	influenceStrategy(HttpExecutionStrategy strategy)	Optionally modify the passed HttpExecutionStrategy to a new HttpExecutionStrategy that suits this HttpExecutionStrategyInfluencer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.servicetalk.http.api.StreamingHttpClientFilterFactory

append, asMultiAddressClientFilter

Methods inherited from interface io.servicetalk.http.api.StreamingHttpConnectionFilterFactory

append

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)

Description copied from interface: StreamingHttpClientFilterFactory

Creates a StreamingHttpClientFilter using the provided StreamingHttpClientFilter.

Specified by:

create in interface StreamingHttpClientFilterFactory

Parameters:

client - FilterableStreamingHttpClient to filter

Returns:

StreamingHttpClientFilter using the provided StreamingHttpClientFilter.

create

public StreamingHttpConnectionFilter create(FilterableStreamingHttpConnection connection)

Description copied from interface: StreamingHttpConnectionFilterFactory

Create a StreamingHttpConnectionFilter using the provided FilterableStreamingHttpConnection.

Specified by:

create in interface StreamingHttpConnectionFilterFactory

Parameters:

connection - FilterableStreamingHttpConnection to filter

Returns:

StreamingHttpConnectionFilter using the provided FilterableStreamingHttpConnection.

influenceStrategy

public HttpExecutionStrategy influenceStrategy(HttpExecutionStrategy strategy)

Description copied from interface: HttpExecutionStrategyInfluencer

Optionally modify the passed HttpExecutionStrategy to a new HttpExecutionStrategy that suits this HttpExecutionStrategyInfluencer.

Specified by:

influenceStrategy in interface HttpExecutionStrategyInfluencer

Parameters:

strategy - HttpExecutionStrategy to influence.

Returns:

HttpExecutionStrategy that suits this HttpExecutionStrategyInfluencer