Modifier and Type	Class and Description
private class	HttpWebHandlerAdapter.ObservationSignalListener

Modifier and Type	Field and Description
private ApplicationContext	applicationContext
private ServerCodecConfigurer	codecConfigurer
private static final ServerRequestObservationConvention	DEFAULT_OBSERVATION_CONVENTION
private static final String	DISCONNECTED_CLIENT_LOG_CATEGORY Log category to use for network failure after a client has gone away.
private static final DisconnectedClientHelper	disconnectedClientHelper
private boolean	enableLoggingRequestDetails Whether to log potentially sensitive info (form data at DEBUG, headers at TRACE).
private ForwardedHeaderTransformer	forwardedHeaderTransformer
private LocaleContextResolver	localeContextResolver
private static final Log	logger
private ServerRequestObservationConvention	observationConvention
private ObservationRegistry	observationRegistry
private WebSessionManager	sessionManager

Access	Constructor and Description
public	HttpWebHandlerAdapter(WebHandler delegate)

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() This method must be invoked after all properties have been set to complete initialization.
protected ServerWebExchange	createExchange(ServerHttpRequest request, ServerHttpResponse response)
private String	formatHeaders(HttpHeaders responseHeaders)
protected String	Returns: the String to display, never empty or `null` formatRequest(ServerHttpRequest the request to format request) Format the request for logging purposes including HTTP method and URL.
public ApplicationContext	getApplicationContext() Return the configured `ApplicationContext`, if any.
public ServerCodecConfigurer	getCodecConfigurer() Return the configured `ServerCodecConfigurer`.
public ForwardedHeaderTransformer	getForwardedHeaderTransformer() Return the configured `ForwardedHeaderTransformer`.
public LocaleContextResolver	getLocaleContextResolver() Return the configured `LocaleContextResolver`.
public ServerRequestObservationConvention	getObservationConvention() Return the Observation convention configured for server exchanges observations.
public ObservationRegistry	getObservationRegistry() Return the configured `ObservationRegistry`.
public WebSessionManager	getSessionManager() Return the configured `WebSessionManager`.
public Mono<Void>	handle(ServerHttpRequest current request request, ServerHttpResponse current response response) Implements org.springframework.http.server.reactive.HttpHandler.handle. Handle the given request and write to the response.
private Mono<Void>	handleUnresolvedError(ServerWebExchange exchange, ServerRequestObservationContext observationContext, Throwable ex)
private void	logResponse(ServerWebExchange exchange)
public void	setApplicationContext(ApplicationContext the context applicationContext) Configure the `ApplicationContext` associated with the web application, if it was initialized with one via `org.springframework.web.server.adapter.WebHttpHandlerBuilder#applicationContext(ApplicationContext)`.
public void	setCodecConfigurer(ServerCodecConfigurer the codec configurer to use codecConfigurer) Configure a custom `ServerCodecConfigurer`.
public void	setForwardedHeaderTransformer(ForwardedHeaderTransformer the transformer to use transformer) Enable processing of forwarded headers, either extracting and removing, or remove only.
public void	setLocaleContextResolver(LocaleContextResolver the locale context resolver to use resolver) Configure a custom `LocaleContextResolver`.
public void	setObservationConvention(ServerRequestObservationConvention the observation convention to use observationConvention) Configure a `ServerRequestObservationConvention` for server exchanges observations.
public void	setObservationRegistry(ObservationRegistry the observation registry to use observationRegistry) Configure an `ObservationRegistry` for recording server exchange observations.
public void	setSessionManager(WebSessionManager the session manager to use sessionManager) Configure a custom `WebSessionManager` to use for managing web sessions.

Inherited from org.springframework.web.server.handler.WebHandlerDecorator:: getDelegate handle toString

Field Detail

applicationContext	back to summary
private ApplicationContext applicationContext Annotations @Nullable

codecConfigurer	back to summary
private ServerCodecConfigurer codecConfigurer Annotations @Nullable

DEFAULT_OBSERVATION_CONVENTION	back to summary
private static final ServerRequestObservationConvention DEFAULT_OBSERVATION_CONVENTION

DISCONNECTED_CLIENT_LOG_CATEGORY back to summary

DISCONNECTED_CLIENT_LOG_CATEGORY	back to summary
private static final String DISCONNECTED_CLIENT_LOG_CATEGORY Log category to use for network failure after a client has gone away. See Also `DisconnectedClientHelper`

