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

pack-priv Class DefaultHandlerStrategiesBuilder

extends Object
implements Builder
Class Inheritance
All Implemented Interfaces
org.springframework.web.reactive.function.server.HandlerStrategies.Builder
Imports
java.util.ArrayList, .List, java.util.function.Consumer, org.springframework.http.codec.HttpMessageReader, .HttpMessageWriter, .ServerCodecConfigurer, org.springframework.util.Assert, org.springframework.web.reactive.handler.WebFluxResponseStatusExceptionHandler, org.springframework.web.reactive.result.view.ViewResolver, org.springframework.web.server.WebExceptionHandler, .WebFilter, org.springframework.web.server.i18n.AcceptHeaderLocaleContextResolver, .LocaleContextResolver
Default implementation of HandlerStrategies.Builder.
Author
Arjen Poutsma
Since
5.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
DefaultHandlerStrategiesBuilder.DefaultHandlerStrategies

Field Summary

Modifier and TypeField and Description
private final ServerCodecConfigurer
codecConfigurer

private final List<WebExceptionHandler>
exceptionHandlers

private LocaleContextResolver
localeContextResolver

private final List<ViewResolver>
viewResolvers

private final List<WebFilter>
webFilters

Constructor Summary

AccessConstructor and Description
public
DefaultHandlerStrategiesBuilder()

Method Summary

Modifier and TypeMethod and Description
public HandlerStrategies
build()

Implements org.springframework.web.reactive.function.server.HandlerStrategies.Builder.build.

Builds the HandlerStrategies.

public HandlerStrategies.Builder
codecs(Consumer<ServerCodecConfigurer>
the consumer to customize the codecs
consumer)

Implements org.springframework.web.reactive.function.server.HandlerStrategies.Builder.codecs.

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

public void
defaultConfiguration()

public HandlerStrategies.Builder
exceptionHandler(WebExceptionHandler
the exception handler to add
exceptionHandler)

Implements org.springframework.web.reactive.function.server.HandlerStrategies.Builder.exceptionHandler.

Add the given exception handler to this builder.

public HandlerStrategies.Builder
localeContextResolver(LocaleContextResolver
the locale context resolver to add
localeContextResolver)

Implements org.springframework.web.reactive.function.server.HandlerStrategies.Builder.localeContextResolver.

Add the given locale context resolver to this builder.

public HandlerStrategies.Builder
viewResolver(ViewResolver
the view resolver to add
viewResolver)

Implements org.springframework.web.reactive.function.server.HandlerStrategies.Builder.viewResolver.

Add the given view resolver to this builder.

public HandlerStrategies.Builder
webFilter(WebFilter
the filter to add
filter)

Implements org.springframework.web.reactive.function.server.HandlerStrategies.Builder.webFilter.

Add the given web filter to this builder.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

codecConfigurerback to summary
private final ServerCodecConfigurer codecConfigurer
exceptionHandlersback to summary
private final List<WebExceptionHandler> exceptionHandlers
localeContextResolverback to summary
private LocaleContextResolver localeContextResolver
viewResolversback to summary
private final List<ViewResolver> viewResolvers
webFiltersback to summary
private final List<WebFilter> webFilters

Constructor Detail

DefaultHandlerStrategiesBuilderback to summary
public DefaultHandlerStrategiesBuilder()

Method Detail

buildback to summary
public HandlerStrategies build()

Implements org.springframework.web.reactive.function.server.HandlerStrategies.Builder.build.

Doc from org.springframework.web.reactive.function.server.HandlerStrategies.Builder.build.

Builds the HandlerStrategies.

Returns:HandlerStrategies

the built strategies

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

Implements org.springframework.web.reactive.function.server.HandlerStrategies.Builder.codecs.

Doc from org.springframework.web.reactive.function.server.HandlerStrategies.Builder.codecs.

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

Annotations
@Override
defaultConfigurationback to summary
public void defaultConfiguration()
exceptionHandlerback to summary
public HandlerStrategies.Builder exceptionHandler(WebExceptionHandler exceptionHandler)

Implements org.springframework.web.reactive.function.server.HandlerStrategies.Builder.exceptionHandler.

Doc from org.springframework.web.reactive.function.server.HandlerStrategies.Builder.exceptionHandler.

Add the given exception handler to this builder.

Parameters
exceptionHandler:WebExceptionHandler

the exception handler to add

Returns:HandlerStrategies.Builder

this builder

Annotations
@Override
localeContextResolverback to summary
public HandlerStrategies.Builder localeContextResolver(LocaleContextResolver localeContextResolver)

Implements org.springframework.web.reactive.function.server.HandlerStrategies.Builder.localeContextResolver.

Doc from org.springframework.web.reactive.function.server.HandlerStrategies.Builder.localeContextResolver.

Add the given locale context resolver to this builder.

Parameters
localeContextResolver:LocaleContextResolver

the locale context resolver to add

Returns:HandlerStrategies.Builder

this builder

Annotations
@Override
viewResolverback to summary
public HandlerStrategies.Builder viewResolver(ViewResolver viewResolver)

Implements org.springframework.web.reactive.function.server.HandlerStrategies.Builder.viewResolver.

Doc from org.springframework.web.reactive.function.server.HandlerStrategies.Builder.viewResolver.

Add the given view resolver to this builder.

Parameters
viewResolver:ViewResolver

the view resolver to add

Returns:HandlerStrategies.Builder

this builder

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

Implements org.springframework.web.reactive.function.server.HandlerStrategies.Builder.webFilter.

