io.servicetalk.http.api

Class RedirectConfigBuilder

Object

RedirectConfigBuilder

public final class RedirectConfigBuilder
extends Object

Builder for RedirectConfig.

Constructor Summary

Constructors

Constructor and Description
RedirectConfigBuilder()

Method Summary

Modifier and Type	Method and Description
RedirectConfigBuilder	allowedMethods(HttpRequestMethod... methods) Sets HttpRequestMethods that are allowed to follow redirects.
RedirectConfigBuilder	allowedStatuses(HttpResponseStatus... statuses) Sets HttpResponseStatuses that are allowed to follow redirects.
RedirectConfigBuilder	allowNonRelativeRedirects(boolean allowNonRelativeRedirects) Allows non-relative redirects (if supported by the underlying client implementation).
RedirectConfig	build() Builds a new RedirectConfig.
RedirectConfigBuilder	changePostToGet(boolean changePostToGet) Enforces change of the request method from POST to GET for subsequent requests for 301 (Moved Permanently) and 302 (Found) status codes.
RedirectConfigBuilder	headersToRedirect(CharSequence... headerNames) Configures headers that have to be copied from the original request on each non-relative redirect.
RedirectConfigBuilder	locationMapper(BiFunction<HttpRequestMetaData,HttpResponseMetaData,String> locationMapper) Sets a function to extract redirect location information from the redirect response, optionally considering the previous request as well.
RedirectConfigBuilder	maxRedirects(int maxRedirects) Sets the maximum number of redirects to follow.
RedirectConfigBuilder	redirectPayloadBody(boolean redirectPayloadBody) Allows redirecting payload body of the original request on each non-relative redirect.
RedirectConfigBuilder	redirectPredicate(RedirectConfig.RedirectPredicate predicate) Sets a predicate for an additional check to decide if the redirect should be performed or not based on the given context.
RedirectConfigBuilder	redirectRequestTransformer(RedirectConfig.RedirectRequestTransformer transformer) Sets a transformer to apply further modifications for the redirect request after it was initialized.
RedirectConfigBuilder	trailersToRedirect(CharSequence... trailerNames) Configures trailers that have to be copied from the original request on each non-relative redirect.

Methods inherited from class Object

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

Constructor Detail

RedirectConfigBuilder

public RedirectConfigBuilder()

Method Detail

maxRedirects

public RedirectConfigBuilder maxRedirects(int maxRedirects)

Sets the maximum number of redirects to follow.

Parameters:

maxRedirects - The maximum number of redirects to follow

Returns:

this

allowedStatuses

public RedirectConfigBuilder allowedStatuses(HttpResponseStatus... statuses)

Sets HttpResponseStatuses that are allowed to follow redirects.

All statuses must belong to REDIRECTION_3XX status class.

Parameters:

statuses - HttpResponseStatuses that are allowed to follow redirects

Returns:

this

allowedMethods

public RedirectConfigBuilder allowedMethods(HttpRequestMethod... methods)

Sets HttpRequestMethods that are allowed to follow redirects.

Parameters:

methods - HttpRequestMethods that are allowed to follow redirects

Returns:

this

allowNonRelativeRedirects

public RedirectConfigBuilder allowNonRelativeRedirects(boolean allowNonRelativeRedirects)

Allows non-relative redirects (if supported by the underlying client implementation). Non-relative redirects are redirects to either a different target host/port or a different scheme.

Notes:

1. This option has effect only when redirections is performed by a client that is capable to communicate with multiple target hosts or schemes, like the one which is produced by MultiAddressHttpClientBuilder. If a client is limited to only one target host/port/scheme, it will follow only relative redirects.
2. For security reasons, redirection should not automatically copy headers nor message body of the original request for non-relative locations. Use headersToRedirect(CharSequence...), redirectPayloadBody(boolean), trailersToRedirect(CharSequence...), or redirectRequestTransformer(RedirectConfig.RedirectRequestTransformer) if headers or message body should be preserved.

Parameters:

allowNonRelativeRedirects - If true, redirection will follow non-relative locations (if supported by the underlying client implementation)

Returns:

this

See Also:

MultiAddressHttpClientBuilder, headersToRedirect(CharSequence...), redirectPayloadBody(boolean), trailersToRedirect(CharSequence...), redirectRequestTransformer(RedirectConfig.RedirectRequestTransformer)

locationMapper

public RedirectConfigBuilder locationMapper(BiFunction<HttpRequestMetaData,HttpResponseMetaData,String> locationMapper)