private static final String DISCONNECTED_CLIENT_LOG_CATEGORY

Log category to use for network failure after a client has gone away.

See Also: DisconnectedClientHelper

disconnectedClientHelper	back to summary
private static final DisconnectedClientHelper disconnectedClientHelper

enableLoggingRequestDetails	back to summary
private boolean enableLoggingRequestDetails Whether to log potentially sensitive info (form data at DEBUG, headers at TRACE).

forwardedHeaderTransformer	back to summary
private ForwardedHeaderTransformer forwardedHeaderTransformer Annotations @Nullable

localeContextResolver	back to summary
private LocaleContextResolver localeContextResolver

logger	back to summary
private static final Log logger

observationConvention	back to summary
private ServerRequestObservationConvention observationConvention

observationRegistry	back to summary
private ObservationRegistry observationRegistry

sessionManager	back to summary
private WebSessionManager sessionManager

HttpWebHandlerAdapter	back to summary
public HttpWebHandlerAdapter(WebHandler delegate)

Method Detail

afterPropertiesSet	back to summary
public void afterPropertiesSet() This method must be invoked after all properties have been set to complete initialization.

createExchange	back to summary
protected ServerWebExchange createExchange(ServerHttpRequest request, ServerHttpResponse response)

formatHeaders	back to summary
private String formatHeaders(HttpHeaders responseHeaders)

formatRequest back to summary

formatRequest	back to summary
protected String formatRequest(ServerHttpRequest request) Format the request for logging purposes including HTTP method and URL. By default this prints the HTTP method, the URL path, and the query. Parameters request:ServerHttpRequest the request to format Returns:String the String to display, never empty or `null`

protected String formatRequest(ServerHttpRequest request)

Format the request for logging purposes including HTTP method and URL.

By default this prints the HTTP method, the URL path, and the query.

Parameters

request:ServerHttpRequest: the request to format

Returns:String

the String to display, never empty or null

getApplicationContext back to summary

getApplicationContext	back to summary
public ApplicationContext getApplicationContext() Return the configured `ApplicationContext`, if any. Annotations @Nullable Since 5.0.3

public ApplicationContext getApplicationContext()

Return the configured ApplicationContext, if any.

Annotations

@Nullable

Since

5.0.3

getCodecConfigurer	back to summary
public ServerCodecConfigurer getCodecConfigurer() Return the configured `ServerCodecConfigurer`.

getForwardedHeaderTransformer back to summary

getForwardedHeaderTransformer	back to summary
public ForwardedHeaderTransformer getForwardedHeaderTransformer() Return the configured `ForwardedHeaderTransformer`. Annotations @Nullable Since 5.1

public ForwardedHeaderTransformer getForwardedHeaderTransformer()

Return the configured ForwardedHeaderTransformer.

Annotations

@Nullable

Since

5.1

getLocaleContextResolver	back to summary
public LocaleContextResolver getLocaleContextResolver() Return the configured `LocaleContextResolver`.

getObservationConvention	back to summary
public ServerRequestObservationConvention getObservationConvention() Return the Observation convention configured for server exchanges observations. Since 6.1

getObservationConvention

back to summary

public ServerRequestObservationConvention getObservationConvention()

Return the Observation convention configured for server exchanges observations.

Since: 6.1

getObservationRegistry back to summary

getObservationRegistry	back to summary
public ObservationRegistry getObservationRegistry() Return the configured `ObservationRegistry`. Since 6.1

public ObservationRegistry getObservationRegistry()

Return the configured ObservationRegistry.

Since: 6.1

getSessionManager	back to summary
public WebSessionManager getSessionManager() Return the configured `WebSessionManager`.

handle	back to summary
public Mono<Void> handle(ServerHttpRequest request, ServerHttpResponse response) Implements org.springframework.http.server.reactive.HttpHandler.handle. Doc from org.springframework.http.server.reactive.HttpHandler.handle. Handle the given request and write to the response. Parameters request:ServerHttpRequest current request response:ServerHttpResponse current response Returns:Mono<Void> indicates completion of request handling Annotations @Override

handle

back to summary

public Mono<Void> handle(ServerHttpRequest request, ServerHttpResponse response)

