org.springframework.web.server.adapter

Class WebHttpHandlerBuilder

java.lang.Object

org.springframework.web.server.adapter.WebHttpHandlerBuilder

public class WebHttpHandlerBuilder
extends Object

Builder for an HttpHandler that adapts to a target WebHandler along with a chain of WebFilters and a set of WebExceptionHandlers.

Example usage:

 WebFilter filter = ... ;
 WebHandler webHandler = ... ;
 WebExceptionHandler exceptionHandler = ...;

 HttpHandler httpHandler = WebHttpHandlerBuilder.webHandler(webHandler)
         .filters(filter)
         .exceptionHandlers(exceptionHandler)
         .build();
 

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
static String	WEB_HANDLER_BEAN_NAME Well-known name for the target WebHandler in the bean factory.
static String	WEB_SESSION_MANAGER_BEAN_NAME Well-known name for the WebSessionManager in the bean factory.

Method Summary

Modifier and Type	Method and Description
static WebHttpHandlerBuilder	applicationContext(org.springframework.context.ApplicationContext context) Factory method to create a new builder instance by detecting beans in an ApplicationContext.
HttpHandler	build() Build the HttpHandler.
WebHttpHandlerBuilder	exceptionHandlers(WebExceptionHandler... exceptionHandlers) Add the given exception handler to apply at the end of request processing.
WebHttpHandlerBuilder	filters(WebFilter... filters) Add the given filters to use for processing requests.
WebHttpHandlerBuilder	sessionManager(WebSessionManager sessionManager) Configure the WebSessionManager to set on the WebServerExchange.
static WebHttpHandlerBuilder	webHandler(WebHandler webHandler) Factory method to create a new builder instance.

Methods inherited from class java.lang.Object

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

Field Detail

WEB_HANDLER_BEAN_NAME

public static final String WEB_HANDLER_BEAN_NAME

Well-known name for the target WebHandler in the bean factory.

See Also:

Constant Field Values

WEB_SESSION_MANAGER_BEAN_NAME

public static final String WEB_SESSION_MANAGER_BEAN_NAME

Well-known name for the WebSessionManager in the bean factory.

See Also:

Constant Field Values

Method Detail

webHandler

public static WebHttpHandlerBuilder webHandler(WebHandler webHandler)

Factory method to create a new builder instance.

Parameters:

webHandler - the target handler for the request

Returns:

the prepared builder

applicationContext

public static WebHttpHandlerBuilder applicationContext(org.springframework.context.ApplicationContext context)

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.
• WebSessionManager [0..1] -- looked up by the name WEB_SESSION_MANAGER_BEAN_NAME.

Parameters:

context - the application context to use for the lookup

Returns:

the prepared builder

filters

public WebHttpHandlerBuilder filters(WebFilter... filters)

Add the given filters to use for processing requests.

Parameters:

filters - the filters to add

exceptionHandlers

public WebHttpHandlerBuilder exceptionHandlers(WebExceptionHandler... exceptionHandlers)

Add the given exception handler to apply at the end of request processing.

Parameters:

exceptionHandlers - the exception handlers

sessionManager

public WebHttpHandlerBuilder sessionManager(WebSessionManager sessionManager)

Configure the WebSessionManager to set on the WebServerExchange.

By default DefaultWebSessionManager is used.

Parameters:

sessionManager - the session manager

See Also:

HttpWebHandlerAdapter.setSessionManager(WebSessionManager)

build

public HttpHandler build()

Build the HttpHandler.