程序包 cn.taketoday.web.reactive.function.client

类 ExchangeFilterFunctions

java.lang.Object

cn.taketoday.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.

从以下版本开始:

4.0

作者:

Rob Winch, Arjen Poutsma, Sam Brannen, Harry Yang

嵌套类概要

嵌套类

修饰符和类型	类	说明
static final record	ExchangeFilterFunctions.Credentials	Stores username and password for HTTP basic authentication.

字段概要

字段

修饰符和类型	字段	说明
private static final String	BASIC_AUTHENTICATION_CREDENTIALS_ATTRIBUTE	Name of the request attribute with ExchangeFilterFunctions.Credentials for basicAuthentication().

构造器概要

构造器

构造器	说明
ExchangeFilterFunctions()

方法概要

修饰符和类型	方法	说明
static ExchangeFilterFunction	basicAuthentication()	Variant of basicAuthentication(String, String) that looks up the Credentials in a request attribute.
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	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 given HttpStatus predicate matches.

从类继承的方法 java.lang.Object

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

字段详细资料

BASIC_AUTHENTICATION_CREDENTIALS_ATTRIBUTE

private static final String BASIC_AUTHENTICATION_CREDENTIALS_ATTRIBUTE

Name of the request attribute with ExchangeFilterFunctions.Credentials for basicAuthentication().

构造器详细资料

ExchangeFilterFunctions

public ExchangeFilterFunctions()

方法详细资料

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(org.reactivestreams.Publisher<T>, long).

参数:

maxByteCount - the limit as number of bytes

返回:

the filter to limit the response size with

statusError

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

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

参数:

statusPredicate - the predicate to check the HTTP status with

exceptionFunction - the function that to create the exception

返回:

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).

参数:

username - the username

password - the password

返回:

the filter to add authentication headers with

另请参阅:

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

basicAuthentication

public static ExchangeFilterFunction basicAuthentication()

Variant of basicAuthentication(String, String) that looks up the Credentials in a request attribute.

返回:

the filter to use

另请参阅:

• ExchangeFilterFunctions.Credentials