org.springframework.web.reactive.function.client

Class ExchangeFilterFunctions

java.lang.Object

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

public abstract class ExchangeFilterFunctions
extends java.lang.Object

Implementations of ExchangeFilterFunction that provide various useful request filter operations, such as basic authentication, error handling, etc.

Since:

5.0

Author:

Rob Winch, Arjen Poutsma

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExchangeFilterFunctions.Credentials Represents a combination of username and password, as used by basicAuthentication().

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASIC_AUTHENTICATION_CREDENTIALS_ATTRIBUTE Name of the ClientRequest attribute that contains the ExchangeFilterFunctions.Credentials, as used by basicAuthentication().

Constructor Summary

Constructors

Constructor and Description
ExchangeFilterFunctions()

Method Summary

Modifier and Type	Method and Description
static ExchangeFilterFunction	basicAuthentication() Return a filter that adds an Authorization header for HTTP Basic Authentication, based on the ExchangeFilterFunctions.Credentials provided in the request attributes.
static ExchangeFilterFunction	basicAuthentication(java.lang.String username, java.lang.String password) Return a filter that adds an Authorization header for HTTP Basic Authentication, based on the given username and password.
static ExchangeFilterFunction	statusError(java.util.function.Predicate<HttpStatus> statusPredicate, java.util.function.Function<ClientResponse,? extends java.lang.Throwable> exceptionFunction) Return a filter that returns a given Throwable as response if the given HttpStatus predicate matches.

Methods inherited from class java.lang.Object

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

Field Detail

BASIC_AUTHENTICATION_CREDENTIALS_ATTRIBUTE

public static final java.lang.String BASIC_AUTHENTICATION_CREDENTIALS_ATTRIBUTE

Name of the ClientRequest attribute that contains the ExchangeFilterFunctions.Credentials, as used by basicAuthentication().

Constructor Detail

ExchangeFilterFunctions

public ExchangeFilterFunctions()

Method Detail

basicAuthentication

public static ExchangeFilterFunction basicAuthentication(java.lang.String username,
                                                         java.lang.String password)

Return a filter that adds an Authorization header for HTTP Basic Authentication, based on the given username and password.

Note that Basic Authentication only supports characters in the ISO-8859-1 character set.

Parameters:

username - the username to use

password - the password to use

Returns:

the ExchangeFilterFunction that adds the Authorization header

Throws:

java.lang.IllegalArgumentException - if either username or password contain characters that cannot be encoded to ISO-8859-1

basicAuthentication

public static ExchangeFilterFunction basicAuthentication()

Return a filter that adds an Authorization header for HTTP Basic Authentication, based on the ExchangeFilterFunctions.Credentials provided in the request attributes. If the attribute is not found, no authorization header is added.

Note that Basic Authentication only supports characters in the ISO-8859-1 character set.

Returns:

the ExchangeFilterFunction that adds the Authorization header

See Also:

BASIC_AUTHENTICATION_CREDENTIALS_ATTRIBUTE, ExchangeFilterFunctions.Credentials.basicAuthenticationCredentials(String, String)

statusError

public static ExchangeFilterFunction statusError(java.util.function.Predicate<HttpStatus> statusPredicate,
                                                 java.util.function.Function<ClientResponse,? extends java.lang.Throwable> exceptionFunction)

Return a filter that returns a given Throwable as response if the given HttpStatus predicate matches.

Parameters:

statusPredicate - the predicate that should match the response status

exceptionFunction - the function that returns the exception

Returns:

the ExchangeFilterFunction that returns the given exception if the predicate matches