Top Description Inners Methods
org.springframework.web.reactive.function.server

public Interface HandlerStrategies

Known Direct Implementers
org.springframework.web.reactive.function.server.DefaultHandlerStrategiesBuilder.DefaultHandlerStrategies
Imports
java.util.List, java.util.function.Consumer, org.springframework.http.codec.HttpMessageReader, .HttpMessageWriter, .ServerCodecConfigurer, org.springframework.web.reactive.result.view.ViewResolver, org.springframework.web.server.WebExceptionHandler, .WebFilter, org.springframework.web.server.i18n.LocaleContextResolver

Defines the strategies to be used for processing HandlerFunctions.

An instance of this class is immutable. Instances are typically created through the mutable Builder: either through builder() to set up default strategies, or empty() to start from scratch.

Authors
Arjen Poutsma, Juergen Hoeller, Sebastien Deleuze
Since
5.0
See Also
RouterFunctions#toHttpHandler(RouterFunction, HandlerStrategies)

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface

Method Summary

Modifier and TypeMethod and Description
public static HandlerStrategies.Builder

Returns:

the builder
builder
()

Return a mutable builder for a HandlerStrategies with default initialization.

public static HandlerStrategies.Builder

Returns:

the builder
empty
()

Return a mutable, empty builder for a HandlerStrategies.

public List<WebExceptionHandler>

Returns:

the exception handlers
exceptionHandlers
()

Return the WebExceptionHandlers to be used for handling exceptions.

public LocaleContextResolver

Returns:

the locale context resolver
localeContextResolver
()

Return the LocaleContextResolver to be used for resolving locale context.

public List<HttpMessageReader<?>>

Returns:

the message readers
messageReaders
()

Return the HttpMessageReaders to be used for request body conversion.

public List<HttpMessageWriter<?>>

Returns:

the message writers
messageWriters
()

Return the HttpMessageWriters to be used for response body conversion.

public List<ViewResolver>

Returns:

the view resolvers
viewResolvers
()

Return the ViewResolvers to be used for view name resolution.

public List<WebFilter>

Returns:

the web filters
webFilters
()

Return the WebFilters to be used for filtering the request and response.

public static HandlerStrategies

Returns:

the new HandlerStrategies
withDefaults
()

Return a new HandlerStrategies with default initialization.

Method Detail

builderback to summary
public static HandlerStrategies.Builder builder()

Return a mutable builder for a HandlerStrategies with default initialization.

Returns:HandlerStrategies.Builder

the builder

emptyback to summary
public static HandlerStrategies.Builder empty()

Return a mutable, empty builder for a HandlerStrategies.

Returns:HandlerStrategies.Builder

the builder

exceptionHandlersback to summary
public List<WebExceptionHandler> exceptionHandlers()

Return the WebExceptionHandlers to be used for handling exceptions.

Returns:List<WebExceptionHandler>

the exception handlers

localeContextResolverback to summary
public LocaleContextResolver localeContextResolver()

Return the LocaleContextResolver to be used for resolving locale context.

Returns:LocaleContextResolver

the locale context resolver

messageReadersback to summary
public List<HttpMessageReader<?>> messageReaders()

Return the HttpMessageReaders to be used for request body conversion.

Returns:List<HttpMessageReader<?>>

the message readers

messageWritersback to summary
public List<HttpMessageWriter<?>> messageWriters()

Return the HttpMessageWriters to be used for response body conversion.

Returns:List<HttpMessageWriter<?>>

the message writers

viewResolversback to summary
public List<ViewResolver> viewResolvers()

Return the ViewResolvers to be used for view name resolution.

Returns:List<ViewResolver>

the view resolvers

webFiltersback to summary
public List<WebFilter> webFilters()

Return the WebFilters to be used for filtering the request and response.

Returns:List<WebFilter>

the web filters

withDefaultsback to summary
public static HandlerStrategies withDefaults()

Return a new HandlerStrategies with default initialization.

Returns:HandlerStrategies

the new HandlerStrategies

org.springframework.web.reactive.function.server back to summary

public Interface HandlerStrategies.Builder

Known Direct Implementers
org.springframework.web.reactive.function.server.DefaultHandlerStrategiesBuilder

A mutable builder for a HandlerStrategies.

Method Summary

Modifier and TypeMethod and Description
public HandlerStrategies

Returns:

the built strategies
build
()

Builds the HandlerStrategies.

public HandlerStrategies.Builder

Returns:

this builder
codecs
(Consumer<ServerCodecConfigurer>
the consumer to customize the codecs
consumer
)

Customize the list of server-side HTTP message readers and writers.

public HandlerStrategies.Builder

Returns:

this builder
exceptionHandler
(WebExceptionHandler
the exception handler to add
exceptionHandler
)

Add the given exception handler to this builder.

public HandlerStrategies.Builder

Returns:

this builder
localeContextResolver
(LocaleContextResolver
the locale context resolver to add
localeContextResolver
)

Add the given locale context resolver to this builder.

public HandlerStrategies.Builder

Returns:

this builder
viewResolver
(ViewResolver
the view resolver to add
viewResolver
)

Add the given view resolver to this builder.

public HandlerStrategies.Builder

Returns:

this builder
webFilter
(WebFilter
the filter to add
filter
)

Add the given web filter to this builder.

Method Detail

buildback to summary
public HandlerStrategies build()

Builds the HandlerStrategies.

Returns:HandlerStrategies

the built strategies

codecsback to summary
public HandlerStrategies.Builder codecs(Consumer<ServerCodecConfigurer> consumer)

Customize the list of server-side HTTP message readers and writers.

Parameters
consumer:Consumer<ServerCodecConfigurer>

the consumer to customize the codecs

Returns:HandlerStrategies.Builder

this builder

exceptionHandlerback to summary
public HandlerStrategies.Builder exceptionHandler(WebExceptionHandler exceptionHandler)

Add the given exception handler to this builder.

Parameters
exceptionHandler:WebExceptionHandler

the exception handler to add

Returns:HandlerStrategies.Builder

this builder

localeContextResolverback to summary
public HandlerStrategies.Builder localeContextResolver(LocaleContextResolver localeContextResolver)

Add the given locale context resolver to this builder.

Parameters
localeContextResolver:LocaleContextResolver

the locale context resolver to add

Returns:HandlerStrategies.Builder

this builder

viewResolverback to summary
public HandlerStrategies.Builder viewResolver(ViewResolver viewResolver)

Add the given view resolver to this builder.

Parameters
viewResolver:ViewResolver

the view resolver to add

Returns:HandlerStrategies.Builder

this builder

webFilterback to summary
public HandlerStrategies.Builder webFilter(WebFilter filter)

Add the given web filter to this builder.

Parameters
filter:WebFilter

the filter to add

Returns:HandlerStrategies.Builder

this builder