Implements org.springframework.http.server.reactive.HttpHandler.handle.

Doc from org.springframework.http.server.reactive.HttpHandler.handle.

Handle the given request and write to the response.

Parameters

request:ServerHttpRequest: current request
response:ServerHttpResponse: current response

Returns:Mono<Void>

indicates completion of request handling

Annotations

@Override

handleUnresolvedError	back to summary
private Mono<Void> handleUnresolvedError(ServerWebExchange exchange, ServerRequestObservationContext observationContext, Throwable ex)

logResponse	back to summary
private void logResponse(ServerWebExchange exchange)

setApplicationContext back to summary

setApplicationContext	back to summary
public void setApplicationContext(ApplicationContext applicationContext) Configure the `ApplicationContext` associated with the web application, if it was initialized with one via `org.springframework.web.server.adapter.WebHttpHandlerBuilder#applicationContext(ApplicationContext)`. Parameters applicationContext:ApplicationContext the context Since 5.0.3

public void setApplicationContext(ApplicationContext applicationContext)

Configure the ApplicationContext associated with the web application, if it was initialized with one via org.springframework.web.server.adapter.WebHttpHandlerBuilder#applicationContext(ApplicationContext).

Parameters

applicationContext:ApplicationContext: the context

Since

5.0.3

setCodecConfigurer back to summary

setCodecConfigurer	back to summary
public void setCodecConfigurer(ServerCodecConfigurer codecConfigurer) Configure a custom `ServerCodecConfigurer`. The provided instance is set on each created `DefaultServerWebExchange`. By default this is set to `ServerCodecConfigurer#create()`. Parameters codecConfigurer:ServerCodecConfigurer the codec configurer to use

public void setCodecConfigurer(ServerCodecConfigurer codecConfigurer)

Configure a custom ServerCodecConfigurer. The provided instance is set on each created DefaultServerWebExchange.

By default this is set to ServerCodecConfigurer#create().

Parameters

codecConfigurer:ServerCodecConfigurer: the codec configurer to use

setForwardedHeaderTransformer	back to summary
public void setForwardedHeaderTransformer(ForwardedHeaderTransformer transformer) Enable processing of forwarded headers, either extracting and removing, or remove only. By default this is not set. Parameters transformer:ForwardedHeaderTransformer the transformer to use Since 5.1

setForwardedHeaderTransformer

back to summary

public void setForwardedHeaderTransformer(ForwardedHeaderTransformer transformer)

Enable processing of forwarded headers, either extracting and removing, or remove only.

By default this is not set.

Parameters

transformer:ForwardedHeaderTransformer: the transformer to use

Since

5.1

setLocaleContextResolver back to summary

setLocaleContextResolver	back to summary
public void setLocaleContextResolver(LocaleContextResolver resolver) Configure a custom `LocaleContextResolver`. The provided instance is set on each created `DefaultServerWebExchange`. By default this is set to `org.springframework.web.server.i18n.AcceptHeaderLocaleContextResolver`. Parameters resolver:LocaleContextResolver the locale context resolver to use

public void setLocaleContextResolver(LocaleContextResolver resolver)

Configure a custom LocaleContextResolver. The provided instance is set on each created DefaultServerWebExchange.

By default this is set to org.springframework.web.server.i18n.AcceptHeaderLocaleContextResolver.

Parameters

resolver:LocaleContextResolver: the locale context resolver to use

setObservationConvention back to summary

setObservationConvention	back to summary
public void setObservationConvention(ServerRequestObservationConvention observationConvention) Configure a `ServerRequestObservationConvention` for server exchanges observations. By default, a `DefaultServerRequestObservationConvention` instance will be used. Parameters observationConvention:ServerRequestObservationConvention the observation convention to use Since 6.1

public void setObservationConvention(ServerRequestObservationConvention observationConvention)

Configure a ServerRequestObservationConvention for server exchanges observations. By default, a DefaultServerRequestObservationConvention instance will be used.

Parameters

observationConvention:ServerRequestObservationConvention: the observation convention to use

Since

6.1

setObservationRegistry back to summary

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

public void setObservationRegistry(ObservationRegistry observationRegistry)

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

Parameters

observationRegistry:ObservationRegistry: the observation registry to use

Since

6.1

setSessionManager back to summary

