io.servicetalk.http.utils

Class RedirectingHttpRequesterFilter

Object

RedirectingHttpRequesterFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpClientFilterFactory, StreamingHttpConnectionFilterFactory

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

An HTTP request filter that performs automatic redirection if a client 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.
• Depending on its parameters and context: HttpClient or HttpConnection, this filter may be limited to automatically following relative redirects only.
• This implementation will automatically redirect headers and message body for relative locations.
• For security reasons, this implementation will NOT automatically redirect headers and message body for non-relative locations. Use RedirectConfig to opt-in for redirect of requires request components.

Constructor Summary

Constructors

Constructor and Description
RedirectingHttpRequesterFilter() Create a new instance, only performing relative redirects.
RedirectingHttpRequesterFilter(boolean onlyRelativeClient) Deprecated. Use RedirectingHttpRequesterFilter(RedirectConfig).
RedirectingHttpRequesterFilter(boolean onlyRelativeClient, boolean onlyRelativeConnection) Deprecated. Use RedirectingHttpRequesterFilter(RedirectConfig).
RedirectingHttpRequesterFilter(boolean onlyRelativeClient, boolean onlyRelativeConnection, int maxRedirects) Deprecated. Use RedirectingHttpRequesterFilter(RedirectConfig).
RedirectingHttpRequesterFilter(boolean onlyRelativeClient, int maxRedirects) Deprecated. Use RedirectingHttpRequesterFilter(RedirectConfig).
RedirectingHttpRequesterFilter(int maxRedirects) Deprecated. Use RedirectingHttpRequesterFilter(RedirectConfig).
RedirectingHttpRequesterFilter(RedirectConfig config) Create a new instance.

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

@Deprecated
public RedirectingHttpRequesterFilter(int maxRedirects)

Deprecated. Use RedirectingHttpRequesterFilter(RedirectConfig).

Create a new instance, only performing relative redirects.

Parameters:

maxRedirects - The maximum number of follow up redirects.

RedirectingHttpRequesterFilter

@Deprecated
public RedirectingHttpRequesterFilter(boolean onlyRelativeClient)

Deprecated. Use RedirectingHttpRequesterFilter(RedirectConfig).

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

Parameters:

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

RedirectingHttpRequesterFilter

@Deprecated
public RedirectingHttpRequesterFilter(boolean onlyRelativeClient,
                                                  int maxRedirects)

Deprecated. Use RedirectingHttpRequesterFilter(RedirectConfig).

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

@Deprecated
public RedirectingHttpRequesterFilter(boolean onlyRelativeClient,
                                                  boolean onlyRelativeConnection)

Deprecated. Use RedirectingHttpRequesterFilter(RedirectConfig).

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

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

Deprecated. Use RedirectingHttpRequesterFilter(RedirectConfig).

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.

RedirectingHttpRequesterFilter

public RedirectingHttpRequesterFilter(RedirectConfig config)

Create a new instance.

Parameters:

config - RedirectConfig to customize the behavior.

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