Sets a function to extract redirect location information from the redirect response, optionally considering the previous request as well.

Per RFC7231, section 7.1.2 3xx (Redirection) responses use Location header value as the preferred target resource for automatically redirecting the request. However, the target resource can be identified by a custom header or a combination of previous request and 3xx (Redirection) response meta-data.

Parameters:

locationMapper - A function to extract redirect location information. If the function returns null, redirection response won't be followed

Returns:

this

redirectPredicate

public RedirectConfigBuilder redirectPredicate(RedirectConfig.RedirectPredicate predicate)

Sets a predicate for an additional check to decide if the redirect should be performed or not based on the given context.

Parameters:

predicate - RedirectConfig.RedirectPredicate for an additional check to decide if the redirect should be performed or not based on the given context

Returns:

this

See Also:

maxRedirects(int), allowedMethods(HttpRequestMethod...), allowNonRelativeRedirects(boolean)

changePostToGet

public RedirectConfigBuilder changePostToGet(boolean changePostToGet)

Enforces change of the request method from POST to GET for subsequent requests for 301 (Moved Permanently) and 302 (Found) status codes.

For historical reasons, RFC7231 sections 6.4.2 and 6.4.3 allow user agents to change the request method from POST to GET for the subsequent request. If this behavior is undesired, this option can be turned off or 307 (Temporary Redirect) and 308 (Permanent Redirect) status codes can be used instead.

Parameters:

changePostToGet - if true, request method will change from POST to GET while following 301 (Moved Permanently) or 302 (Found) redirect status codes

Returns:

this

headersToRedirect

public RedirectConfigBuilder headersToRedirect(CharSequence... headerNames)

Configures headers that have to be copied from the original request on each non-relative redirect.

Note: for security reasons, redirection should not automatically copy any headers from the original request when it performs a non-relative redirect. For relative redirects, everything is copied by default. Use redirectRequestTransformer(RedirectConfig.RedirectRequestTransformer) if more customization required.

Parameters:

headerNames - Names of headers that have to be copied on each non-relative redirect

Returns:

this

See Also:

allowNonRelativeRedirects(boolean), redirectPayloadBody(boolean), trailersToRedirect(CharSequence...), redirectRequestTransformer(RedirectConfig.RedirectRequestTransformer)

redirectPayloadBody

public RedirectConfigBuilder redirectPayloadBody(boolean redirectPayloadBody)

Allows redirecting payload body of the original request on each non-relative redirect.

Note: for security reasons, redirection should not automatically copy payload body of the original request when it performs a non-relative redirect. For relative redirects, everything is copied by default. Use redirectRequestTransformer(RedirectConfig.RedirectRequestTransformer) if more customization required.

Note: This option expects that the redirected requests have a payload body that is replayable, i.e. multiple subscribes to the payload Publisher observe the same data. Publishers that do not emit any data or which are created from in-memory data are typically replayable.

Parameters:

redirectPayloadBody - If true, payload body of the original request will be repeated for each non-relative redirect

Returns:

this

See Also:

allowNonRelativeRedirects(boolean), headersToRedirect(CharSequence...), trailersToRedirect(CharSequence...), redirectRequestTransformer(RedirectConfig.RedirectRequestTransformer)

trailersToRedirect

public RedirectConfigBuilder trailersToRedirect(CharSequence... trailerNames)

Configures trailers that have to be copied from the original request on each non-relative redirect.

Note: for security reasons, redirection should not automatically copy any trailers from the original request when it performs a non-relative redirect. For relative redirects, everything is copied by default. Use redirectRequestTransformer(RedirectConfig.RedirectRequestTransformer) if more customization required.

Parameters:

trailerNames - Names of trailers that have to be copied on each non-relative redirect

Returns:

this

See Also:

allowNonRelativeRedirects(boolean), headersToRedirect(CharSequence...), redirectPayloadBody(boolean), redirectRequestTransformer(RedirectConfig.RedirectRequestTransformer)

redirectRequestTransformer

public RedirectConfigBuilder redirectRequestTransformer(RedirectConfig.RedirectRequestTransformer transformer)

Sets a transformer to apply further modifications for the redirect request after it was initialized.

It can be used to add/remove headers, payload body, or trailers.

Parameters:

transformer - RedirectConfig.RedirectRequestTransformer that modifies a request for redirect

Returns:

this

See Also:

headersToRedirect(CharSequence...), redirectPayloadBody(boolean), trailersToRedirect(CharSequence...)

build

public RedirectConfig build()

Builds a new RedirectConfig.

Returns:

a new RedirectConfig