Class ExchangeFilterFunctions
java.lang.Object
org.springframework.web.reactive.function.client.ExchangeFilterFunctions
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
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Deprecated. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ExchangeFilterFunction
Deprecated.as of Spring 5.1 in favor of usingHttpHeaders.setBasicAuth(String, String)
while building the request.static ExchangeFilterFunction
basicAuthentication
(String username, String password) Return a filter that applies HTTP Basic Authentication to the request headers viaHttpHeaders.setBasicAuth(String)
andHttpHeaders.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<HttpStatusCode> statusPredicate, Function<ClientResponse, ? extends Throwable> exceptionFunction) Return a filter that generates an error signal when the givenHttpStatusCode
predicate matches.
-
Constructor Details
-
ExchangeFilterFunctions
public ExchangeFilterFunctions()
-
-
Method Details
-
limitResponseSize
Consume up to the specified number of bytes from the response body and cancel if any more data arrives.Internally delegates to
DataBufferUtils.takeUntilByteCount(org.reactivestreams.Publisher<T>, 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<HttpStatusCode> statusPredicate, Function<ClientResponse, ? extends Throwable> exceptionFunction) Return a filter that generates an error signal when the givenHttpStatusCode
predicate matches.- Parameters:
statusPredicate
- the predicate to check the HTTP status withexceptionFunction
- the function to create the exception- Returns:
- the filter to generate an error signal
-
basicAuthentication
Return a filter that applies HTTP Basic Authentication to the request headers viaHttpHeaders.setBasicAuth(String)
andHttpHeaders.encodeBasicAuth(String, String, Charset)
.- Parameters:
username
- the usernamepassword
- the password- Returns:
- the filter to add authentication headers with
- See Also:
-
basicAuthentication
Deprecated.as of Spring 5.1 in favor of usingHttpHeaders.setBasicAuth(String, String)
while building the request.Variant ofbasicAuthentication(String, String)
that looks up theCredentials
in arequest attribute
.- Returns:
- the filter to use
- See Also:
-
HttpHeaders.setBasicAuth(String, String)
while building the request.