Doc from org.springframework.web.reactive.function.server.HandlerStrategies.Builder.webFilter.

Add the given web filter to this builder.

Parameters
filter:WebFilter

the filter to add

Returns:HandlerStrategies.Builder

this builder

Annotations
@Override
org.springframework.web.reactive.function.server back to summary

private Class DefaultHandlerStrategiesBuilder.DefaultHandlerStrategies

extends Object
implements HandlerStrategies
Class Inheritance
  • java.lang.Object
  • org.springframework.web.reactive.function.server.DefaultHandlerStrategiesBuilder.DefaultHandlerStrategies
All Implemented Interfaces
org.springframework.web.reactive.function.server.HandlerStrategies

Field Summary

Modifier and TypeField and Description
private final List<WebExceptionHandler>
exceptionHandlers

private final LocaleContextResolver
localeContextResolver

private final List<HttpMessageReader<?>>
messageReaders

private final List<HttpMessageWriter<?>>
messageWriters

private final List<ViewResolver>
viewResolvers

private final List<WebFilter>
webFilters

Constructor Summary

AccessConstructor and Description
public
DefaultHandlerStrategies(List<HttpMessageReader<?>> messageReaders, List<HttpMessageWriter<?>> messageWriters, List<ViewResolver> viewResolvers, List<WebFilter> webFilters, List<WebExceptionHandler> exceptionHandlers, LocaleContextResolver localeContextResolver)

Method Summary

Modifier and TypeMethod and Description
public List<WebExceptionHandler>
exceptionHandlers()

Implements org.springframework.web.reactive.function.server.HandlerStrategies.exceptionHandlers.

Return the WebExceptionHandlers to be used for handling exceptions.

public LocaleContextResolver
localeContextResolver()

Implements org.springframework.web.reactive.function.server.HandlerStrategies.localeContextResolver.

Return the LocaleContextResolver to be used for resolving locale context.

public List<HttpMessageReader<?>>
messageReaders()

Implements org.springframework.web.reactive.function.server.HandlerStrategies.messageReaders.

Return the HttpMessageReaders to be used for request body conversion.

public List<HttpMessageWriter<?>>
messageWriters()

Implements org.springframework.web.reactive.function.server.HandlerStrategies.messageWriters.

Return the HttpMessageWriters to be used for response body conversion.

public List<ViewResolver>
viewResolvers()

Implements org.springframework.web.reactive.function.server.HandlerStrategies.viewResolvers.

Return the ViewResolvers to be used for view name resolution.

public List<WebFilter>
webFilters()

Implements org.springframework.web.reactive.function.server.HandlerStrategies.webFilters.

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

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

exceptionHandlersback to summary
private final List<WebExceptionHandler> exceptionHandlers
localeContextResolverback to summary
private final LocaleContextResolver localeContextResolver
messageReadersback to summary
private final List<HttpMessageReader<?>> messageReaders
messageWritersback to summary
private final List<HttpMessageWriter<?>> messageWriters
viewResolversback to summary
private final List<ViewResolver> viewResolvers
webFiltersback to summary
private final List<WebFilter> webFilters

Constructor Detail

DefaultHandlerStrategiesback to summary
public DefaultHandlerStrategies(List<HttpMessageReader<?>> messageReaders, List<HttpMessageWriter<?>> messageWriters, List<ViewResolver> viewResolvers, List<WebFilter> webFilters, List<WebExceptionHandler> exceptionHandlers, LocaleContextResolver localeContextResolver)

Method Detail

exceptionHandlersback to summary
public List<WebExceptionHandler> exceptionHandlers()

Implements org.springframework.web.reactive.function.server.HandlerStrategies.exceptionHandlers.

Doc from org.springframework.web.reactive.function.server.HandlerStrategies.exceptionHandlers.

Return the WebExceptionHandlers to be used for handling exceptions.

Returns:List<WebExceptionHandler>

the exception handlers

Annotations
@Override
localeContextResolverback to summary
public LocaleContextResolver localeContextResolver()

Implements org.springframework.web.reactive.function.server.HandlerStrategies.localeContextResolver.

Doc from org.springframework.web.reactive.function.server.HandlerStrategies.localeContextResolver.

Return the LocaleContextResolver to be used for resolving locale context.

Returns:LocaleContextResolver

the locale context resolver

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

Implements org.springframework.web.reactive.function.server.HandlerStrategies.messageReaders.

Doc from org.springframework.web.reactive.function.server.HandlerStrategies.messageReaders.

Return the HttpMessageReaders to be used for request body conversion.

Returns:List<HttpMessageReader<?>>

the message readers

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

Implements org.springframework.web.reactive.function.server.HandlerStrategies.messageWriters.

Doc from org.springframework.web.reactive.function.server.HandlerStrategies.messageWriters.

Return the HttpMessageWriters to be used for response body conversion.

Returns:List<HttpMessageWriter<?>>

the message writers

Annotations
@Override
viewResolversback to summary
public List<ViewResolver> viewResolvers()

Implements org.springframework.web.reactive.function.server.HandlerStrategies.viewResolvers.

Doc from org.springframework.web.reactive.function.server.HandlerStrategies.viewResolvers.

Return the ViewResolvers to be used for view name resolution.

Returns:List<ViewResolver>

the view resolvers

Annotations
@Override
webFiltersback to summary
public List<WebFilter> webFilters()

Implements org.springframework.web.reactive.function.server.HandlerStrategies.webFilters.

Doc from org.springframework.web.reactive.function.server.HandlerStrategies.webFilters.

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

Returns:List<WebFilter>

the web filters

Annotations
@Override