Class ExchangeFilterFunctions

java.lang.Object

org.springframework.web.reactive.function.client.ExchangeFilterFunctions

public abstract class ExchangeFilterFunctions
extends Object

Static factory methods providing access to built-in implementations of ExchangeFilterFunction for basic authentication, error handling, etc.

Since:

5.0

Author:

Rob Winch, Arjen Poutsma, Sam Brannen, Kai Zander

Constructor Summary

Constructors

Constructor	Description
ExchangeFilterFunctions()

Method Summary

Modifier and Type	Method	Description
static ExchangeFilterFunction	basicAuthentication(String username, String password)	Return a filter that applies HTTP Basic Authentication to the request headers via HttpHeaders.setBasicAuth(String) and HttpHeaders.encodeBasicAuth(String, String, Charset).
static ExchangeFilterFunction	basicAuthentication(String username, String password, @Nullable Charset charset)	Return a filter that applies HTTP Basic Authentication to the request headers via HttpHeaders.setBasicAuth(String) and HttpHeaders.encodeBasicAuth(String, String, Charset).
static ExchangeFilterFunction	limitResponseSize(long maxByteCount)	Consume up to the specified number of bytes from the response body and cancel if any more data arrives.
static ExchangeFilterFunction	statusError(Predicate<org.springframework.http.HttpStatusCode> statusPredicate, Function<ClientResponse, ? extends Throwable> exceptionFunction)	Return a filter that generates an error signal when the given HttpStatusCode predicate matches.

Methods inherited from class Object

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

Constructor Details

ExchangeFilterFunctions

public ExchangeFilterFunctions()

Method Details

limitResponseSize

public static ExchangeFilterFunction limitResponseSize(long maxByteCount)

Consume up to the specified number of bytes from the response body and cancel if any more data arrives.

Internally delegates to DataBufferUtils.takeUntilByteCount(Publisher, long).

Parameters:

maxByteCount - the limit as number of bytes

Returns:

the filter to limit the response size with

Since:

5.1

statusError

public static ExchangeFilterFunction statusError(Predicate<org.springframework.http.HttpStatusCode> statusPredicate,
 Function<ClientResponse, ? extends Throwable> exceptionFunction)

Return a filter that generates an error signal when the given HttpStatusCode predicate matches.

Parameters:

statusPredicate - the predicate to check the HTTP status with

exceptionFunction - the function to create the exception

Returns:

the filter to generate an error signal

basicAuthentication

public static ExchangeFilterFunction basicAuthentication(String username,
 String password)

Return a filter that applies HTTP Basic Authentication to the request headers via HttpHeaders.setBasicAuth(String) and HttpHeaders.encodeBasicAuth(String, String, Charset).

ISO-8859-1 is used to convert the credentials into an octet sequence.

Parameters:

username - the username

password - the password

Returns:

the filter to add authentication headers with

See Also:

• basicAuthentication(String, String, Charset)
• HttpHeaders.encodeBasicAuth(String, String, Charset)
• HttpHeaders.setBasicAuth(String)

basicAuthentication

public static ExchangeFilterFunction basicAuthentication(String username,
 String password,
 @Nullable Charset charset)

Return a filter that applies HTTP Basic Authentication to the request headers via HttpHeaders.setBasicAuth(String) and HttpHeaders.encodeBasicAuth(String, String, Charset).

Parameters:

username - the username

password - the password

charset - the charset to use to convert the credentials into an octet sequence. Defaults to ISO-8859-1.

Returns:

the filter to add authentication headers with

Since:

7.0.8

See Also:

• basicAuthentication(String, String)
• HttpHeaders.encodeBasicAuth(String, String, Charset)
• HttpHeaders.setBasicAuth(String)