ExchangeFilterFunctions (Spring Framework 5.0.0.M3 API)

java.lang.Object
- org.springframework.web.client.reactive.ExchangeFilterFunctions

```
public abstract class ExchangeFilterFunctions
extends 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

Constructor Summary

Constructors
Constructor and Description

ExchangeFilterFunctions()

Constructors
Constructor and Description
`ExchangeFilterFunctions()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ExchangeFilterFunction`	`basicAuthentication(String username, String password)` Return a filter that adds an Authorization header for HTTP Basic Authentication.
`static ExchangeFilterFunction`	`clientError()` Return a filter that will publish a `WebClientException` when the `ClientResponse` has a 4xx status code.
`static ExchangeFilterFunction`	`clientOrServerError()` Return a filter that will publish a `WebClientException` if the `ClientResponse` has a 4xx or 5xx status code.
`static ExchangeFilterFunction`	`errorMapper(Function<ClientResponse,Optional<? extends Throwable>> mapper)` Return a filter that maps the response to a potential error.
`static ExchangeFilterFunction`	`errorPredicate(Predicate<ClientResponse> predicate)` Return a filter that will publish a `WebClientException` if the response satisfies the given `predicate` function.
`static ExchangeFilterFunction`	`serverError()` Return a filter that will publish a `WebClientException` if the `ClientResponse` has a 5xx status code.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ExchangeFilterFunctions
```
public ExchangeFilterFunctions()
```
- Method Detail
  - clientError
```
public static ExchangeFilterFunction clientError()
```
    Return a filter that will publish a WebClientException when the ClientResponse has a 4xx status code.
    
    Returns:
    
    the ExchangeFilterFunction that publishes a WebClientException when the response has a client error
  - serverError
```
public static ExchangeFilterFunction serverError()
```
    Return a filter that will publish a WebClientException if the ClientResponse has a 5xx status code.
    
    Returns:
    
    the ExchangeFilterFunction that publishes a WebClientException when the response has a server error
  - clientOrServerError
```
public static ExchangeFilterFunction clientOrServerError()
```
    Return a filter that will publish a WebClientException if the ClientResponse has a 4xx or 5xx status code.
    
    Returns:
    
    the ExchangeFilterFunction that publishes a WebClientException when the response has a client or server error
  - errorPredicate
```
public static ExchangeFilterFunction errorPredicate(Predicate<ClientResponse> predicate)
```
    Return a filter that will publish a WebClientException if the response satisfies the given predicate function.
    
    Parameters:
    
    predicate - the predicate to test the response with
    
    Returns:
    
    the ExchangeFilterFunction that publishes a WebClientException when predicate returns true
  - errorMapper
```
public static ExchangeFilterFunction errorMapper(Function<ClientResponse,Optional<? extends Throwable>> mapper)
```
    Return a filter that maps the response to a potential error. Exceptions returned by mapper will be published as signal in the Mono<ClientResponse> return value.
    
    Parameters:
    
    mapper - the function that maps from response to optional error
    
    Returns:
    
    the ExchangeFilterFunction that propagates the errors provided by mapper
  - basicAuthentication
```
public static ExchangeFilterFunction basicAuthentication(String username,
                                                         String password)
```
    Return a filter that adds an Authorization header for HTTP Basic Authentication.
    
    Parameters:
    
    username - the username to use
    
    password - the password to use
    
    Returns:
    
    the ExchangeFilterFunction that adds the Authorization header

Class ExchangeFilterFunctions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExchangeFilterFunctions

Method Detail

clientError

serverError

clientOrServerError

errorPredicate

errorMapper

basicAuthentication