Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	WebHttpHandlerBuilder.SpringWebBlockHoundIntegration `BlockHoundIntegration` for spring-web classes.

Field Summary

Modifier and Type	Field and Description
private final ApplicationContext	applicationContext
private ServerCodecConfigurer	codecConfigurer
private final List<WebExceptionHandler>	exceptionHandlers
private final List<WebFilter>	filters
public static final String	FORWARDED_HEADER_TRANSFORMER_BEAN_NAME Well-known name for the ForwardedHeaderTransformer in the bean factory.
private ForwardedHeaderTransformer	forwardedHeaderTransformer
private Function<HttpHandler, HttpHandler>	httpHandlerDecorator
public static final String	LOCALE_CONTEXT_RESOLVER_BEAN_NAME Well-known name for the LocaleContextResolver in the bean factory.
private LocaleContextResolver	localeContextResolver
private ServerRequestObservationConvention	observationConvention
private ObservationRegistry	observationRegistry
public static final String	SERVER_CODEC_CONFIGURER_BEAN_NAME Well-known name for the ServerCodecConfigurer in the bean factory.
private WebSessionManager	sessionManager
public static final String	WEB_HANDLER_BEAN_NAME Well-known name for the target WebHandler in the bean factory.
public static final String	WEB_SESSION_MANAGER_BEAN_NAME Well-known name for the WebSessionManager in the bean factory.
private final WebHandler	webHandler

Constructor Summary

Access	Constructor and Description
private	WebHttpHandlerBuilder(WebHandler webHandler, ApplicationContext applicationContext) Private constructor to use when initialized from an ApplicationContext.
private	WebHttpHandlerBuilder(WebHttpHandlerBuilder other) Copy constructor.

Method Summary

Modifier and Type	Method and Description
public static WebHttpHandlerBuilder	Returns: the prepared builder applicationContext(ApplicationContext the application context to use for the lookup context) Static factory method to create a new builder instance by detecting beans in an `ApplicationContext`.
public HttpHandler	build() Build the `HttpHandler`.
public WebHttpHandlerBuilder	Returns: the cloned builder instance clone() Overrides java.lang.Object.clone. Clone this `WebHttpHandlerBuilder`.
public WebHttpHandlerBuilder	codecConfigurer(ServerCodecConfigurer the codec configurer codecConfigurer) Configure the `ServerCodecConfigurer` to set on the `WebServerExchange`.
public WebHttpHandlerBuilder	exceptionHandler(WebExceptionHandler... the exception handler(s) handlers) Add the given exception handler(s).
public WebHttpHandlerBuilder	exceptionHandlers(Consumer<List<WebExceptionHandler>> the consumer to use consumer) Manipulate the "live" list of currently configured exception handlers.
public WebHttpHandlerBuilder	filter(WebFilter... the filter(s) to add that's filters) Add the given filter(s).
public WebHttpHandlerBuilder	filters(Consumer<List<WebFilter>> the consumer to use consumer) Manipulate the "live" list of currently configured filters.
public WebHttpHandlerBuilder	forwardedHeaderTransformer(ForwardedHeaderTransformer the transformer transformer) Configure the `ForwardedHeaderTransformer` for extracting and/or removing forwarded headers.
public boolean	hasCodecConfigurer() Whether a `ServerCodecConfigurer` is configured or not, either detected from an `ApplicationContext` or explicitly configured via `codecConfigurer`.
public boolean	hasForwardedHeaderTransformer() Whether a `ForwardedHeaderTransformer` is configured or not, either detected from an `ApplicationContext` or explicitly configured via `forwardedHeaderTransformer(ForwardedHeaderTransformer)`.
public boolean	hasHttpHandlerDecorator() Whether a decorator for `HttpHandler` is configured or not via `httpHandlerDecorator(Function)`.
public boolean	hasLocaleContextResolver() Whether a `LocaleContextResolver` is configured or not, either detected from an `ApplicationContext` or explicitly configured via `localeContextResolver`.
public boolean	hasSessionManager() Whether a `WebSessionManager` is configured or not, either detected from an `ApplicationContext` or explicitly configured via `sessionManager`.
public WebHttpHandlerBuilder	httpHandlerDecorator(Function<HttpHandler, HttpHandler> the decorator to apply handlerDecorator) Configure a `Function` to decorate the `HttpHandler` returned by this builder which effectively wraps the entire `WebExceptionHandler` - `WebFilter` - `WebHandler` processing chain.
public WebHttpHandlerBuilder	localeContextResolver(LocaleContextResolver the locale context resolver localeContextResolver) Configure the `LocaleContextResolver` to set on the `WebServerExchange`.
public WebHttpHandlerBuilder	observationConvention(ServerRequestObservationConvention the convention to use for all recorded observations observationConvention) Configure a `ServerRequestObservationConvention` to use for server observations.
public WebHttpHandlerBuilder	observationRegistry(ObservationRegistry the observation registry observationRegistry) Configure an `ObservationRegistry` for recording server exchange observations.
public WebHttpHandlerBuilder	sessionManager(WebSessionManager the session manager manager) Configure the `WebSessionManager` to set on the `WebServerExchange`.
private void	updateFilters()
public static WebHttpHandlerBuilder	Returns: the prepared builder webHandler(WebHandler the target handler for the request webHandler) Static factory method to create a new builder instance.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

applicationContext	back to summary
private final ApplicationContext applicationContext Annotations @Nullable

codecConfigurer	back to summary
private ServerCodecConfigurer codecConfigurer Annotations @Nullable

exceptionHandlers	back to summary
private final List<WebExceptionHandler> exceptionHandlers

filters	back to summary
private final List<WebFilter> filters

FORWARDED_HEADER_TRANSFORMER_BEAN_NAME	back to summary
public static final String FORWARDED_HEADER_TRANSFORMER_BEAN_NAME Well-known name for the ForwardedHeaderTransformer in the bean factory.

forwardedHeaderTransformer	back to summary
private ForwardedHeaderTransformer forwardedHeaderTransformer Annotations @Nullable

httpHandlerDecorator	back to summary
private Function<HttpHandler, HttpHandler> httpHandlerDecorator Annotations @Nullable

LOCALE_CONTEXT_RESOLVER_BEAN_NAME	back to summary
public static final String LOCALE_CONTEXT_RESOLVER_BEAN_NAME Well-known name for the LocaleContextResolver in the bean factory.

localeContextResolver	back to summary
private LocaleContextResolver localeContextResolver Annotations @Nullable

observationConvention	back to summary
private ServerRequestObservationConvention observationConvention Annotations @Nullable

observationRegistry	back to summary
private ObservationRegistry observationRegistry Annotations @Nullable

SERVER_CODEC_CONFIGURER_BEAN_NAME	back to summary
public static final String SERVER_CODEC_CONFIGURER_BEAN_NAME Well-known name for the ServerCodecConfigurer in the bean factory.

sessionManager	back to summary
private WebSessionManager sessionManager Annotations @Nullable

WEB_HANDLER_BEAN_NAME	back to summary
public static final String WEB_HANDLER_BEAN_NAME Well-known name for the target WebHandler in the bean factory.

WEB_SESSION_MANAGER_BEAN_NAME	back to summary
public static final String WEB_SESSION_MANAGER_BEAN_NAME Well-known name for the WebSessionManager in the bean factory.

webHandler	back to summary
private final WebHandler webHandler

Constructor Detail

WebHttpHandlerBuilder	back to summary
private WebHttpHandlerBuilder(WebHandler webHandler, ApplicationContext applicationContext) Private constructor to use when initialized from an ApplicationContext.

WebHttpHandlerBuilder	back to summary
private WebHttpHandlerBuilder(WebHttpHandlerBuilder other) Copy constructor.

Method Detail

applicationContext back to summary

applicationContext	back to summary
public static WebHttpHandlerBuilder applicationContext(ApplicationContext context) Static factory method to create a new builder instance by detecting beans in an `ApplicationContext`. The following are detected: `WebHandler` [1] -- looked up by the name `WEB_HANDLER_BEAN_NAME`. `WebFilter` [0..N] -- detected by type and ordered, see `AnnotationAwareOrderComparator`. `WebExceptionHandler` [0..N] -- detected by type and ordered. `HttpHandlerDecoratorFactory` [0..N] -- detected by type and ordered. `ObservationRegistry` -- detected by type and configured if unique. `ServerRequestObservationConvention` -- detected by type and configured if unique. `WebSessionManager` [0..1] -- looked up by the name `WEB_SESSION_MANAGER_BEAN_NAME`. `ServerCodecConfigurer` [0..1] -- looked up by the name `SERVER_CODEC_CONFIGURER_BEAN_NAME`. `LocaleContextResolver` [0..1] -- looked up by the name `LOCALE_CONTEXT_RESOLVER_BEAN_NAME`. Parameters context:ApplicationContext the application context to use for the lookup Returns:WebHttpHandlerBuilder the prepared builder

public static WebHttpHandlerBuilder applicationContext(ApplicationContext context)

Static factory method to create a new builder instance by detecting beans in an ApplicationContext. The following are detected:

WebHandler [1] -- looked up by the name WEB_HANDLER_BEAN_NAME.
WebFilter [0..N] -- detected by type and ordered, see AnnotationAwareOrderComparator.
WebExceptionHandler [0..N] -- detected by type and ordered.
HttpHandlerDecoratorFactory [0..N] -- detected by type and ordered.
ObservationRegistry -- detected by type and configured if unique.
ServerRequestObservationConvention -- detected by type and configured if unique.
WebSessionManager [0..1] -- looked up by the name WEB_SESSION_MANAGER_BEAN_NAME.
ServerCodecConfigurer [0..1] -- looked up by the name SERVER_CODEC_CONFIGURER_BEAN_NAME.
LocaleContextResolver [0..1] -- looked up by the name LOCALE_CONTEXT_RESOLVER_BEAN_NAME.

Parameters

context:ApplicationContext: the application context to use for the lookup

Returns:WebHttpHandlerBuilder

the prepared builder

build	back to summary
public HttpHandler build() Build the `HttpHandler`.

clone back to summary

clone	back to summary
public WebHttpHandlerBuilder clone() Overrides java.lang.Object.clone. Clone this `WebHttpHandlerBuilder`. Returns:WebHttpHandlerBuilder the cloned builder instance Annotations @Override

public WebHttpHandlerBuilder clone()

Overrides java.lang.Object.clone.

Clone this WebHttpHandlerBuilder.

Returns:WebHttpHandlerBuilder

the cloned builder instance

Annotations

@Override

codecConfigurer back to summary

codecConfigurer	back to summary
public WebHttpHandlerBuilder codecConfigurer(ServerCodecConfigurer codecConfigurer) Configure the `ServerCodecConfigurer` to set on the `WebServerExchange`. Parameters codecConfigurer:ServerCodecConfigurer the codec configurer

public WebHttpHandlerBuilder codecConfigurer(ServerCodecConfigurer codecConfigurer)

Configure the ServerCodecConfigurer to set on the WebServerExchange.

Parameters

codecConfigurer:ServerCodecConfigurer: the codec configurer

exceptionHandler	back to summary
public WebHttpHandlerBuilder exceptionHandler(WebExceptionHandler... handlers) Add the given exception handler(s). Parameters handlers:WebExceptionHandler[] the exception handler(s)

exceptionHandler

back to summary

public WebHttpHandlerBuilder exceptionHandler(WebExceptionHandler... handlers)

Add the given exception handler(s).

Parameters

handlers:WebExceptionHandler[]: the exception handler(s)

exceptionHandlers	back to summary
public WebHttpHandlerBuilder exceptionHandlers(Consumer<List<WebExceptionHandler>> consumer) Manipulate the "live" list of currently configured exception handlers. Parameters consumer:Consumer<List<WebExceptionHandler>> the consumer to use

exceptionHandlers

back to summary

public WebHttpHandlerBuilder exceptionHandlers(Consumer<List<WebExceptionHandler>> consumer)

Manipulate the "live" list of currently configured exception handlers.

Parameters

consumer:Consumer<List<WebExceptionHandler>>: the consumer to use

filter	back to summary
public WebHttpHandlerBuilder filter(WebFilter... filters) Add the given filter(s). Parameters filters:WebFilter[] the filter(s) to add that's

filter

back to summary

public WebHttpHandlerBuilder filter(WebFilter... filters)

Add the given filter(s).

Parameters

filters:WebFilter[]: the filter(s) to add that's

filters	back to summary
public WebHttpHandlerBuilder filters(Consumer<List<WebFilter>> consumer) Manipulate the "live" list of currently configured filters. Parameters consumer:Consumer<List<WebFilter>> the consumer to use

filters

back to summary

public WebHttpHandlerBuilder filters(Consumer<List<WebFilter>> consumer)

Manipulate the "live" list of currently configured filters.

Parameters

consumer:Consumer<List<WebFilter>>: the consumer to use

forwardedHeaderTransformer back to summary

forwardedHeaderTransformer	back to summary
public WebHttpHandlerBuilder forwardedHeaderTransformer(ForwardedHeaderTransformer transformer) Configure the `ForwardedHeaderTransformer` for extracting and/or removing forwarded headers. Parameters transformer:ForwardedHeaderTransformer the transformer Since 5.1

public WebHttpHandlerBuilder forwardedHeaderTransformer(ForwardedHeaderTransformer transformer)

Configure the ForwardedHeaderTransformer for extracting and/or removing forwarded headers.

Parameters

transformer:ForwardedHeaderTransformer: the transformer

Since

5.1

hasCodecConfigurer back to summary

hasCodecConfigurer	back to summary
public boolean hasCodecConfigurer() Whether a `ServerCodecConfigurer` is configured or not, either detected from an `ApplicationContext` or explicitly configured via `codecConfigurer`. Since 5.0.9

public boolean hasCodecConfigurer()

Whether a ServerCodecConfigurer is configured or not, either detected from an ApplicationContext or explicitly configured via codecConfigurer.

Since: 5.0.9

hasForwardedHeaderTransformer back to summary

hasForwardedHeaderTransformer	back to summary
public boolean hasForwardedHeaderTransformer() Whether a `ForwardedHeaderTransformer` is configured or not, either detected from an `ApplicationContext` or explicitly configured via `forwardedHeaderTransformer(ForwardedHeaderTransformer)`. Since 5.1

public boolean hasForwardedHeaderTransformer()

Whether a ForwardedHeaderTransformer is configured or not, either detected from an ApplicationContext or explicitly configured via forwardedHeaderTransformer(ForwardedHeaderTransformer).

Since: 5.1

hasHttpHandlerDecorator back to summary

hasHttpHandlerDecorator	back to summary
public boolean hasHttpHandlerDecorator() Whether a decorator for `HttpHandler` is configured or not via `httpHandlerDecorator(Function)`. Since 5.3

public boolean hasHttpHandlerDecorator()

Whether a decorator for HttpHandler is configured or not via httpHandlerDecorator(Function).

Since: 5.3

hasLocaleContextResolver back to summary

hasLocaleContextResolver	back to summary
public boolean hasLocaleContextResolver() Whether a `LocaleContextResolver` is configured or not, either detected from an `ApplicationContext` or explicitly configured via `localeContextResolver`. Since 5.0.9

public boolean hasLocaleContextResolver()

Whether a LocaleContextResolver is configured or not, either detected from an ApplicationContext or explicitly configured via localeContextResolver.

Since: 5.0.9

hasSessionManager back to summary

hasSessionManager	back to summary
public boolean hasSessionManager() Whether a `WebSessionManager` is configured or not, either detected from an `ApplicationContext` or explicitly configured via `sessionManager`. Since 5.0.9

public boolean hasSessionManager()

Whether a WebSessionManager is configured or not, either detected from an ApplicationContext or explicitly configured via sessionManager.

Since: 5.0.9

httpHandlerDecorator back to summary

httpHandlerDecorator	back to summary
public WebHttpHandlerBuilder httpHandlerDecorator(Function<HttpHandler, HttpHandler> handlerDecorator) Configure a `Function` to decorate the `HttpHandler` returned by this builder which effectively wraps the entire `WebExceptionHandler` - `WebFilter` - `WebHandler` processing chain. This provides access to the request and response before the entire chain and likewise the ability to observe the result of the entire chain. Parameters handlerDecorator:Function<HttpHandler, HttpHandler> the decorator to apply Since 5.3

public WebHttpHandlerBuilder httpHandlerDecorator(Function<HttpHandler, HttpHandler> handlerDecorator)

Configure a Function to decorate the HttpHandler returned by this builder which effectively wraps the entire WebExceptionHandler - WebFilter - WebHandler processing chain. This provides access to the request and response before the entire chain and likewise the ability to observe the result of the entire chain.

Parameters

handlerDecorator:Function<HttpHandler, HttpHandler>: the decorator to apply

Since

5.3

localeContextResolver back to summary

localeContextResolver	back to summary
public WebHttpHandlerBuilder localeContextResolver(LocaleContextResolver localeContextResolver) Configure the `LocaleContextResolver` to set on the `WebServerExchange`. Parameters localeContextResolver:LocaleContextResolver the locale context resolver

public WebHttpHandlerBuilder localeContextResolver(LocaleContextResolver localeContextResolver)

Configure the LocaleContextResolver to set on the WebServerExchange.

Parameters

localeContextResolver:LocaleContextResolver: the locale context resolver

observationConvention back to summary

observationConvention	back to summary
public WebHttpHandlerBuilder observationConvention(ServerRequestObservationConvention observationConvention) Configure a `ServerRequestObservationConvention` to use for server observations. By default, a `DefaultServerRequestObservationConvention` will be used. Parameters observationConvention:ServerRequestObservationConvention the convention to use for all recorded observations Since 6.1

public WebHttpHandlerBuilder observationConvention(ServerRequestObservationConvention observationConvention)

Configure a ServerRequestObservationConvention to use for server observations. By default, a DefaultServerRequestObservationConvention will be used.

Parameters

observationConvention:ServerRequestObservationConvention: the convention to use for all recorded observations

Since

6.1

observationRegistry back to summary

observationRegistry	back to summary
public WebHttpHandlerBuilder observationRegistry(ObservationRegistry observationRegistry) Configure an `ObservationRegistry` for recording server exchange observations. By default, a `no-op` registry will be configured. Parameters observationRegistry:ObservationRegistry the observation registry Since 6.1

public WebHttpHandlerBuilder observationRegistry(ObservationRegistry observationRegistry)

Configure an ObservationRegistry for recording server exchange observations. By default, a no-op registry will be configured.

Parameters

observationRegistry:ObservationRegistry: the observation registry

Since

6.1

sessionManager back to summary

sessionManager	back to summary
public WebHttpHandlerBuilder sessionManager(WebSessionManager manager) Configure the `WebSessionManager` to set on the `WebServerExchange`. By default `DefaultWebSessionManager` is used. Parameters manager:WebSessionManager the session manager See Also `HttpWebHandlerAdapter#setSessionManager(WebSessionManager)`

public WebHttpHandlerBuilder sessionManager(WebSessionManager manager)

Configure the WebSessionManager to set on the WebServerExchange.

By default DefaultWebSessionManager is used.

Parameters

manager:WebSessionManager: the session manager

updateFilters	back to summary
private void updateFilters()

webHandler	back to summary
public static WebHttpHandlerBuilder webHandler(WebHandler webHandler) Static factory method to create a new builder instance. Parameters webHandler:WebHandler the target handler for the request Returns:WebHttpHandlerBuilder the prepared builder

webHandler

back to summary

public static WebHttpHandlerBuilder webHandler(WebHandler webHandler)

Static factory method to create a new builder instance.

Parameters

webHandler:WebHandler: the target handler for the request

Returns:WebHttpHandlerBuilder

the prepared builder

org.springframework.web.server.adapter back to summary

public Class WebHttpHandlerBuilder.SpringWebBlockHoundIntegration

Class Inheritance

extends Object
implements BlockHoundIntegration

java.lang.Object
org.springframework.web.server.adapter.WebHttpHandlerBuilder.SpringWebBlockHoundIntegration

All Implemented Interfaces

reactor.blockhound.integration.BlockHoundIntegration, java.lang.Comparable

BlockHoundIntegration for spring-web classes.

Since: 5.3.6

Constructor Summary

Access	Constructor and Description
public	SpringWebBlockHoundIntegration()

Method Summary

Modifier and Type	Method and Description
public void	applyTo(BlockHound.Builder an instance of `BlockHound.Builder` that is being installed builder) Implements reactor.blockhound.integration.BlockHoundIntegration.applyTo. Lets an integration apply the customizations (see `BlockHound.Builder`) before BlockHound is installed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

SpringWebBlockHoundIntegration	back to summary
public SpringWebBlockHoundIntegration()

Method Detail

applyTo back to summary

applyTo	back to summary
public void applyTo(BlockHound.Builder builder) Implements reactor.blockhound.integration.BlockHoundIntegration.applyTo. Doc from reactor.blockhound.integration.BlockHoundIntegration.applyTo. Lets an integration apply the customizations (see `BlockHound.Builder`) before BlockHound is installed. Parameters builder:BlockHound.Builder an instance of `BlockHound.Builder` that is being installed Annotations @Override

public void applyTo(BlockHound.Builder builder)

Implements reactor.blockhound.integration.BlockHoundIntegration.applyTo.

Doc from reactor.blockhound.integration.BlockHoundIntegration.applyTo.

Lets an integration apply the customizations (see BlockHound.Builder) before BlockHound is installed.

Parameters

builder:BlockHound.Builder: an instance of BlockHound.Builder that is being installed

Annotations

@Override

public final Class WebHttpHandlerBuilder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class WebHttpHandlerBuilder.SpringWebBlockHoundIntegration

Constructor Summary

Method Summary

Constructor Detail

Method Detail