Package com.linecorp.armeria.client.redirect

Class RedirectConfigBuilder

java.lang.Object

com.linecorp.armeria.client.redirect.RedirectConfigBuilder

@UnstableApi
public final class RedirectConfigBuilder
extends Object

A builder for RedirectConfig.

See Also:

• AbstractClientOptionsBuilder.followRedirects(RedirectConfig)

Method Summary

Modifier and Type	Method	Description
RedirectConfigBuilder	allowAllDomains()	Allows automatic redirection to all domains.
RedirectConfigBuilder	allowDomains(Iterable<String> domains)	Sets the domains that are allowed for automatic redirection.
RedirectConfigBuilder	allowDomains(String... domains)	Sets the domains that are allowed for automatic redirection.
RedirectConfigBuilder	allowDomains(BiPredicate<? super ClientRequestContext,? super String> predicate)	Sets the BiPredicate that returns true if the host component of a redirection URI is allowed for automatic redirection.
RedirectConfigBuilder	allowProtocols(SessionProtocol... protocols)	Sets the SessionProtocols that are allowed for automatic redirection.
RedirectConfigBuilder	allowProtocols(Iterable<SessionProtocol> protocols)	Sets the SessionProtocols that are allowed for automatic redirection.
RedirectConfig	build()	Returns a newly-created RedirectConfig based on the properties set so far.
RedirectConfigBuilder	maxRedirects(int maxRedirects)	Sets the maximum number of automatic redirection that the client executes.

Methods inherited from class java.lang.Object

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

Method Details

maxRedirects

public RedirectConfigBuilder maxRedirects(int maxRedirects)

Sets the maximum number of automatic redirection that the client executes.

allowProtocols

public RedirectConfigBuilder allowProtocols(SessionProtocol... protocols)

Sets the SessionProtocols that are allowed for automatic redirection. Only SessionProtocol.HTTP and SessionProtocol.HTTPS can be set.

When the allowed SessionProtocols are not set, SessionProtocol.HTTPS is set by default. If the WebClient is created with a base URI that has SessionProtocol.HTTP, SessionProtocol.HTTP is also set.

allowProtocols

public RedirectConfigBuilder allowProtocols(Iterable<SessionProtocol> protocols)

Sets the SessionProtocols that are allowed for automatic redirection. Only SessionProtocol.HTTP and SessionProtocol.HTTPS can be set.

When the allowed SessionProtocols are not set, SessionProtocol.HTTPS is set by default. If the WebClient is created with a base URI that has SessionProtocol.HTTP, SessionProtocol.HTTP is also set.

allowAllDomains

public RedirectConfigBuilder allowAllDomains()

Allows automatic redirection to all domains.

If the WebClient is created without a base URI, the WebClient executes automatic redirection to all domains by default. If the WebClient is created with a base URI, automatic redirection is executed to the domain of the base URI by default.

allowDomains

public RedirectConfigBuilder allowDomains(String... domains)

Sets the domains that are allowed for automatic redirection. If the host component of a redirection URI equals to the specified domains, automatic redirection is executed.

If the WebClient is created without a base URI, the WebClient executes automatic redirection to all domains by default. If the WebClient is created with a base URI, automatic redirection is executed to the domain of the base URI by default.

allowDomains

public RedirectConfigBuilder allowDomains(Iterable<String> domains)

Sets the domains that are allowed for automatic redirection. If the host component of a redirection URI equals to the specified domains, automatic redirection is executed.

If the WebClient is created without a base URI, the WebClient executes automatic redirection to all domains by default. If the WebClient is created with a base URI, automatic redirection is executed to the domain of the base URI by default.

allowDomains

public RedirectConfigBuilder allowDomains(BiPredicate<? super ClientRequestContext,? super String> predicate)

Sets the BiPredicate that returns true if the host component of a redirection URI is allowed for automatic redirection.

If the WebClient is created without a base URI, the WebClient executes automatic redirection to all domains by default. If the WebClient is created with a base URI, automatic redirection is executed to the domain of the base URI by default.

build

public RedirectConfig build()

Returns a newly-created RedirectConfig based on the properties set so far.