setSessionManager	back to summary
public void setSessionManager(WebSessionManager sessionManager) Configure a custom `WebSessionManager` to use for managing web sessions. The provided instance is set on each created `DefaultServerWebExchange`. By default this is set to `DefaultWebSessionManager`. Parameters sessionManager:WebSessionManager the session manager to use

public void setSessionManager(WebSessionManager sessionManager)

Configure a custom WebSessionManager to use for managing web sessions. The provided instance is set on each created DefaultServerWebExchange.

By default this is set to DefaultWebSessionManager.

Parameters

sessionManager:WebSessionManager: the session manager to use

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

private final Class HttpWebHandlerAdapter.ObservationSignalListener

Class Inheritance

extends DefaultSignalListener<Void>

java.lang.Object
reactor.core.observability.DefaultSignalListener
org.springframework.web.server.adapter.HttpWebHandlerAdapter.ObservationSignalListener

Field Summary

Modifier and Type	Field and Description
private final Observation	observation
private final ServerRequestObservationContext	observationContext
private final AtomicBoolean	observationRecorded

Constructor Summary

Access	Constructor and Description
pack-priv	ObservationSignalListener(ServerRequestObservationContext observationContext)

Method Summary

Modifier and Type	Method and Description
public Context	addToContext(Context the original downstream operator's `Context` originalContext) Overrides default reactor.core.observability.SignalListener.addToContext. In some cases, the tap operation should alter the `Context` exposed by the operator in order to store additional data.
public void	doFirst() Overrides reactor.core.observability.DefaultSignalListener.doFirst. Implements reactor.core.observability.SignalListener.doFirst. Handle the very beginning of the `Subscriber`-`Publisher` interaction.
public void	doOnCancel() Overrides reactor.core.observability.DefaultSignalListener.doOnCancel. Implements reactor.core.observability.SignalListener.doOnCancel. Handle the downstream cancelling its currently observed `Subscription`.
public void	doOnComplete() Overrides reactor.core.observability.DefaultSignalListener.doOnComplete. Implements reactor.core.observability.SignalListener.doOnComplete. Handle graceful onComplete sequence termination.
public void	doOnError(Throwable the exception that terminated the sequence error) Overrides reactor.core.observability.DefaultSignalListener.doOnError. Implements reactor.core.observability.SignalListener.doOnError. Handle onError sequence termination.
private void	doOnTerminate(ServerRequestObservationContext context)

Inherited from reactor.core.observability.DefaultSignalListener:: doAfterComplete doAfterError doFinally doOnFusion doOnMalformedOnComplete doOnMalformedOnError doOnMalformedOnNext doOnNext doOnRequest doOnSubscription getFusionMode handleListenerError

Field Detail

observation	back to summary
private final Observation observation

observationContext	back to summary
private final ServerRequestObservationContext observationContext

observationRecorded	back to summary
private final AtomicBoolean observationRecorded

Constructor Detail

ObservationSignalListener	back to summary
pack-priv ObservationSignalListener(ServerRequestObservationContext observationContext)

Method Detail

addToContext back to summary

addToContext	back to summary
public Context addToContext(Context originalContext) Overrides default reactor.core.observability.SignalListener.addToContext. Doc from reactor.core.observability.SignalListener.addToContext. In some cases, the tap operation should alter the `Context` exposed by the operator in order to store additional data. This method is invoked when the tap subscriber is created, which is between the invocation of `doFirst()` and the invocation of `doOnSubscription()`. Generally, only addition of new keys should be performed on the downstream original `Context`. Extra care should be exercised if any pre-existing key is to be removed or replaced. Parameters originalContext:Context the original downstream operator's `Context` Returns:Context the `Context` to use and expose upstream Annotations @Override

public Context addToContext(Context originalContext)

Overrides default reactor.core.observability.SignalListener.addToContext.

Doc from reactor.core.observability.SignalListener.addToContext.

In some cases, the tap operation should alter the Context exposed by the operator in order to store additional data. This method is invoked when the tap subscriber is created, which is between the invocation of doFirst() and the invocation of doOnSubscription(). Generally, only addition of new keys should be performed on the downstream original Context. Extra care should be exercised if any pre-existing key is to be removed or replaced.

Parameters

originalContext:Context: the original downstream operator's Context

Returns:Context

the Context to use and expose upstream

Annotations

@Override

doFirst back to summary

doFirst	back to summary
public void doFirst() throws Throwable Overrides reactor.core.observability.DefaultSignalListener.doFirst. Implements reactor.core.observability.SignalListener.doFirst. Doc from reactor.core.observability.SignalListener.doFirst. Handle the very beginning of the `Subscriber`-`Publisher` interaction. This handler is invoked right before subscribing to the parent `Publisher`, as a downstream `Subscriber` has called `Publisher#subscribe(Subscriber)`. Once the `Publisher` has acknowledged with a `Subscription`, the `doOnSubscription()` handler will be invoked before that `Subscription` is passed down. Annotations @Override

public void doFirst() throws Throwable

Overrides reactor.core.observability.DefaultSignalListener.doFirst.

Implements reactor.core.observability.SignalListener.doFirst.

Doc from reactor.core.observability.SignalListener.doFirst.

Handle the very beginning of the Subscriber-Publisher interaction. This handler is invoked right before subscribing to the parent Publisher, as a downstream Subscriber has called Publisher#subscribe(Subscriber).

Once the Publisher has acknowledged with a Subscription, the doOnSubscription() handler will be invoked before that Subscription is passed down.

Annotations

@Override

doOnCancel back to summary

doOnCancel	back to summary
public void doOnCancel() throws Throwable Overrides reactor.core.observability.DefaultSignalListener.doOnCancel. Implements reactor.core.observability.SignalListener.doOnCancel. Doc from reactor.core.observability.SignalListener.doOnCancel. Handle the downstream cancelling its currently observed `Subscription`. This handler is invoked before propagating the cancellation upstream, while `doFinally(SignalType)` is invoked right after the cancellation has been propagated upstream. Annotations @Override

public void doOnCancel() throws Throwable

Overrides reactor.core.observability.DefaultSignalListener.doOnCancel.

Implements reactor.core.observability.SignalListener.doOnCancel.

Doc from reactor.core.observability.SignalListener.doOnCancel.

Handle the downstream cancelling its currently observed Subscription.

This handler is invoked before propagating the cancellation upstream, while doFinally(SignalType) is invoked right after the cancellation has been propagated upstream.

Annotations

@Override

doOnComplete back to summary

doOnComplete	back to summary
public void doOnComplete() throws Throwable Overrides reactor.core.observability.DefaultSignalListener.doOnComplete. Implements reactor.core.observability.SignalListener.doOnComplete. Doc from reactor.core.observability.SignalListener.doOnComplete. Handle graceful onComplete sequence termination. This handler is invoked before propagating the completion downstream, while both `doAfterComplete()` and `doFinally(SignalType)` are invoked after. Annotations @Override

public void doOnComplete() throws Throwable

Overrides reactor.core.observability.DefaultSignalListener.doOnComplete.

Implements reactor.core.observability.SignalListener.doOnComplete.

Doc from reactor.core.observability.SignalListener.doOnComplete.

Handle graceful onComplete sequence termination.

This handler is invoked before propagating the completion downstream, while both doAfterComplete() and doFinally(SignalType) are invoked after.

Annotations

@Override

doOnError back to summary

doOnError	back to summary
public void doOnError(Throwable error) throws Throwable Overrides reactor.core.observability.DefaultSignalListener.doOnError. Implements reactor.core.observability.SignalListener.doOnError. Doc from reactor.core.observability.SignalListener.doOnError. Handle onError sequence termination. This handler is invoked before propagating the error downstream, while both `doAfterError(Throwable)` and `doFinally(SignalType)` are invoked after. Parameters error:Throwable the exception that terminated the sequence Annotations @Override

public void doOnError(Throwable error) throws Throwable

Overrides reactor.core.observability.DefaultSignalListener.doOnError.

Implements reactor.core.observability.SignalListener.doOnError.

Doc from reactor.core.observability.SignalListener.doOnError.

Handle onError sequence termination.

This handler is invoked before propagating the error downstream, while both doAfterError(Throwable) and doFinally(SignalType) are invoked after.

Parameters

error:Throwable: the exception that terminated the sequence

Annotations

@Override

doOnTerminate	back to summary
private void doOnTerminate(ServerRequestObservationContext context)

public Class HttpWebHandlerAdapter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class HttpWebHandlerAdapter.ObservationSignalListener

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail