Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractFileNameVersionStrategy - Class in org.springframework.web.reactive.resource
-
Abstract base class for filename suffix based
VersionStrategy
implementations, e.g. - AbstractFileNameVersionStrategy() - Constructor for class org.springframework.web.reactive.resource.AbstractFileNameVersionStrategy
- AbstractHandlerMapping - Class in org.springframework.web.reactive.handler
-
Abstract base class for
HandlerMapping
implementations. - AbstractHandlerMapping() - Constructor for class org.springframework.web.reactive.handler.AbstractHandlerMapping
- AbstractHandlerMethodMapping<T> - Class in org.springframework.web.reactive.result.method
-
Abstract base class for
HandlerMapping
implementations that define a mapping between a request and aHandlerMethod
. - AbstractHandlerMethodMapping() - Constructor for class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
- AbstractLinkParser() - Constructor for class org.springframework.web.reactive.resource.CssLinkResourceTransformer.AbstractLinkParser
- AbstractListenerWebSocketSession<T> - Class in org.springframework.web.reactive.socket.adapter
-
Base class for
WebSocketSession
implementations that bridge between event-listener WebSocket APIs (e.g. - AbstractListenerWebSocketSession(T, String, HandshakeInfo, DataBufferFactory) - Constructor for class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
-
Base constructor.
- AbstractListenerWebSocketSession(T, String, HandshakeInfo, DataBufferFactory, Sinks.Empty<Void>) - Constructor for class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
-
Alternative constructor with completion sink to use to signal when the handling of the session is complete, with success or error.
- AbstractListenerWebSocketSession.WebSocketSendProcessor - Class in org.springframework.web.reactive.socket.adapter
-
Processor to send web socket messages.
- AbstractMessageReaderArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Abstract base class for argument resolvers that resolve method arguments by reading the request body with an
HttpMessageReader
. - AbstractMessageReaderArgumentResolver(List<HttpMessageReader<?>>) - Constructor for class org.springframework.web.reactive.result.method.annotation.AbstractMessageReaderArgumentResolver
-
Constructor with
HttpMessageReader
's and aValidator
. - AbstractMessageReaderArgumentResolver(List<HttpMessageReader<?>>, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.AbstractMessageReaderArgumentResolver
-
Constructor that also accepts a
ReactiveAdapterRegistry
. - AbstractMessageWriterResultHandler - Class in org.springframework.web.reactive.result.method.annotation
-
Abstract base class for result handlers that handle return values by writing to the response with
HttpMessageWriter
. - AbstractMessageWriterResultHandler(List<HttpMessageWriter<?>>, RequestedContentTypeResolver) - Constructor for class org.springframework.web.reactive.result.method.annotation.AbstractMessageWriterResultHandler
-
Constructor with
HttpMessageWriters
and aRequestedContentTypeResolver
. - AbstractMessageWriterResultHandler(List<HttpMessageWriter<?>>, RequestedContentTypeResolver, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.AbstractMessageWriterResultHandler
-
Constructor with an additional
ReactiveAdapterRegistry
. - AbstractNamedValueArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Abstract base class for resolving method arguments from a named value.
- AbstractNamedValueArgumentResolver(ConfigurableBeanFactory, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver
-
Create a new
AbstractNamedValueArgumentResolver
instance. - AbstractNamedValueArgumentResolver.NamedValueInfo - Class in org.springframework.web.reactive.result.method.annotation
-
Represents the information about a named value, including name, whether it's required and a default value.
- AbstractNamedValueSyncArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
An extension of
AbstractNamedValueArgumentResolver
for named value resolvers that are synchronous and yet non-blocking. - AbstractNamedValueSyncArgumentResolver(ConfigurableBeanFactory, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver
-
Create a new
AbstractNamedValueSyncArgumentResolver
. - AbstractPrefixVersionStrategy - Class in org.springframework.web.reactive.resource
-
Abstract base class for
VersionStrategy
implementations that insert a prefix into the URL path, e.g. - AbstractPrefixVersionStrategy(String) - Constructor for class org.springframework.web.reactive.resource.AbstractPrefixVersionStrategy
- AbstractRequestCondition<T extends AbstractRequestCondition<T>> - Class in org.springframework.web.reactive.result.condition
-
A base class for
RequestCondition
types providing implementations ofAbstractRequestCondition.equals(Object)
,AbstractRequestCondition.hashCode()
, andAbstractRequestCondition.toString()
. - AbstractRequestCondition() - Constructor for class org.springframework.web.reactive.result.condition.AbstractRequestCondition
- AbstractResourceResolver - Class in org.springframework.web.reactive.resource
-
Base
ResourceResolver
providing consistent logging. - AbstractResourceResolver() - Constructor for class org.springframework.web.reactive.resource.AbstractResourceResolver
- AbstractUrlBasedView - Class in org.springframework.web.reactive.result.view
-
Abstract base class for URL-based views.
- AbstractUrlBasedView() - Constructor for class org.springframework.web.reactive.result.view.AbstractUrlBasedView
-
Constructor for use as a bean.
- AbstractUrlBasedView(String) - Constructor for class org.springframework.web.reactive.result.view.AbstractUrlBasedView
-
Create a new AbstractUrlBasedView with the given URL.
- AbstractUrlHandlerMapping - Class in org.springframework.web.reactive.handler
-
Abstract base class for URL-mapped
HandlerMapping
implementations. - AbstractUrlHandlerMapping() - Constructor for class org.springframework.web.reactive.handler.AbstractUrlHandlerMapping
- AbstractView - Class in org.springframework.web.reactive.result.view
-
Base class for
View
implementations. - AbstractView() - Constructor for class org.springframework.web.reactive.result.view.AbstractView
- AbstractView(ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.view.AbstractView
- AbstractWebSocketSession<T> - Class in org.springframework.web.reactive.socket.adapter
-
Convenient base class for
WebSocketSession
implementations that holds common fields and exposes accessors. - AbstractWebSocketSession(T, String, HandshakeInfo, DataBufferFactory) - Constructor for class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
-
Create a new WebSocket session.
- accept() - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Headers
-
Get the list of acceptable media types, as specified by the
Accept
header. - accept() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper.HeadersWrapper
- accept(MediaType...) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
Set the list of acceptable media types, as specified by the
Accept
header. - accept(MediaType...) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that tests if the request's accept header is compatible with any of the given media types. - accept(RequestPredicates.Visitor) - Method in interface org.springframework.web.reactive.function.server.RequestPredicate
-
Accept the given visitor.
- accept(RouterFunctions.Visitor) - Method in interface org.springframework.web.reactive.function.server.RouterFunction
-
Accept the given visitor.
- acceptCharset() - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Headers
-
Get the list of acceptable charsets, as specified by the
Accept-Charset
header. - acceptCharset() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper.HeadersWrapper
- acceptCharset(Charset...) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
Set the list of acceptable charsets, as specified by the
Accept-Charset
header. - accepted() - Static method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Create a builder with an 202 Accepted status.
- acceptLanguage() - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Headers
-
Get the list of acceptable languages, as specified by the
Accept-Language
header. - acceptLanguage() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper.HeadersWrapper
- add(RouterFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds the given route to this builder.
- addContentVersionStrategy(String...) - Method in class org.springframework.web.reactive.resource.VersionResourceResolver
-
Insert a content-based version in resource URLs that match the given path patterns.
- addCorsMappings(CorsRegistry) - Method in class org.springframework.web.reactive.config.DelegatingWebFluxConfiguration
- addCorsMappings(CorsRegistry) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Override this method to configure cross-origin requests processing.
- addCorsMappings(CorsRegistry) - Method in interface org.springframework.web.reactive.config.WebFluxConfigurer
-
Configure "global" cross-origin request processing.
- addCorsMappings(CorsRegistry) - Method in class org.springframework.web.reactive.config.WebFluxConfigurerComposite
- addCustomResolver(HandlerMethodArgumentResolver...) - Method in class org.springframework.web.reactive.result.method.annotation.ArgumentResolverConfigurer
-
Configure resolvers for custom controller method arguments.
- addFixedVersionStrategy(String, String...) - Method in class org.springframework.web.reactive.resource.VersionResourceResolver
-
Insert a fixed, prefix-based version in resource URLs that match the given path patterns, for example:
"{version}/js/main.js"
. - addFormatters(FormatterRegistry) - Method in class org.springframework.web.reactive.config.DelegatingWebFluxConfiguration
- addFormatters(FormatterRegistry) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Override this method to add custom
Converter
and/orFormatter
delegates to the commonFormattingConversionService
. - addFormatters(FormatterRegistry) - Method in interface org.springframework.web.reactive.config.WebFluxConfigurer
-
Add custom
Converters
andFormatters
for performing type conversion and formatting of annotated controller method arguments. - addFormatters(FormatterRegistry) - Method in class org.springframework.web.reactive.config.WebFluxConfigurerComposite
- addMapping(String) - Method in class org.springframework.web.reactive.config.CorsRegistry
-
Enable cross-origin request handling for the specified path pattern.
- addPathPrefix(String, Predicate<Class<?>>) - Method in class org.springframework.web.reactive.config.PathMatchConfigurer
-
Configure a path prefix to apply to matching controller methods.
- addResolver(ResourceResolver) - Method in class org.springframework.web.reactive.config.ResourceChainRegistration
-
Add a resource resolver to the chain.
- addResourceHandler(String...) - Method in class org.springframework.web.reactive.config.ResourceHandlerRegistry
-
Add a resource handler for serving static resources based on the specified URL path patterns.
- addResourceHandlers(ResourceHandlerRegistry) - Method in class org.springframework.web.reactive.config.DelegatingWebFluxConfiguration
- addResourceHandlers(ResourceHandlerRegistry) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Override this method to add resource handlers for serving static resources.
- addResourceHandlers(ResourceHandlerRegistry) - Method in interface org.springframework.web.reactive.config.WebFluxConfigurer
-
Add resource handlers for serving static resources.
- addResourceHandlers(ResourceHandlerRegistry) - Method in class org.springframework.web.reactive.config.WebFluxConfigurerComposite
- addResourceLocations(String...) - Method in class org.springframework.web.reactive.config.ResourceHandlerRegistration
-
Add one or more resource locations from which to serve static content.
- addTransformer(ResourceTransformer) - Method in class org.springframework.web.reactive.config.ResourceChainRegistration
-
Add a resource transformer to the chain.
- addVersion(String, String) - Method in class org.springframework.web.reactive.resource.AbstractFileNameVersionStrategy
- addVersion(String, String) - Method in class org.springframework.web.reactive.resource.AbstractPrefixVersionStrategy
- addVersion(String, String) - Method in interface org.springframework.web.reactive.resource.VersionStrategy
-
Add a version to the given request path.
- addVersionStrategy(VersionStrategy, String...) - Method in class org.springframework.web.reactive.resource.VersionResourceResolver
-
Register a custom VersionStrategy to apply to resource URLs that match the given path patterns.
- addWebFluxConfigurers(List<WebFluxConfigurer>) - Method in class org.springframework.web.reactive.config.WebFluxConfigurerComposite
- after(BiFunction<ServerRequest, ServerResponse, ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Filter the response object for all routes created by this builder with the given response processing function.
- afterPropertiesSet() - Method in class org.springframework.web.reactive.function.server.support.RouterFunctionMapping
- afterPropertiesSet() - Method in class org.springframework.web.reactive.function.server.support.ServerResponseResultHandler
- afterPropertiesSet() - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
- afterPropertiesSet() - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Detects handler methods at initialization.
- afterPropertiesSet() - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
- afterPropertiesSet() - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
- afterPropertiesSet() - Method in class org.springframework.web.reactive.result.view.AbstractUrlBasedView
- afterPropertiesSet() - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerConfigurer
-
Initialize FreeMarkerConfigurationFactory's Configuration if not overridden by a pre-configured FreeMarker Configuration.
- afterPropertiesSet() - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
- afterPropertiesSet() - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
- all() - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that always matches. - allow(Set<HttpMethod>) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Set the set of allowed
HTTP methods
, as specified by theAllow
header. - allow(Set<HttpMethod>) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder
-
Set the set of allowed
HTTP methods
, as specified by theAllow
header. - allow(HttpMethod...) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Set the set of allowed
HTTP methods
, as specified by theAllow
header. - allow(HttpMethod...) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder
-
Set the set of allowed
HTTP methods
, as specified by theAllow
header. - allowCredentials(boolean) - Method in class org.springframework.web.reactive.config.CorsRegistration
-
Whether the browser should send credentials, such as cookies along with cross domain requests, to the annotated endpoint.
- allowedHeaders(String...) - Method in class org.springframework.web.reactive.config.CorsRegistration
-
Set the list of headers that a pre-flight request can list as allowed for use during an actual request.
- allowedMethods(String...) - Method in class org.springframework.web.reactive.config.CorsRegistration
-
Set the HTTP methods to allow, e.g.
- allowedOriginPatterns(String...) - Method in class org.springframework.web.reactive.config.CorsRegistration
-
Alternative to
CorsRegistration.allowedOrigins(String...)
that supports more flexible patterns for specifying the origins for which cross-origin requests are allowed from a browser. - allowedOrigins(String...) - Method in class org.springframework.web.reactive.config.CorsRegistration
-
Set the origins for which cross-origin requests are allowed from a browser.
- and() - Method in interface org.springframework.web.reactive.function.server.RequestPredicates.Visitor
-
Receive "middle" notification of a logical AND predicate.
- and(RequestPredicate) - Method in interface org.springframework.web.reactive.function.server.RequestPredicate
-
Return a composed request predicate that tests against both this predicate AND the
other
predicate. - and(RouterFunction<T>) - Method in interface org.springframework.web.reactive.function.server.RouterFunction
-
Return a composed routing function that first invokes this function, and then invokes the
other
function (of the same response typeT
) if this route had no result. - andNest(RequestPredicate, RouterFunction<T>) - Method in interface org.springframework.web.reactive.function.server.RouterFunction
-
Return a composed routing function that routes to the given router function if this route does not match and the given request predicate applies.
- andOther(RouterFunction<?>) - Method in interface org.springframework.web.reactive.function.server.RouterFunction
-
Return a composed routing function that first invokes this function, and then invokes the
other
function (of a different response type) if this route had no result. - andRoute(RequestPredicate, HandlerFunction<T>) - Method in interface org.springframework.web.reactive.function.server.RouterFunction
-
Return a composed routing function that routes to the given handler function if this route does not match and the given request predicate applies.
- andThen(ExchangeFilterFunction) - Method in interface org.springframework.web.reactive.function.client.ExchangeFilterFunction
-
Return a composed filter function that first applies this filter, and then applies the given
"after"
filter. - andThen(HandlerFilterFunction<T, T>) - Method in interface org.springframework.web.reactive.function.server.HandlerFilterFunction
-
Return a composed filter function that first applies this filter, and then applies the
after
filter. - appendCurrentRequestQuery(String, ServerHttpRequest) - Method in class org.springframework.web.reactive.result.view.RedirectView
-
Append the query of the current request to the target redirect URL.
- apply(Consumer<WebClient.Builder>) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Apply the given
Consumer
to this builder instance. - apply(ExchangeFunction) - Method in interface org.springframework.web.reactive.function.client.ExchangeFilterFunction
-
Apply this filter to the given ExchangeFunction, resulting in a filtered exchange function.
- apply(HandlerFunction<T>) - Method in interface org.springframework.web.reactive.function.server.HandlerFilterFunction
-
Apply this filter to the given handler function, resulting in a filtered handler function.
- applyExceptionHandler(Throwable) - Method in class org.springframework.web.reactive.HandlerResult
-
Deprecated, for removal: This API element is subject to removal in a future version.without a replacement; for internal invocation only, not used as of 6.0
- applyLifecycleMethods(String, AbstractUrlBasedView) - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Apply the containing
ApplicationContext
's lifecycle methods to the givenView
instance, if such a context is available. - ArgumentResolverConfigurer - Class in org.springframework.web.reactive.result.method.annotation
-
Helps to configure resolvers for Controller method arguments.
- ArgumentResolverConfigurer() - Constructor for class org.springframework.web.reactive.result.method.annotation.ArgumentResolverConfigurer
- asHttpHeaders() - Method in interface org.springframework.web.reactive.function.client.ClientResponse.Headers
-
Return the headers as an
HttpHeaders
instance. - asHttpHeaders() - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper.HeadersWrapper
- asHttpHeaders() - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Headers
-
Get the headers as an instance of
HttpHeaders
. - asHttpHeaders() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper.HeadersWrapper
- attribute(String) - Method in interface org.springframework.web.reactive.function.client.ClientRequest
-
Return the request attribute value if present.
- attribute(String) - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the request attribute value if present.
- attribute(String) - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- attribute(String, Object) - Method in interface org.springframework.web.reactive.function.client.ClientRequest.Builder
-
Set the attribute with the given name to the given value.
- attribute(String, Object) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
Set the attribute with the given name to the given value.
- attribute(String, Object) - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Builder
-
Add an attribute with the given name and value.
- attributes() - Method in interface org.springframework.web.reactive.function.client.ClientRequest
-
Return the attributes of this request.
- attributes() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get a mutable map of request attributes.
- attributes() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- attributes(Consumer<Map<String, Object>>) - Method in interface org.springframework.web.reactive.function.client.ClientRequest.Builder
-
Manipulate the request attributes with the given consumer.
- attributes(Consumer<Map<String, Object>>) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
Provides access to every attribute declared so far with the possibility to add, replace, or remove values.
- attributes(Consumer<Map<String, Object>>) - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Builder
-
Manipulate this request's attributes with the given consumer.
- attributes(Map<String, Object>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Visitor
-
Receive notification of a router function with attributes.
- autodetectConfiguration() - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
-
Autodetect a
FreeMarkerConfig
object in theApplicationContext
. - autodetectViewConfig() - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
B
- BAD_DATA - Static variable in class org.springframework.web.reactive.socket.CloseStatus
-
"1007 indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 [RFC3629] data within a text message)."
- badRequest() - Static method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Create a builder with a 400 Bad Request status.
- baseUrl(String) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Configure a base URL for requests.
- basicAuthentication() - Static method in class org.springframework.web.reactive.function.client.ExchangeFilterFunctions
-
Deprecated.as of Spring 5.1 in favor of using
HttpHeaders.setBasicAuth(String, String)
while building the request. - basicAuthentication(String, String) - Static method in class org.springframework.web.reactive.function.client.ExchangeFilterFunctions
-
Return a filter that applies HTTP Basic Authentication to the request headers via
HttpHeaders.setBasicAuth(String)
andHttpHeaders.encodeBasicAuth(String, String, Charset)
. - basicAuthenticationCredentials(String, String) - Static method in class org.springframework.web.reactive.function.client.ExchangeFilterFunctions.Credentials
-
Deprecated.Return a Consumer that stores the given username and password as a request attribute of type
Credentials
that is in turn used byExchangeFilterFunctions.basicAuthentication()
. - before(Function<ServerRequest, ServerRequest>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Filter the request object for all routes created by this builder with the given request processing function.
- BEST_MATCHING_HANDLER_ATTRIBUTE - Static variable in interface org.springframework.web.reactive.HandlerMapping
-
Name of the
attribute
that contains the mapped handler for the best matching pattern. - BEST_MATCHING_PATTERN_ATTRIBUTE - Static variable in interface org.springframework.web.reactive.HandlerMapping
-
Name of the
attribute
that contains the best matching pattern within the handler mapping. - BINARY - Enum constant in enum class org.springframework.web.reactive.socket.WebSocketMessage.Type
-
Binary WebSocket message.
- binaryMessage(Function<DataBufferFactory, DataBuffer>) - Method in class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
- binaryMessage(Function<DataBufferFactory, DataBuffer>) - Method in interface org.springframework.web.reactive.socket.WebSocketSession
-
Factory method to create a binary WebSocketMessage using the
WebSocketSession.bufferFactory()
for the session. - BINDING_CONTEXT_ATTRIBUTE - Static variable in interface org.springframework.web.reactive.result.view.View
-
The name of the exchange attribute that contains the
BindingContext
for the request which can be used to createBindingResult
instances for objects in to the model. - BindingContext - Class in org.springframework.web.reactive
-
Context to assist with binding request data onto Objects and provide access to a shared
Model
with controller-specific attributes. - BindingContext() - Constructor for class org.springframework.web.reactive.BindingContext
-
Create a new
BindingContext
. - BindingContext(WebBindingInitializer) - Constructor for class org.springframework.web.reactive.BindingContext
-
Create a new
BindingContext
with the given initializer. - bindRequestParameters(WebExchangeDataBinder, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ModelAttributeMethodArgumentResolver
-
Extension point to bind the request to the target object.
- BindStatus - Class in org.springframework.web.reactive.result.view
-
Simple adapter to expose the bind status of a field or object.
- BindStatus(RequestContext, String, boolean) - Constructor for class org.springframework.web.reactive.result.view.BindStatus
-
Create a new BindStatus instance, representing a field or object status.
- body() - Method in interface org.springframework.web.reactive.function.client.ClientRequest
-
Return the body inserter of this request.
- body(Object, Class<?>) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestBodySpec
-
Variant of
WebClient.RequestBodySpec.body(Publisher, Class)
that allows using any producer that can be resolved toPublisher
viaReactiveAdapterRegistry
. - body(Object, Class<?>) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder
-
Variant of
ServerResponse.BodyBuilder.body(Publisher, Class)
that allows using any producer that can be resolved toPublisher
viaReactiveAdapterRegistry
. - body(Object, ParameterizedTypeReference<?>) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestBodySpec
-
Variant of
WebClient.RequestBodySpec.body(Publisher, ParameterizedTypeReference)
that allows using any producer that can be resolved toPublisher
viaReactiveAdapterRegistry
. - body(Object, ParameterizedTypeReference<?>) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder
-
Variant of
ServerResponse.BodyBuilder.body(Publisher, ParameterizedTypeReference)
that allows using any producer that can be resolved toPublisher
viaReactiveAdapterRegistry
. - body(String) - Method in interface org.springframework.web.reactive.function.client.ClientResponse.Builder
-
Set the body of the response to the UTF-8 encoded bytes of the given string.
- body(String) - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Builder
-
Set the body of the request to the UTF-8 encoded bytes of the given string.
- body(Function<Flux<DataBuffer>, Flux<DataBuffer>>) - Method in interface org.springframework.web.reactive.function.client.ClientResponse.Builder
-
Transform the response body, if set in the builder.
- body(BodyExtractor<T, ? super ClientHttpResponse>) - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Extract the body with the given
BodyExtractor
. - body(BodyExtractor<T, ? super ClientHttpResponse>) - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- body(BodyExtractor<T, ? super ServerHttpRequest>) - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Extract the body with the given
BodyExtractor
. - body(BodyExtractor<T, ? super ServerHttpRequest>) - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- body(BodyExtractor<T, ? super ServerHttpRequest>, Map<String, Object>) - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Extract the body with the given
BodyExtractor
and hints. - body(BodyExtractor<T, ? super ServerHttpRequest>, Map<String, Object>) - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- body(BodyInserter<?, ? super ClientHttpRequest>) - Method in interface org.springframework.web.reactive.function.client.ClientRequest.Builder
-
Set the body of the request to the given
BodyInserter
. - body(BodyInserter<?, ? super ClientHttpRequest>) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestBodySpec
-
Set the body of the request using the given body inserter.
- body(BodyInserter<?, ? super ServerHttpResponse>) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder
-
Set the body of the response to the given
BodyInserter
and return it. - body(P, Class<S>) - Method in interface org.springframework.web.reactive.function.client.ClientRequest.Builder
-
Set the body of the request to the given
Publisher
and return it. - body(P, Class<T>) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestBodySpec
-
Shortcut for
WebClient.RequestBodySpec.body(BodyInserter)
with a Publisher inserter. - body(P, Class<T>) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder
-
Set the body from the given
Publisher
. - body(P, ParameterizedTypeReference<S>) - Method in interface org.springframework.web.reactive.function.client.ClientRequest.Builder
-
Set the body of the request to the given
Publisher
and return it. - body(P, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestBodySpec
-
Variant of
WebClient.RequestBodySpec.body(Publisher, Class)
that allows providing element type information with generics. - body(P, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder
-
Variant of
ServerResponse.BodyBuilder.body(Publisher, Class)
that allows using any producer that can be resolved toPublisher
viaReactiveAdapterRegistry
. - body(Flux<DataBuffer>) - Method in interface org.springframework.web.reactive.function.client.ClientResponse.Builder
-
Set the body of the response.
- body(Flux<DataBuffer>) - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Builder
-
Set the body of the request.
- BodyExtractor<T,
M extends org.springframework.http.ReactiveHttpInputMessage> - Interface in org.springframework.web.reactive.function -
A function that can extract data from a
ReactiveHttpInputMessage
body. - BodyExtractor.Context - Interface in org.springframework.web.reactive.function
-
Defines the context used during the extraction.
- BodyExtractors - Class in org.springframework.web.reactive.function
-
Static factory methods for
BodyExtractor
implementations. - BodyExtractors() - Constructor for class org.springframework.web.reactive.function.BodyExtractors
- BodyInserter<T,
M extends org.springframework.http.ReactiveHttpOutputMessage> - Interface in org.springframework.web.reactive.function -
A combination of functions that can populate a
ReactiveHttpOutputMessage
body. - BodyInserter.Context - Interface in org.springframework.web.reactive.function
-
Defines the context used during the insertion.
- BodyInserters - Class in org.springframework.web.reactive.function
-
Static factory methods for
BodyInserter
implementations. - BodyInserters() - Constructor for class org.springframework.web.reactive.function.BodyInserters
- BodyInserters.FormInserter<T> - Interface in org.springframework.web.reactive.function
-
Extension of
BodyInserter
that allows for adding form data or multipart form data. - BodyInserters.MultipartInserter - Interface in org.springframework.web.reactive.function
-
Extension of
BodyInserters.FormInserter
that allows for adding asynchronous parts. - bodyToFlux(Class<? extends T>) - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Extract the body to a
Flux
. - bodyToFlux(Class<? extends T>) - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- bodyToFlux(Class<? extends T>) - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Extract the body to a
Flux
. - bodyToFlux(Class<? extends T>) - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- bodyToFlux(Class<T>) - Method in interface org.springframework.web.reactive.function.client.WebClient.ResponseSpec
-
Decode the body to a
Flux
with elements of the given type. - bodyToFlux(ParameterizedTypeReference<T>) - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Extract the body to a
Flux
. - bodyToFlux(ParameterizedTypeReference<T>) - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- bodyToFlux(ParameterizedTypeReference<T>) - Method in interface org.springframework.web.reactive.function.client.WebClient.ResponseSpec
-
Variant of
WebClient.ResponseSpec.bodyToMono(Class)
with aParameterizedTypeReference
. - bodyToFlux(ParameterizedTypeReference<T>) - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Extract the body to a
Flux
. - bodyToFlux(ParameterizedTypeReference<T>) - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- bodyToMono(Class<? extends T>) - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Extract the body to a
Mono
. - bodyToMono(Class<? extends T>) - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- bodyToMono(Class<? extends T>) - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Extract the body to a
Mono
. - bodyToMono(Class<? extends T>) - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- bodyToMono(Class<T>) - Method in interface org.springframework.web.reactive.function.client.WebClient.ResponseSpec
-
Decode the body to the given target type.
- bodyToMono(ParameterizedTypeReference<T>) - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Extract the body to a
Mono
. - bodyToMono(ParameterizedTypeReference<T>) - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- bodyToMono(ParameterizedTypeReference<T>) - Method in interface org.springframework.web.reactive.function.client.WebClient.ResponseSpec
-
Variant of
WebClient.ResponseSpec.bodyToMono(Class)
with aParameterizedTypeReference
. - bodyToMono(ParameterizedTypeReference<T>) - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Extract the body to a
Mono
. - bodyToMono(ParameterizedTypeReference<T>) - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- bodyValue(Object) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestBodySpec
-
Shortcut for
WebClient.RequestBodySpec.body(BodyInserter)
with a value inserter. - bodyValue(Object) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder
-
Set the body of the response to the given
Object
and return it. - bufferFactory() - Method in class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
- bufferFactory() - Method in class org.springframework.web.reactive.socket.adapter.Netty5WebSocketSessionSupport
- bufferFactory() - Method in class org.springframework.web.reactive.socket.adapter.NettyWebSocketSessionSupport
- bufferFactory() - Method in class org.springframework.web.reactive.socket.client.StandardWebSocketClient
- bufferFactory() - Method in interface org.springframework.web.reactive.socket.WebSocketSession
-
Return a
DataBuffer
Factory to create message payloads. - build() - Method in class org.springframework.web.reactive.accept.RequestedContentTypeResolverBuilder
-
Build a
RequestedContentTypeResolver
that delegates to the list of resolvers configured through this builder. - build() - Method in interface org.springframework.web.reactive.function.client.ClientRequest.Builder
-
Build the request.
- build() - Method in interface org.springframework.web.reactive.function.client.ClientResponse.Builder
-
Build the response.
- build() - Method in interface org.springframework.web.reactive.function.client.ExchangeStrategies.Builder
-
Builds the
ExchangeStrategies
. - build() - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Build the
WebClient
instance. - build() - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Build the response.
- build() - Method in interface org.springframework.web.reactive.function.server.HandlerStrategies.Builder
-
Builds the
HandlerStrategies
. - build() - Method in interface org.springframework.web.reactive.function.server.RenderingResponse.Builder
-
Build the response.
- build() - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Builds the
RouterFunction
. - build() - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Builder
-
Build the request.
- build() - Method in interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder
-
Build the response entity with no body.
- build() - Method in interface org.springframework.web.reactive.result.method.RequestMappingInfo.Builder
-
Build the RequestMappingInfo.
- build() - Method in interface org.springframework.web.reactive.result.view.Rendering.Builder
-
Build the
Rendering
instance. - build(BiFunction<ServerWebExchange, ServerResponse.Context, Mono<Void>>) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder
-
Build the response entity with a custom writer function.
- build(Publisher<Void>) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder
-
Build the response entity with no body.
- builder() - Static method in interface org.springframework.web.reactive.function.client.ExchangeStrategies
-
Return a builder pre-configured with default configuration to start.
- builder() - Static method in interface org.springframework.web.reactive.function.client.WebClient
-
Obtain a
WebClient
builder. - builder() - Static method in interface org.springframework.web.reactive.function.server.HandlerStrategies
-
Return a mutable builder for a
HandlerStrategies
with default initialization. - BuilderConfiguration() - Constructor for class org.springframework.web.reactive.result.method.RequestMappingInfo.BuilderConfiguration
C
- cacheControl(CacheControl) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Set the caching directives for the resource, as specified by the HTTP 1.1
Cache-Control
header. - cacheControl(CacheControl) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder
-
Set the caching directives for the resource, as specified by the HTTP 1.1
Cache-Control
header. - CachingResourceResolver - Class in org.springframework.web.reactive.resource
-
A
ResourceResolver
that resolves resources from aCache
or otherwise delegates to the resolver chain and caches the result. - CachingResourceResolver(Cache) - Constructor for class org.springframework.web.reactive.resource.CachingResourceResolver
- CachingResourceResolver(CacheManager, String) - Constructor for class org.springframework.web.reactive.resource.CachingResourceResolver
- CachingResourceTransformer - Class in org.springframework.web.reactive.resource
-
A
ResourceTransformer
that checks aCache
to see if a previously transformed resource exists in the cache and returns it if found, or otherwise delegates to the resolver chain and caches the result. - CachingResourceTransformer(Cache) - Constructor for class org.springframework.web.reactive.resource.CachingResourceTransformer
- CachingResourceTransformer(CacheManager, String) - Constructor for class org.springframework.web.reactive.resource.CachingResourceTransformer
- canHandle(String, Locale) - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Indicates whether this
ViewResolver
can handle the supplied view name. - canSuspendReceiving() - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
-
Whether the underlying WebSocket API has flow control and can suspend and resume the receiving of messages.
- canSuspendReceiving() - Method in class org.springframework.web.reactive.socket.adapter.JettyWebSocketSession
- canSuspendReceiving() - Method in class org.springframework.web.reactive.socket.adapter.StandardWebSocketSession
- canSuspendReceiving() - Method in class org.springframework.web.reactive.socket.adapter.TomcatWebSocketSession
- canSuspendReceiving() - Method in class org.springframework.web.reactive.socket.adapter.UndertowWebSocketSession
- changeLocale(Locale) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Change the current locale to the specified one.
- changeLocale(Locale, TimeZone) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Change the current locale to the specified locale and time zone context.
- changeParser(RouterFunction<T>, PathPatternParser) - Static method in class org.springframework.web.reactive.function.server.RouterFunctions
-
Changes the
PathPatternParser
on the given router function. - checkAnnotatedParamNoReactiveWrapper(MethodParameter, Class<A>, BiPredicate<A, Class<?>>) - Method in class org.springframework.web.reactive.result.method.HandlerMethodArgumentResolverSupport
-
Evaluate the
Predicate
on the method parameter type if it has the given annotation, nesting withinOptional
if necessary, but raise anIllegalStateException
if the same matches the generic type within a reactive type wrapper. - checkNotModified(String) - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Check whether the requested resource has been modified given the supplied
ETag
(entity tag), as determined by the application. - checkNotModified(Instant) - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Check whether the requested resource has been modified given the supplied last-modified timestamp (as determined by the application).
- checkNotModified(Instant, String) - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Check whether the requested resource has been modified given the supplied
ETag
(entity tag) and last-modified timestamp, as determined by the application. - checkParameterType(MethodParameter, Predicate<Class<?>>) - Method in class org.springframework.web.reactive.result.method.HandlerMethodArgumentResolverSupport
-
Evaluate the
Predicate
on the method parameter type or on the generic type within a reactive type wrapper. - checkParameterTypeNoReactiveWrapper(MethodParameter, Predicate<Class<?>>) - Method in class org.springframework.web.reactive.result.method.HandlerMethodArgumentResolverSupport
-
Evaluate the
Predicate
on the method parameter type but raise anIllegalStateException
if the same matches the generic type within a reactive type wrapper. - checkResource(Resource, Resource) - Method in class org.springframework.web.reactive.resource.PathResourceResolver
-
Perform additional checks on a resolved resource beyond checking whether the resource exists and is readable.
- checkResourceExists(Locale) - Method in class org.springframework.web.reactive.result.view.AbstractUrlBasedView
-
Check whether the resource for the configured URL actually exists.
- checkResourceExists(Locale) - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
-
Check that the FreeMarker template used for this view exists and is valid.
- checkResourceExists(Locale) - Method in class org.springframework.web.reactive.result.view.RedirectView
- checkResourceExists(Locale) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
- clearMediaTypesAttribute(ServerWebExchange) - Static method in class org.springframework.web.reactive.result.condition.ProducesRequestCondition
-
Use this to clear
ProducesRequestCondition.MEDIA_TYPES_ATTRIBUTE
that contains the parsed, requested media types. - CLIENT_NAME - Enum constant in enum class org.springframework.web.reactive.function.client.ClientHttpObservationDocumentation.HighCardinalityKeyNames
-
Client name derived from the request URI host.
- clientConnector(ClientHttpConnector) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Configure the
ClientHttpConnector
to use. - ClientHttpObservationDocumentation - Enum Class in org.springframework.web.reactive.function.client
-
Documented
KeyValues
for theHTTP client
observations. - ClientHttpObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.web.reactive.function.client
- ClientHttpObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.web.reactive.function.client
- clientName(ClientRequestObservationContext) - Method in class org.springframework.web.reactive.function.client.DefaultClientRequestObservationConvention
- ClientRequest - Interface in org.springframework.web.reactive.function.client
-
Represents a typed, immutable, client-side HTTP request, as executed by the
ExchangeFunction
. - ClientRequest.Builder - Interface in org.springframework.web.reactive.function.client
-
Defines a builder for a request.
- ClientRequestObservationContext - Class in org.springframework.web.reactive.function.client
-
Context that holds information for metadata collection during the
HTTP client exchange observations
. - ClientRequestObservationContext() - Constructor for class org.springframework.web.reactive.function.client.ClientRequestObservationContext
- ClientRequestObservationConvention - Interface in org.springframework.web.reactive.function.client
-
Interface for an
ObservationConvention
related toHTTP client exchange observations
. - ClientResponse - Interface in org.springframework.web.reactive.function.client
-
Represents an HTTP response, as returned by
WebClient
and alsoExchangeFunction
. - ClientResponse.Builder - Interface in org.springframework.web.reactive.function.client
-
Defines a builder for a response.
- ClientResponse.Headers - Interface in org.springframework.web.reactive.function.client
-
Represents the headers of the HTTP response.
- ClientResponseWrapper - Class in org.springframework.web.reactive.function.client.support
-
Implementation of the
ClientResponse
interface that can be subclassed to adapt the request in aexchange filter function
. - ClientResponseWrapper(ClientResponse) - Constructor for class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
-
Create a new
ClientResponseWrapper
that wraps the given response. - ClientResponseWrapper.HeadersWrapper - Class in org.springframework.web.reactive.function.client.support
-
Implementation of the
Headers
interface that can be subclassed to adapt the headers in aexchange filter function
. - clone() - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Clone this
WebClient.Builder
. - close() - Method in interface org.springframework.web.reactive.socket.WebSocketSession
-
Close the WebSocket session with
CloseStatus.NORMAL
. - close(CloseStatus) - Method in class org.springframework.web.reactive.socket.adapter.JettyWebSocketSession
- close(CloseStatus) - Method in class org.springframework.web.reactive.socket.adapter.ReactorNetty2WebSocketSession
- close(CloseStatus) - Method in class org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession
- close(CloseStatus) - Method in class org.springframework.web.reactive.socket.adapter.StandardWebSocketSession
- close(CloseStatus) - Method in class org.springframework.web.reactive.socket.adapter.UndertowWebSocketSession
- close(CloseStatus) - Method in interface org.springframework.web.reactive.socket.WebSocketSession
-
Close the WebSocket session with the given status.
- closeStatus() - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
- closeStatus() - Method in class org.springframework.web.reactive.socket.adapter.ReactorNetty2WebSocketSession
- closeStatus() - Method in class org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession
- closeStatus() - Method in interface org.springframework.web.reactive.socket.WebSocketSession
-
Provides access to the
CloseStatus
with which the session is closed either locally or remotely, or completes empty if the session ended without a status. - CloseStatus - Class in org.springframework.web.reactive.socket
-
Representation of WebSocket "close" status codes and reasons.
- CloseStatus(int) - Constructor for class org.springframework.web.reactive.socket.CloseStatus
-
Create a new
CloseStatus
instance. - CloseStatus(int, String) - Constructor for class org.springframework.web.reactive.socket.CloseStatus
-
Create a new
CloseStatus
instance. - codecs(Consumer<ClientCodecConfigurer>) - Method in interface org.springframework.web.reactive.function.client.ExchangeStrategies.Builder
-
Customize the list of client-side HTTP message readers and writers.
- codecs(Consumer<ClientCodecConfigurer>) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
- codecs(Consumer<ServerCodecConfigurer>) - Method in interface org.springframework.web.reactive.function.server.HandlerStrategies.Builder
-
Customize the list of server-side HTTP message readers and writers.
- combine(CorsConfiguration) - Method in class org.springframework.web.reactive.config.CorsRegistration
-
Apply the given
CorsConfiguration
to the one being configured viaCorsConfiguration.combine(CorsConfiguration)
which in turn has been initialized withCorsConfiguration.applyPermitDefaultValues()
. - combine(CompositeRequestCondition) - Method in class org.springframework.web.reactive.result.condition.CompositeRequestCondition
-
If one instance is empty, return the other.
- combine(ConsumesRequestCondition) - Method in class org.springframework.web.reactive.result.condition.ConsumesRequestCondition
-
Returns the "other" instance if it has any expressions; returns "this" instance otherwise.
- combine(HeadersRequestCondition) - Method in class org.springframework.web.reactive.result.condition.HeadersRequestCondition
-
Returns a new instance with the union of the header expressions from "this" and the "other" instance.
- combine(ParamsRequestCondition) - Method in class org.springframework.web.reactive.result.condition.ParamsRequestCondition
-
Returns a new instance with the union of the param expressions from "this" and the "other" instance.
- combine(PatternsRequestCondition) - Method in class org.springframework.web.reactive.result.condition.PatternsRequestCondition
-
Returns a new instance with URL patterns from the current instance ("this") and the "other" instance as follows: If there are patterns in both instances, combine the patterns in "this" with the patterns in "other" using
PathPattern.combine(PathPattern)
. - combine(ProducesRequestCondition) - Method in class org.springframework.web.reactive.result.condition.ProducesRequestCondition
-
Returns the "other" instance if it has any expressions; returns "this" instance otherwise.
- combine(RequestConditionHolder) - Method in class org.springframework.web.reactive.result.condition.RequestConditionHolder
-
Combine the request conditions held by the two RequestConditionHolder instances after making sure the conditions are of the same type.
- combine(RequestMethodsRequestCondition) - Method in class org.springframework.web.reactive.result.condition.RequestMethodsRequestCondition
-
Returns a new instance with a union of the HTTP request methods from "this" and the "other" instance.
- combine(RequestMappingInfo) - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Combines "this" request mapping info (i.e.
- combine(T) - Method in interface org.springframework.web.reactive.result.condition.RequestCondition
-
Combine this condition with another such as conditions from a type-level and method-level
@RequestMapping
annotation. - compareTo(CompositeRequestCondition, ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.CompositeRequestCondition
-
If one instance is empty, the other "wins".
- compareTo(ConsumesRequestCondition, ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.ConsumesRequestCondition
-
Returns: 0 if the two conditions have the same number of expressions Less than 0 if "this" has more or more specific media type expressions Greater than 0 if "other" has more or more specific media type expressions
- compareTo(HeadersRequestCondition, ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.HeadersRequestCondition
-
Compare to another condition based on header expressions.
- compareTo(ParamsRequestCondition, ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.ParamsRequestCondition
-
Compare to another condition based on parameter expressions.
- compareTo(PatternsRequestCondition, ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.PatternsRequestCondition
-
Compare the two conditions based on the URL patterns they contain.
- compareTo(ProducesRequestCondition, ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.ProducesRequestCondition
-
Compares this and another "produces" condition as follows: Sort 'Accept' header media types by quality value via
MimeTypeUtils.sortBySpecificity(List)
and iterate the list. - compareTo(RequestConditionHolder, ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.RequestConditionHolder
-
Compare the request conditions held by the two RequestConditionHolder instances after making sure the conditions are of the same type.
- compareTo(RequestMethodsRequestCondition, ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.RequestMethodsRequestCondition
-
Returns: 0 if the two conditions contain the same number of HTTP request methods Less than 0 if "this" instance has an HTTP request method but "other" doesn't Greater than 0 "other" has an HTTP request method but "this" doesn't
- compareTo(RequestMappingInfo, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Compares "this" info (i.e.
- compareTo(T, ServerWebExchange) - Method in interface org.springframework.web.reactive.result.condition.RequestCondition
-
Compare this condition to another condition in the context of a specific request.
- CompositeRequestCondition - Class in org.springframework.web.reactive.result.condition
-
Implements the
RequestCondition
contract by delegating to multipleRequestCondition
types and using a logical conjunction (' && '
) to ensure all conditions match a given request. - CompositeRequestCondition(RequestCondition<?>...) - Constructor for class org.springframework.web.reactive.result.condition.CompositeRequestCondition
-
Create an instance with 0 or more
RequestCondition
types. - computeKey(ServerWebExchange, String) - Method in class org.springframework.web.reactive.resource.CachingResourceResolver
- configureArgumentResolvers(ArgumentResolverConfigurer) - Method in class org.springframework.web.reactive.config.DelegatingWebFluxConfiguration
- configureArgumentResolvers(ArgumentResolverConfigurer) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Configure resolvers for custom controller method arguments.
- configureArgumentResolvers(ArgumentResolverConfigurer) - Method in interface org.springframework.web.reactive.config.WebFluxConfigurer
-
Configure resolvers for custom
@RequestMapping
method arguments. - configureArgumentResolvers(ArgumentResolverConfigurer) - Method in class org.springframework.web.reactive.config.WebFluxConfigurerComposite
- configureContentTypeResolver(RequestedContentTypeResolverBuilder) - Method in class org.springframework.web.reactive.config.DelegatingWebFluxConfiguration
- configureContentTypeResolver(RequestedContentTypeResolverBuilder) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Override to configure how the requested content type is resolved.
- configureContentTypeResolver(RequestedContentTypeResolverBuilder) - Method in interface org.springframework.web.reactive.config.WebFluxConfigurer
-
Configure how the content type requested for the response is resolved when handling requests with annotated controllers.
- configureContentTypeResolver(RequestedContentTypeResolverBuilder) - Method in class org.springframework.web.reactive.config.WebFluxConfigurerComposite
- configureHttpMessageCodecs(ServerCodecConfigurer) - Method in class org.springframework.web.reactive.config.DelegatingWebFluxConfiguration
- configureHttpMessageCodecs(ServerCodecConfigurer) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Override to configure the HTTP message readers and writers to use.
- configureHttpMessageCodecs(ServerCodecConfigurer) - Method in interface org.springframework.web.reactive.config.WebFluxConfigurer
-
Configure the HTTP message readers and writers for reading from the request body and for writing to the response body in annotated controllers and functional endpoints.
- configureHttpMessageCodecs(ServerCodecConfigurer) - Method in class org.springframework.web.reactive.config.WebFluxConfigurerComposite
- configurePathMatching(PathMatchConfigurer) - Method in class org.springframework.web.reactive.config.DelegatingWebFluxConfiguration
- configurePathMatching(PathMatchConfigurer) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Override to configure path matching options.
- configurePathMatching(PathMatchConfigurer) - Method in interface org.springframework.web.reactive.config.WebFluxConfigurer
-
Configure path matching options.
- configurePathMatching(PathMatchConfigurer) - Method in class org.springframework.web.reactive.config.WebFluxConfigurerComposite
- configureViewResolvers(ViewResolverRegistry) - Method in class org.springframework.web.reactive.config.DelegatingWebFluxConfiguration
- configureViewResolvers(ViewResolverRegistry) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Configure view resolution for supporting template engines.
- configureViewResolvers(ViewResolverRegistry) - Method in interface org.springframework.web.reactive.config.WebFluxConfigurer
-
Configure view resolution for rendering responses with a view and a model, where the view is typically an HTML template but could also be based on an HTTP message writer (e.g.
- configureViewResolvers(ViewResolverRegistry) - Method in class org.springframework.web.reactive.config.WebFluxConfigurerComposite
- consumes(String...) - Method in interface org.springframework.web.reactive.result.method.RequestMappingInfo.Builder
-
Set the consumes conditions.
- ConsumesRequestCondition - Class in org.springframework.web.reactive.result.condition
-
A logical disjunction (' || ') request condition to match a request's 'Content-Type' header to a list of media type expressions.
- ConsumesRequestCondition(String...) - Constructor for class org.springframework.web.reactive.result.condition.ConsumesRequestCondition
-
Creates a new instance from 0 or more "consumes" expressions.
- ConsumesRequestCondition(String[], String[]) - Constructor for class org.springframework.web.reactive.result.condition.ConsumesRequestCondition
-
Creates a new instance with "consumes" and "header" expressions.
- contentLength() - Method in interface org.springframework.web.reactive.function.client.ClientResponse.Headers
-
Return the length of the body in bytes, as specified by the
Content-Length
header. - contentLength() - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper.HeadersWrapper
- contentLength() - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Headers
-
Get the length of the body in bytes, as specified by the
Content-Length
header. - contentLength() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper.HeadersWrapper
- contentLength(long) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestBodySpec
-
Set the length of the body in bytes, as specified by the
Content-Length
header. - contentLength(long) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Set the length of the body in bytes, as specified by the
Content-Length
header. - contentLength(long) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder
-
Set the length of the body in bytes, as specified by the
Content-Length
header. - contentType() - Method in interface org.springframework.web.reactive.function.client.ClientResponse.Headers
-
Return the media type of the body, as specified by the
Content-Type
header. - contentType() - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper.HeadersWrapper
- contentType() - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Headers
-
Get the media type of the body, as specified by the
Content-Type
header. - contentType() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper.HeadersWrapper
- contentType(MediaType) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestBodySpec
-
Set the media type of the body, as specified by the
Content-Type
header. - contentType(MediaType) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Set the media type of the body, as specified by the
Content-Type
header. - contentType(MediaType) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder
-
Set the media type of the body, as specified by the
Content-Type
header. - contentType(MediaType...) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that tests if the request's content type is included by any of the given media types. - ContentVersionStrategy - Class in org.springframework.web.reactive.resource
-
A
VersionStrategy
that calculates a Hex MD5 hash from the content of the resource and appends it to the file name, e.g. - ContentVersionStrategy() - Constructor for class org.springframework.web.reactive.resource.ContentVersionStrategy
- context(Function<Context, Context>) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
Deprecated.in 5.3.2 to be removed soon after; this method cannot provide context to downstream (nested or subsequent) requests and is of limited value.
- contextPath(String) - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Builder
-
Set the context path of the request.
- contextRelative(boolean) - Method in interface org.springframework.web.reactive.result.view.Rendering.RedirectBuilder
-
Whether to the provided redirect URL should be prepended with the application context path (if any).
- ContextWebSocketHandler - Class in org.springframework.web.reactive.socket.adapter
-
WebSocketHandler
decorator that enriches the context of the target handler. - ContinuationHandlerMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
No-op resolver for method arguments of type
Continuation
. - ContinuationHandlerMethodArgumentResolver() - Constructor for class org.springframework.web.reactive.result.method.annotation.ContinuationHandlerMethodArgumentResolver
- cookie(String, String) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
Add a cookie with the given name and value.
- cookie(String, String...) - Method in interface org.springframework.web.reactive.function.client.ClientRequest.Builder
-
Add a cookie with the given name and value(s).
- cookie(String, String...) - Method in interface org.springframework.web.reactive.function.client.ClientResponse.Builder
-
Add a cookie with the given name and value(s).
- cookie(String, String...) - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Builder
-
Add a cookie with the given name and value(s).
- cookie(ResponseCookie) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Add the given cookie to the response.
- cookie(ResponseCookie) - Method in interface org.springframework.web.reactive.function.server.RenderingResponse.Builder
-
Add the given cookie to the response.
- cookie(ResponseCookie) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder
-
Add the given cookie to the response.
- cookies() - Method in interface org.springframework.web.reactive.function.client.ClientRequest
-
Return the cookies of this request.
- cookies() - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Return the cookies of this response.
- cookies() - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- cookies() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the cookies of this request.
- cookies() - Method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Return the cookies of this response.
- cookies() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- cookies(Consumer<MultiValueMap<String, String>>) - Method in interface org.springframework.web.reactive.function.client.ClientRequest.Builder
-
Manipulate this request's cookies with the given consumer.
- cookies(Consumer<MultiValueMap<String, String>>) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
Provides access to every cookie declared so far with the possibility to add, replace, or remove values.
- cookies(Consumer<MultiValueMap<String, HttpCookie>>) - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Builder
-
Manipulate this request's cookies with the given consumer.
- cookies(Consumer<MultiValueMap<String, ResponseCookie>>) - Method in interface org.springframework.web.reactive.function.client.ClientResponse.Builder
-
Manipulate this response's cookies with the given consumer.
- cookies(Consumer<MultiValueMap<String, ResponseCookie>>) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Manipulate this response's cookies with the given consumer.
- cookies(Consumer<MultiValueMap<String, ResponseCookie>>) - Method in interface org.springframework.web.reactive.function.server.RenderingResponse.Builder
-
Manipulate this response's cookies with the given consumer.
- cookies(Consumer<MultiValueMap<String, ResponseCookie>>) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder
-
Manipulate this response's cookies with the given consumer.
- CookieValueMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolve method arguments annotated with
@CookieValue
. - CookieValueMethodArgumentResolver(ConfigurableBeanFactory, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.CookieValueMethodArgumentResolver
-
Create a new
CookieValueMethodArgumentResolver
instance. - COROUTINES_FLOW_CLASS_NAME - Static variable in class org.springframework.web.reactive.result.method.annotation.AbstractMessageWriterResultHandler
- CorsRegistration - Class in org.springframework.web.reactive.config
-
Assists with the creation of a
CorsConfiguration
instance for a given URL path pattern. - CorsRegistration(String) - Constructor for class org.springframework.web.reactive.config.CorsRegistration
- CorsRegistry - Class in org.springframework.web.reactive.config
-
Assists with the registration of global, URL pattern based
CorsConfiguration
mappings. - CorsRegistry() - Constructor for class org.springframework.web.reactive.config.CorsRegistry
- create() - Static method in interface org.springframework.web.reactive.function.client.WebClient
-
Create a new
WebClient
with Reactor Netty by default. - create(int, String) - Static method in class org.springframework.web.reactive.socket.CloseStatus
-
Return a constant for the given code, or create a new instance if the code does not match or there is a reason.
- create(int, String, HttpHeaders, byte[], Charset) - Static method in exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Create
WebClientResponseException
or an HTTP status specific subclass. - create(int, String, HttpHeaders, byte[], Charset, HttpRequest) - Static method in exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Create
WebClientResponseException
or an HTTP status specific subclass. - create(int, ExchangeStrategies) - Static method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Create a response builder with the given raw status code and strategies for reading the body.
- create(String) - Static method in interface org.springframework.web.reactive.function.client.WebClient
-
Variant of
WebClient.create()
that accepts a default base URL. - create(String) - Static method in interface org.springframework.web.reactive.function.server.RenderingResponse
-
Create a builder with the given template name.
- create(ClientHttpConnector) - Static method in class org.springframework.web.reactive.function.client.ExchangeFunctions
-
Create an
ExchangeFunction
with the givenClientHttpConnector
. - create(ClientHttpConnector, ExchangeStrategies) - Static method in class org.springframework.web.reactive.function.client.ExchangeFunctions
-
Create an
ExchangeFunction
with the givenClientHttpConnector
andExchangeStrategies
. - create(HttpMethod, URI) - Static method in interface org.springframework.web.reactive.function.client.ClientRequest
-
Create a request builder with the given HTTP method and url.
- create(HttpStatusCode) - Static method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Create a response builder with the given status code and using default strategies for reading the body.
- create(HttpStatusCode, String, HttpHeaders, byte[], Charset, HttpRequest) - Static method in exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Create
WebClientResponseException
or an HTTP status specific subclass. - create(HttpStatusCode, List<HttpMessageReader<?>>) - Static method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Create a response builder with the given status code and message body readers.
- create(HttpStatusCode, ExchangeStrategies) - Static method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Create a response builder with the given status code and strategies for reading the body.
- create(ServerWebExchange, List<HttpMessageReader<?>>) - Static method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Create a new
ServerRequest
based on the givenServerWebExchange
and message readers. - createConnectionBuilder(URI) - Method in class org.springframework.web.reactive.socket.client.UndertowWebSocketClient
-
Create a
WebSocketClient.ConnectionBuilder
for the given URI. - created(URI) - Static method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Create a new builder with a 201 Created status and a location header set to the given URI.
- createDataBinder(ServerWebExchange, Object, String) - Method in class org.springframework.web.reactive.BindingContext
-
Create a
WebExchangeDataBinder
to apply data binding and validation with on the target, command object. - createDataBinder(ServerWebExchange, String) - Method in class org.springframework.web.reactive.BindingContext
-
Create a
WebExchangeDataBinder
without a target object for type conversion of request values to simple types. - createEngineFromName(String) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
- createError() - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Create a
Mono
that terminates with aWebClientResponseException
, containing the response status, headers, body, and the originating request. - createError() - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- createException() - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Create a
WebClientResponseException
that contains the response status, headers, body, and the originating request. - createException() - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- createHandlerMethod(Object, Method) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Create the HandlerMethod instance.
- createLocaleContextResolver() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Override to plug a subclass of
LocaleContextResolver
. - createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver
-
Create the
AbstractNamedValueArgumentResolver.NamedValueInfo
object for the given method parameter. - createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.CookieValueMethodArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.ExpressionValueMethodArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.MatrixVariableMethodArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.PathVariableMethodArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.RequestAttributeMethodArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.RequestHeaderMethodArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.RequestParamMethodArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.SessionAttributeMethodArgumentResolver
- createProblemDetail(Exception, HttpStatusCode, String, String, Object[], ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Convenience method to create a
ProblemDetail
for any exception that doesn't implementErrorResponse
, also performing aMessageSource
lookup for the "detail" field. - createRequestContext(ServerWebExchange, Map<String, Object>) - Method in class org.springframework.web.reactive.result.view.AbstractView
-
Create a
RequestContext
to expose under the specified attribute name. - createRequestMappingHandlerAdapter() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Override to plug a subclass of
RequestMappingHandlerAdapter
. - createRequestMappingHandlerMapping() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Override to plug a subclass of
RequestMappingHandlerMapping
. - createRequestMappingInfo(RequestMapping, RequestCondition<?>) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
-
Create a
RequestMappingInfo
from the supplied@RequestMapping
annotation, which is either a directly declared annotation, a meta-annotation, or the synthesized result of merging annotation attributes within an annotation hierarchy. - createResponseEntity(Object, HttpHeaders, HttpStatusCode, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Create the
ResponseEntity
to use from the given body, headers, and statusCode. - createRouterFunctionMapping() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Override to plug a subclass of
RouterFunctionMapping
. - createTargetUrl(Map<String, Object>, ServerWebExchange) - Method in class org.springframework.web.reactive.result.view.RedirectView
-
Create the target URL and, if necessary, pre-pend the contextPath, expand URI template variables, append the current request query, and apply the configured
RequestDataValueProcessor
. - createView(String) - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Creates a new View instance of the specified view class and configures it.
- createWebSocketSession(Session, HandshakeInfo, Sinks.Empty<Void>) - Method in class org.springframework.web.reactive.socket.client.StandardWebSocketClient
- createWebSocketSession(Session, HandshakeInfo, Sinks.Empty<Void>) - Method in class org.springframework.web.reactive.socket.client.TomcatWebSocketClient
- Credentials(String, String) - Constructor for class org.springframework.web.reactive.function.client.ExchangeFilterFunctions.Credentials
-
Deprecated.Create a new
Credentials
instance with the given username and password. - CssLinkResourceTransformer - Class in org.springframework.web.reactive.resource
-
A
ResourceTransformer
implementation that modifies links in a CSS file to match the public URL paths that should be exposed to clients (e.g. - CssLinkResourceTransformer() - Constructor for class org.springframework.web.reactive.resource.CssLinkResourceTransformer
- CssLinkResourceTransformer.AbstractLinkParser - Class in org.springframework.web.reactive.resource
-
Abstract base class for
CssLinkResourceTransformer.LinkParser
implementations. - CssLinkResourceTransformer.LinkParser - Interface in org.springframework.web.reactive.resource
-
Extract content chunks that represent links.
- customCondition(RequestCondition<?>) - Method in interface org.springframework.web.reactive.result.method.RequestMappingInfo.Builder
-
Set a custom condition to use.
D
- decorate(WebSocketHandler, ContextView) - Static method in class org.springframework.web.reactive.socket.adapter.ContextWebSocketHandler
-
Return the given handler, decorated to insert the given context, or the same handler instance when the context is empty.
- DEFAULT_CODINGS - Static variable in class org.springframework.web.reactive.resource.EncodedResourceResolver
-
The default content codings.
- DEFAULT_CONTENT_TYPE - Static variable in class org.springframework.web.reactive.result.view.ViewResolverSupport
-
The default
content-type
for views. - DEFAULT_FRAME_MAX_SIZE - Static variable in class org.springframework.web.reactive.socket.adapter.Netty5WebSocketSessionSupport
-
The default max size for inbound WebSocket frames.
- DEFAULT_FRAME_MAX_SIZE - Static variable in class org.springframework.web.reactive.socket.adapter.NettyWebSocketSessionSupport
-
The default max size for inbound WebSocket frames.
- DefaultClientRequestObservationConvention - Class in org.springframework.web.reactive.function.client
-
Default implementation for a
ClientRequestObservationConvention
, extracting information from theClientRequestObservationContext
. - DefaultClientRequestObservationConvention() - Constructor for class org.springframework.web.reactive.function.client.DefaultClientRequestObservationConvention
-
Create a convention with the default name
"http.client.requests"
. - DefaultClientRequestObservationConvention(String) - Constructor for class org.springframework.web.reactive.function.client.DefaultClientRequestObservationConvention
-
Create a convention with a custom name.
- defaultCookie(String, String...) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Global option to specify a cookie to be added to every request, if the request does not already contain such a cookie.
- defaultCookies(Consumer<MultiValueMap<String, String>>) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Provides access to every
WebClient.Builder.defaultCookie(String, String...)
declared so far with the possibility to add, replace, or remove. - defaultHeader(String, String...) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Global option to specify a header to be added to every request, if the request does not already contain such a header.
- defaultHeaders(Consumer<HttpHeaders>) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Provides access to every
WebClient.Builder.defaultHeader(String, String...)
declared so far with the possibility to add, replace, or remove. - defaultRequest(Consumer<WebClient.RequestHeadersSpec<?>>) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Provide a consumer to customize every request being built.
- defaultStatusHandler(Predicate<HttpStatusCode>, Function<ClientResponse, Mono<? extends Throwable>>) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Register a default
status handler
to apply to every response. - defaultUriVariables(Map<String, ?>) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Configure default URL variable values to use when expanding URI templates with a
Map
. - defaultViews(View...) - Method in class org.springframework.web.reactive.config.ViewResolverRegistry
-
Set default views associated with any view name and selected based on the best match for the requested content type.
- DelegatingWebFluxConfiguration - Class in org.springframework.web.reactive.config
-
A subclass of
WebFluxConfigurationSupport
that detects and delegates to all beans of typeWebFluxConfigurer
allowing them to customize the configuration provided byWebFluxConfigurationSupport
. - DelegatingWebFluxConfiguration() - Constructor for class org.springframework.web.reactive.config.DelegatingWebFluxConfiguration
- delete() - Method in interface org.springframework.web.reactive.function.client.WebClient
-
Start building an HTTP DELETE request.
- DELETE(String) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that matches if request's HTTP method isDELETE
and the givenpattern
matches against the request path. - DELETE(String, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
DELETE
requests that match the given pattern. - DELETE(String, RequestPredicate, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
DELETE
requests that match the given pattern and predicate. - DELETE(HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles HTTP
DELETE
requests. - DELETE(RequestPredicate, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
DELETE
requests that match the given predicate. - detectHandlerMethods(Object) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Look for handler methods in a handler.
- determineStatus(Throwable) - Method in class org.springframework.web.reactive.handler.WebFluxResponseStatusExceptionHandler
- discardData(WebSocketMessage) - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession.WebSocketSendProcessor
- DispatcherHandler - Class in org.springframework.web.reactive
-
Central dispatcher for HTTP request handlers/controllers.
- DispatcherHandler() - Constructor for class org.springframework.web.reactive.DispatcherHandler
-
Create a new
DispatcherHandler
which needs to be configured with anApplicationContext
throughDispatcherHandler.setApplicationContext(org.springframework.context.ApplicationContext)
. - DispatcherHandler(ApplicationContext) - Constructor for class org.springframework.web.reactive.DispatcherHandler
-
Create a new
DispatcherHandler
for the givenApplicationContext
. - DispatchExceptionHandler - Interface in org.springframework.web.reactive
-
Contract to map a
Throwable
to aHandlerResult
. - doStart() - Method in class org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService
- doStop() - Method in class org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService
E
- empty() - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Inserter that does not write.
- empty() - Static method in interface org.springframework.web.reactive.function.client.ExchangeStrategies
-
Return a builder with empty configuration to start.
- empty() - Static method in interface org.springframework.web.reactive.function.server.HandlerStrategies
-
Return a mutable, empty builder for a
HandlerStrategies
. - EnableWebFlux - Annotation Interface in org.springframework.web.reactive.config
-
Adding this annotation to an
@Configuration
class imports the Spring WebFlux configuration fromWebFluxConfigurationSupport
that enables use of annotated controllers and functional endpoints. - EncodedResourceResolver - Class in org.springframework.web.reactive.resource
-
Resolver that delegates to the chain, and if a resource is found, it then attempts to find an encoded (e.g.
- EncodedResourceResolver() - Constructor for class org.springframework.web.reactive.resource.EncodedResourceResolver
- endAnd() - Method in interface org.springframework.web.reactive.function.server.RequestPredicates.Visitor
-
Receive last notification of a logical AND predicate.
- endNegate() - Method in interface org.springframework.web.reactive.function.server.RequestPredicates.Visitor
-
Receive last notification of a negated predicate.
- endNested(RequestPredicate) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Visitor
-
Receive notification of the end of a nested router function.
- endOr() - Method in interface org.springframework.web.reactive.function.server.RequestPredicates.Visitor
-
Receive last notification of a logical OR predicate.
- entity() - Method in interface org.springframework.web.reactive.function.server.EntityResponse
-
Return the entity that makes up this response.
- EntityResponse<T> - Interface in org.springframework.web.reactive.function.server
-
Entity-specific subtype of
ServerResponse
that exposes entity data. - EntityResponse.Builder<T> - Interface in org.springframework.web.reactive.function.server
-
Defines a builder for
EntityResponse
. - equals(Object) - Method in class org.springframework.web.reactive.function.client.ExchangeFilterFunctions.Credentials
-
Deprecated.
- equals(Object) - Method in class org.springframework.web.reactive.result.condition.AbstractRequestCondition
- equals(Object) - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
- equals(Object) - Method in class org.springframework.web.reactive.socket.CloseStatus
- equals(Object) - Method in class org.springframework.web.reactive.socket.WebSocketMessage
- equalsCode(CloseStatus) - Method in class org.springframework.web.reactive.socket.CloseStatus
-
Deprecated.as of 5.3 in favor of comparing codes directly
- ErrorsMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolve
Errors
orBindingResult
method arguments. - ErrorsMethodArgumentResolver(ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.ErrorsMethodArgumentResolver
- eTag(String) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Set the entity tag of the body, as specified by the
ETag
header. - eTag(String) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder
-
Set the entity tag of the body, as specified by the
ETag
header. - exception(ClientRequestObservationContext) - Method in class org.springframework.web.reactive.function.client.DefaultClientRequestObservationConvention
- EXCEPTION - Enum constant in enum class org.springframework.web.reactive.function.client.ClientHttpObservationDocumentation.LowCardinalityKeyNames
-
Name of the exception thrown during the exchange, or "none" if no exception happened.
- exceptionHandler(WebExceptionHandler) - Method in interface org.springframework.web.reactive.function.server.HandlerStrategies.Builder
-
Add the given exception handler to this builder.
- exceptionHandlers() - Method in interface org.springframework.web.reactive.function.server.HandlerStrategies
-
Return the
WebExceptionHandlers
to be used for handling exceptions. - exchange() - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
Deprecated.since 5.3 due to the possibility to leak memory and/or connections; please, use
WebClient.RequestHeadersSpec.exchangeToMono(Function)
,WebClient.RequestHeadersSpec.exchangeToFlux(Function)
; consider also usingWebClient.RequestHeadersSpec.retrieve()
which provides access to the response status and headers viaResponseEntity
along with error status handling. - exchange() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the web exchange that this request is based on.
- exchange() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- exchange(ClientRequest) - Method in interface org.springframework.web.reactive.function.client.ExchangeFunction
-
Exchange the given request for a
ClientResponse
promise. - ExchangeFilterFunction - Interface in org.springframework.web.reactive.function.client
-
Represents a function that filters an exchange function.
- ExchangeFilterFunctions - Class in org.springframework.web.reactive.function.client
-
Static factory methods providing access to built-in implementations of
ExchangeFilterFunction
for basic authentication, error handling, etc. - ExchangeFilterFunctions() - Constructor for class org.springframework.web.reactive.function.client.ExchangeFilterFunctions
- ExchangeFilterFunctions.Credentials - Class in org.springframework.web.reactive.function.client
-
Deprecated.as of Spring 5.1 in favor of using
HttpHeaders.setBasicAuth(String, String)
while building the request. - exchangeFunction(ExchangeFunction) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
- ExchangeFunction - Interface in org.springframework.web.reactive.function.client
-
Represents a function that exchanges a request for a (delayed) ClientResponse.
- ExchangeFunctions - Class in org.springframework.web.reactive.function.client
-
Static factory methods to create an
ExchangeFunction
. - ExchangeFunctions() - Constructor for class org.springframework.web.reactive.function.client.ExchangeFunctions
- exchangeStrategies(Consumer<ExchangeStrategies.Builder>) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Deprecated.as of 5.1.13 in favor of
WebClient.Builder.codecs(Consumer)
- exchangeStrategies(ExchangeStrategies) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Configure the
ExchangeStrategies
to use. - ExchangeStrategies - Interface in org.springframework.web.reactive.function.client
-
Provides strategies for use in an
ExchangeFunction
. - ExchangeStrategies.Builder - Interface in org.springframework.web.reactive.function.client
-
A mutable builder for an
ExchangeStrategies
. - exchangeToFlux(Function<ClientResponse, ? extends Flux<V>>) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
An alternative to
WebClient.RequestHeadersSpec.retrieve()
that provides more control via access to theClientResponse
. - exchangeToMono(Function<ClientResponse, ? extends Mono<V>>) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
An alternative to
WebClient.RequestHeadersSpec.retrieve()
that provides more control via access to theClientResponse
. - execute(URI, HttpHeaders, WebSocketHandler) - Method in class org.springframework.web.reactive.socket.client.JettyWebSocketClient
-
Deprecated.
- execute(URI, HttpHeaders, WebSocketHandler) - Method in class org.springframework.web.reactive.socket.client.ReactorNetty2WebSocketClient
- execute(URI, HttpHeaders, WebSocketHandler) - Method in class org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient
- execute(URI, HttpHeaders, WebSocketHandler) - Method in class org.springframework.web.reactive.socket.client.StandardWebSocketClient
- execute(URI, HttpHeaders, WebSocketHandler) - Method in class org.springframework.web.reactive.socket.client.UndertowWebSocketClient
- execute(URI, HttpHeaders, WebSocketHandler) - Method in interface org.springframework.web.reactive.socket.client.WebSocketClient
-
A variant of
WebSocketClient.execute(URI, WebSocketHandler)
with custom headers. - execute(URI, WebSocketHandler) - Method in class org.springframework.web.reactive.socket.client.JettyWebSocketClient
-
Deprecated.
- execute(URI, WebSocketHandler) - Method in class org.springframework.web.reactive.socket.client.ReactorNetty2WebSocketClient
- execute(URI, WebSocketHandler) - Method in class org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient
- execute(URI, WebSocketHandler) - Method in class org.springframework.web.reactive.socket.client.StandardWebSocketClient
- execute(URI, WebSocketHandler) - Method in class org.springframework.web.reactive.socket.client.UndertowWebSocketClient
- execute(URI, WebSocketHandler) - Method in interface org.springframework.web.reactive.socket.client.WebSocketClient
-
Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.
- expandTargetUrlTemplate(String, Map<String, Object>, Map<String, String>) - Method in class org.springframework.web.reactive.result.view.RedirectView
-
Expand URI template variables in the target URL with either model attribute values or as a fallback with URI variable values from the current request.
- exposedHeaders(String...) - Method in class org.springframework.web.reactive.config.CorsRegistration
-
Set the list of response headers other than "simple" headers, i.e.
- ExpressionValueMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolves method arguments annotated with
@Value
. - ExpressionValueMethodArgumentResolver(ConfigurableBeanFactory, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.ExpressionValueMethodArgumentResolver
-
Create a new
ExpressionValueMethodArgumentResolver
instance. - extract(M, BodyExtractor.Context) - Method in interface org.springframework.web.reactive.function.BodyExtractor
-
Extract from the given input message.
- extractLink(int, char, String, Set<CssLinkResourceTransformer.ContentChunkInfo>) - Method in class org.springframework.web.reactive.resource.CssLinkResourceTransformer.AbstractLinkParser
- extractUnquotedLink(int, String, Set<CssLinkResourceTransformer.ContentChunkInfo>) - Method in class org.springframework.web.reactive.resource.CssLinkResourceTransformer.AbstractLinkParser
-
Invoked after a keyword match, after whitespace has been removed, and when the next char is neither a single nor double quote.
- extractVersion(String) - Method in class org.springframework.web.reactive.resource.AbstractFileNameVersionStrategy
- extractVersion(String) - Method in class org.springframework.web.reactive.resource.AbstractPrefixVersionStrategy
- extractVersion(String) - Method in interface org.springframework.web.reactive.resource.VersionStrategy
-
Extract the resource version from the request path.
F
- filter(ClientRequest, ExchangeFunction) - Method in interface org.springframework.web.reactive.function.client.ExchangeFilterFunction
-
Apply this filter to the given request and exchange function.
- filter(ExchangeFilterFunction) - Method in interface org.springframework.web.reactive.function.client.ExchangeFunction
-
Filter the exchange function with the given
ExchangeFilterFunction
, resulting in a filteredExchangeFunction
. - filter(ExchangeFilterFunction) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Add the given filter to the end of the filter chain.
- filter(HandlerFilterFunction<ServerResponse, ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Filters all routes created by this builder with the given filter function.
- filter(HandlerFilterFunction<T, S>) - Method in interface org.springframework.web.reactive.function.server.RouterFunction
-
Filter all handler functions routed by this function with the given filter function.
- filter(ServerRequest, HandlerFunction<T>) - Method in interface org.springframework.web.reactive.function.server.HandlerFilterFunction
-
Apply this filter to the given handler function.
- filters(Consumer<List<ExchangeFilterFunction>>) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Manipulate the filters with the given consumer.
- findEditor(Class<?>) - Method in class org.springframework.web.reactive.result.view.BindStatus
-
Find a PropertyEditor for the given value class, associated with the property that this bound status is currently bound to.
- findWebJarResourcePath(String) - Method in class org.springframework.web.reactive.resource.WebJarsResourceResolver
- firstHeader(String) - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Headers
-
Get the first header value, if any, for the header with the given name.
- FixedContentTypeResolver - Class in org.springframework.web.reactive.accept
-
Resolver that always resolves to a fixed list of media types.
- FixedContentTypeResolver(List<MediaType>) - Constructor for class org.springframework.web.reactive.accept.FixedContentTypeResolver
-
Constructor with an ordered List of default
MediaType
's to return for use in applications that support a variety of content types. - FixedContentTypeResolver(MediaType) - Constructor for class org.springframework.web.reactive.accept.FixedContentTypeResolver
-
Constructor with a single default
MediaType
. - fixedResolver(MediaType...) - Method in class org.springframework.web.reactive.accept.RequestedContentTypeResolverBuilder
-
Add resolver that returns a fixed set of media types.
- FixedVersionStrategy - Class in org.springframework.web.reactive.resource
-
A
VersionStrategy
that relies on a fixed version applied as a request path prefix, e.g. - FixedVersionStrategy(String) - Constructor for class org.springframework.web.reactive.resource.FixedVersionStrategy
-
Create a new FixedVersionStrategy with the given version string.
- forClient(WebClient) - Static method in class org.springframework.web.reactive.function.client.support.WebClientAdapter
-
Create a
WebClientAdapter
for the givenWebClient
instance. - formatMappingName() - Method in class org.springframework.web.reactive.handler.AbstractHandlerMapping
- formatViewName() - Method in class org.springframework.web.reactive.result.view.AbstractView
- formData() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the form data from the body of the request if the Content-Type is
"application/x-www-form-urlencoded"
or an empty map otherwise. - formData() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- freeMarker() - Method in class org.springframework.web.reactive.config.ViewResolverRegistry
-
Register a
FreeMarkerViewResolver
with a ".ftl" suffix. - FreeMarkerConfig - Interface in org.springframework.web.reactive.result.view.freemarker
-
Interface to be implemented by objects that configure and manage a FreeMarker Configuration object in a web environment.
- FreeMarkerConfigurer - Class in org.springframework.web.reactive.result.view.freemarker
-
Configures FreeMarker for web usage via the "configLocation" and/or "freemarkerSettings" and/or "templateLoaderPath" properties.
- FreeMarkerConfigurer() - Constructor for class org.springframework.web.reactive.result.view.freemarker.FreeMarkerConfigurer
- FreeMarkerView - Class in org.springframework.web.reactive.result.view.freemarker
-
A
View
implementation that uses the FreeMarker template engine. - FreeMarkerView() - Constructor for class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
- FreeMarkerViewResolver - Class in org.springframework.web.reactive.result.view.freemarker
-
A
ViewResolver
for resolvingFreeMarkerView
instances, i.e. - FreeMarkerViewResolver() - Constructor for class org.springframework.web.reactive.result.view.freemarker.FreeMarkerViewResolver
-
Simple constructor.
- FreeMarkerViewResolver(String, String) - Constructor for class org.springframework.web.reactive.result.view.freemarker.FreeMarkerViewResolver
-
Convenience constructor with a prefix and suffix.
- from(ErrorResponse) - Static method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Create a
ServerResponse
from the givenErrorResponse
. - from(ClientRequest) - Static method in interface org.springframework.web.reactive.function.client.ClientRequest
-
Create a builder initialized with the HTTP method, url, headers, cookies, attributes, and body of the given request.
- from(ClientResponse) - Static method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Deprecated.as of 5.3 in favor of the instance based
ClientResponse.mutate()
. - from(RenderingResponse) - Static method in interface org.springframework.web.reactive.function.server.RenderingResponse
-
Create a builder with the template name, status code, headers and model of the given response.
- from(ServerRequest) - Static method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Create a builder with the message readers, method name, URI, headers, cookies, and attributes of the given request.
- from(ServerResponse) - Static method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Create a builder with the status code and headers of the given response.
- fromDataBuffers(T) - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Inserter to write the given
Publisher<DataBuffer>
to the body. - fromFormData(String, String) - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Return a
BodyInserters.FormInserter
to write the given key-value pair as URL-encoded form data. - fromFormData(MultiValueMap<String, String>) - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Return a
BodyInserters.FormInserter
to write the givenMultiValueMap
as URL-encoded form data. - fromMultipartAsyncData(String, P, Class<T>) - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Return a
BodyInserters.MultipartInserter
to write the given asynchronous parts, as multipart data. - fromMultipartAsyncData(String, P, ParameterizedTypeReference<T>) - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Variant of
BodyInserters.fromMultipartAsyncData(String, Publisher, Class)
that accepts aParameterizedTypeReference
for the element type, which allows specifying generic type information. - fromMultipartData(String, Object) - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Return a
BodyInserters.MultipartInserter
to write the given parts, as multipart data. - fromMultipartData(MultiValueMap<String, ?>) - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Return a
BodyInserters.MultipartInserter
to write the givenMultiValueMap
as multipart data. - fromObject(T) - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Deprecated.As of Spring Framework 5.2, in favor of
BodyInserters.fromValue(Object)
- fromObject(T) - Static method in interface org.springframework.web.reactive.function.server.EntityResponse
-
Create a builder with the given object.
- fromProducer(T, Class<?>) - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Inserter to write the given producer of value(s) which must be a
Publisher
or another producer adaptable to aPublisher
viaReactiveAdapterRegistry
. - fromProducer(T, Class<?>) - Static method in interface org.springframework.web.reactive.function.server.EntityResponse
-
Create a builder with the given producer.
- fromProducer(T, ParameterizedTypeReference<?>) - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Inserter to write the given producer of value(s) which must be a
Publisher
or another producer adaptable to aPublisher
viaReactiveAdapterRegistry
. - fromProducer(T, ParameterizedTypeReference<?>) - Static method in interface org.springframework.web.reactive.function.server.EntityResponse
-
Create a builder with the given producer.
- fromPublisher(P, Class<T>) - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Inserter to write the given
Publisher
. - fromPublisher(P, Class<T>) - Static method in interface org.springframework.web.reactive.function.server.EntityResponse
-
Create a builder with the given publisher.
- fromPublisher(P, ParameterizedTypeReference<T>) - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Inserter to write the given
Publisher
. - fromPublisher(P, ParameterizedTypeReference<T>) - Static method in interface org.springframework.web.reactive.function.server.EntityResponse
-
Create a builder with the given publisher.
- fromResource(T) - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Inserter to write the given
Resource
. - fromServerSentEvents(S) - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Inserter to write the given
ServerSentEvent
publisher. - fromValue(T) - Static method in class org.springframework.web.reactive.function.BodyInserters
-
Inserter to write the given value.
G
- get() - Method in interface org.springframework.web.reactive.function.client.WebClient
-
Start building an HTTP GET request.
- GET(String) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that matches if request's HTTP method isGET
and the givenpattern
matches against the request path. - GET(String, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
GET
requests that match the given pattern. - GET(String, RequestPredicate, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
GET
requests that match the given pattern and predicate. - GET(HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles HTTP
GET
requests. - GET(RequestPredicate, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
GET
requests that match the given predicate. - getActualValue() - Method in class org.springframework.web.reactive.result.view.BindStatus
-
Return the actual value of the field, i.e.
- getAdapter(HandlerResult) - Method in class org.springframework.web.reactive.result.HandlerResultHandlerSupport
-
Get a
ReactiveAdapter
for the top-level return value type. - getAdapterRegistry() - Method in class org.springframework.web.reactive.result.HandlerResultHandlerSupport
-
Return the configured
ReactiveAdapterRegistry
. - getAdapterRegistry() - Method in class org.springframework.web.reactive.result.method.HandlerMethodArgumentResolverSupport
-
Return the configured
ReactiveAdapterRegistry
. - getAllowedLocations() - Method in class org.springframework.web.reactive.resource.PathResourceResolver
- getApplicationContext() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- getApplicationContext() - Method in class org.springframework.web.reactive.result.view.AbstractView
- getApplicationContext() - Method in class org.springframework.web.reactive.result.view.script.RenderingContext
-
Return the application context.
- getApplicationContext() - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Return the containing
ApplicationContext
, if any. - getArgumentResolverConfigurer() - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
-
Return the configured resolvers for controller method arguments.
- getAsyncSendTimeout() - Method in class org.springframework.web.reactive.socket.server.upgrade.StandardWebSocketUpgradeStrategy
- getAttributes() - Method in class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
- getAttributes() - Method in class org.springframework.web.reactive.socket.HandshakeInfo
-
Attributes extracted from the handshake request to add to the session.
- getAttributes() - Method in interface org.springframework.web.reactive.socket.WebSocketSession
-
Return the map with attributes associated with the WebSocket session.
- getBeanName() - Method in class org.springframework.web.reactive.result.view.AbstractView
-
Get the view's name.
- getBindingContext() - Method in class org.springframework.web.reactive.HandlerResult
-
Return the BindingContext used for request handling.
- getBindStatus(String) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Create a BindStatus for the given bind object using the "defaultHtmlEscape" setting.
- getBindStatus(String, boolean) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Create a BindStatus for the given bind object, using the "defaultHtmlEscape" setting.
- getBodyType() - Method in exception org.springframework.web.reactive.function.UnsupportedMediaTypeException
-
Return the body type in the context of which this exception was generated.
- getByteBufferPool() - Method in class org.springframework.web.reactive.socket.client.UndertowWebSocketClient
-
Return the
ByteBufferPool
currently used for newly created WebSocket sessions by this client. - getCache() - Method in class org.springframework.web.reactive.resource.CachingResourceResolver
-
Return the configured
Cache
. - getCache() - Method in class org.springframework.web.reactive.resource.CachingResourceTransformer
-
Return the configured
Cache
. - getCacheControl() - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Return the
CacheControl
instance to build the Cache-Control HTTP response header. - getChannelId() - Method in class org.springframework.web.reactive.socket.adapter.ReactorNetty2WebSocketSession
-
Return the id of the underlying Netty channel.
- getChannelId() - Method in class org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession
-
Return the id of the underlying Netty channel.
- getCharset() - Method in interface org.springframework.web.reactive.result.view.script.ScriptTemplateConfig
-
Return the charset used to read script and template files.
- getCharset() - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
- getCode() - Method in class org.springframework.web.reactive.socket.CloseStatus
-
Return the status code.
- getCondition() - Method in class org.springframework.web.reactive.result.condition.RequestConditionHolder
-
Return the held request condition, or
null
if not holding one. - getConditions() - Method in class org.springframework.web.reactive.result.condition.CompositeRequestCondition
-
Return the underlying conditions, possibly empty but never
null
. - getConfigurableWebBindingInitializer(FormattingConversionService, Validator) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Return the
ConfigurableWebBindingInitializer
to use for initializing allWebDataBinder
instances. - getConfiguration() - Method in interface org.springframework.web.reactive.result.view.freemarker.FreeMarkerConfig
-
Return the FreeMarker Configuration object for the current web application context.
- getConfiguration() - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerConfigurer
-
Return the Configuration object wrapped by this bean.
- getConfiguration() - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
-
Get the FreeMarker
Configuration
used by this view. - getConnectionBuilderConsumer() - Method in class org.springframework.web.reactive.socket.client.UndertowWebSocketClient
-
Return the configured
Consumer<ConnectionBuilder>
. - getConsumableMediaTypes() - Method in class org.springframework.web.reactive.result.condition.ConsumesRequestCondition
-
Returns the media types for this condition excluding negated expressions.
- getConsumesCondition() - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Returns the "consumes" condition of this
RequestMappingInfo
; or instance with 0 consumes expressions, nevernull
. - getContainer(HttpServletRequest) - Method in class org.springframework.web.reactive.socket.server.upgrade.StandardWebSocketUpgradeStrategy
- getContent() - Method in class org.springframework.web.reactive.result.condition.AbstractRequestCondition
-
Return the discrete items a request condition is composed of.
- getContent() - Method in class org.springframework.web.reactive.result.condition.CompositeRequestCondition
- getContent() - Method in class org.springframework.web.reactive.result.condition.ConsumesRequestCondition
- getContent() - Method in class org.springframework.web.reactive.result.condition.HeadersRequestCondition
- getContent() - Method in class org.springframework.web.reactive.result.condition.ParamsRequestCondition
- getContent() - Method in class org.springframework.web.reactive.result.condition.PatternsRequestCondition
- getContent() - Method in class org.springframework.web.reactive.result.condition.ProducesRequestCondition
- getContent() - Method in class org.springframework.web.reactive.result.condition.RequestConditionHolder
- getContent() - Method in class org.springframework.web.reactive.result.condition.RequestMethodsRequestCondition
- getContentCodings() - Method in class org.springframework.web.reactive.resource.CachingResourceResolver
-
Return a read-only list with the supported content codings.
- getContentCodings() - Method in class org.springframework.web.reactive.resource.EncodedResourceResolver
-
Return a read-only list with the supported content codings.
- getContentType() - Method in exception org.springframework.web.reactive.function.UnsupportedMediaTypeException
-
Return the request Content-Type header if it was parsed successfully, or
null
otherwise. - getContentTypeResolver() - Method in class org.springframework.web.reactive.result.HandlerResultHandlerSupport
-
Return the configured
RequestedContentTypeResolver
. - getContentTypeResolver() - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
-
Return the configured
RequestedContentTypeResolver
. - getContentTypeResolver() - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo.BuilderConfiguration
- getContentTypes() - Method in class org.springframework.web.reactive.accept.FixedContentTypeResolver
-
Return the configured list of media types.
- getContextPath() - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Return the context path of the current web application.
- getContextualName(ClientRequestObservationContext) - Method in class org.springframework.web.reactive.function.client.DefaultClientRequestObservationConvention
- getContextUrl(String) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Return a context-aware URl for the given relative URL.
- getContextUrl(String, Map<String, ?>) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Return a context-aware URl for the given relative URL with placeholders -- named keys with braces
{}
. - getCookies() - Method in class org.springframework.web.reactive.socket.HandshakeInfo
-
For a server session this returns the server request cookies from the handshake request.
- getCorsConfiguration() - Method in class org.springframework.web.reactive.config.CorsRegistration
- getCorsConfiguration(Object, ServerWebExchange) - Method in class org.springframework.web.reactive.handler.AbstractHandlerMapping
-
Retrieve the CORS configuration for the given handler.
- getCorsConfiguration(Object, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
- getCorsConfigurations() - Method in class org.springframework.web.reactive.config.CorsRegistry
-
Return the registered
CorsConfiguration
objects, keyed by path pattern. - getCorsConfigurations() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Callback for building the global CORS configuration.
- getCorsProcessor() - Method in class org.springframework.web.reactive.handler.AbstractHandlerMapping
-
Return the configured
CorsProcessor
. - getCustomCondition() - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Returns the "custom" condition of this
RequestMappingInfo
; ornull
. - getCustomMethodCondition(Method) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
-
Provide a custom method-level request condition.
- getCustomTypeCondition(Class<?>) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
-
Provide a custom type-level request condition.
- getDefaultCharset() - Method in class org.springframework.web.reactive.result.view.AbstractView
-
Get the default charset, used when the content type does not contain one.
- getDefaultCharset() - Method in class org.springframework.web.reactive.result.view.ViewResolverSupport
-
Return the default charset, used when the content type does not contain one.
- getDefaultHtmlEscape() - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Return the default HTML escape setting, differentiating between no default specified and an explicit value.
- getDefaultViews() - Method in class org.springframework.web.reactive.config.ViewResolverRegistry
- getDefaultViews() - Method in class org.springframework.web.reactive.result.view.ViewResolutionResultHandler
-
Return the configured default
View
's. - getDelegate() - Method in class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
- getDirectPaths() - Method in class org.springframework.web.reactive.result.condition.PatternsRequestCondition
-
Return the mapping paths that are not patterns.
- getDirectPaths() - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Return the mapping paths that are not patterns.
- getDirectPaths(RequestMappingInfo) - Method in class org.springframework.web.reactive.result.method.RequestMappingInfoHandlerMapping
- getDirectPaths(T) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Return the request mapping paths that are not patterns.
- getDisplayValue() - Method in class org.springframework.web.reactive.result.view.BindStatus
-
Return a suitable display value for the field, i.e.
- getEditor() - Method in class org.springframework.web.reactive.result.view.BindStatus
-
Return the PropertyEditor for the property that this bind status is currently bound to.
- getEncoding() - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
-
Get the encoding for the FreeMarker template.
- getEngine() - Method in interface org.springframework.web.reactive.result.view.script.ScriptTemplateConfig
-
Return the
ScriptEngine
to use by the views. - getEngine() - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
- getEngine() - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
- getEngineName() - Method in interface org.springframework.web.reactive.result.view.script.ScriptTemplateConfig
-
Return the engine name that will be used to instantiate the
ScriptEngine
. - getEngineName() - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
- getEngineSupplier() - Method in interface org.springframework.web.reactive.result.view.script.ScriptTemplateConfig
-
Return the engine supplier that will be used to instantiate the
ScriptEngine
. - getEngineSupplier() - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
- getErrorCode() - Method in class org.springframework.web.reactive.result.view.BindStatus
-
Return the first error codes for the field or object, if any.
- getErrorCodes() - Method in class org.springframework.web.reactive.result.view.BindStatus
-
Return the error codes for the field or object, if any.
- getErrorMessage() - Method in class org.springframework.web.reactive.result.view.BindStatus
-
Return the first error message for the field or object, if any.
- getErrorMessages() - Method in class org.springframework.web.reactive.result.view.BindStatus
-
Return the resolved error messages for the field or object, if any.
- getErrorMessagesAsString(String) - Method in class org.springframework.web.reactive.result.view.BindStatus
-
Return an error message string, concatenating all messages separated by the given delimiter.
- getErrors() - Method in class org.springframework.web.reactive.result.view.BindStatus
-
Return the Errors instance (typically a BindingResult) that this bind status is currently associated with.
- getErrors(String) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Retrieve the Errors instance for the given bind object, using the "defaultHtmlEscape" setting.
- getErrors(String, boolean) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Retrieve the Errors instance for the given bind object.
- getExceptionHandler() - Method in class org.springframework.web.reactive.HandlerResult
-
Return the
configured
exception handler. - getExchange() - Method in class org.springframework.web.reactive.result.view.RequestContext
- getExpression() - Method in class org.springframework.web.reactive.result.view.BindStatus
-
Return a bind expression that can be used in HTML forms as input name for the respective field, or
null
if not field-specific. - getExpressions() - Method in class org.springframework.web.reactive.result.condition.ConsumesRequestCondition
-
Return the contained MediaType expressions.
- getExpressions() - Method in class org.springframework.web.reactive.result.condition.HeadersRequestCondition
-
Return the contained request header expressions.
- getExpressions() - Method in class org.springframework.web.reactive.result.condition.ParamsRequestCondition
-
Return the contained request parameter expressions.
- getExpressions() - Method in class org.springframework.web.reactive.result.condition.ProducesRequestCondition
-
Return the contained "produces" expressions.
- getExtensions() - Method in class org.springframework.web.reactive.resource.EncodedResourceResolver
-
Return a read-only map with coding-to-extension mappings.
- getExtraHiddenFields(ServerWebExchange) - Method in interface org.springframework.web.reactive.result.view.RequestDataValueProcessor
-
Invoked after all form fields have been rendered.
- getFilename() - Method in class org.springframework.web.reactive.resource.TransformedResource
- getForUriString(String, ServerWebExchange) - Method in class org.springframework.web.reactive.resource.ResourceUrlProvider
-
Get the public resource URL for the given URI string.
- getHandlePing() - Method in class org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient
-
Deprecated.as of 5.3 in favor of
ReactorNettyWebSocketClient.getWebsocketClientSpec()
- getHandlePing() - Method in class org.springframework.web.reactive.socket.server.upgrade.ReactorNettyRequestUpgradeStrategy
-
Deprecated.as of 5.2.6 in favor of
ReactorNettyRequestUpgradeStrategy.getWebsocketServerSpec()
- getHandler() - Method in class org.springframework.web.reactive.HandlerResult
-
Return the handler that handled the request.
- getHandler(ServerWebExchange) - Method in class org.springframework.web.reactive.handler.AbstractHandlerMapping
- getHandler(ServerWebExchange) - Method in interface org.springframework.web.reactive.HandlerMapping
-
Return a handler for this request.
- getHandlerInternal(ServerWebExchange) - Method in class org.springframework.web.reactive.function.server.support.RouterFunctionMapping
- getHandlerInternal(ServerWebExchange) - Method in class org.springframework.web.reactive.handler.AbstractHandlerMapping
-
Look up a handler for the given request, returning an empty
Mono
if no specific one is found. - getHandlerInternal(ServerWebExchange) - Method in class org.springframework.web.reactive.handler.AbstractUrlHandlerMapping
- getHandlerInternal(ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Look up a handler method for the given request.
- getHandlerInternal(ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.RequestMappingInfoHandlerMapping
- getHandlerMap() - Method in class org.springframework.web.reactive.handler.AbstractUrlHandlerMapping
-
Return a read-only view of registered path patterns and handlers which may be an actual handler instance or the bean name of lazily initialized handler.
- getHandlerMap() - Method in class org.springframework.web.reactive.resource.ResourceUrlProvider
-
Return a read-only view of the resource handler mappings either manually configured or auto-detected from Spring configuration.
- getHandlerMapping() - Method in class org.springframework.web.reactive.config.ResourceHandlerRegistry
-
Return a handler mapping with the mapped resource handlers; or
null
in case of no registrations. - getHandlerMappings() - Method in class org.springframework.web.reactive.DispatcherHandler
- getHandlerMethods() - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Return a (read-only) map with all mappings and HandlerMethod's.
- getHandshakeInfo() - Method in class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
- getHandshakeInfo() - Method in interface org.springframework.web.reactive.socket.WebSocketSession
-
Return information from the handshake request.
- getHeaders() - Method in exception org.springframework.web.reactive.function.client.WebClientRequestException
-
Return the HTTP request headers.
- getHeaders() - Method in exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Return the HTTP response headers.
- getHeaders() - Method in class org.springframework.web.reactive.socket.HandshakeInfo
-
Return the HTTP headers from the handshake request, either server request headers for a server session or the client response headers for a client session.
- getHeadersCondition() - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Returns the "headers" condition of this
RequestMappingInfo
; or instance with 0 header expressions, nevernull
. - getHighCardinalityKeyValues(ClientRequestObservationContext) - Method in class org.springframework.web.reactive.function.client.DefaultClientRequestObservationConvention
- getHosts() - Method in class org.springframework.web.reactive.result.view.RedirectView
-
Return the configured application hosts.
- getHttpClient() - Method in class org.springframework.web.reactive.socket.client.ReactorNetty2WebSocketClient
-
Return the configured
HttpClient
. - getHttpClient() - Method in class org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient
-
Return the configured
HttpClient
. - getId() - Method in class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
- getId() - Method in interface org.springframework.web.reactive.socket.WebSocketSession
-
Return the id for the session.
- getInbound() - Method in class org.springframework.web.reactive.socket.adapter.ReactorNetty2WebSocketSession.WebSocketConnection
- getInbound() - Method in class org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession.WebSocketConnection
- getJettyClient() - Method in class org.springframework.web.reactive.socket.client.JettyWebSocketClient
-
Deprecated.Return the underlying Jetty
WebSocketClient
. - getKeyword() - Method in class org.springframework.web.reactive.resource.CssLinkResourceTransformer.AbstractLinkParser
-
Return the keyword to use to search for links, e.g.
- getLocale() - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Return the current Locale.
- getLocale() - Method in class org.springframework.web.reactive.result.view.script.RenderingContext
-
Return the locale of the rendered template.
- getLocations() - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Return the
List
ofResource
paths to use as sources for serving static resources. - getLocationValues() - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Return the configured location values.
- getLogPrefix() - Method in class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
- getLogPrefix() - Method in class org.springframework.web.reactive.socket.HandshakeInfo
-
A log prefix used in the handshake to correlate log messages, if any.
- getLowCardinalityKeyValues(ClientRequestObservationContext) - Method in class org.springframework.web.reactive.function.client.DefaultClientRequestObservationConvention
- getMappingComparator(ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Return a comparator for sorting matching mappings.
- getMappingComparator(ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.RequestMappingInfoHandlerMapping
-
Provide a Comparator to sort RequestMappingInfos matched to a request.
- getMappingForMethod(Method, Class<?>) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Provide the mapping for a handler method.
- getMappingForMethod(Method, Class<?>) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
-
Uses method and type-level @
RequestMapping
annotations to create the RequestMappingInfo. - getMatchingCondition(ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.CompositeRequestCondition
-
Delegate to all contained conditions to match the request and return the resulting "matching" condition instances.
- getMatchingCondition(ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.ConsumesRequestCondition
-
Checks if any of the contained media type expressions match the given request 'Content-Type' header and returns an instance that is guaranteed to contain matching expressions only.
- getMatchingCondition(ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.HeadersRequestCondition
-
Returns "this" instance if the request matches all expressions; or
null
otherwise. - getMatchingCondition(ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.ParamsRequestCondition
-
Returns "this" instance if the request matches all param expressions; or
null
otherwise. - getMatchingCondition(ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.PatternsRequestCondition
-
Checks if any of the patterns match the given request and returns an instance that is guaranteed to contain matching patterns, sorted.
- getMatchingCondition(ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.ProducesRequestCondition
-
Checks if any of the contained media type expressions match the given request 'Content-Type' header and returns an instance that is guaranteed to contain matching expressions only.
- getMatchingCondition(ServerWebExchange) - Method in interface org.springframework.web.reactive.result.condition.RequestCondition
-
Check if the condition matches the request returning a potentially new instance created for the current request.
- getMatchingCondition(ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.RequestConditionHolder
-
Get the matching condition for the held request condition wrap it in a new RequestConditionHolder instance.
- getMatchingCondition(ServerWebExchange) - Method in class org.springframework.web.reactive.result.condition.RequestMethodsRequestCondition
-
Check if any of the HTTP request methods match the given request and return an instance that contains the matching HTTP request method only.
- getMatchingCondition(ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Checks if all conditions in this request mapping info match the provided request and returns a potentially new request mapping info with conditions tailored to the current request.
- getMatchingMapping(RequestMappingInfo, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.RequestMappingInfoHandlerMapping
-
Check if the given RequestMappingInfo matches the current request and return a (potentially new) instance with conditions that match the current request -- for example with a subset of URL patterns.
- getMatchingMapping(T, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Check if a mapping matches the current request and return a (potentially new) mapping with conditions relevant to the current request.
- getMaxBinaryMessageBufferSize() - Method in class org.springframework.web.reactive.socket.server.upgrade.StandardWebSocketUpgradeStrategy
- getMaxFramePayloadLength() - Method in class org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient
-
Deprecated.as of 5.3 in favor of
ReactorNettyWebSocketClient.getWebsocketClientSpec()
- getMaxFramePayloadLength() - Method in class org.springframework.web.reactive.socket.server.upgrade.ReactorNettyRequestUpgradeStrategy
-
Deprecated.as of 5.2.6 in favor of
ReactorNettyRequestUpgradeStrategy.getWebsocketServerSpec()
- getMaxSessionIdleTimeout() - Method in class org.springframework.web.reactive.socket.server.upgrade.StandardWebSocketUpgradeStrategy
- getMaxTextMessageBufferSize() - Method in class org.springframework.web.reactive.socket.server.upgrade.StandardWebSocketUpgradeStrategy
- getMediaType() - Method in interface org.springframework.web.reactive.result.condition.MediaTypeExpression
- getMediaTypes() - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Return the
configured
media type mappings. - getMessage(String) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
- getMessage(String, Object[]) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
- getMessage(String, Object[], boolean) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Retrieve the message for the given code.
- getMessage(String, Object[], String) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
- getMessage(String, Object[], String, boolean) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Retrieve the message for the given code.
- getMessage(String, String) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
- getMessage(String, List<?>) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
- getMessage(String, List<?>, String) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
- getMessage(MessageSourceResolvable) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Retrieve the given MessageSourceResolvable (e.g.
- getMessage(MessageSourceResolvable, boolean) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Retrieve the given MessageSourceResolvable (e.g.
- getMessageCodesResolver() - Method in class org.springframework.web.reactive.config.DelegatingWebFluxConfiguration
- getMessageCodesResolver() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Override this method to provide a custom
MessageCodesResolver
. - getMessageCodesResolver() - Method in interface org.springframework.web.reactive.config.WebFluxConfigurer
-
Provide a custom
MessageCodesResolver
to use for data binding in annotated controller method arguments instead of the one created by default inDataBinder
. - getMessageCodesResolver() - Method in class org.springframework.web.reactive.config.WebFluxConfigurerComposite
- getMessageReaders() - Method in class org.springframework.web.reactive.result.method.annotation.AbstractMessageReaderArgumentResolver
-
Return the configured message converters.
- getMessageReaders() - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
-
Return the configurer for HTTP message readers.
- getMessageSource() - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Get the
MessageSource
that this exception handler uses. - getMessageSource() - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Return the MessageSource in use with this request.
- getMessageWriter() - Method in class org.springframework.web.reactive.result.view.HttpMessageWriterView
-
Return the configured message writer.
- getMessageWriters() - Method in class org.springframework.web.reactive.result.method.annotation.AbstractMessageWriterResultHandler
-
Return the configured message converters.
- getMethod() - Method in exception org.springframework.web.reactive.function.client.WebClientRequestException
-
Return the HTTP request method.
- getMethods() - Method in class org.springframework.web.reactive.result.condition.RequestMethodsRequestCondition
-
Returns all
RequestMethods
contained in this condition. - getMethodsCondition() - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Returns the HTTP request methods of this
RequestMappingInfo
; or instance with 0 request methods, nevernull
. - getModel() - Method in class org.springframework.web.reactive.BindingContext
-
Return the default model.
- getModel() - Method in class org.springframework.web.reactive.HandlerResult
-
Return the model used for request handling.
- getModel() - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Return the model Map that this RequestContext encapsulates, if any.
- getModelAttributes(Map<String, ?>, ServerWebExchange) - Method in class org.springframework.web.reactive.result.view.AbstractView
-
Prepare the model to use for rendering.
- getModelAttributes(Map<String, ?>, ServerWebExchange) - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
-
Prepare the model to use for rendering by potentially exposing a
RequestContext
for use in Spring FreeMarker macros and then delegating to the inherited implementation of this method. - getModelKeys() - Method in class org.springframework.web.reactive.result.view.HttpMessageWriterView
-
Return the configured model keys.
- getModelObject(String) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Retrieve the model object for the given model name, either from the model or from the request attributes.
- getName() - Method in class org.springframework.web.reactive.function.client.DefaultClientRequestObservationConvention
- getName() - Method in interface org.springframework.web.reactive.result.condition.NameValueExpression
- getName() - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Return the name for this mapping, or
null
. - getNativeMessage() - Method in class org.springframework.web.reactive.socket.WebSocketMessage
-
Return the message from the API of the underlying WebSocket library.
- getObjectWrapper() - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
-
Get the configured FreeMarker
ObjectWrapper
, or the default wrapper if none specified. - getOrder() - Method in class org.springframework.web.reactive.config.ViewResolverRegistry
- getOrder() - Method in class org.springframework.web.reactive.function.server.support.ServerResponseResultHandler
- getOrder() - Method in class org.springframework.web.reactive.handler.AbstractHandlerMapping
- getOrder() - Method in class org.springframework.web.reactive.result.HandlerResultHandlerSupport
- getOrder() - Method in class org.springframework.web.reactive.result.view.ViewResolverSupport
- getOrder() - Method in class org.springframework.web.reactive.socket.server.support.WebSocketHandlerAdapter
-
Return the
configured
order for this instance. - getOutbound() - Method in class org.springframework.web.reactive.socket.adapter.ReactorNetty2WebSocketSession.WebSocketConnection
- getOutbound() - Method in class org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession.WebSocketConnection
- getParameterName() - Method in class org.springframework.web.reactive.accept.ParameterContentTypeResolver
- getParameterNameDiscoverer() - Method in class org.springframework.web.reactive.result.method.InvocableHandlerMethod
-
Return the configured parameter name discoverer.
- getParameterNameDiscoverer() - Method in class org.springframework.web.reactive.result.method.SyncInvocableHandlerMethod
-
Return the configured parameter name discoverer.
- getParamsCondition() - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Returns the "parameters" condition of this
RequestMappingInfo
; or instance with 0 parameter expressions, nevernull
. - getPartValues(MethodParameter, RequestPart, boolean, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.RequestPartMethodArgumentResolver
- getPath() - Method in class org.springframework.web.reactive.result.view.BindStatus
-
Return the bean and property path for which values and errors will be resolved (e.g.
- getPathMatchConfigurer() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Callback for building the
PathMatchConfigurer
. - getPathPattern() - Method in class org.springframework.web.reactive.config.CorsRegistration
- getPathPatternParser() - Method in class org.springframework.web.reactive.handler.AbstractHandlerMapping
-
Return the
PathPatternParser
instance that is used forCORS configuration checks
. - getPathPatterns() - Method in class org.springframework.web.reactive.config.ResourceHandlerRegistration
-
Returns the URL path patterns for the resource handler.
- getPathPrefixes() - Method in class org.springframework.web.reactive.config.PathMatchConfigurer
- getPathPrefixes() - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
-
The configured path prefixes as a read-only, possibly empty map.
- getPatternParser() - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo.BuilderConfiguration
- getPatterns() - Method in class org.springframework.web.reactive.result.condition.PatternsRequestCondition
- getPatternsCondition() - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Returns the URL patterns of this
RequestMappingInfo
; or instance with 0 patterns, nevernull
. - getPayload() - Method in class org.springframework.web.reactive.socket.WebSocketMessage
-
Return the message payload.
- getPayloadAsText() - Method in class org.springframework.web.reactive.socket.WebSocketMessage
-
A variant of
WebSocketMessage.getPayloadAsText(Charset)
that usesUTF-8
for decoding the raw content to text. - getPayloadAsText(Charset) - Method in class org.springframework.web.reactive.socket.WebSocketMessage
-
A shortcut for decoding the raw content of the message to text with the given character encoding.
- getPrefix() - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Return the prefix that gets prepended to view names when building a URL.
- getPrincipal() - Method in class org.springframework.web.reactive.socket.HandshakeInfo
-
Return the principal associated with the handshake request, if any.
- getProducesCondition() - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Returns the "produces" condition of this
RequestMappingInfo
; or instance with 0 produces expressions, nevernull
. - getProducibleMediaTypes() - Method in class org.springframework.web.reactive.result.condition.ProducesRequestCondition
-
Return the contained producible media types excluding negated expressions.
- getQueryString() - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Return the query string of the current request.
- getRawStatusCode() - Method in exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Deprecated.as of 6.0, in favor of
WebClientResponseException.getStatusCode()
- getReactiveAdapterRegistry() - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
-
Return the configured registry for adapting reactive types.
- getReason() - Method in class org.springframework.web.reactive.socket.CloseStatus
-
Return the reason, or
null
if none. - getRemoteAddress() - Method in class org.springframework.web.reactive.socket.HandshakeInfo
-
For a server session this is the remote address where the handshake request came from.
- getRenderFunction() - Method in interface org.springframework.web.reactive.result.view.script.ScriptTemplateConfig
-
Return the render function name (optional).
- getRenderFunction() - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
- getRenderObject() - Method in interface org.springframework.web.reactive.result.view.script.ScriptTemplateConfig
-
Return the object where the render function belongs (optional).
- getRenderObject() - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
- getRequest() - Method in class org.springframework.web.reactive.function.client.ClientRequestObservationContext
-
Return the immutable client request.
- getRequest() - Method in exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Return the corresponding request.
- getRequestContextAttribute() - Method in class org.springframework.web.reactive.result.view.AbstractView
-
Get the name of the
RequestContext
attribute for this view, if any. - getRequestContextAttribute() - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Return the name of the
RequestContext
attribute for all views, if any. - getRequestDataValueProcessor() - Method in class org.springframework.web.reactive.result.view.AbstractView
-
Get the
RequestDataValueProcessor
to use. - getRequestDataValueProcessor() - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Return the
RequestDataValueProcessor
instance to apply to in form tag libraries and to redirect URLs. - getRequestHandler() - Method in class org.springframework.web.reactive.config.ResourceHandlerRegistration
-
Returns a
ResourceWebHandler
instance. - getRequestPath() - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Return the request path of the request.
- getResolverChain() - Method in interface org.springframework.web.reactive.resource.ResourceTransformerChain
-
Return the
ResourceResolverChain
that was used to resolve theResource
being transformed. - getResolvers() - Method in class org.springframework.web.reactive.result.method.InvocableHandlerMethod
-
Return the configured argument resolvers.
- getResolvers() - Method in class org.springframework.web.reactive.result.method.SyncInvocableHandlerMethod
-
Return the configured argument resolvers.
- getResource(String) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
- getResource(String, Resource) - Method in class org.springframework.web.reactive.resource.PathResourceResolver
-
Find the resource under the given location.
- getResource(ServerWebExchange) - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
- getResourceHttpMessageWriter() - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Return the configured resource message writer.
- getResourceLoaderPath() - Method in interface org.springframework.web.reactive.result.view.script.ScriptTemplateConfig
-
Return the resource loader path(s) via a Spring resource location.
- getResourceLoaderPath() - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
- getResourceResolvers() - Method in class org.springframework.web.reactive.config.ResourceChainRegistration
- getResourceResolvers() - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Return the list of configured resource resolvers.
- getResourceTransformers() - Method in class org.springframework.web.reactive.config.ResourceChainRegistration
- getResourceTransformers() - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Return the list of configured resource transformers.
- getResourceUrlProvider() - Method in class org.springframework.web.reactive.resource.ResourceTransformerSupport
-
Return the configured
ResourceUrlProvider
. - getResourceVersion(Resource) - Method in class org.springframework.web.reactive.resource.ContentVersionStrategy
- getResourceVersion(Resource) - Method in class org.springframework.web.reactive.resource.FixedVersionStrategy
- getResourceVersion(Resource) - Method in interface org.springframework.web.reactive.resource.VersionStrategy
-
Determine the version for the given resource.
- getResponseBodyAs(Class<E>) - Method in exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Decode the error content to the specified type.
- getResponseBodyAs(ParameterizedTypeReference<E>) - Method in exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Variant of
WebClientResponseException.getResponseBodyAs(Class)
withParameterizedTypeReference
. - getResponseBodyAsByteArray() - Method in exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Return the response body as a byte array.
- getResponseBodyAsString() - Method in exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Return the response content as a String using the charset of media type for the response, if available, or otherwise falling back on ISO-8859-1.
- getResponseBodyAsString(Charset) - Method in exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Variant of
WebClientResponseException.getResponseBodyAsString()
that allows specifying the charset to fall back on, if a charset is not available from the media type for the response. - getResponseHeaders() - Method in interface org.springframework.web.reactive.resource.HttpResource
-
The HTTP headers to be contributed to the HTTP response that serves the current resource.
- getReturnType() - Method in class org.springframework.web.reactive.HandlerResult
-
Return the type of the value returned from the handler -- e.g.
- getReturnTypeSource() - Method in class org.springframework.web.reactive.HandlerResult
-
Return the
MethodParameter
from whichreturnType
was created. - getReturnValue() - Method in class org.springframework.web.reactive.HandlerResult
-
Return the value returned from the handler, if any.
- getRouterFunction() - Method in class org.springframework.web.reactive.function.server.support.RouterFunctionMapping
-
Return the configured
RouterFunction
. - getScripts() - Method in interface org.springframework.web.reactive.result.view.script.ScriptTemplateConfig
-
Return the scripts to be loaded by the script engine (library or user provided).
- getScripts() - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
- getSendProcessor() - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
- getSessionAttributePredicate() - Method in class org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService
-
Return the configured predicate for initialization WebSocket session attributes from
WebSession
attributes. - getStatusCode() - Method in exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Return the HTTP status code value.
- getStatusCode() - Method in class org.springframework.web.reactive.result.view.RedirectView
-
Get the redirect status code to use.
- getStatusText() - Method in exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Return the HTTP status text.
- getStrategyForPath(String) - Method in class org.springframework.web.reactive.resource.VersionResourceResolver
-
Find a
VersionStrategy
for the request path of the requested resource. - getStrategyMap() - Method in class org.springframework.web.reactive.resource.VersionResourceResolver
-
Return the map with version strategies keyed by path pattern.
- getSubProtocol() - Method in class org.springframework.web.reactive.socket.HandshakeInfo
-
The sub-protocol negotiated at handshake time, or
null
if none. - getSubProtocols() - Method in class org.springframework.web.reactive.socket.adapter.ContextWebSocketHandler
- getSubProtocols() - Method in interface org.springframework.web.reactive.socket.WebSocketHandler
-
Return the list of sub-protocols supported by this handler.
- getSuffix() - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Return the suffix that gets appended to view names when building a URL.
- getSupportedMediaTypes() - Method in exception org.springframework.web.reactive.function.UnsupportedMediaTypeException
-
Return the list of supported content types in cases when the Content-Type header is parsed but not supported, or an empty list otherwise.
- getSupportedMediaTypes() - Method in class org.springframework.web.reactive.result.view.AbstractView
-
Get the configured media types supported by this view.
- getSupportedMediaTypes() - Method in class org.springframework.web.reactive.result.view.HttpMessageWriterView
-
Return the list of media types this View supports, or an empty list.
- getSupportedMediaTypes() - Method in interface org.springframework.web.reactive.result.view.View
-
Return the list of media types this View supports, or an empty list.
- getSupportedMediaTypes() - Method in class org.springframework.web.reactive.result.view.ViewResolverSupport
-
Return the configured media types supported by this view.
- getTemplate(String) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
- getTemplate(Locale) - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
-
Get the FreeMarker template for the given locale, to be rendered by this view.
- getTemplateLoader() - Method in class org.springframework.web.reactive.result.view.script.RenderingContext
-
Return a function that takes a template path as input and returns the template content as a String.
- getTemplateModel(Map<String, Object>, ServerWebExchange) - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
-
Build a FreeMarker template model for the given model map.
- getTimeZone() - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Return the current TimeZone.
- getToStringInfix() - Method in class org.springframework.web.reactive.result.condition.AbstractRequestCondition
-
The notation to use when printing discrete items of content.
- getToStringInfix() - Method in class org.springframework.web.reactive.result.condition.CompositeRequestCondition
- getToStringInfix() - Method in class org.springframework.web.reactive.result.condition.ConsumesRequestCondition
- getToStringInfix() - Method in class org.springframework.web.reactive.result.condition.HeadersRequestCondition
- getToStringInfix() - Method in class org.springframework.web.reactive.result.condition.ParamsRequestCondition
- getToStringInfix() - Method in class org.springframework.web.reactive.result.condition.PatternsRequestCondition
- getToStringInfix() - Method in class org.springframework.web.reactive.result.condition.ProducesRequestCondition
- getToStringInfix() - Method in class org.springframework.web.reactive.result.condition.RequestConditionHolder
- getToStringInfix() - Method in class org.springframework.web.reactive.result.condition.RequestMethodsRequestCondition
- getType() - Method in class org.springframework.web.reactive.socket.WebSocketMessage
-
Return the message type (text, binary, etc).
- getUpgradeStrategy() - Method in class org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService
-
Return the
RequestUpgradeStrategy
for WebSocket requests. - getUri() - Method in exception org.springframework.web.reactive.function.client.WebClientRequestException
-
Return the request URI.
- getUri() - Method in class org.springframework.web.reactive.socket.HandshakeInfo
-
Return the URL for the WebSocket endpoint.
- getUriTemplate() - Method in class org.springframework.web.reactive.function.client.ClientRequestObservationContext
-
Return the URI template used for the current client exchange,
null
if none was used. - getUrl() - Method in class org.springframework.web.reactive.result.view.AbstractUrlBasedView
-
Return the URL of the resource that this view wraps.
- getUrl() - Method in class org.springframework.web.reactive.result.view.script.RenderingContext
-
Return the URL of the rendered template.
- getUrlMap() - Method in class org.springframework.web.reactive.handler.SimpleUrlHandlerMapping
-
Allow
Map
access to the URL path mappings, with the option to add or override specific entries. - getValidator() - Method in class org.springframework.web.reactive.config.DelegatingWebFluxConfiguration
- getValidator() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Override this method to provide a custom
Validator
. - getValidator() - Method in interface org.springframework.web.reactive.config.WebFluxConfigurer
-
Provide a custom
Validator
. - getValidator() - Method in class org.springframework.web.reactive.config.WebFluxConfigurerComposite
- getValue() - Method in interface org.springframework.web.reactive.result.condition.NameValueExpression
- getValue() - Method in class org.springframework.web.reactive.result.view.BindStatus
-
Return the current value of the field, i.e.
- getValuesToBind(WebExchangeDataBinder, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ModelAttributeMethodArgumentResolver
-
Protected method to obtain the values for data binding.
- getValueType() - Method in class org.springframework.web.reactive.result.view.BindStatus
-
Get the '
Class
' type of the field. - getViewClass() - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Return the view class to be used to create views.
- getViewNames() - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Return the view names (or name patterns) that can be handled by this
ViewResolver
. - getViewResolver() - Method in class org.springframework.web.reactive.config.UrlBasedViewResolverRegistration
- getViewResolverRegistry() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Callback for building the
ViewResolverRegistry
. - getViewResolvers() - Method in class org.springframework.web.reactive.config.ViewResolverRegistry
- getViewResolvers() - Method in class org.springframework.web.reactive.result.view.ViewResolutionResultHandler
-
Return a read-only list of view resolvers.
- getWebBindingInitializer() - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
-
Return the configured WebBindingInitializer, or
null
if none. - getWebsocketClientSpec() - Method in class org.springframework.web.reactive.socket.client.ReactorNetty2WebSocketClient
-
Build an instance of
WebsocketClientSpec
that reflects the current configuration. - getWebsocketClientSpec() - Method in class org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient
-
Build an instance of
WebsocketClientSpec
that reflects the current configuration. - getWebSocketContainer() - Method in class org.springframework.web.reactive.socket.client.StandardWebSocketClient
-
Return the configured
WebSocketContainer
to use. - getWebsocketServerSpec() - Method in class org.springframework.web.reactive.socket.server.upgrade.ReactorNetty2RequestUpgradeStrategy
-
Build an instance of
WebsocketServerSpec
that reflects the current configuration. - getWebsocketServerSpec() - Method in class org.springframework.web.reactive.socket.server.upgrade.ReactorNettyRequestUpgradeStrategy
-
Build an instance of
WebsocketServerSpec
that reflects the current configuration. - getWebSocketService() - Method in class org.springframework.web.reactive.config.DelegatingWebFluxConfiguration
- getWebSocketService() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- getWebSocketService() - Method in interface org.springframework.web.reactive.config.WebFluxConfigurer
-
Provide the
WebSocketService
to createWebSocketHandlerAdapter
with. - getWebSocketService() - Method in class org.springframework.web.reactive.config.WebFluxConfigurerComposite
- getWebSocketService() - Method in class org.springframework.web.reactive.socket.server.support.WebSocketHandlerAdapter
-
Return the configured
WebSocketService
to handle requests. - getXnioWorker() - Method in class org.springframework.web.reactive.socket.client.UndertowWebSocketClient
-
Return the configured
XnioWorker
. - GOING_AWAY - Static variable in class org.springframework.web.reactive.socket.CloseStatus
-
"1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page."
H
- handle(ServerRequest) - Method in interface org.springframework.web.reactive.function.server.HandlerFunction
-
Handle the given request.
- handle(WebSocketSession) - Method in class org.springframework.web.reactive.socket.adapter.ContextWebSocketHandler
- handle(WebSocketSession) - Method in interface org.springframework.web.reactive.socket.WebSocketHandler
-
Invoked when a new WebSocket connection is established, and allows handling of the session.
- handle(ServerWebExchange) - Method in class org.springframework.web.reactive.DispatcherHandler
- handle(ServerWebExchange) - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Processes a resource request.
- handle(ServerWebExchange, Object) - Method in class org.springframework.web.reactive.function.server.support.HandlerFunctionAdapter
- handle(ServerWebExchange, Object) - Method in interface org.springframework.web.reactive.HandlerAdapter
-
Handle the request with the given handler, previously checked via
HandlerAdapter.supports(Object)
. - handle(ServerWebExchange, Object) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
- handle(ServerWebExchange, Object) - Method in class org.springframework.web.reactive.result.SimpleHandlerAdapter
- handle(ServerWebExchange, Object) - Method in class org.springframework.web.reactive.socket.server.support.WebSocketHandlerAdapter
- handleError(ServerWebExchange, Throwable) - Method in interface org.springframework.web.reactive.DispatchExceptionHandler
-
Handle the given exception, mapping it to a
HandlerResult
that can then be used to render an HTTP response. - handleError(ServerWebExchange, Throwable) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
- handleErrorResponseException(ErrorResponseException, HttpHeaders, HttpStatusCode, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Customize the handling of any
ErrorResponseException
. - handleException(Exception, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Handle all exceptions raised within Spring MVC handling of the request.
- handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Internal handler method that all others in this class delegate to, for common handling, and for the creation of a
ResponseEntity
. - handleMatch(RequestMappingInfo, HandlerMethod, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.RequestMappingInfoHandlerMapping
-
Expose URI template variables, matrix variables, and producible media types in the request.
- handleMatch(T, HandlerMethod, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Invoked when a matching mapping is found.
- handleMethodNotAllowedException(MethodNotAllowedException, HttpHeaders, HttpStatusCode, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Customize the handling of
MethodNotAllowedException
. - handleMissingRequestValueException(MissingRequestValueException, HttpHeaders, HttpStatusCode, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Customize the handling of
MissingRequestValueException
. - handleMissingValue(String, MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver
-
Invoked when a named value is required, but
AbstractNamedValueArgumentResolver.resolveName(String, MethodParameter, ServerWebExchange)
returnednull
and there is no default value. - handleMissingValue(String, MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.CookieValueMethodArgumentResolver
- handleMissingValue(String, MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.ExpressionValueMethodArgumentResolver
- handleMissingValue(String, MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.MatrixVariableMethodArgumentResolver
- handleMissingValue(String, MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.PathVariableMethodArgumentResolver
- handleMissingValue(String, MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.RequestAttributeMethodArgumentResolver
- handleMissingValue(String, MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.RequestHeaderMethodArgumentResolver
- handleMissingValue(String, MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.SessionAttributeMethodArgumentResolver
- handleMissingValue(String, MethodParameter, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver
-
Invoked when a named value is required, but
AbstractNamedValueArgumentResolver.resolveName(String, MethodParameter, ServerWebExchange)
returnednull
and there is no default value. - handleMissingValue(String, MethodParameter, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.RequestParamMethodArgumentResolver
- handleNoMatch(Set<RequestMappingInfo>, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.RequestMappingInfoHandlerMapping
-
Iterate all RequestMappingInfos once again, look if any match by URL at least and raise exceptions accordingly.
- handleNoMatch(Set<T>, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Invoked when no matching mapping is not found.
- handleNotAcceptableStatusException(NotAcceptableStatusException, HttpHeaders, HttpStatusCode, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Customize the handling of
NotAcceptableStatusException
. - handlePreFlight(ServerWebExchange) - Method in class org.springframework.web.reactive.DispatcherHandler
- HandlerAdapter - Interface in org.springframework.web.reactive
-
Contract to abstract the details of invoking a handler of a given type.
- handleRequest(ServerWebExchange, WebSocketHandler) - Method in class org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService
- handleRequest(ServerWebExchange, WebSocketHandler) - Method in interface org.springframework.web.reactive.socket.server.WebSocketService
-
Handle the request with the given
WebSocketHandler
. - handleResolvedValue(Object, String, MethodParameter, Model, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver
-
Invoked after a value is resolved.
- handleResolvedValue(Object, String, MethodParameter, Model, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.PathVariableMethodArgumentResolver
- handleResponseStatusException(ResponseStatusException, HttpHeaders, HttpStatusCode, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Customize the handling of any
ResponseStatusException
. - handleResult(ServerWebExchange, HandlerResult) - Method in class org.springframework.web.reactive.function.server.support.ServerResponseResultHandler
- handleResult(ServerWebExchange, HandlerResult) - Method in interface org.springframework.web.reactive.HandlerResultHandler
-
Process the given result modifying response headers and/or writing data to the response.
- handleResult(ServerWebExchange, HandlerResult) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseBodyResultHandler
- handleResult(ServerWebExchange, HandlerResult) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityResultHandler
- handleResult(ServerWebExchange, HandlerResult) - Method in class org.springframework.web.reactive.result.view.ViewResolutionResultHandler
- HandlerFilterFunction<T extends ServerResponse,
R extends ServerResponse> - Interface in org.springframework.web.reactive.function.server -
Represents a function that filters a handler function.
- HandlerFunction<T extends ServerResponse> - Interface in org.springframework.web.reactive.function.server
-
Represents a function that handles a request.
- handlerFunctionAdapter() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- HandlerFunctionAdapter - Class in org.springframework.web.reactive.function.server.support
-
HandlerAdapter
implementation that supportsHandlerFunctions
. - HandlerFunctionAdapter() - Constructor for class org.springframework.web.reactive.function.server.support.HandlerFunctionAdapter
- HandlerMapping - Interface in org.springframework.web.reactive
-
Interface to be implemented by objects that define a mapping between requests and handler objects.
- HandlerMethodArgumentResolver - Interface in org.springframework.web.reactive.result.method
-
Strategy to resolve the argument value for a method parameter in the context of the current HTTP request.
- HandlerMethodArgumentResolverSupport - Class in org.springframework.web.reactive.result.method
-
Base class for
HandlerMethodArgumentResolver
implementations with access to aReactiveAdapterRegistry
and methods to check for method parameter support. - HandlerMethodArgumentResolverSupport(ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.HandlerMethodArgumentResolverSupport
- handlerMethodsInitialized(Map<T, HandlerMethod>) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Invoked after all handler methods have been detected.
- HandlerResult - Class in org.springframework.web.reactive
-
Represent the result of the invocation of a handler or a handler method.
- HandlerResult(Object, Object, MethodParameter) - Constructor for class org.springframework.web.reactive.HandlerResult
-
Create a new
HandlerResult
. - HandlerResult(Object, Object, MethodParameter, BindingContext) - Constructor for class org.springframework.web.reactive.HandlerResult
-
Create a new
HandlerResult
. - HandlerResultHandler - Interface in org.springframework.web.reactive
-
Process the
HandlerResult
, usually returned by aHandlerAdapter
. - HandlerResultHandlerSupport - Class in org.springframework.web.reactive.result
-
Base class for
HandlerResultHandler
with support for content negotiation and access to aReactiveAdapter
registry. - HandlerResultHandlerSupport(RequestedContentTypeResolver, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.HandlerResultHandlerSupport
- HandlerStrategies - Interface in org.springframework.web.reactive.function.server
-
Defines the strategies to be used for processing
HandlerFunctions
. - HandlerStrategies.Builder - Interface in org.springframework.web.reactive.function.server
-
A mutable builder for a
HandlerStrategies
. - handleServerErrorException(ServerErrorException, HttpHeaders, HttpStatusCode, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Customize the handling of
ServerErrorException
. - handleServerWebInputException(ServerWebInputException, HttpHeaders, HttpStatusCode, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Customize the handling of
ServerWebInputException
. - handleUnsatisfiedRequestParameterException(UnsatisfiedRequestParameterException, HttpHeaders, HttpStatusCode, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Customize the handling of
UnsatisfiedRequestParameterException
. - handleUnsupportedMediaTypeStatusException(UnsupportedMediaTypeStatusException, HttpHeaders, HttpStatusCode, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Customize the handling of
UnsupportedMediaTypeStatusException
. - handleWebExchangeBindException(WebExchangeBindException, HttpHeaders, HttpStatusCode, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Customize the handling of
WebExchangeBindException
. - HandshakeInfo - Class in org.springframework.web.reactive.socket
-
Simple container of information related to the handshake request that started the
WebSocketSession
session. - HandshakeInfo(URI, HttpHeaders, MultiValueMap<String, HttpCookie>, Mono<Principal>, String, InetSocketAddress, Map<String, Object>, String) - Constructor for class org.springframework.web.reactive.socket.HandshakeInfo
-
Constructor targeting server-side use with extra information such as the cookies, remote address, attributes, and a log prefix.
- HandshakeInfo(URI, HttpHeaders, Mono<Principal>, String) - Constructor for class org.springframework.web.reactive.socket.HandshakeInfo
-
Constructor with basic information about the handshake.
- HandshakeInfo(URI, HttpHeaders, Mono<Principal>, String, InetSocketAddress, Map<String, Object>, String) - Constructor for class org.springframework.web.reactive.socket.HandshakeInfo
-
Deprecated.as of 5.3.5 in favor of
HandshakeInfo(URI, HttpHeaders, MultiValueMap, Mono, String, InetSocketAddress, Map, String)
- HandshakeWebSocketService - Class in org.springframework.web.reactive.socket.server.support
-
WebSocketService
implementation that handles a WebSocket HTTP handshake request by delegating to aRequestUpgradeStrategy
which is either auto-detected (no-arg constructor) from the classpath but can also be explicitly configured. - HandshakeWebSocketService() - Constructor for class org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService
-
Default constructor automatic, classpath detection based discovery of the
RequestUpgradeStrategy
to use. - HandshakeWebSocketService(RequestUpgradeStrategy) - Constructor for class org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService
-
Alternative constructor with the
RequestUpgradeStrategy
to use. - hasCorsConfigurationSource(Object) - Method in class org.springframework.web.reactive.handler.AbstractHandlerMapping
-
Return
true
if there is aCorsConfigurationSource
for this handler. - hasCorsConfigurationSource(Object) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
- hasExceptionHandler() - Method in class org.springframework.web.reactive.HandlerResult
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of checking via
HandlerResult.getExceptionHandler()
- hashCode() - Method in class org.springframework.web.reactive.function.client.ExchangeFilterFunctions.Credentials
-
Deprecated.
- hashCode() - Method in class org.springframework.web.reactive.result.condition.AbstractRequestCondition
- hashCode() - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
- hashCode() - Method in class org.springframework.web.reactive.socket.CloseStatus
- hashCode() - Method in class org.springframework.web.reactive.socket.WebSocketMessage
- hasMappingForPattern(String) - Method in class org.springframework.web.reactive.config.ResourceHandlerRegistry
-
Whether a resource handler has already been registered for the given path pattern.
- hasRegistrations() - Method in class org.springframework.web.reactive.config.ViewResolverRegistry
-
Whether any view resolvers have been registered.
- head() - Method in interface org.springframework.web.reactive.function.client.WebClient
-
Start building an HTTP HEAD request.
- HEAD(String) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that matches if request's HTTP method isHEAD
and the givenpattern
matches against the request path. - HEAD(String, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
HEAD
requests that match the given pattern. - HEAD(String, RequestPredicate, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
HEAD
requests that match the given pattern and predicate. - HEAD(HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles HTTP
HEAD
requests. - HEAD(RequestPredicate, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
HEAD
requests that match the given predicate. - header(String) - Method in interface org.springframework.web.reactive.function.client.ClientResponse.Headers
-
Return the header value(s), if any, for the header of the given name.
- header(String) - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper.HeadersWrapper
- header(String) - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Headers
-
Get the header value(s), if any, for the header with the given name.
- header(String) - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper.HeadersWrapper
- header(String, String) - Method in interface org.springframework.web.reactive.function.server.RequestPredicates.Visitor
-
Receive notification of an HTTP header predicate.
- header(String, String...) - Method in interface org.springframework.web.reactive.function.client.ClientRequest.Builder
-
Add the given header value(s) under the given name.
- header(String, String...) - Method in interface org.springframework.web.reactive.function.client.ClientResponse.Builder
-
Add the given header value(s) under the given name.
- header(String, String...) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
Add the given, single header value under the given name.
- header(String, String...) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Add the given header value(s) under the given name.
- header(String, String...) - Method in interface org.springframework.web.reactive.function.server.RenderingResponse.Builder
-
Add the given header value(s) under the given name.
- header(String, String...) - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Builder
-
Add the given header value(s) under the given name.
- header(String, String...) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder
-
Add the given header value(s) under the given name.
- header(String, String...) - Method in interface org.springframework.web.reactive.result.view.Rendering.Builder
-
Specify a header to add to the response.
- HeaderContentTypeResolver - Class in org.springframework.web.reactive.accept
-
Resolver that looks at the 'Accept' header of the request.
- HeaderContentTypeResolver() - Constructor for class org.springframework.web.reactive.accept.HeaderContentTypeResolver
- headerResolver() - Method in class org.springframework.web.reactive.accept.RequestedContentTypeResolverBuilder
-
Add resolver to get the requested content type from the "Accept" header.
- headers() - Method in interface org.springframework.web.reactive.function.client.ClientRequest
-
Return the headers of this request.
- headers() - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Return the headers of this response.
- headers() - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- headers() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the headers of this request.
- headers() - Method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Return the headers of this response.
- headers() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- headers() - Method in interface org.springframework.web.reactive.result.view.Rendering
-
Return headers to add to the response.
- headers(String...) - Method in interface org.springframework.web.reactive.result.method.RequestMappingInfo.Builder
-
Set the header conditions.
- headers(Consumer<HttpHeaders>) - Method in interface org.springframework.web.reactive.function.client.ClientRequest.Builder
-
Manipulate this request's headers with the given consumer.
- headers(Consumer<HttpHeaders>) - Method in interface org.springframework.web.reactive.function.client.ClientResponse.Builder
-
Manipulate this response's headers with the given consumer.
- headers(Consumer<HttpHeaders>) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
Provides access to every header declared so far with the possibility to add, replace, or remove values.
- headers(Consumer<HttpHeaders>) - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Builder
-
Manipulate this request's headers with the given consumer.
- headers(Consumer<HttpHeaders>) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder
-
Manipulate this response's headers with the given consumer.
- headers(Predicate<ServerRequest.Headers>) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that tests the request's headers against the given headers predicate. - headers(HttpHeaders) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Copy the given headers into the entity's headers map.
- headers(HttpHeaders) - Method in interface org.springframework.web.reactive.function.server.RenderingResponse.Builder
-
Copy the given headers into the entity's headers map.
- headers(HttpHeaders) - Method in interface org.springframework.web.reactive.result.view.Rendering.Builder
-
Specify headers to add to the response.
- HeadersRequestCondition - Class in org.springframework.web.reactive.result.condition
-
A logical conjunction (
' && '
) request condition that matches a request against a set of header expressions with syntax defined inRequestMapping.headers()
. - HeadersRequestCondition(String...) - Constructor for class org.springframework.web.reactive.result.condition.HeadersRequestCondition
-
Create a new instance from the given header expressions.
- HeadersWrapper(ClientResponse.Headers) - Constructor for class org.springframework.web.reactive.function.client.support.ClientResponseWrapper.HeadersWrapper
-
Create a new
HeadersWrapper
that wraps the given request. - HeadersWrapper(ServerRequest.Headers) - Constructor for class org.springframework.web.reactive.function.server.support.ServerRequestWrapper.HeadersWrapper
-
Create a new
HeadersWrapper
that wraps the given request. - hint(String, Object) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Add a serialization hint like
Jackson2CodecSupport.JSON_VIEW_HINT
to customize how the body will be serialized. - hint(String, Object) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder
-
Add a serialization hint like
Jackson2CodecSupport.JSON_VIEW_HINT
to customize how the body will be serialized. - hints() - Method in interface org.springframework.web.reactive.function.BodyExtractor.Context
-
Return the map of hints to use to customize body extraction.
- hints() - Method in interface org.springframework.web.reactive.function.BodyInserter.Context
-
Return the map of hints to use for response body conversion.
- hints(Consumer<Map<String, Object>>) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Customize the serialization hints with the given consumer.
- hints(Consumer<Map<String, Object>>) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder
-
Customize the serialization hints with the given consumer.
- host() - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Headers
-
Get the value of the
Host
header, if available. - host() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper.HeadersWrapper
- HTTP_REACTIVE_CLIENT_EXCHANGES - Enum constant in enum class org.springframework.web.reactive.function.client.ClientHttpObservationDocumentation
-
HTTP exchanges observations for reactive clients.
- HTTP_URL - Enum constant in enum class org.springframework.web.reactive.function.client.ClientHttpObservationDocumentation.HighCardinalityKeyNames
-
HTTP request URI.
- HttpEntityMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolves method arguments of type
HttpEntity
orRequestEntity
by reading the body of the request through a compatibleHttpMessageReader
. - HttpEntityMethodArgumentResolver(List<HttpMessageReader<?>>, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.HttpEntityMethodArgumentResolver
- HttpMessageWriterView - Class in org.springframework.web.reactive.result.view
-
View
that writes model attribute(s) with anHttpMessageWriter
. - HttpMessageWriterView(Encoder<?>) - Constructor for class org.springframework.web.reactive.result.view.HttpMessageWriterView
-
Constructor with an
Encoder
. - HttpMessageWriterView(HttpMessageWriter<?>) - Constructor for class org.springframework.web.reactive.result.view.HttpMessageWriterView
-
Constructor with a fully initialized
HttpMessageWriter
. - httpRequest() - Method in interface org.springframework.web.reactive.function.client.ClientRequest
-
Return consumer(s) configured to access to the
ClientHttpRequest
. - httpRequest(Consumer<ClientHttpRequest>) - Method in interface org.springframework.web.reactive.function.client.ClientRequest.Builder
-
Callback for access to the
ClientHttpRequest
that in turn provides access to the native request of the underlying HTTP library. - httpRequest(Consumer<ClientHttpRequest>) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
Callback for access to the
ClientHttpRequest
that in turn provides access to the native request of the underlying HTTP library. - HttpResource - Interface in org.springframework.web.reactive.resource
-
Extended interface for a
Resource
to be written to an HTTP response. - httpUrl(ClientRequestObservationContext) - Method in class org.springframework.web.reactive.function.client.DefaultClientRequestObservationConvention
I
- ifModifiedSince(ZonedDateTime) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
Set the value of the
If-Modified-Since
header. - ifNoneMatch(String...) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
Set the values of the
If-None-Match
header. - initAllowedLocations() - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Look for a
PathResourceResolver
among the configured resource resolvers and set itsallowedLocations
property (if empty) to match thelocations
configured on this class. - initApplicationContext() - Method in class org.springframework.web.reactive.handler.SimpleUrlHandlerMapping
-
Calls the
SimpleUrlHandlerMapping.registerHandlers(java.util.Map<java.lang.String, java.lang.Object>)
method in addition to the superclass's initialization. - initCorsConfiguration(Object, Method, RequestMappingInfo) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
- initCorsConfiguration(Object, Method, T) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Extract and return the CORS configuration for the mapping.
- initDataBinder(WebExchangeDataBinder, ServerWebExchange) - Method in class org.springframework.web.reactive.BindingContext
-
Initialize the data binder instance for the given exchange.
- initHandlerMethods() - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Scan beans in the ApplicationContext, detect and register handler methods.
- initRouterFunctions() - Method in class org.springframework.web.reactive.function.server.support.RouterFunctionMapping
-
Initialized the router functions by detecting them in the application context.
- initStrategies(ApplicationContext) - Method in class org.springframework.web.reactive.DispatcherHandler
- insert(M, BodyInserter.Context) - Method in interface org.springframework.web.reactive.function.BodyInserter
-
Insert into the given output message.
- inserter() - Method in interface org.springframework.web.reactive.function.server.EntityResponse
-
Return the
BodyInserter
that writes the entity to the output stream. - instantiateView() - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerViewResolver
- instantiateView() - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateViewResolver
- instantiateView() - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Instantiate the specified view class.
- InvocableHandlerMethod - Class in org.springframework.web.reactive.result.method
-
Extension of
HandlerMethod
that invokes the underlying method with argument values resolved from the current HTTP request through a list ofHandlerMethodArgumentResolver
. - InvocableHandlerMethod(Object, Method) - Constructor for class org.springframework.web.reactive.result.method.InvocableHandlerMethod
-
Create an instance from a bean instance and a method.
- InvocableHandlerMethod(HandlerMethod) - Constructor for class org.springframework.web.reactive.result.method.InvocableHandlerMethod
-
Create an instance from a
HandlerMethod
. - invoke(ServerWebExchange, BindingContext, Object...) - Method in class org.springframework.web.reactive.result.method.InvocableHandlerMethod
-
Invoke the method for the given exchange.
- invokeForHandlerResult(ServerWebExchange, BindingContext, Object...) - Method in class org.springframework.web.reactive.result.method.SyncInvocableHandlerMethod
-
Invoke the method for the given exchange.
- isAborted() - Method in class org.springframework.web.reactive.function.client.ClientRequestObservationContext
-
Whether the client aborted the current HTTP exchange before receiving any response.
- isBodyRequired() - Method in class org.springframework.web.reactive.result.condition.ConsumesRequestCondition
-
Return the setting for
ConsumesRequestCondition.setBodyRequired(boolean)
. - isContextRelative() - Method in class org.springframework.web.reactive.result.view.RedirectView
-
Whether to interpret URLs as relative to the current context path.
- isDataEmpty(WebSocketMessage) - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession.WebSocketSendProcessor
- isDefaultHtmlEscape() - Method in class org.springframework.web.reactive.result.view.RequestContext
-
Is default HTML escaping active? Falls back to
false
in case of no explicit default given. - isEmpty() - Method in class org.springframework.web.reactive.result.condition.AbstractRequestCondition
-
Indicates whether this condition is empty, i.e.
- isEmpty() - Method in class org.springframework.web.reactive.result.condition.CompositeRequestCondition
-
Whether this instance contains 0 conditions or not.
- isEmpty() - Method in class org.springframework.web.reactive.result.condition.ConsumesRequestCondition
-
Whether the condition has any media type expressions.
- isEmpty() - Method in class org.springframework.web.reactive.result.condition.ProducesRequestCondition
-
Whether the condition has any media type expressions.
- isError() - Method in class org.springframework.web.reactive.result.view.BindStatus
-
Return if this status represents a field or object error.
- isHandler(Class<?>) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Whether the given type is a handler with handler methods.
- isHandler(Class<?>) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
-
Whether the given type is a handler with handler methods.
- isInvalidPath(String) - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Identifies invalid resource paths.
- isNegated() - Method in interface org.springframework.web.reactive.result.condition.MediaTypeExpression
- isNegated() - Method in interface org.springframework.web.reactive.result.condition.NameValueExpression
- isOpen() - Method in class org.springframework.web.reactive.socket.adapter.JettyWebSocketSession
- isOpen() - Method in class org.springframework.web.reactive.socket.adapter.ReactorNetty2WebSocketSession
- isOpen() - Method in class org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession
- isOpen() - Method in class org.springframework.web.reactive.socket.adapter.StandardWebSocketSession
- isOpen() - Method in class org.springframework.web.reactive.socket.adapter.UndertowWebSocketSession
- isOpen() - Method in interface org.springframework.web.reactive.socket.WebSocketSession
-
Whether the underlying connection is open.
- isOptimizeLocations() - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Return whether to optimize the specified locations through an existence check on startup, filtering non-existing directories upfront so that they do not have to be checked on every resource access.
- isPropagateQuery() - Method in class org.springframework.web.reactive.result.view.RedirectView
-
Whether the query string of the current URL is appended to the redirect URL.
- isRedirectView() - Method in class org.springframework.web.reactive.result.view.RedirectView
- isRedirectView() - Method in interface org.springframework.web.reactive.result.view.View
-
Whether this View does render by performing a redirect.
- isRemoteHost(String) - Method in class org.springframework.web.reactive.result.view.RedirectView
-
Whether the given targetUrl has a host that is a "foreign" system in which case
HttpServletResponse.encodeRedirectURL(java.lang.String)
will not be applied. - isRunning() - Method in class org.springframework.web.reactive.socket.client.JettyWebSocketClient
-
Deprecated.
- isRunning() - Method in class org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService
- isSharedEngine() - Method in interface org.springframework.web.reactive.result.view.script.ScriptTemplateConfig
-
Return whether to use a shared engine for all threads or whether to create thread-local engine instances for each thread.
- isSharedEngine() - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
- isUseCaseSensitiveMatch() - Method in class org.springframework.web.reactive.config.PathMatchConfigurer
- isUseLastModified() - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Return whether the
Resource.lastModified()
information is used to drive HTTP responses when serving static resources. - isUseTrailingSlashMatch() - Method in class org.springframework.web.reactive.config.PathMatchConfigurer
-
Deprecated.
- isWritePossible() - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession.WebSocketSendProcessor
J
- JettyRequestUpgradeStrategy - Class in org.springframework.web.reactive.socket.server.upgrade
-
A WebSocket
RequestUpgradeStrategy
for Jetty 11. - JettyRequestUpgradeStrategy() - Constructor for class org.springframework.web.reactive.socket.server.upgrade.JettyRequestUpgradeStrategy
- JettyWebSocketClient - Class in org.springframework.web.reactive.socket.client
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0.3, in favor of
StandardWebSocketClient
- JettyWebSocketClient() - Constructor for class org.springframework.web.reactive.socket.client.JettyWebSocketClient
-
Deprecated.Default constructor that creates and manages an instance of a Jetty
WebSocketClient
. - JettyWebSocketClient(WebSocketClient) - Constructor for class org.springframework.web.reactive.socket.client.JettyWebSocketClient
-
Deprecated.Constructor that accepts an existing instance of a Jetty
WebSocketClient
. - JettyWebSocketHandlerAdapter - Class in org.springframework.web.reactive.socket.adapter
-
Jetty
@WebSocket
handler that delegates events to a reactiveWebSocketHandler
and its session. - JettyWebSocketHandlerAdapter(WebSocketHandler, Function<Session, JettyWebSocketSession>) - Constructor for class org.springframework.web.reactive.socket.adapter.JettyWebSocketHandlerAdapter
- JettyWebSocketSession - Class in org.springframework.web.reactive.socket.adapter
-
Spring
WebSocketSession
implementation that adapts to a Jetty WebSocketSession
. - JettyWebSocketSession(Session, HandshakeInfo, DataBufferFactory) - Constructor for class org.springframework.web.reactive.socket.adapter.JettyWebSocketSession
- JettyWebSocketSession(Session, HandshakeInfo, DataBufferFactory, Sinks.Empty<Void>) - Constructor for class org.springframework.web.reactive.socket.adapter.JettyWebSocketSession
L
- lastModified() - Method in class org.springframework.web.reactive.resource.TransformedResource
- lastModified(Instant) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Set the time the resource was last changed, as specified by the
Last-Modified
header. - lastModified(Instant) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder
-
Set the time the resource was last changed, as specified by the
Last-Modified
header. - lastModified(ZonedDateTime) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Set the time the resource was last changed, as specified by the
Last-Modified
header. - lastModified(ZonedDateTime) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder
-
Set the time the resource was last changed, as specified by the
Last-Modified
header. - limitResponseSize(long) - Static method in class org.springframework.web.reactive.function.client.ExchangeFilterFunctions
-
Consume up to the specified number of bytes from the response body and cancel if any more data arrives.
- loadScripts(ScriptEngine) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
- localAddress() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the local address to which this request is connected, if available.
- localAddress() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- localeContextResolver() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- localeContextResolver() - Method in interface org.springframework.web.reactive.function.server.HandlerStrategies
-
Return the
LocaleContextResolver
to be used for resolving locale context. - localeContextResolver(LocaleContextResolver) - Method in interface org.springframework.web.reactive.function.server.HandlerStrategies.Builder
-
Add the given locale context resolver to this builder.
- location(URI) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Set the location of a resource, as specified by the
Location
header. - location(URI) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder
-
Set the location of a resource, as specified by the
Location
header. - LOG_ID_ATTRIBUTE - Static variable in interface org.springframework.web.reactive.function.client.ClientRequest
-
Name of
attribute
whose value can be used to correlate log messages for this request. - logger - Variable in class org.springframework.web.reactive.resource.AbstractFileNameVersionStrategy
- logger - Variable in class org.springframework.web.reactive.resource.AbstractPrefixVersionStrategy
- logger - Variable in class org.springframework.web.reactive.resource.AbstractResourceResolver
- logger - Variable in class org.springframework.web.reactive.result.HandlerResultHandlerSupport
- logger - Variable in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
-
Common logger for use in subclasses.
- logger - Variable in class org.springframework.web.reactive.result.method.HandlerMethodArgumentResolverSupport
- logger - Variable in class org.springframework.web.reactive.result.view.AbstractView
-
Logger that is available to subclasses.
- logger - Variable in class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
- logPrefix() - Method in interface org.springframework.web.reactive.function.client.ClientRequest
-
Return a log message prefix to use to correlate messages for this request.
- logPrefix() - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Return a log message prefix to use to correlate messages for this exchange.
- logPrefix() - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- lookupHandler(PathContainer, ServerWebExchange) - Method in class org.springframework.web.reactive.handler.AbstractUrlHandlerMapping
-
Look up a handler instance for the given URL lookup path.
- lookupHandlerMethod(ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Look up the best-matching handler method for the current request.
M
- mappingName(String) - Method in interface org.springframework.web.reactive.result.method.RequestMappingInfo.Builder
-
Set the mapping name.
- mappingsLogger - Variable in class org.springframework.web.reactive.handler.AbstractHandlerMapping
-
Dedicated "hidden" logger for request mappings.
- MATCHING_PATTERN_ATTRIBUTE - Static variable in class org.springframework.web.reactive.function.server.RouterFunctions
-
Name of the
attribute
that contains the matching pattern, as aPathPattern
. - MATRIX_VARIABLES_ATTRIBUTE - Static variable in interface org.springframework.web.reactive.HandlerMapping
-
Name of the
attribute
that contains a map with URI variable names and a corresponding MultiValueMap of URI matrix variables for each. - MatrixVariableMapMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolves arguments of type
Map
annotated with@MatrixVariable
where the annotation does not specify a name. - MatrixVariableMapMethodArgumentResolver(ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.MatrixVariableMapMethodArgumentResolver
- MatrixVariableMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolves arguments annotated with
@MatrixVariable
. - MatrixVariableMethodArgumentResolver(ConfigurableBeanFactory, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.MatrixVariableMethodArgumentResolver
- maxAge(long) - Method in class org.springframework.web.reactive.config.CorsRegistration
-
Configure how long in seconds the response from a pre-flight request can be cached by clients.
- MEDIA_TYPE_ALL_LIST - Static variable in interface org.springframework.web.reactive.accept.RequestedContentTypeResolver
-
A singleton list with
MediaType.ALL
that is returned fromRequestedContentTypeResolver.resolveMediaTypes(org.springframework.web.server.ServerWebExchange)
when no specific media types are requested. - mediaType(String, MediaType) - Method in class org.springframework.web.reactive.accept.RequestedContentTypeResolverBuilder.ParameterResolverConfigurer
-
Configure a mapping between a lookup key (extracted from a query parameter value) and a corresponding
MediaType
. - mediaType(Map<String, MediaType>) - Method in class org.springframework.web.reactive.accept.RequestedContentTypeResolverBuilder.ParameterResolverConfigurer
- MediaTypeExpression - Interface in org.springframework.web.reactive.result.condition
-
A contract for media type expressions (e.g.
- messageReaders() - Method in interface org.springframework.web.reactive.function.BodyExtractor.Context
-
Return the
HttpMessageReaders
to be used for body extraction. - messageReaders() - Method in interface org.springframework.web.reactive.function.client.ExchangeStrategies
-
Return
HttpMessageReaders
to read and decode the response body with. - messageReaders() - Method in interface org.springframework.web.reactive.function.server.HandlerStrategies
-
Return the
HttpMessageReaders
to be used for request body conversion. - messageReaders() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the readers used to convert the body of this request.
- messageReaders() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- messageWriters() - Method in interface org.springframework.web.reactive.function.BodyInserter.Context
-
Return the
HttpMessageWriters
to be used for response body conversion. - messageWriters() - Method in interface org.springframework.web.reactive.function.client.ExchangeStrategies
-
Return
HttpMessageWriters
to write and encode the request body with. - messageWriters() - Method in interface org.springframework.web.reactive.function.server.HandlerStrategies
-
Return the
HttpMessageWriters
to be used for response body conversion. - messageWriters() - Method in interface org.springframework.web.reactive.function.server.ServerResponse.Context
-
Return the
HttpMessageWriters
to be used for response body conversion. - method() - Method in interface org.springframework.web.reactive.function.client.ClientRequest
-
Return the HTTP method.
- method() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the HTTP method.
- method() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- method(Set<HttpMethod>) - Method in interface org.springframework.web.reactive.function.server.RequestPredicates.Visitor
-
Receive notification of an HTTP method predicate.
- method(HttpMethod) - Method in interface org.springframework.web.reactive.function.client.ClientRequest.Builder
-
Set the method of the request.
- method(HttpMethod) - Method in interface org.springframework.web.reactive.function.client.WebClient
-
Start building a request for the given
HttpMethod
. - method(HttpMethod) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that matches if the request's HTTP method is equal to the given method. - method(HttpMethod) - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Builder
-
Set the method of the request.
- method(HttpMethod, URI) - Static method in interface org.springframework.web.reactive.function.client.ClientRequest
-
Deprecated.in favor of
ClientRequest.create(HttpMethod, URI)
- method(ClientRequestObservationContext) - Method in class org.springframework.web.reactive.function.client.DefaultClientRequestObservationConvention
- METHOD - Enum constant in enum class org.springframework.web.reactive.function.client.ClientHttpObservationDocumentation.LowCardinalityKeyNames
-
Name of HTTP request method or "none" if the request could not be created.
- methodName() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Deprecated.as of 6.0, in favor of
ServerRequest.method()
- methodName() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
-
Deprecated.
- methods(HttpMethod...) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that matches if the request's HTTP method is equal to one the of the given methods. - methods(RequestMethod...) - Method in interface org.springframework.web.reactive.result.method.RequestMappingInfo.Builder
-
Set the request method conditions.
- model() - Method in interface org.springframework.web.reactive.function.server.RenderingResponse
-
Return the unmodifiable model map.
- model(Map<String, ?>) - Method in interface org.springframework.web.reactive.result.view.Rendering.Builder
-
Add the given attributes to the model.
- modelAttribute(Object) - Method in interface org.springframework.web.reactive.function.server.RenderingResponse.Builder
-
Add the supplied attribute to the model using a generated name.
- modelAttribute(Object) - Method in interface org.springframework.web.reactive.result.view.Rendering.Builder
-
Add an attribute to the model using a
generated name
. - modelAttribute(String, Object) - Method in interface org.springframework.web.reactive.function.server.RenderingResponse.Builder
-
Add the supplied attribute value under the supplied name.
- modelAttribute(String, Object) - Method in interface org.springframework.web.reactive.result.view.Rendering.Builder
-
Add the given model attribute with the supplied name.
- ModelAttributeMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolve
@ModelAttribute
annotated method arguments. - ModelAttributeMethodArgumentResolver(ReactiveAdapterRegistry, boolean) - Constructor for class org.springframework.web.reactive.result.method.annotation.ModelAttributeMethodArgumentResolver
-
Class constructor with a default resolution mode flag.
- modelAttributes() - Method in interface org.springframework.web.reactive.result.view.Rendering
-
Return attributes to add to the model.
- modelAttributes(Object...) - Method in interface org.springframework.web.reactive.function.server.RenderingResponse.Builder
-
Copy all attributes in the supplied array into the model, using attribute name generation for each element.
- modelAttributes(Object...) - Method in interface org.springframework.web.reactive.result.view.Rendering.Builder
-
Add all given attributes to the model using
generated names
. - modelAttributes(Collection<?>) - Method in interface org.springframework.web.reactive.function.server.RenderingResponse.Builder
-
Copy all attributes in the supplied
Collection
into the model, using attribute name generation for each element. - modelAttributes(Map<String, ?>) - Method in interface org.springframework.web.reactive.function.server.RenderingResponse.Builder
-
Copy all attributes in the supplied
Map
into the model. - ModelMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolver for a controller method argument of type
Model
that can also be resolved as aMap
. - ModelMethodArgumentResolver(ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.ModelMethodArgumentResolver
- multipartData() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the parts of a multipart request if the Content-Type is
"multipart/form-data"
or an empty map otherwise. - multipartData() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- mutate() - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Return a builder to mutate this response, for example to change the status, headers, cookies, and replace or transform the body.
- mutate() - Method in interface org.springframework.web.reactive.function.client.ExchangeStrategies
-
Return a builder to create a new
ExchangeStrategies
instance replicated from the current instance. - mutate() - Method in interface org.springframework.web.reactive.function.client.WebClient
-
Return a builder to create a new
WebClient
whose settings are replicated from the currentWebClient
. - mutate() - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Return a builder to create a new RequestMappingInfo by modifying this one.
N
- name() - Method in interface org.springframework.web.reactive.function.server.RenderingResponse
-
Return the name of the template to be rendered.
- NamedValueInfo(String, boolean, String) - Constructor for class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver.NamedValueInfo
- NameValueExpression<T> - Interface in org.springframework.web.reactive.result.condition
-
A contract for
"name!=value"
style expression used to specify request parameters and request header conditions in@RequestMapping
. - negate() - Method in interface org.springframework.web.reactive.function.server.RequestPredicate
-
Return a predicate that represents the logical negation of this predicate.
- nest(RequestPredicate, Consumer<RouterFunctions.Builder>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Route to a built router function if the given request predicate applies.
- nest(RequestPredicate, Supplier<RouterFunction<ServerResponse>>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Route to the supplied router function if the given request predicate applies.
- nest(RequestPredicate, RouterFunction<T>) - Static method in class org.springframework.web.reactive.function.server.RouterFunctions
-
Route to the given router function if the given request predicate applies.
- nest(ServerRequest) - Method in interface org.springframework.web.reactive.function.server.RequestPredicate
-
Transform the given request into a request used for a nested route.
- Netty5WebSocketSessionSupport<T> - Class in org.springframework.web.reactive.socket.adapter
-
Base class for Netty-based
WebSocketSession
adapters that provides convenience methods to convert NettyWebSocketFrames
to and fromWebSocketMessages
. - Netty5WebSocketSessionSupport(T, HandshakeInfo, Netty5DataBufferFactory) - Constructor for class org.springframework.web.reactive.socket.adapter.Netty5WebSocketSessionSupport
- NettyWebSocketSessionSupport<T> - Class in org.springframework.web.reactive.socket.adapter
-
Base class for Netty-based
WebSocketSession
adapters that provides convenience methods to convert NettyWebSocketFrames
to and fromWebSocketMessages
. - NettyWebSocketSessionSupport(T, HandshakeInfo, NettyDataBufferFactory) - Constructor for class org.springframework.web.reactive.socket.adapter.NettyWebSocketSessionSupport
- NO_CLOSE_FRAME - Static variable in class org.springframework.web.reactive.socket.CloseStatus
-
"1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
- NO_STATUS_CODE - Static variable in class org.springframework.web.reactive.socket.CloseStatus
-
"1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
- noContent() - Static method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Create a builder with a 204 No Content status.
- NORMAL - Static variable in class org.springframework.web.reactive.socket.CloseStatus
-
"1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled."
- NOT_ACCEPTABLE - Static variable in class org.springframework.web.reactive.socket.CloseStatus
-
"1003 indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands only text data MAY send this if it receives a binary message)."
- notFound() - Static method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Create a builder with a 404 Not Found status.
O
- observationConvention(ClientRequestObservationConvention) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Provide an
ObservationConvention
to use for collecting metadata for the request observation. - observationRegistry(ObservationRegistry) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Provide an
ObservationRegistry
to use for recording observations for HTTP client calls. - obtainApplicationContext() - Method in class org.springframework.web.reactive.result.view.AbstractView
-
Obtain the
ApplicationContext
for actual use. - obtainConfiguration() - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
-
Obtain the FreeMarker
Configuration
for actual use. - ofRequestProcessor(Function<ClientRequest, Mono<ClientRequest>>) - Static method in interface org.springframework.web.reactive.function.client.ExchangeFilterFunction
-
Adapt the given request processor function to a filter function that only operates on the
ClientRequest
. - ofRequestProcessor(Function<ServerRequest, Mono<ServerRequest>>) - Static method in interface org.springframework.web.reactive.function.server.HandlerFilterFunction
-
Adapt the given request processor function to a filter function that only operates on the
ServerRequest
. - ofResponseProcessor(Function<ClientResponse, Mono<ClientResponse>>) - Static method in interface org.springframework.web.reactive.function.client.ExchangeFilterFunction
-
Adapt the given response processor function to a filter function that only operates on the
ClientResponse
. - ofResponseProcessor(Function<T, Mono<R>>) - Static method in interface org.springframework.web.reactive.function.server.HandlerFilterFunction
-
Adapt the given response processor function to a filter function that only operates on the
ServerResponse
. - ok() - Static method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Create a builder with the status set to 200 OK.
- onApplicationEvent(ContextRefreshedEvent) - Method in class org.springframework.web.reactive.resource.ResourceUrlProvider
- onClose(Session, CloseReason) - Method in class org.springframework.web.reactive.socket.adapter.StandardWebSocketHandlerAdapter
- onComplete() - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
- onError(WebSocketChannel, Throwable) - Method in class org.springframework.web.reactive.socket.adapter.UndertowWebSocketHandlerAdapter
- onError(Session, Throwable) - Method in class org.springframework.web.reactive.socket.adapter.StandardWebSocketHandlerAdapter
- onError(Class<T>, BiFunction<? super T, ServerRequest, Mono<ServerResponse>>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Filters all exceptions of the given type by applying the given response provider function.
- onError(Throwable) - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
- onError(Predicate<? super Throwable>, BiFunction<? super Throwable, ServerRequest, Mono<ServerResponse>>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Filters all exceptions that match the predicate by applying the given response provider function.
- onFullBinaryMessage(WebSocketChannel, BufferedBinaryMessage) - Method in class org.springframework.web.reactive.socket.adapter.UndertowWebSocketHandlerAdapter
- onFullCloseMessage(WebSocketChannel, BufferedBinaryMessage) - Method in class org.springframework.web.reactive.socket.adapter.UndertowWebSocketHandlerAdapter
- onFullPongMessage(WebSocketChannel, BufferedBinaryMessage) - Method in class org.springframework.web.reactive.socket.adapter.UndertowWebSocketHandlerAdapter
- onFullTextMessage(WebSocketChannel, BufferedTextMessage) - Method in class org.springframework.web.reactive.socket.adapter.UndertowWebSocketHandlerAdapter
- onNext(Void) - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
- onOpen(Session, EndpointConfig) - Method in class org.springframework.web.reactive.socket.adapter.StandardWebSocketHandlerAdapter
- onRawStatus(IntPredicate, Function<ClientResponse, Mono<? extends Throwable>>) - Method in interface org.springframework.web.reactive.function.client.WebClient.ResponseSpec
-
Variant of
WebClient.ResponseSpec.onStatus(Predicate, Function)
that works with raw status code values. - onStatus(Predicate<HttpStatusCode>, Function<ClientResponse, Mono<? extends Throwable>>) - Method in interface org.springframework.web.reactive.function.client.WebClient.ResponseSpec
-
Provide a function to map specific error status codes to an error signal to be propagated downstream instead of the response.
- onSubscribe(Subscription) - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
- onWebSocketBinary(byte[], int, int) - Method in class org.springframework.web.reactive.socket.adapter.JettyWebSocketHandlerAdapter
- onWebSocketClose(int, String) - Method in class org.springframework.web.reactive.socket.adapter.JettyWebSocketHandlerAdapter
- onWebSocketConnect(Session) - Method in class org.springframework.web.reactive.socket.adapter.JettyWebSocketHandlerAdapter
- onWebSocketError(Throwable) - Method in class org.springframework.web.reactive.socket.adapter.JettyWebSocketHandlerAdapter
- onWebSocketFrame(Frame) - Method in class org.springframework.web.reactive.socket.adapter.JettyWebSocketHandlerAdapter
- onWebSocketText(String) - Method in class org.springframework.web.reactive.socket.adapter.JettyWebSocketHandlerAdapter
- options() - Method in interface org.springframework.web.reactive.function.client.WebClient
-
Start building an HTTP OPTIONS request.
- options(RequestMappingInfo.BuilderConfiguration) - Method in interface org.springframework.web.reactive.result.method.RequestMappingInfo.Builder
-
Provide additional configuration needed for request mapping purposes.
- OPTIONS(String) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that matches if request's HTTP method isOPTIONS
and the givenpattern
matches against the request path. - OPTIONS(String, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
OPTIONS
requests that match the given pattern. - OPTIONS(String, RequestPredicate, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
OPTIONS
requests that match the given pattern and predicate. - OPTIONS(HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles HTTP
OPTIONS
requests. - OPTIONS(RequestPredicate, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
OPTIONS
requests that match the given predicate. - or() - Method in interface org.springframework.web.reactive.function.server.RequestPredicates.Visitor
-
Receive "middle" notification of a logical OR predicate.
- or(RequestPredicate) - Method in interface org.springframework.web.reactive.function.server.RequestPredicate
-
Return a composed request predicate that tests against both this predicate OR the
other
predicate. - order(int) - Method in class org.springframework.web.reactive.config.ViewResolverRegistry
-
Set the order for the
ViewResolutionResultHandler
. - org.springframework.web.reactive - package org.springframework.web.reactive
-
Top-level package for the
spring-webflux
module that containsDispatcherHandler
, the main entry point for WebFlux server endpoint processing including key contracts used to map requests to handlers, invoke them, and process the result. - org.springframework.web.reactive.accept - package org.springframework.web.reactive.accept
-
RequestedContentTypeResolver
strategy and implementations to resolve the requested content type for a given request. - org.springframework.web.reactive.config - package org.springframework.web.reactive.config
-
Spring WebFlux configuration infrastructure.
- org.springframework.web.reactive.function - package org.springframework.web.reactive.function
-
Provides a foundation for both the reactive client and server subpackages.
- org.springframework.web.reactive.function.client - package org.springframework.web.reactive.function.client
-
Provides a reactive
WebClient
that builds on top of theorg.springframework.http.client.reactive
reactive HTTP adapter layer. - org.springframework.web.reactive.function.client.support - package org.springframework.web.reactive.function.client.support
-
Classes supporting the
org.springframework.web.reactive.function.client
package. - org.springframework.web.reactive.function.server - package org.springframework.web.reactive.function.server
-
Provides the types that make up Spring's functional web framework for Reactive environments.
- org.springframework.web.reactive.function.server.support - package org.springframework.web.reactive.function.server.support
-
Classes supporting the
org.springframework.web.reactive.function.server
package. - org.springframework.web.reactive.handler - package org.springframework.web.reactive.handler
-
Provides HandlerMapping implementations including abstract base classes.
- org.springframework.web.reactive.resource - package org.springframework.web.reactive.resource
-
Support classes for serving static resources.
- org.springframework.web.reactive.result - package org.springframework.web.reactive.result
-
Support for various programming model styles including the invocation of different types of handlers, e.g.
- org.springframework.web.reactive.result.condition - package org.springframework.web.reactive.result.condition
-
RequestCondition
and implementations for matching requests based on different criteria. - org.springframework.web.reactive.result.method - package org.springframework.web.reactive.result.method
-
Infrastructure for handler method processing.
- org.springframework.web.reactive.result.method.annotation - package org.springframework.web.reactive.result.method.annotation
-
Infrastructure for annotation-based handler method processing.
- org.springframework.web.reactive.result.view - package org.springframework.web.reactive.result.view
-
Support for result handling through view resolution.
- org.springframework.web.reactive.result.view.freemarker - package org.springframework.web.reactive.result.view.freemarker
-
Support classes for the integration of FreeMarker as Spring web view technology.
- org.springframework.web.reactive.result.view.script - package org.springframework.web.reactive.result.view.script
-
Support classes for views based on the JSR-223 script engine abstraction (as included in Java 6+), e.g.
- org.springframework.web.reactive.socket - package org.springframework.web.reactive.socket
-
Abstractions and support classes for reactive WebSocket interactions.
- org.springframework.web.reactive.socket.adapter - package org.springframework.web.reactive.socket.adapter
-
Classes adapting Spring's Reactive WebSocket API to and from WebSocket runtimes.
- org.springframework.web.reactive.socket.client - package org.springframework.web.reactive.socket.client
-
Client support for WebSocket interactions.
- org.springframework.web.reactive.socket.server - package org.springframework.web.reactive.socket.server
-
Server support for WebSocket interactions.
- org.springframework.web.reactive.socket.server.support - package org.springframework.web.reactive.socket.server.support
-
Server-side support classes for WebSocket requests.
- org.springframework.web.reactive.socket.server.upgrade - package org.springframework.web.reactive.socket.server.upgrade
-
Holds implementations of
RequestUpgradeStrategy
. - outcome(ClientRequestObservationContext) - Method in class org.springframework.web.reactive.function.client.DefaultClientRequestObservationConvention
- OUTCOME - Enum constant in enum class org.springframework.web.reactive.function.client.ClientHttpObservationDocumentation.LowCardinalityKeyNames
-
Outcome of the HTTP client exchange.
P
- ParameterContentTypeResolver - Class in org.springframework.web.reactive.accept
-
Resolver that checks a query parameter and uses it to look up a matching MediaType.
- ParameterContentTypeResolver(Map<String, MediaType>) - Constructor for class org.springframework.web.reactive.accept.ParameterContentTypeResolver
- parameterName(String) - Method in class org.springframework.web.reactive.accept.RequestedContentTypeResolverBuilder.ParameterResolverConfigurer
-
Set the name of the parameter to use to determine requested media types.
- parameterResolver() - Method in class org.springframework.web.reactive.accept.RequestedContentTypeResolverBuilder
-
Add a resolver to get the requested content type from a query parameter.
- ParameterResolverConfigurer() - Constructor for class org.springframework.web.reactive.accept.RequestedContentTypeResolverBuilder.ParameterResolverConfigurer
- params(String...) - Method in interface org.springframework.web.reactive.result.method.RequestMappingInfo.Builder
-
Set the request param conditions.
- ParamsRequestCondition - Class in org.springframework.web.reactive.result.condition
-
A logical conjunction (
' && '
) request condition that matches a request against a set parameter expressions with syntax defined inRequestMapping.params()
. - ParamsRequestCondition(String...) - Constructor for class org.springframework.web.reactive.result.condition.ParamsRequestCondition
-
Create a new instance from the given param expressions.
- parse(String, SortedSet<CssLinkResourceTransformer.ContentChunkInfo>) - Method in class org.springframework.web.reactive.resource.CssLinkResourceTransformer.AbstractLinkParser
- parse(String, SortedSet<CssLinkResourceTransformer.ContentChunkInfo>) - Method in interface org.springframework.web.reactive.resource.CssLinkResourceTransformer.LinkParser
- patch() - Method in interface org.springframework.web.reactive.function.client.WebClient
-
Start building an HTTP PATCH request.
- PATCH(String) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that matches if request's HTTP method isPATCH
and the givenpattern
matches against the request path. - PATCH(String, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
PATCH
requests that match the given pattern. - PATCH(String, RequestPredicate, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
PATCH
requests that match the given pattern and predicate. - PATCH(HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles HTTP
PATCH
requests. - PATCH(RequestPredicate, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
PATCH
requests that match the given predicate. - path() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the request path.
- path() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- path(String) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that tests the request path against the given path pattern. - path(String) - Method in interface org.springframework.web.reactive.function.server.RequestPredicates.Visitor
-
Receive notification of a path predicate.
- path(String, Consumer<RouterFunctions.Builder>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Route to a built router function if the given path prefix pattern applies.
- path(String, Supplier<RouterFunction<ServerResponse>>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Route to the supplied router function if the given path prefix pattern applies.
- PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE - Static variable in interface org.springframework.web.reactive.HandlerMapping
-
Name of the
attribute
that contains the path within the handler mapping, in case of a pattern match such as"/static/**"
or the full relevant URI otherwise. - pathContainer() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Deprecated.as of 5.3, in favor on
ServerRequest.requestPath()
- pathContainer() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
-
Deprecated.
- pathExtension(String) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that matches if the request's path has the given extension. - pathExtension(String) - Method in interface org.springframework.web.reactive.function.server.RequestPredicates.Visitor
-
Receive notification of a path extension predicate.
- pathExtension(Predicate<String>) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that matches if the request's path matches the given predicate. - PathMatchConfigurer - Class in org.springframework.web.reactive.config
-
Assist with configuring
HandlerMapping
's with path matching options. - PathMatchConfigurer() - Constructor for class org.springframework.web.reactive.config.PathMatchConfigurer
- pathPredicates(PathPatternParser) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a function that creates new path-matching
RequestPredicates
from pattern Strings using the givenPathPatternParser
. - PathResourceResolver - Class in org.springframework.web.reactive.resource
-
A simple
ResourceResolver
that tries to find a resource under the given locations matching to the request path. - PathResourceResolver() - Constructor for class org.springframework.web.reactive.resource.PathResourceResolver
- paths(String...) - Method in interface org.springframework.web.reactive.result.method.RequestMappingInfo.Builder
-
Set the path patterns.
- paths(String...) - Static method in class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Create a new
RequestMappingInfo.Builder
with the given paths. - pathVariable(String) - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the path variable with the given name, if present.
- pathVariable(String) - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- PathVariableMapMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolver for
Map
method arguments annotated with@PathVariable
where the annotation does not specify a path variable name. - PathVariableMapMethodArgumentResolver(ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.PathVariableMapMethodArgumentResolver
- PathVariableMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolves method arguments annotated with @
PathVariable
. - PathVariableMethodArgumentResolver(ConfigurableBeanFactory, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.PathVariableMethodArgumentResolver
-
Create a new
PathVariableMethodArgumentResolver
. - pathVariables() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get all path variables for this request.
- pathVariables() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- PatternsRequestCondition - Class in org.springframework.web.reactive.result.condition
-
A logical disjunction (' || ') request condition that matches a request against a set of URL path patterns.
- PatternsRequestCondition(List<PathPattern>) - Constructor for class org.springframework.web.reactive.result.condition.PatternsRequestCondition
-
Creates a new instance with the given URL patterns.
- PatternsRequestCondition(PathPattern...) - Constructor for class org.springframework.web.reactive.result.condition.PatternsRequestCondition
-
Creates a new instance with the given URL patterns.
- permanentRedirect(URI) - Static method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Create a builder with a 308 Permanent Redirect status and a location header set to the given URI.
- PING - Enum constant in enum class org.springframework.web.reactive.socket.WebSocketMessage.Type
-
WebSocket ping.
- pingMessage(Function<DataBufferFactory, DataBuffer>) - Method in class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
- pingMessage(Function<DataBufferFactory, DataBuffer>) - Method in interface org.springframework.web.reactive.socket.WebSocketSession
-
Factory method to create a ping WebSocketMessage using the
WebSocketSession.bufferFactory()
for the session. - POLICY_VIOLATION - Static variable in class org.springframework.web.reactive.socket.CloseStatus
-
"1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy.
- PONG - Enum constant in enum class org.springframework.web.reactive.socket.WebSocketMessage.Type
-
WebSocket pong.
- pongMessage(Function<DataBufferFactory, DataBuffer>) - Method in class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
- pongMessage(Function<DataBufferFactory, DataBuffer>) - Method in interface org.springframework.web.reactive.socket.WebSocketSession
-
Factory method to create a pong WebSocketMessage using the
WebSocketSession.bufferFactory()
for the session. - post() - Method in interface org.springframework.web.reactive.function.client.WebClient
-
Start building an HTTP POST request.
- POST(String) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that matches if request's HTTP method isPOST
and the givenpattern
matches against the request path. - POST(String, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
POST
requests that match the given pattern. - POST(String, RequestPredicate, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
POST
requests that match the given pattern and predicate. - POST(HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles HTTP
POST
requests. - POST(RequestPredicate, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
POST
requests that match the given predicate. - postProcessTemplateLoaders(List<TemplateLoader>) - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerConfigurer
-
This implementation registers an additional ClassTemplateLoader for the Spring-provided macros, added to the end of the list.
- prefix(String) - Method in class org.springframework.web.reactive.config.UrlBasedViewResolverRegistration
-
Set the prefix that gets prepended to view names when building a URL.
- principal() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the authenticated user for the request, if any.
- principal() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- PrincipalMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolves method argument value of type
Principal
. - PrincipalMethodArgumentResolver(ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.PrincipalMethodArgumentResolver
- processAction(ServerWebExchange, String, String) - Method in interface org.springframework.web.reactive.result.view.RequestDataValueProcessor
-
Invoked when a new form action is rendered.
- processFormFieldValue(ServerWebExchange, String, String, String) - Method in interface org.springframework.web.reactive.result.view.RequestDataValueProcessor
-
Invoked when a form field value is rendered.
- processPath(String) - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Process the given resource path.
- processUrl(ServerWebExchange, String) - Method in interface org.springframework.web.reactive.result.view.RequestDataValueProcessor
-
Invoked when a URL is about to be rendered or redirected to.
- produces(String...) - Method in interface org.springframework.web.reactive.result.method.RequestMappingInfo.Builder
-
Set the produces conditions.
- ProducesRequestCondition - Class in org.springframework.web.reactive.result.condition
-
A logical disjunction (' || ') request condition to match a request's 'Accept' header to a list of media type expressions.
- ProducesRequestCondition(String...) - Constructor for class org.springframework.web.reactive.result.condition.ProducesRequestCondition
-
Creates a new instance from "produces" expressions.
- ProducesRequestCondition(String[], String[]) - Constructor for class org.springframework.web.reactive.result.condition.ProducesRequestCondition
-
Creates a new instance with "produces" and "header" expressions.
- ProducesRequestCondition(String[], String[], RequestedContentTypeResolver) - Constructor for class org.springframework.web.reactive.result.condition.ProducesRequestCondition
-
Same as
ProducesRequestCondition(String[], String[])
but also accepting aContentNegotiationManager
. - PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE - Static variable in interface org.springframework.web.reactive.HandlerMapping
-
Name of the
attribute
containing the set of producible MediaType's applicable to the mapped handler. - propagateQuery(boolean) - Method in interface org.springframework.web.reactive.result.view.Rendering.RedirectBuilder
-
Whether to append the query string of the current URL to the target redirect URL or not.
- PROTOCOL_ERROR - Static variable in class org.springframework.web.reactive.socket.CloseStatus
-
"1002 indicates that an endpoint is terminating the connection due to a protocol error."
- put() - Method in interface org.springframework.web.reactive.function.client.WebClient
-
Start building an HTTP PUT request.
- PUT(String) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that matches if request's HTTP method isPUT
and the givenpattern
matches against the request path. - PUT(String, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
PUT
requests that match the given pattern. - PUT(String, RequestPredicate, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
PUT
requests that match the given pattern and predicate. - PUT(HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles HTTP
PUT
requests. - PUT(RequestPredicate, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all HTTP
PUT
requests that match the given predicate.
Q
- queryParam(String) - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the first query parameter with the given name, if present.
- queryParam(String) - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- queryParam(String, String) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that matches if the request's query parameter of the given name has the given value. - queryParam(String, String) - Method in interface org.springframework.web.reactive.function.server.RequestPredicates.Visitor
-
Receive notification of a query parameter predicate.
- queryParam(String, Predicate<String>) - Static method in class org.springframework.web.reactive.function.server.RequestPredicates
-
Return a
RequestPredicate
that tests the request's query parameter of the given name against the given predicate. - queryParams() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get all query parameters for this request.
- queryParams() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
R
- range() - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Headers
-
Get the value of the
Range
header. - range() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper.HeadersWrapper
- rawStatusCode() - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0, in favor of
ClientResponse.statusCode()
- rawStatusCode() - Method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Deprecated.as of 6.0, in favor of
ServerResponse.statusCode()
- rawStatusCode(int) - Method in interface org.springframework.web.reactive.function.client.ClientResponse.Builder
-
Set the raw status code of the response.
- ReactorNetty2RequestUpgradeStrategy - Class in org.springframework.web.reactive.socket.server.upgrade
-
A WebSocket
RequestUpgradeStrategy
for Reactor Netty for Netty 5. - ReactorNetty2RequestUpgradeStrategy() - Constructor for class org.springframework.web.reactive.socket.server.upgrade.ReactorNetty2RequestUpgradeStrategy
-
Create an instances with a default
WebsocketServerSpec.Builder
. - ReactorNetty2RequestUpgradeStrategy(Supplier<WebsocketServerSpec.Builder>) - Constructor for class org.springframework.web.reactive.socket.server.upgrade.ReactorNetty2RequestUpgradeStrategy
-
Create an instance with a pre-configured
WebsocketServerSpec.Builder
to use for WebSocket upgrades. - ReactorNetty2WebSocketClient - Class in org.springframework.web.reactive.socket.client
-
WebSocketClient
implementation for use with Reactor Netty for Netty 5. - ReactorNetty2WebSocketClient() - Constructor for class org.springframework.web.reactive.socket.client.ReactorNetty2WebSocketClient
-
Default constructor.
- ReactorNetty2WebSocketClient(HttpClient) - Constructor for class org.springframework.web.reactive.socket.client.ReactorNetty2WebSocketClient
-
Constructor that accepts an existing
HttpClient
builder with a defaultWebsocketClientSpec.Builder
. - ReactorNetty2WebSocketClient(HttpClient, Supplier<WebsocketClientSpec.Builder>) - Constructor for class org.springframework.web.reactive.socket.client.ReactorNetty2WebSocketClient
-
Constructor that accepts an existing
HttpClient
builder and a pre-configuredWebsocketClientSpec.Builder
. - ReactorNetty2WebSocketSession - Class in org.springframework.web.reactive.socket.adapter
-
WebSocketSession
implementation for use with the Reactor Netty's (Netty 5)NettyInbound
andNettyOutbound
. - ReactorNetty2WebSocketSession(WebsocketInbound, WebsocketOutbound, HandshakeInfo, Netty5DataBufferFactory) - Constructor for class org.springframework.web.reactive.socket.adapter.ReactorNetty2WebSocketSession
-
Constructor for the session, using the
Netty5WebSocketSessionSupport.DEFAULT_FRAME_MAX_SIZE
value. - ReactorNetty2WebSocketSession(WebsocketInbound, WebsocketOutbound, HandshakeInfo, Netty5DataBufferFactory, int) - Constructor for class org.springframework.web.reactive.socket.adapter.ReactorNetty2WebSocketSession
-
Constructor with an additional maxFramePayloadLength argument.
- ReactorNetty2WebSocketSession.WebSocketConnection - Class in org.springframework.web.reactive.socket.adapter
-
Simple container for
NettyInbound
andNettyOutbound
. - ReactorNettyRequestUpgradeStrategy - Class in org.springframework.web.reactive.socket.server.upgrade
-
A WebSocket
RequestUpgradeStrategy
for Reactor Netty. - ReactorNettyRequestUpgradeStrategy() - Constructor for class org.springframework.web.reactive.socket.server.upgrade.ReactorNettyRequestUpgradeStrategy
-
Create an instances with a default
WebsocketServerSpec.Builder
. - ReactorNettyRequestUpgradeStrategy(Supplier<WebsocketServerSpec.Builder>) - Constructor for class org.springframework.web.reactive.socket.server.upgrade.ReactorNettyRequestUpgradeStrategy
-
Create an instance with a pre-configured
WebsocketServerSpec.Builder
to use for WebSocket upgrades. - ReactorNettyWebSocketClient - Class in org.springframework.web.reactive.socket.client
-
WebSocketClient
implementation for use with Reactor Netty. - ReactorNettyWebSocketClient() - Constructor for class org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient
-
Default constructor.
- ReactorNettyWebSocketClient(HttpClient) - Constructor for class org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient
-
Constructor that accepts an existing
HttpClient
builder with a defaultWebsocketClientSpec.Builder
. - ReactorNettyWebSocketClient(HttpClient, Supplier<WebsocketClientSpec.Builder>) - Constructor for class org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient
-
Constructor that accepts an existing
HttpClient
builder and a pre-configuredWebsocketClientSpec.Builder
. - ReactorNettyWebSocketSession - Class in org.springframework.web.reactive.socket.adapter
- ReactorNettyWebSocketSession(WebsocketInbound, WebsocketOutbound, HandshakeInfo, NettyDataBufferFactory) - Constructor for class org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession
-
Constructor for the session, using the
NettyWebSocketSessionSupport.DEFAULT_FRAME_MAX_SIZE
value. - ReactorNettyWebSocketSession(WebsocketInbound, WebsocketOutbound, HandshakeInfo, NettyDataBufferFactory, int) - Constructor for class org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession
-
Constructor with an additional maxFramePayloadLength argument.
- ReactorNettyWebSocketSession.WebSocketConnection - Class in org.springframework.web.reactive.socket.adapter
-
Simple container for
NettyInbound
andNettyOutbound
. - readBody(MethodParameter, boolean, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.AbstractMessageReaderArgumentResolver
-
Read the body from a method argument with
HttpMessageReader
. - readBody(MethodParameter, MethodParameter, boolean, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.AbstractMessageReaderArgumentResolver
-
Read the body from a method argument with
HttpMessageReader
. - receive() - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
- receive() - Method in class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
- receive() - Method in class org.springframework.web.reactive.socket.adapter.ReactorNetty2WebSocketSession
- receive() - Method in class org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession
- receive() - Method in interface org.springframework.web.reactive.socket.WebSocketSession
-
Provides access to the stream of inbound messages.
- REDIRECT_URL_PREFIX - Static variable in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Prefix for special view names that specify a redirect URL (usually to a controller after a form has been submitted and processed).
- redirectTo(String) - Static method in interface org.springframework.web.reactive.result.view.Rendering
-
Create a new builder for a redirect through a
RedirectView
. - RedirectView - Class in org.springframework.web.reactive.result.view
-
View that redirects to an absolute or context relative URL.
- RedirectView() - Constructor for class org.springframework.web.reactive.result.view.RedirectView
-
Constructor for use as a bean.
- RedirectView(String) - Constructor for class org.springframework.web.reactive.result.view.RedirectView
-
Create a new
RedirectView
with the given redirect URL. - RedirectView(String, HttpStatusCode) - Constructor for class org.springframework.web.reactive.result.view.RedirectView
-
Create a new
RedirectView
with the given URL and an alternate redirect status code such asHttpStatus.TEMPORARY_REDIRECT
orHttpStatus.PERMANENT_REDIRECT
. - registerExtension(String, String) - Method in class org.springframework.web.reactive.resource.EncodedResourceResolver
-
Java config friendly alternative to
EncodedResourceResolver.setExtensions(Map)
. - registerHandler(String[], String) - Method in class org.springframework.web.reactive.handler.AbstractUrlHandlerMapping
-
Register the specified handler for the given URL paths.
- registerHandler(String, Object) - Method in class org.springframework.web.reactive.handler.AbstractUrlHandlerMapping
-
Register the specified handler for the given URL path.
- registerHandlerMethod(Object, Method, RequestMappingInfo) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
- registerHandlerMethod(Object, Method, T) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Register a handler method and its unique mapping.
- registerHandlers(Map<String, Object>) - Method in class org.springframework.web.reactive.handler.SimpleUrlHandlerMapping
-
Register all handlers specified in the URL map for the corresponding paths.
- registerHandlers(Map<String, ResourceWebHandler>) - Method in class org.springframework.web.reactive.resource.ResourceUrlProvider
-
Manually configure resource handler mappings.
- registerMapping(RequestMappingInfo, Object, Method) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
- registerMapping(T, Object, Method) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Register the given mapping.
- release() - Method in class org.springframework.web.reactive.socket.WebSocketMessage
-
Release the payload
DataBuffer
which is useful on runtimes (e.g. - releaseBody() - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Release the body of this response.
- releaseBody() - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- remoteAddress() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the remote address to which this request is connected, if available.
- remoteAddress() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- removeVersion(String, String) - Method in class org.springframework.web.reactive.resource.AbstractFileNameVersionStrategy
- removeVersion(String, String) - Method in class org.springframework.web.reactive.resource.AbstractPrefixVersionStrategy
- removeVersion(String, String) - Method in interface org.springframework.web.reactive.resource.VersionStrategy
-
Remove the version from the request path.
- render(String, Object...) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder
-
Render the template with the given
name
using the givenmodelAttributes
. - render(String, Map<String, ?>) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder
-
Render the template with the given
name
using the givenmodel
. - render(Map<String, ?>, MediaType, ServerWebExchange) - Method in class org.springframework.web.reactive.result.view.AbstractView
-
Prepare the model to render.
- render(Map<String, ?>, MediaType, ServerWebExchange) - Method in class org.springframework.web.reactive.result.view.HttpMessageWriterView
- render(Map<String, ?>, MediaType, ServerWebExchange) - Method in interface org.springframework.web.reactive.result.view.View
-
Render the view based on the given
HandlerResult
. - Rendering - Interface in org.springframework.web.reactive.result.view
-
Public API for HTML rendering.
- Rendering.Builder<B extends Rendering.Builder<B>> - Interface in org.springframework.web.reactive.result.view
-
Defines a builder for
Rendering
. - Rendering.RedirectBuilder - Interface in org.springframework.web.reactive.result.view
-
Extends
Rendering.Builder
with extra options for redirect scenarios. - RenderingContext - Class in org.springframework.web.reactive.result.view.script
-
Context passed to
ScriptTemplateView
render function in order to make the application context, the locale, the template loader and the url available on scripting side. - RenderingContext(ApplicationContext, Locale, Function<String, String>, String) - Constructor for class org.springframework.web.reactive.result.view.script.RenderingContext
-
Create a new
RenderingContext
. - RenderingResponse - Interface in org.springframework.web.reactive.function.server
-
Rendering-specific subtype of
ServerResponse
that exposes model and template data. - RenderingResponse.Builder - Interface in org.springframework.web.reactive.function.server
-
Defines a builder for
RenderingResponse
. - renderInternal(Map<String, Object>, MediaType, ServerWebExchange) - Method in class org.springframework.web.reactive.result.view.AbstractView
-
Subclasses must implement this method to actually render the view.
- renderInternal(Map<String, Object>, MediaType, ServerWebExchange) - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
- renderInternal(Map<String, Object>, MediaType, ServerWebExchange) - Method in class org.springframework.web.reactive.result.view.RedirectView
-
Convert model to request parameters and redirect to the given URL.
- renderInternal(Map<String, Object>, MediaType, ServerWebExchange) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
- request() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
-
Return the wrapped request.
- request(HttpRequest) - Method in interface org.springframework.web.reactive.function.client.ClientResponse.Builder
-
Set the request associated with the response.
- REQUEST_ATTRIBUTE - Static variable in class org.springframework.web.reactive.function.server.RouterFunctions
-
Name of the
ServerWebExchange
attribute that contains theServerRequest
. - REQUEST_DATA_VALUE_PROCESSOR_BEAN_NAME - Static variable in class org.springframework.web.reactive.result.view.AbstractView
-
Well-known name for the RequestDataValueProcessor in the bean factory.
- RequestAttributeMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolves method arguments annotated with an @
RequestAttribute
. - RequestAttributeMethodArgumentResolver(ConfigurableBeanFactory, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.RequestAttributeMethodArgumentResolver
-
Create a new
RequestAttributeMethodArgumentResolver
instance. - RequestBodyMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolves method arguments annotated with
@RequestBody
by reading the body of the request through a compatibleHttpMessageReader
. - RequestBodyMethodArgumentResolver(List<HttpMessageReader<?>>, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.RequestBodyMethodArgumentResolver
- RequestCondition<T> - Interface in org.springframework.web.reactive.result.condition
-
Contract for request mapping conditions.
- RequestConditionHolder - Class in org.springframework.web.reactive.result.condition
-
A holder for a
RequestCondition
useful when the type of the request condition is not known ahead of time, e.g. - RequestConditionHolder(RequestCondition<?>) - Constructor for class org.springframework.web.reactive.result.condition.RequestConditionHolder
-
Create a new holder to wrap the given request condition.
- RequestContext - Class in org.springframework.web.reactive.result.view
-
Context holder for request-specific state, like the
MessageSource
to use, current locale, binding errors, etc. - RequestContext(ServerWebExchange, Map<String, Object>, MessageSource) - Constructor for class org.springframework.web.reactive.result.view.RequestContext
- RequestContext(ServerWebExchange, Map<String, Object>, MessageSource, RequestDataValueProcessor) - Constructor for class org.springframework.web.reactive.result.view.RequestContext
- RequestDataValueProcessor - Interface in org.springframework.web.reactive.result.view
-
A contract for inspecting and potentially modifying request data values such as URL query parameters or form field values before they are rendered by a view or before a redirect.
- RequestedContentTypeResolver - Interface in org.springframework.web.reactive.accept
-
Strategy to resolve the requested media types for a
ServerWebExchange
. - RequestedContentTypeResolverBuilder - Class in org.springframework.web.reactive.accept
-
Builder for a composite
RequestedContentTypeResolver
that delegates to other resolvers each implementing a different strategy to determine the requested content type -- e.g. - RequestedContentTypeResolverBuilder() - Constructor for class org.springframework.web.reactive.accept.RequestedContentTypeResolverBuilder
- RequestedContentTypeResolverBuilder.ParameterResolverConfigurer - Class in org.springframework.web.reactive.accept
-
Helper to create and configure
ParameterContentTypeResolver
. - RequestHeaderMapMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolves
Map
method arguments annotated with@RequestHeader
. - RequestHeaderMapMethodArgumentResolver(ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.RequestHeaderMapMethodArgumentResolver
- RequestHeaderMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolves method arguments annotated with
@RequestHeader
except forMap
arguments. - RequestHeaderMethodArgumentResolver(ConfigurableBeanFactory, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.RequestHeaderMethodArgumentResolver
-
Create a new
RequestHeaderMethodArgumentResolver
instance. - requestMappingHandlerAdapter(ReactiveAdapterRegistry, ServerCodecConfigurer, FormattingConversionService, Validator) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- RequestMappingHandlerAdapter - Class in org.springframework.web.reactive.result.method.annotation
-
Supports the invocation of
@RequestMapping
handler methods. - RequestMappingHandlerAdapter() - Constructor for class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
- requestMappingHandlerMapping(RequestedContentTypeResolver) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- RequestMappingHandlerMapping - Class in org.springframework.web.reactive.result.method.annotation
-
An extension of
RequestMappingInfoHandlerMapping
that createsRequestMappingInfo
instances from class-level and method-level@RequestMapping
annotations. - RequestMappingHandlerMapping() - Constructor for class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
- RequestMappingInfo - Class in org.springframework.web.reactive.result.method
-
Request mapping information.
- RequestMappingInfo(String, PatternsRequestCondition, RequestMethodsRequestCondition, ParamsRequestCondition, HeadersRequestCondition, ConsumesRequestCondition, ProducesRequestCondition, RequestCondition<?>) - Constructor for class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Deprecated.as of 5.3.4 in favor using
RequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
. - RequestMappingInfo(PatternsRequestCondition, RequestMethodsRequestCondition, ParamsRequestCondition, HeadersRequestCondition, ConsumesRequestCondition, ProducesRequestCondition, RequestCondition<?>) - Constructor for class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Deprecated.as of 5.3.4 in favor using
RequestMappingInfo.Builder
viaRequestMappingInfo.paths(String...)
. - RequestMappingInfo(RequestMappingInfo, RequestCondition<?>) - Constructor for class org.springframework.web.reactive.result.method.RequestMappingInfo
-
Deprecated.since 5.3.4 in favor of using a
RequestMappingInfo.Builder
viaRequestMappingInfo.mutate()
. - RequestMappingInfo.Builder - Interface in org.springframework.web.reactive.result.method
-
Defines a builder for creating a RequestMappingInfo.
- RequestMappingInfo.BuilderConfiguration - Class in org.springframework.web.reactive.result.method
-
Container for configuration options used for request mapping purposes.
- RequestMappingInfoHandlerMapping - Class in org.springframework.web.reactive.result.method
-
Abstract base class for classes for which
RequestMappingInfo
defines the mapping between a request and a handler method. - RequestMappingInfoHandlerMapping() - Constructor for class org.springframework.web.reactive.result.method.RequestMappingInfoHandlerMapping
- RequestMethodsRequestCondition - Class in org.springframework.web.reactive.result.condition
-
A logical disjunction (' || ') request condition that matches a request against a set of
RequestMethods
. - RequestMethodsRequestCondition(RequestMethod...) - Constructor for class org.springframework.web.reactive.result.condition.RequestMethodsRequestCondition
-
Create a new instance with the given request methods.
- RequestParamMapMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolver for
Map
method arguments annotated with@RequestParam
where the annotation does not specify a request parameter name. - RequestParamMapMethodArgumentResolver(ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.RequestParamMapMethodArgumentResolver
- RequestParamMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolver for method arguments annotated with @
RequestParam
from URI query string parameters. - RequestParamMethodArgumentResolver(ConfigurableBeanFactory, ReactiveAdapterRegistry, boolean) - Constructor for class org.springframework.web.reactive.result.method.annotation.RequestParamMethodArgumentResolver
-
Class constructor with a default resolution mode flag.
- RequestPartMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolver for
@RequestPart
arguments where the named part is decoded much like an@RequestBody
argument but based on the content of an individual part instead. - RequestPartMethodArgumentResolver(List<HttpMessageReader<?>>, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.RequestPartMethodArgumentResolver
- requestPath() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the request path as a
PathContainer
. - requestPath() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- RequestPredicate - Interface in org.springframework.web.reactive.function.server
-
Represents a function that evaluates on a given
ServerRequest
. - RequestPredicates - Class in org.springframework.web.reactive.function.server
-
Implementations of
RequestPredicate
that implement various useful request matching operations, such as matching based on path, HTTP method, etc. - RequestPredicates() - Constructor for class org.springframework.web.reactive.function.server.RequestPredicates
- RequestPredicates.Visitor - Interface in org.springframework.web.reactive.function.server
-
Receives notifications from the logical structure of request predicates.
- requestToBodilessEntity(HttpRequestValues) - Method in class org.springframework.web.reactive.function.client.support.WebClientAdapter
- requestToBody(HttpRequestValues, ParameterizedTypeReference<T>) - Method in class org.springframework.web.reactive.function.client.support.WebClientAdapter
- requestToBodyFlux(HttpRequestValues, ParameterizedTypeReference<T>) - Method in class org.springframework.web.reactive.function.client.support.WebClientAdapter
- requestToEntity(HttpRequestValues, ParameterizedTypeReference<T>) - Method in class org.springframework.web.reactive.function.client.support.WebClientAdapter
- requestToEntityFlux(HttpRequestValues, ParameterizedTypeReference<T>) - Method in class org.springframework.web.reactive.function.client.support.WebClientAdapter
- requestToHeaders(HttpRequestValues) - Method in class org.springframework.web.reactive.function.client.support.WebClientAdapter
- requestToVoid(HttpRequestValues) - Method in class org.springframework.web.reactive.function.client.support.WebClientAdapter
- RequestUpgradeStrategy - Interface in org.springframework.web.reactive.socket.server
-
A strategy for upgrading an HTTP request to a WebSocket session depending on the underlying network runtime.
- REQUIRED_EXTENSION - Static variable in class org.springframework.web.reactive.socket.CloseStatus
-
"1010 indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake.
- requiredViewClass() - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerViewResolver
-
Requires
FreeMarkerView
. - requiredViewClass() - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateViewResolver
- requiredViewClass() - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Return the required type of view for this resolver.
- resolveArgument(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver
- resolveArgument(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver
- resolveArgument(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ContinuationHandlerMethodArgumentResolver
- resolveArgument(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ErrorsMethodArgumentResolver
- resolveArgument(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.HttpEntityMethodArgumentResolver
- resolveArgument(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ModelAttributeMethodArgumentResolver
- resolveArgument(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.PrincipalMethodArgumentResolver
- resolveArgument(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.RequestBodyMethodArgumentResolver
- resolveArgument(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.RequestPartMethodArgumentResolver
- resolveArgument(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.WebSessionMethodArgumentResolver
- resolveArgument(MethodParameter, BindingContext, ServerWebExchange) - Method in interface org.springframework.web.reactive.result.method.HandlerMethodArgumentResolver
-
Resolve the value for the method parameter.
- resolveArgument(MethodParameter, BindingContext, ServerWebExchange) - Method in interface org.springframework.web.reactive.result.method.SyncHandlerMethodArgumentResolver
-
Resolve the value for the method parameter.
- resolveArgumentValue(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver
- resolveArgumentValue(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.MatrixVariableMapMethodArgumentResolver
- resolveArgumentValue(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ModelMethodArgumentResolver
- resolveArgumentValue(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.PathVariableMapMethodArgumentResolver
- resolveArgumentValue(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.RequestHeaderMapMethodArgumentResolver
- resolveArgumentValue(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.RequestParamMapMethodArgumentResolver
- resolveArgumentValue(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ServerWebExchangeMethodArgumentResolver
- resolveArgumentValue(MethodParameter, BindingContext, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.SessionStatusMethodArgumentResolver
- resolveArgumentValue(MethodParameter, BindingContext, ServerWebExchange) - Method in interface org.springframework.web.reactive.result.method.SyncHandlerMethodArgumentResolver
-
Resolve the value for the method parameter synchronously.
- resolveAsyncAttributes(Map<String, Object>, ServerWebExchange) - Method in class org.springframework.web.reactive.result.view.AbstractView
-
Use the configured
ReactiveAdapterRegistry
to adapt asynchronous attributes toMono<T>
orMono<List<T>>
and then wait to resolve them into actual values. - RESOLVED_RESOURCE_CACHE_KEY_PREFIX - Static variable in class org.springframework.web.reactive.resource.CachingResourceResolver
-
The prefix used for resolved resource cache keys.
- RESOLVED_URL_PATH_CACHE_KEY_PREFIX - Static variable in class org.springframework.web.reactive.resource.CachingResourceResolver
-
The prefix used for resolved URL path cache keys.
- resolveEmbeddedValuesInPatterns(String[]) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
-
Resolve placeholder values in the given array of patterns.
- resolveMediaTypes(ServerWebExchange) - Method in class org.springframework.web.reactive.accept.FixedContentTypeResolver
- resolveMediaTypes(ServerWebExchange) - Method in class org.springframework.web.reactive.accept.HeaderContentTypeResolver
- resolveMediaTypes(ServerWebExchange) - Method in class org.springframework.web.reactive.accept.ParameterContentTypeResolver
- resolveMediaTypes(ServerWebExchange) - Method in interface org.springframework.web.reactive.accept.RequestedContentTypeResolver
-
Resolve the given request to a list of requested media types.
- resolveName(String, MethodParameter, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver
-
Resolve the given parameter type and value name into an argument value.
- resolveName(String, MethodParameter, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver
- resolveName(String, MethodParameter, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.SessionAttributeMethodArgumentResolver
- resolveNamedValue(String, MethodParameter, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver
-
Actually resolve the value synchronously.
- resolveNamedValue(String, MethodParameter, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.CookieValueMethodArgumentResolver
- resolveNamedValue(String, MethodParameter, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.ExpressionValueMethodArgumentResolver
- resolveNamedValue(String, MethodParameter, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.MatrixVariableMethodArgumentResolver
- resolveNamedValue(String, MethodParameter, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.PathVariableMethodArgumentResolver
- resolveNamedValue(String, MethodParameter, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.RequestAttributeMethodArgumentResolver
- resolveNamedValue(String, MethodParameter, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.RequestHeaderMethodArgumentResolver
- resolveNamedValue(String, MethodParameter, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.RequestParamMethodArgumentResolver
- resolver(RequestedContentTypeResolver) - Method in class org.springframework.web.reactive.accept.RequestedContentTypeResolverBuilder
-
Add a custom resolver.
- resolveResource(ServerWebExchange, String, List<? extends Resource>) - Method in interface org.springframework.web.reactive.resource.ResourceResolverChain
-
Resolve the supplied request and request path to a
Resource
that exists under one of the given resource locations. - resolveResource(ServerWebExchange, String, List<? extends Resource>, ResourceResolverChain) - Method in class org.springframework.web.reactive.resource.AbstractResourceResolver
- resolveResource(ServerWebExchange, String, List<? extends Resource>, ResourceResolverChain) - Method in interface org.springframework.web.reactive.resource.ResourceResolver
-
Resolve the supplied request and request path to a
Resource
that exists under one of the given resource locations. - resolveResourceInternal(ServerWebExchange, String, List<? extends Resource>, ResourceResolverChain) - Method in class org.springframework.web.reactive.resource.AbstractResourceResolver
- resolveResourceInternal(ServerWebExchange, String, List<? extends Resource>, ResourceResolverChain) - Method in class org.springframework.web.reactive.resource.CachingResourceResolver
- resolveResourceInternal(ServerWebExchange, String, List<? extends Resource>, ResourceResolverChain) - Method in class org.springframework.web.reactive.resource.EncodedResourceResolver
- resolveResourceInternal(ServerWebExchange, String, List<? extends Resource>, ResourceResolverChain) - Method in class org.springframework.web.reactive.resource.PathResourceResolver
- resolveResourceInternal(ServerWebExchange, String, List<? extends Resource>, ResourceResolverChain) - Method in class org.springframework.web.reactive.resource.VersionResourceResolver
- resolveResourceInternal(ServerWebExchange, String, List<? extends Resource>, ResourceResolverChain) - Method in class org.springframework.web.reactive.resource.WebJarsResourceResolver
- resolveUrlPath(String, List<? extends Resource>) - Method in interface org.springframework.web.reactive.resource.ResourceResolverChain
-
Resolve the externally facing public URL path for clients to use to access the resource that is located at the given internal resource path.
- resolveUrlPath(String, List<? extends Resource>, ResourceResolverChain) - Method in class org.springframework.web.reactive.resource.AbstractResourceResolver
- resolveUrlPath(String, List<? extends Resource>, ResourceResolverChain) - Method in interface org.springframework.web.reactive.resource.ResourceResolver
-
Resolve the externally facing public URL path for clients to use to access the resource that is located at the given internal resource path.
- resolveUrlPath(String, ServerWebExchange, Resource, ResourceTransformerChain) - Method in class org.springframework.web.reactive.resource.ResourceTransformerSupport
-
A transformer can use this method when a resource being transformed contains links to other resources.
- resolveUrlPathInternal(String, List<? extends Resource>, ResourceResolverChain) - Method in class org.springframework.web.reactive.resource.AbstractResourceResolver
- resolveUrlPathInternal(String, List<? extends Resource>, ResourceResolverChain) - Method in class org.springframework.web.reactive.resource.CachingResourceResolver
- resolveUrlPathInternal(String, List<? extends Resource>, ResourceResolverChain) - Method in class org.springframework.web.reactive.resource.EncodedResourceResolver
- resolveUrlPathInternal(String, List<? extends Resource>, ResourceResolverChain) - Method in class org.springframework.web.reactive.resource.PathResourceResolver
- resolveUrlPathInternal(String, List<? extends Resource>, ResourceResolverChain) - Method in class org.springframework.web.reactive.resource.VersionResourceResolver
- resolveUrlPathInternal(String, List<? extends Resource>, ResourceResolverChain) - Method in class org.springframework.web.reactive.resource.WebJarsResourceResolver
- resolveViewName(String, Locale) - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
- resolveViewName(String, Locale) - Method in interface org.springframework.web.reactive.result.view.ViewResolver
-
Resolve the view name to a View instance.
- resourceChain(boolean) - Method in class org.springframework.web.reactive.config.ResourceHandlerRegistration
-
Configure a chain of resource resolvers and transformers to use.
- resourceChain(boolean, Cache) - Method in class org.springframework.web.reactive.config.ResourceHandlerRegistration
-
Configure a chain of resource resolvers and transformers to use.
- ResourceChainRegistration - Class in org.springframework.web.reactive.config
-
Assists with the registration of resource resolvers and transformers.
- ResourceChainRegistration(boolean) - Constructor for class org.springframework.web.reactive.config.ResourceChainRegistration
- ResourceChainRegistration(boolean, Cache) - Constructor for class org.springframework.web.reactive.config.ResourceChainRegistration
- resourceHandlerMapping(ResourceUrlProvider) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Return a handler mapping ordered at Integer.MAX_VALUE-1 with mapped resource handlers.
- ResourceHandlerRegistration - Class in org.springframework.web.reactive.config
-
Assist with creating and configuring a static resources handler.
- ResourceHandlerRegistration(ResourceLoader, String...) - Constructor for class org.springframework.web.reactive.config.ResourceHandlerRegistration
-
Create a
ResourceHandlerRegistration
instance. - ResourceHandlerRegistry - Class in org.springframework.web.reactive.config
-
Stores registrations of resource handlers for serving static resources such as images, css files and others through Spring WebFlux including setting cache headers optimized for efficient loading in a web browser.
- ResourceHandlerRegistry(ResourceLoader) - Constructor for class org.springframework.web.reactive.config.ResourceHandlerRegistry
-
Create a new resource handler registry for the given resource loader (typically an application context).
- resourceLookupFunction(String, Resource) - Static method in class org.springframework.web.reactive.function.server.RouterFunctions
-
Returns the resource lookup function used by
RouterFunctions.resources(String, Resource)
. - ResourceResolver - Interface in org.springframework.web.reactive.resource
-
A strategy for resolving a request to a server-side resource.
- ResourceResolverChain - Interface in org.springframework.web.reactive.resource
-
A contract for invoking a chain of
ResourceResolvers
where each resolver is given a reference to the chain allowing it to delegate when necessary. - resources(String, Resource) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Route requests that match the given pattern to resources relative to the given root location.
- resources(String, Resource) - Static method in class org.springframework.web.reactive.function.server.RouterFunctions
-
Route requests that match the given pattern to resources relative to the given root location.
- resources(Function<ServerRequest, Mono<Resource>>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Route to resources using the provided lookup function.
- resources(Function<ServerRequest, Mono<Resource>>) - Static method in class org.springframework.web.reactive.function.server.RouterFunctions
-
Route to resources using the provided lookup function.
- resources(Function<ServerRequest, Mono<Resource>>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Visitor
-
Receive notification of a resource router function.
- ResourceTransformer - Interface in org.springframework.web.reactive.resource
-
An abstraction for transforming the content of a resource.
- ResourceTransformerChain - Interface in org.springframework.web.reactive.resource
-
A contract for invoking a chain of
ResourceTransformers
where each resolver is given a reference to the chain allowing it to delegate when necessary. - ResourceTransformerSupport - Class in org.springframework.web.reactive.resource
-
A base class for a
ResourceTransformer
with an optional helper method for resolving public links within a transformed resource. - ResourceTransformerSupport() - Constructor for class org.springframework.web.reactive.resource.ResourceTransformerSupport
- resourceUrlProvider() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- ResourceUrlProvider - Class in org.springframework.web.reactive.resource
-
A central component to use to obtain the public URL path that clients should use to access a static resource.
- ResourceUrlProvider() - Constructor for class org.springframework.web.reactive.resource.ResourceUrlProvider
- ResourceWebHandler - Class in org.springframework.web.reactive.resource
-
HttpRequestHandler
that serves static resources in an optimized way according to the guidelines of Page Speed, YSlow, etc. - ResourceWebHandler() - Constructor for class org.springframework.web.reactive.resource.ResourceWebHandler
- response() - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
-
Return the wrapped request.
- responseBodyResultHandler(ReactiveAdapterRegistry, ServerCodecConfigurer, RequestedContentTypeResolver) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- ResponseBodyResultHandler - Class in org.springframework.web.reactive.result.method.annotation
-
HandlerResultHandler
that handles return values from methods annotated with@ResponseBody
writing to the body of the request or response with anHttpMessageWriter
. - ResponseBodyResultHandler(List<HttpMessageWriter<?>>, RequestedContentTypeResolver) - Constructor for class org.springframework.web.reactive.result.method.annotation.ResponseBodyResultHandler
-
Basic constructor with a default
ReactiveAdapterRegistry
. - ResponseBodyResultHandler(List<HttpMessageWriter<?>>, RequestedContentTypeResolver, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.ResponseBodyResultHandler
-
Constructor with an
ReactiveAdapterRegistry
instance. - ResponseEntityExceptionHandler - Class in org.springframework.web.reactive.result.method.annotation
-
A class with an
@ExceptionHandler
method that handles all Spring WebFlux raised exceptions by returning aResponseEntity
with RFC 7807 formatted error details in the body. - ResponseEntityExceptionHandler() - Constructor for class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
- responseEntityResultHandler(ReactiveAdapterRegistry, ServerCodecConfigurer, RequestedContentTypeResolver) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- ResponseEntityResultHandler - Class in org.springframework.web.reactive.result.method.annotation
-
Handles return values of type
HttpEntity
,ResponseEntity
,HttpHeaders
,ErrorResponse
, andProblemDetail
. - ResponseEntityResultHandler(List<HttpMessageWriter<?>>, RequestedContentTypeResolver) - Constructor for class org.springframework.web.reactive.result.method.annotation.ResponseEntityResultHandler
-
Basic constructor with a default
ReactiveAdapterRegistry
. - ResponseEntityResultHandler(List<HttpMessageWriter<?>>, RequestedContentTypeResolver, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.ResponseEntityResultHandler
-
Constructor with an
ReactiveAdapterRegistry
instance. - responseStatusExceptionHandler() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- resumeReceiving() - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
-
Resume receiving new message(s) after demand is generated by the downstream Subscriber.
- resumeReceiving() - Method in class org.springframework.web.reactive.socket.adapter.JettyWebSocketSession
- resumeReceiving() - Method in class org.springframework.web.reactive.socket.adapter.StandardWebSocketSession
- resumeReceiving() - Method in class org.springframework.web.reactive.socket.adapter.TomcatWebSocketSession
- resumeReceiving() - Method in class org.springframework.web.reactive.socket.adapter.UndertowWebSocketSession
- retain() - Method in class org.springframework.web.reactive.socket.WebSocketMessage
-
Retain the data buffer for the message payload, which is useful on runtimes (e.g.
- retrieve() - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec
-
Proceed to declare how to extract the response.
- route() - Static method in class org.springframework.web.reactive.function.server.RouterFunctions
-
Offers a discoverable way to create router functions through a builder-style interface.
- route(RequestPredicate, HandlerFunction<?>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Visitor
-
Receive notification of a standard predicated route to a handler function.
- route(RequestPredicate, HandlerFunction<ServerResponse>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Adds a route to the given handler function that handles all requests that match the given predicate.
- route(RequestPredicate, HandlerFunction<T>) - Static method in class org.springframework.web.reactive.function.server.RouterFunctions
-
Route to the given handler function if the given request predicate applies.
- route(ServerRequest) - Method in interface org.springframework.web.reactive.function.server.RouterFunction
-
Return the handler function that matches the given request.
- RouterFunction<T extends ServerResponse> - Interface in org.springframework.web.reactive.function.server
-
Represents a function that routes to a handler function.
- routerFunctionMapping(ServerCodecConfigurer) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- RouterFunctionMapping - Class in org.springframework.web.reactive.function.server.support
-
HandlerMapping
implementation that supportsRouterFunctions
. - RouterFunctionMapping() - Constructor for class org.springframework.web.reactive.function.server.support.RouterFunctionMapping
-
Create an empty
RouterFunctionMapping
. - RouterFunctionMapping(RouterFunction<?>) - Constructor for class org.springframework.web.reactive.function.server.support.RouterFunctionMapping
-
Create a
RouterFunctionMapping
with the givenRouterFunction
. - RouterFunctions - Class in org.springframework.web.reactive.function.server
-
Central entry point to Spring's functional web framework. Exposes routing functionality, such as to create a
RouterFunction
using a discoverable builder-style API, to create aRouterFunction
given aRequestPredicate
andHandlerFunction
, and to do further subrouting on an existing routing function. - RouterFunctions() - Constructor for class org.springframework.web.reactive.function.server.RouterFunctions
- RouterFunctions.Builder - Interface in org.springframework.web.reactive.function.server
-
Represents a discoverable builder for router functions.
- RouterFunctions.Visitor - Interface in org.springframework.web.reactive.function.server
-
Receives notifications from the logical structure of router functions.
S
- scriptTemplate() - Method in class org.springframework.web.reactive.config.ViewResolverRegistry
-
Register a script template view resolver with an empty default view name prefix and suffix.
- ScriptTemplateConfig - Interface in org.springframework.web.reactive.result.view.script
-
Interface to be implemented by objects that configure and manage a JSR-223
ScriptEngine
for automatic lookup in a web environment. - ScriptTemplateConfigurer - Class in org.springframework.web.reactive.result.view.script
-
An implementation of the Spring WebFlux
ScriptTemplateConfig
for creating aScriptEngine
for use in a web application. - ScriptTemplateConfigurer() - Constructor for class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
-
Default constructor.
- ScriptTemplateConfigurer(String) - Constructor for class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
-
Create a new ScriptTemplateConfigurer using the given engine name.
- ScriptTemplateView - Class in org.springframework.web.reactive.result.view.script
-
An
AbstractUrlBasedView
subclass designed to run any template library based on a JSR-223 script engine. - ScriptTemplateView() - Constructor for class org.springframework.web.reactive.result.view.script.ScriptTemplateView
-
Constructor for use as a bean.
- ScriptTemplateView(String) - Constructor for class org.springframework.web.reactive.result.view.script.ScriptTemplateView
-
Create a new ScriptTemplateView with the given URL.
- ScriptTemplateViewResolver - Class in org.springframework.web.reactive.result.view.script
-
Convenience subclass of
UrlBasedViewResolver
that supportsScriptTemplateView
and custom subclasses of it. - ScriptTemplateViewResolver() - Constructor for class org.springframework.web.reactive.result.view.script.ScriptTemplateViewResolver
-
Sets the default
view class
toScriptTemplateViewResolver.requiredViewClass()
: by defaultScriptTemplateView
. - ScriptTemplateViewResolver(String, String) - Constructor for class org.springframework.web.reactive.result.view.script.ScriptTemplateViewResolver
- seeOther(URI) - Static method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Create a builder with a 303 See Other status and a location header set to the given URI.
- selectMediaType(ServerWebExchange, Supplier<List<MediaType>>) - Method in class org.springframework.web.reactive.result.HandlerResultHandlerSupport
-
Select the best media type for the current request through a content negotiation algorithm.
- selectMediaType(ServerWebExchange, Supplier<List<MediaType>>, List<MediaType>) - Method in class org.springframework.web.reactive.result.HandlerResultHandlerSupport
-
Variant of
HandlerResultHandlerSupport.selectMediaType(ServerWebExchange, Supplier)
with a given list of requested (acceptable) media types. - send(Publisher<WebSocketMessage>) - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
- send(Publisher<WebSocketMessage>) - Method in class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
- send(Publisher<WebSocketMessage>) - Method in class org.springframework.web.reactive.socket.adapter.ReactorNetty2WebSocketSession
- send(Publisher<WebSocketMessage>) - Method in class org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession
- send(Publisher<WebSocketMessage>) - Method in interface org.springframework.web.reactive.socket.WebSocketSession
-
Give a source of outgoing messages, write the messages and return a
Mono<Void>
that completes when the source completes and writing is done. - sendMessage(WebSocketMessage) - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
-
Send the given WebSocket message.
- sendMessage(WebSocketMessage) - Method in class org.springframework.web.reactive.socket.adapter.JettyWebSocketSession
- sendMessage(WebSocketMessage) - Method in class org.springframework.web.reactive.socket.adapter.StandardWebSocketSession
- sendMessage(WebSocketMessage) - Method in class org.springframework.web.reactive.socket.adapter.UndertowWebSocketSession
- sendRedirect(String, ServerWebExchange) - Method in class org.springframework.web.reactive.result.view.RedirectView
-
Send a redirect back to the HTTP client.
- SERVER_ERROR - Static variable in class org.springframework.web.reactive.socket.CloseStatus
-
"1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request."
- serverCodecConfigurer() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Return the configurer for HTTP message readers and writers.
- serverRequest() - Method in interface org.springframework.web.reactive.function.BodyInserter.Context
-
Optionally return the
ServerHttpRequest
, if present. - ServerRequest - Interface in org.springframework.web.reactive.function.server
-
Represents a server-side HTTP request, as handled by a
HandlerFunction
. - ServerRequest.Builder - Interface in org.springframework.web.reactive.function.server
-
Defines a builder for a request.
- ServerRequest.Headers - Interface in org.springframework.web.reactive.function.server
-
Represents the headers of the HTTP request.
- ServerRequestWrapper - Class in org.springframework.web.reactive.function.server.support
-
Implementation of the
ServerRequest
interface that can be subclassed to adapt the request in ahandler filter function
. - ServerRequestWrapper(ServerRequest) - Constructor for class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
-
Create a new
ServerRequestWrapper
that wraps the given request. - ServerRequestWrapper.HeadersWrapper - Class in org.springframework.web.reactive.function.server.support
-
Implementation of the
Headers
interface that can be subclassed to adapt the headers in ahandler filter function
. - serverResponse() - Method in interface org.springframework.web.reactive.function.BodyExtractor.Context
-
Optionally return the
ServerHttpResponse
, if present. - ServerResponse - Interface in org.springframework.web.reactive.function.server
-
Represents a typed server-side HTTP response, as returned by a handler function or filter function.
- ServerResponse.BodyBuilder - Interface in org.springframework.web.reactive.function.server
-
Defines a builder that adds a body to the response.
- ServerResponse.Context - Interface in org.springframework.web.reactive.function.server
-
Defines the context used during the
ServerResponse.writeTo(ServerWebExchange, Context)
. - ServerResponse.HeadersBuilder<B extends ServerResponse.HeadersBuilder<B>> - Interface in org.springframework.web.reactive.function.server
-
Defines a builder that adds headers to the response.
- serverResponseResultHandler(ServerCodecConfigurer) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- ServerResponseResultHandler - Class in org.springframework.web.reactive.function.server.support
-
HandlerResultHandler
implementation that supportsServerResponses
. - ServerResponseResultHandler() - Constructor for class org.springframework.web.reactive.function.server.support.ServerResponseResultHandler
- ServerWebExchangeMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
- ServerWebExchangeMethodArgumentResolver(ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.ServerWebExchangeMethodArgumentResolver
- SERVICE_OVERLOAD - Static variable in class org.springframework.web.reactive.socket.CloseStatus
-
"1013 indicates that the service is experiencing overload.
- SERVICE_RESTARTED - Static variable in class org.springframework.web.reactive.socket.CloseStatus
-
"1012 indicates that the service is restarted.
- session() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the web session for this request.
- session() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- SessionAttributeMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolves method arguments annotated with an @
SessionAttribute
. - SessionAttributeMethodArgumentResolver(ConfigurableBeanFactory, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.SessionAttributeMethodArgumentResolver
- SessionStatusMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolver for a
SessionStatus
argument obtaining it from theBindingContext
. - SessionStatusMethodArgumentResolver() - Constructor for class org.springframework.web.reactive.result.method.annotation.SessionStatusMethodArgumentResolver
- setAllowedLocations(Resource...) - Method in class org.springframework.web.reactive.resource.PathResourceResolver
-
By default, when a Resource is found, the path of the resolved resource is compared to ensure it's under the input location where it was found.
- setApplicationContext(ApplicationContext) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- setApplicationContext(ApplicationContext) - Method in class org.springframework.web.reactive.DispatcherHandler
- setApplicationContext(ApplicationContext) - Method in class org.springframework.web.reactive.resource.ResourceUrlProvider
- setApplicationContext(ApplicationContext) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
-
A
ConfigurableApplicationContext
is expected for resolving expressions in method argument default values as well as for detecting@ControllerAdvice
beans. - setApplicationContext(ApplicationContext) - Method in class org.springframework.web.reactive.result.view.AbstractView
- setApplicationContext(ApplicationContext) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
- setApplicationContext(ApplicationContext) - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Accept the containing
ApplicationContext
, if any. - setArgumentResolverConfigurer(ArgumentResolverConfigurer) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
-
Configure resolvers for controller method arguments.
- setArgumentResolvers(List<? extends HandlerMethodArgumentResolver>) - Method in class org.springframework.web.reactive.result.method.InvocableHandlerMethod
-
Configure the argument resolvers to use for resolving method argument values against a
ServerWebExchange
. - setArgumentResolvers(List<SyncHandlerMethodArgumentResolver>) - Method in class org.springframework.web.reactive.result.method.SyncInvocableHandlerMethod
-
Configure the argument resolvers to use for resolving method argument values against a
ServerWebExchange
. - setAsyncSendTimeout(Long) - Method in class org.springframework.web.reactive.socket.server.upgrade.StandardWebSocketUpgradeStrategy
-
Exposes the underlying config option on
WebSocketContainer.setAsyncSendTimeout(long)
. - setBeanName(String) - Method in class org.springframework.web.reactive.handler.AbstractHandlerMapping
- setBeanName(String) - Method in class org.springframework.web.reactive.result.view.AbstractView
-
Set the view's name.
- setBodyDecodeFunction(Function<ResolvableType, ?>) - Method in exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Provide a function to find a decoder the given target type.
- setBodyRequired(boolean) - Method in class org.springframework.web.reactive.result.condition.ConsumesRequestCondition
-
Whether this condition should expect requests to have a body.
- setByteBufferPool(ByteBufferPool) - Method in class org.springframework.web.reactive.socket.client.UndertowWebSocketClient
-
Set the
ByteBufferPool
to pass toWebSocketClient.connectionBuilder(org.xnio.XnioWorker, io.undertow.connector.ByteBufferPool, java.net.URI)
. - setCacheControl(CacheControl) - Method in class org.springframework.web.reactive.config.ResourceHandlerRegistration
-
Specify the
CacheControl
which should be used by the resource handler. - setCacheControl(CacheControl) - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Set the
CacheControl
instance to build the Cache-Control HTTP response header. - setCharset(Charset) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
-
Set the charset used to read script and template files.
- setConfiguration(Configuration) - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerConfigurer
-
Set a pre-configured Configuration to use for the FreeMarker web config, e.g.
- setConfiguration(Configuration) - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
-
Set the FreeMarker
Configuration
to be used by this view. - setConfigurers(List<WebFluxConfigurer>) - Method in class org.springframework.web.reactive.config.DelegatingWebFluxConfiguration
- setContentCodings(List<String>) - Method in class org.springframework.web.reactive.resource.CachingResourceResolver
-
Configure the supported content codings from the "Accept-Encoding" header for which to cache resource variations.
- setContentCodings(List<String>) - Method in class org.springframework.web.reactive.resource.EncodedResourceResolver
-
Configure the supported content codings in order of preference.
- setContentTypeResolver(RequestedContentTypeResolver) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
-
Set the
RequestedContentTypeResolver
to use to determine requested media types. - setContentTypeResolver(RequestedContentTypeResolver) - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo.BuilderConfiguration
-
Set the ContentNegotiationManager to use for the ProducesRequestCondition.
- setContextRelative(boolean) - Method in class org.springframework.web.reactive.result.view.RedirectView
-
Whether to interpret a given redirect URL that starts with a slash ("/") as relative to the current context path (
true
, the default) or relative to the web server root (false
). - setCorsConfigurations(Map<String, CorsConfiguration>) - Method in class org.springframework.web.reactive.handler.AbstractHandlerMapping
-
Set the "global" CORS configurations based on URL patterns.
- setCorsConfigurationSource(CorsConfigurationSource) - Method in class org.springframework.web.reactive.handler.AbstractHandlerMapping
-
Set the "global" CORS configuration source.
- setCorsProcessor(CorsProcessor) - Method in class org.springframework.web.reactive.handler.AbstractHandlerMapping
-
Configure a custom
CorsProcessor
to use to apply the matchedCorsConfiguration
for a request. - setDefaultCharset(Charset) - Method in class org.springframework.web.reactive.result.view.AbstractView
-
Set the default charset for this view, used when the content type does not contain one.
- setDefaultCharset(Charset) - Method in class org.springframework.web.reactive.result.view.ViewResolverSupport
-
Set the default charset for this view, used when the content type does not contain one.
- setDefaultHtmlEscape(boolean) - Method in class org.springframework.web.reactive.result.view.RequestContext
-
(De)activate default HTML escaping for messages and errors, for the scope of this RequestContext.
- setDefaultViews(List<View>) - Method in class org.springframework.web.reactive.result.view.ViewResolutionResultHandler
-
Set the default views to consider always when resolving view names and trying to satisfy the best matching content type.
- setEmbeddedValueResolver(StringValueResolver) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
- setEncoding(String) - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
-
Set the encoding of the FreeMarker template file.
- setEngine(ScriptEngine) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
-
Set the
ScriptEngine
to use by the view. - setEngine(ScriptEngine) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
-
See
ScriptTemplateConfigurer.setEngine(ScriptEngine)
documentation. - setEngineName(String) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
-
Set the engine name that will be used to instantiate the
ScriptEngine
. - setEngineName(String) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
-
See
ScriptTemplateConfigurer.setEngineName(String)
documentation. - setEngineSupplier(Supplier<ScriptEngine>) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
-
Set the
ScriptEngine
supplier to use by the view, usually used withScriptTemplateConfigurer.setSharedEngine(Boolean)
set tofalse
. - setEngineSupplier(Supplier<ScriptEngine>) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
-
See
ScriptTemplateConfigurer.setEngineSupplier(Supplier)
documentation. - setExceptionHandler(Function<Throwable, Mono<HandlerResult>>) - Method in class org.springframework.web.reactive.HandlerResult
-
Deprecated, for removal: This API element is subject to removal in a future version.
- setExceptionHandler(DispatchExceptionHandler) - Method in class org.springframework.web.reactive.HandlerResult
-
HandlerAdapter
classes can set this to have their exception handling mechanism applied to response rendering and to deferred exceptions when invoking a handler with an asynchronous return value. - setExposeSpringMacroHelpers(boolean) - Method in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
-
Set whether to expose a
RequestContext
for use by Spring's macro library, under the name "springMacroRequestContext". - setExtensions(Map<String, String>) - Method in class org.springframework.web.reactive.resource.EncodedResourceResolver
-
Configure mappings from content codings to file extensions.
- setHandlePing(boolean) - Method in class org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient
-
Deprecated.as of 5.3 in favor of providing a supplier of
WebsocketClientSpec.Builder
with a constructor argument - setHandlePing(boolean) - Method in class org.springframework.web.reactive.socket.server.upgrade.ReactorNettyRequestUpgradeStrategy
-
Deprecated.as of 5.2.6 in favor of providing a supplier of
WebsocketServerSpec.Builder
with a constructor argument - setHandlerPredicate(BiPredicate<Object, ServerWebExchange>) - Method in class org.springframework.web.reactive.handler.AbstractUrlHandlerMapping
-
Configure a predicate for extended matching of the handler that was matched by URL path.
- setHeaders(ServerWebExchange, Resource, MediaType) - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Set headers on the response.
- setHosts(String...) - Method in class org.springframework.web.reactive.result.view.RedirectView
-
Configure one or more hosts associated with the application.
- setLazyInitHandlers(boolean) - Method in class org.springframework.web.reactive.handler.AbstractUrlHandlerMapping
-
Set whether to lazily initialize handlers.
- setLocations(List<Resource>) - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Set the
List
ofResource
paths to use as sources for serving static resources. - setLocationValues(List<String>) - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Accepts a list of String-based location values to be resolved into
Resource
locations. - setMappings(Properties) - Method in class org.springframework.web.reactive.handler.SimpleUrlHandlerMapping
-
Map URL paths to handler bean names.
- setMaxBinaryMessageBufferSize(Integer) - Method in class org.springframework.web.reactive.socket.server.upgrade.StandardWebSocketUpgradeStrategy
-
Exposes the underlying config option on
WebSocketContainer.setDefaultMaxBinaryMessageBufferSize(int)
. - setMaxFramePayloadLength(int) - Method in class org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient
-
Deprecated.as of 5.3 in favor of providing a supplier of
WebsocketClientSpec.Builder
with a constructor argument - setMaxFramePayloadLength(Integer) - Method in class org.springframework.web.reactive.socket.server.upgrade.ReactorNettyRequestUpgradeStrategy
-
Deprecated.as of 5.2.6 in favor of providing a supplier of
WebsocketServerSpec.Builder
with a constructor argument - setMaxSessionIdleTimeout(Long) - Method in class org.springframework.web.reactive.socket.server.upgrade.StandardWebSocketUpgradeStrategy
-
Exposes the underlying config option on
WebSocketContainer.setDefaultMaxSessionIdleTimeout(long)
. - setMaxTextMessageBufferSize(Integer) - Method in class org.springframework.web.reactive.socket.server.upgrade.StandardWebSocketUpgradeStrategy
-
Exposes the underlying config option on
WebSocketContainer.setDefaultMaxTextMessageBufferSize(int)
. - setMediaTypes(Map<String, MediaType>) - Method in class org.springframework.web.reactive.config.ResourceHandlerRegistration
-
Add mappings between file extensions extracted from the filename of static
Resource
s and the media types to use for the response. - setMediaTypes(Map<String, MediaType>) - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Add mappings between file extensions extracted from the filename of static
Resource
s and the media types to use for the response. - setMessageReaders(List<HttpMessageReader<?>>) - Method in class org.springframework.web.reactive.function.server.support.RouterFunctionMapping
-
Configure HTTP message readers to de-serialize the request body with.
- setMessageReaders(List<HttpMessageReader<?>>) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
-
Configure HTTP message readers to de-serialize the request body with.
- setMessageSource(MessageSource) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler
- setMessageWriters(List<HttpMessageWriter<?>>) - Method in class org.springframework.web.reactive.function.server.support.ServerResponseResultHandler
-
Configure HTTP message writers to serialize the request body with.
- setModelKeys(Set<String>) - Method in class org.springframework.web.reactive.result.view.HttpMessageWriterView
-
Set the attributes in the model that should be rendered by this view.
- setOptimizeLocations(boolean) - Method in class org.springframework.web.reactive.config.ResourceHandlerRegistration
-
Set whether to optimize the specified locations through an existence check on startup, filtering non-existing directories upfront so that they do not have to be checked on every resource access.
- setOptimizeLocations(boolean) - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Set whether to optimize the specified locations through an existence check on startup, filtering non-existing directories upfront so that they do not have to be checked on every resource access.
- setOrder(int) - Method in class org.springframework.web.reactive.config.ResourceHandlerRegistry
-
Specify the order to use for resource handling relative to other
HandlerMapping
s configured in the Spring configuration. - setOrder(int) - Method in class org.springframework.web.reactive.function.server.support.ServerResponseResultHandler
-
Set the order for this result handler relative to others.
- setOrder(int) - Method in class org.springframework.web.reactive.handler.AbstractHandlerMapping
-
Specify the order value for this HandlerMapping bean.
- setOrder(int) - Method in class org.springframework.web.reactive.result.HandlerResultHandlerSupport
-
Set the order for this result handler relative to others.
- setOrder(int) - Method in class org.springframework.web.reactive.result.view.ViewResolverSupport
-
Specify the order value for this ViewResolver bean.
- setOrder(int) - Method in class org.springframework.web.reactive.socket.server.support.WebSocketHandlerAdapter
-
Set the order value for this adapter.
- setParameterName(String) - Method in class org.springframework.web.reactive.accept.ParameterContentTypeResolver
-
Set the name of the parameter to use to determine requested media types.
- setParameterNameDiscoverer(ParameterNameDiscoverer) - Method in class org.springframework.web.reactive.result.method.InvocableHandlerMethod
-
Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g.
- setParameterNameDiscoverer(ParameterNameDiscoverer) - Method in class org.springframework.web.reactive.result.method.SyncInvocableHandlerMethod
-
Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g.
- setPathPrefixes(Map<String, Predicate<Class<?>>>) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping
-
Configure path prefixes to apply to controller methods.
- setPatternParser(PathPatternParser) - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo.BuilderConfiguration
- setPrefix(String) - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Set the prefix that gets prepended to view names when building a URL.
- setPropagateQuery(boolean) - Method in class org.springframework.web.reactive.result.view.RedirectView
-
Whether to append the query string of the current URL to the redirect URL (
true
) or not (false
, the default). - setReactiveAdapterRegistry(ReactiveAdapterRegistry) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
-
Configure the registry for adapting various reactive types.
- setReactiveAdapterRegistry(ReactiveAdapterRegistry) - Method in class org.springframework.web.reactive.result.method.InvocableHandlerMethod
-
Configure a reactive adapter registry.
- setReadyToSend(boolean) - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession.WebSocketSendProcessor
-
Subclasses can invoke this before sending a message (false) and after receiving the async send callback (true) effective translating async completion callback into simple flow control.
- setRedirectViewProvider(Function<String, RedirectView>) - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
URL based
RedirectView
provider which can be used to provide, for example, redirect views with a custom default status code. - setRenderFunction(String) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
-
Set the render function name (optional).
- setRenderFunction(String) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
-
See
ScriptTemplateConfigurer.setRenderFunction(String)
documentation. - setRenderObject(String) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
-
Set the object where the render function belongs (optional).
- setRenderObject(String) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
-
See
ScriptTemplateConfigurer.setRenderObject(String)
documentation. - setRequest(ClientRequest) - Method in class org.springframework.web.reactive.function.client.ClientRequestObservationContext
-
Set the client request.
- setRequestContextAttribute(String) - Method in class org.springframework.web.reactive.result.view.AbstractView
-
Set the name of the
RequestContext
attribute for this view. - setRequestContextAttribute(String) - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Set the name of the
RequestContext
attribute for all views. - setResourceHttpMessageWriter(ResourceHttpMessageWriter) - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Configure the
ResourceHttpMessageWriter
to use. - setResourceLoader(ResourceLoader) - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Provide the ResourceLoader to load
location values
with. - setResourceLoaderPath(String) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
-
Set the resource loader path(s) via a Spring resource location.
- setResourceLoaderPath(String) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
-
See
ScriptTemplateConfigurer.setResourceLoaderPath(String)
documentation. - setResourceResolvers(List<ResourceResolver>) - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Configure the list of
ResourceResolvers
to use. - setResourceTransformers(List<ResourceTransformer>) - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Configure the list of
ResourceTransformers
to use. - setResourceUrlProvider(ResourceUrlProvider) - Method in class org.springframework.web.reactive.config.ResourceHandlerRegistry
-
Configure the
ResourceUrlProvider
that can be used byResourceTransformer
instances. - setResourceUrlProvider(ResourceUrlProvider) - Method in class org.springframework.web.reactive.resource.ResourceTransformerSupport
-
Configure a
ResourceUrlProvider
to use when resolving the public URL of links in a transformed resource (e.g. - setScripts(String...) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
-
Set the scripts to be loaded by the script engine (library or user provided).
- setScripts(String...) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
-
See
ScriptTemplateConfigurer.setScripts(String...)
documentation. - setSessionAttributePredicate(Predicate<String>) - Method in class org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService
-
Configure a predicate to use to extract
WebSession
attributes and use them to initialize the WebSocket session with. - setSharedEngine(Boolean) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer
-
When set to
false
, a newScriptEngine
instance will be created for each request, else the same instance will be reused. - setSharedEngine(Boolean) - Method in class org.springframework.web.reactive.result.view.script.ScriptTemplateView
-
See
ScriptTemplateConfigurer.setSharedEngine(Boolean)
documentation. - setStatusCode(HttpStatusCode) - Method in class org.springframework.web.reactive.result.view.RedirectView
-
Set an alternate redirect status code such as
HttpStatus.TEMPORARY_REDIRECT
orHttpStatus.PERMANENT_REDIRECT
. - setStrategyMap(Map<String, VersionStrategy>) - Method in class org.springframework.web.reactive.resource.VersionResourceResolver
-
Set a Map with URL paths as keys and
VersionStrategy
as values. - setSuffix(String) - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Set the suffix that gets appended to view names when building a URL.
- setSupportedMediaTypes(List<MediaType>) - Method in class org.springframework.web.reactive.result.view.AbstractView
-
Set the supported media types for this view.
- setSupportedMediaTypes(List<MediaType>) - Method in class org.springframework.web.reactive.result.view.ViewResolverSupport
-
Set the supported media types for this view.
- setUriTemplate(String) - Method in class org.springframework.web.reactive.function.client.ClientRequestObservationContext
-
Set the URI template used for the current client exchange.
- setUrl(String) - Method in class org.springframework.web.reactive.result.view.AbstractUrlBasedView
-
Set the URL of the resource that this view wraps.
- setUrlMap(Map<String, ?>) - Method in class org.springframework.web.reactive.handler.SimpleUrlHandlerMapping
-
Set a Map with URL paths as keys and handler beans (or handler bean names) as values.
- setUseCaseSensitiveMatch(boolean) - Method in class org.springframework.web.reactive.handler.AbstractHandlerMapping
-
Shortcut method for setting the same property on the underlying pattern parser in use.
- setUseCaseSensitiveMatch(Boolean) - Method in class org.springframework.web.reactive.config.PathMatchConfigurer
-
Whether to match to URLs irrespective of their case.
- setUseLastModified(boolean) - Method in class org.springframework.web.reactive.config.ResourceHandlerRegistration
-
Set whether the
Resource.lastModified()
information should be used to drive HTTP responses. - setUseLastModified(boolean) - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
-
Set whether we should look at the
Resource.lastModified()
when serving resources and use this information to drive"Last-Modified"
HTTP response headers. - setUseTrailingSlashMatch(boolean) - Method in class org.springframework.web.reactive.handler.AbstractHandlerMapping
-
Deprecated.as of 6.0, see
PathPatternParser.setMatchOptionalTrailingSeparator(boolean)
- setUseTrailingSlashMatch(Boolean) - Method in class org.springframework.web.reactive.config.PathMatchConfigurer
-
Deprecated.as of 6.0, see
PathPatternParser.setMatchOptionalTrailingSeparator(boolean)
- setViewClass(Class<?>) - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Set the view class that should be used to create views.
- setViewNames(String...) - Method in class org.springframework.web.reactive.result.view.UrlBasedViewResolver
-
Set the view names (or name patterns) that can be handled by this
ViewResolver
. - setViewResolvers(List<ViewResolver>) - Method in class org.springframework.web.reactive.function.server.support.ServerResponseResultHandler
- setWebBindingInitializer(WebBindingInitializer) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
-
Provide a WebBindingInitializer with "global" initialization to apply to every DataBinder instance.
- simpleHandlerAdapter() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- SimpleHandlerAdapter - Class in org.springframework.web.reactive.result
- SimpleHandlerAdapter() - Constructor for class org.springframework.web.reactive.result.SimpleHandlerAdapter
- SimpleUrlHandlerMapping - Class in org.springframework.web.reactive.handler
-
Implementation of the
HandlerMapping
interface to map from URLs to request handler beans. - SimpleUrlHandlerMapping() - Constructor for class org.springframework.web.reactive.handler.SimpleUrlHandlerMapping
-
Create a
SimpleUrlHandlerMapping
with default settings. - SimpleUrlHandlerMapping(Map<String, ?>) - Constructor for class org.springframework.web.reactive.handler.SimpleUrlHandlerMapping
-
Create a
SimpleUrlHandlerMapping
using the supplied URL map. - SimpleUrlHandlerMapping(Map<String, ?>, int) - Constructor for class org.springframework.web.reactive.handler.SimpleUrlHandlerMapping
-
Create a
SimpleUrlHandlerMapping
using the supplied URL map and order. - SPRING_MACRO_REQUEST_CONTEXT_ATTRIBUTE - Static variable in class org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
-
Attribute name of the
RequestContext
instance in the template model, available to Spring's macros — for example, for creatingBindStatus
objects. - StandardWebSocketClient - Class in org.springframework.web.reactive.socket.client
-
WebSocketClient
implementation for use with the Jakarta WebSocket API. - StandardWebSocketClient() - Constructor for class org.springframework.web.reactive.socket.client.StandardWebSocketClient
-
Default constructor that calls
ContainerProvider.getWebSocketContainer()
to obtain a (new)WebSocketContainer
instance. - StandardWebSocketClient(WebSocketContainer) - Constructor for class org.springframework.web.reactive.socket.client.StandardWebSocketClient
-
Constructor accepting an existing
WebSocketContainer
instance. - StandardWebSocketHandlerAdapter - Class in org.springframework.web.reactive.socket.adapter
-
Adapter for the Jakarta WebSocket API (JSR-356) that delegates events to a reactive
WebSocketHandler
and its session. - StandardWebSocketHandlerAdapter(WebSocketHandler, Function<Session, StandardWebSocketSession>) - Constructor for class org.springframework.web.reactive.socket.adapter.StandardWebSocketHandlerAdapter
- StandardWebSocketSession - Class in org.springframework.web.reactive.socket.adapter
-
Spring
WebSocketSession
adapter for a standard Java (JSR 356)Session
. - StandardWebSocketSession(Session, HandshakeInfo, DataBufferFactory) - Constructor for class org.springframework.web.reactive.socket.adapter.StandardWebSocketSession
- StandardWebSocketSession(Session, HandshakeInfo, DataBufferFactory, Sinks.Empty<Void>) - Constructor for class org.springframework.web.reactive.socket.adapter.StandardWebSocketSession
- StandardWebSocketUpgradeStrategy - Class in org.springframework.web.reactive.socket.server.upgrade
-
A WebSocket
RequestUpgradeStrategy
for the Jakarta WebSocket API 2.1+. - StandardWebSocketUpgradeStrategy() - Constructor for class org.springframework.web.reactive.socket.server.upgrade.StandardWebSocketUpgradeStrategy
- start() - Method in class org.springframework.web.reactive.socket.client.JettyWebSocketClient
-
Deprecated.
- start() - Method in class org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService
- startAnd() - Method in interface org.springframework.web.reactive.function.server.RequestPredicates.Visitor
-
Receive first notification of a logical AND predicate.
- startNegate() - Method in interface org.springframework.web.reactive.function.server.RequestPredicates.Visitor
-
Receive first notification of a negated predicate.
- startNested(RequestPredicate) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Visitor
-
Receive notification of the beginning of a nested router function.
- startOr() - Method in interface org.springframework.web.reactive.function.server.RequestPredicates.Visitor
-
Receive first notification of a logical OR predicate.
- status() - Method in interface org.springframework.web.reactive.result.view.Rendering
-
Return the HTTP status to set the response to.
- status(int) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Set the HTTP status.
- status(int) - Method in interface org.springframework.web.reactive.function.server.RenderingResponse.Builder
-
Set the HTTP status.
- status(int) - Static method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Create a builder with the given HTTP status.
- status(HttpStatusCode) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Set the HTTP status.
- status(HttpStatusCode) - Method in interface org.springframework.web.reactive.function.server.RenderingResponse.Builder
-
Set the HTTP status.
- status(HttpStatusCode) - Static method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Create a builder with the given HTTP status.
- status(HttpStatusCode) - Method in interface org.springframework.web.reactive.result.view.Rendering.Builder
-
Specify the status to use for the response.
- status(ClientRequestObservationContext) - Method in class org.springframework.web.reactive.function.client.DefaultClientRequestObservationConvention
- STATUS - Enum constant in enum class org.springframework.web.reactive.function.client.ClientHttpObservationDocumentation.LowCardinalityKeyNames
-
HTTP response raw status code, or
"IO_ERROR"
in case ofIOException
, or"CLIENT_ERROR"
if no response was received. - statusCode() - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Return the HTTP status code as an
HttpStatusCode
value. - statusCode() - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- statusCode() - Method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Return the status code of this response.
- statusCode(HttpStatusCode) - Method in interface org.springframework.web.reactive.function.client.ClientResponse.Builder
-
Set the status code of the response.
- statusError(Predicate<HttpStatusCode>, Function<ClientResponse, ? extends Throwable>) - Static method in class org.springframework.web.reactive.function.client.ExchangeFilterFunctions
-
Return a filter that generates an error signal when the given
HttpStatusCode
predicate matches. - stop() - Method in class org.springframework.web.reactive.socket.client.JettyWebSocketClient
-
Deprecated.
- stop() - Method in class org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService
- strategies() - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Return the strategies used to convert the body of this response.
- strategies() - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- suffix(String) - Method in class org.springframework.web.reactive.config.UrlBasedViewResolverRegistration
-
Set the suffix that gets appended to view names when building a URL.
- supports(Object) - Method in class org.springframework.web.reactive.function.server.support.HandlerFunctionAdapter
- supports(Object) - Method in interface org.springframework.web.reactive.HandlerAdapter
-
Whether this
HandlerAdapter
supports the givenhandler
. - supports(Object) - Method in class org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
- supports(Object) - Method in class org.springframework.web.reactive.result.SimpleHandlerAdapter
- supports(Object) - Method in class org.springframework.web.reactive.socket.server.support.WebSocketHandlerAdapter
- supports(HandlerResult) - Method in class org.springframework.web.reactive.function.server.support.ServerResponseResultHandler
- supports(HandlerResult) - Method in interface org.springframework.web.reactive.HandlerResultHandler
-
Whether this handler supports the given
HandlerResult
. - supports(HandlerResult) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseBodyResultHandler
- supports(HandlerResult) - Method in class org.springframework.web.reactive.result.method.annotation.ResponseEntityResultHandler
- supports(HandlerResult) - Method in class org.springframework.web.reactive.result.view.ViewResolutionResultHandler
- supportsContext(Observation.Context) - Method in interface org.springframework.web.reactive.function.client.ClientRequestObservationConvention
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.ContinuationHandlerMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.CookieValueMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.ErrorsMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.ExpressionValueMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.HttpEntityMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.MatrixVariableMapMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.MatrixVariableMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.ModelAttributeMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.ModelMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.PathVariableMapMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.PathVariableMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.PrincipalMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.RequestAttributeMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.RequestBodyMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.RequestHeaderMapMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.RequestHeaderMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.RequestParamMapMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.RequestParamMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.RequestPartMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.ServerWebExchangeMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.SessionAttributeMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.SessionStatusMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.reactive.result.method.annotation.WebSessionMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in interface org.springframework.web.reactive.result.method.HandlerMethodArgumentResolver
-
Whether this resolver supports the given method parameter.
- suspendReceiving() - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
-
Suspend receiving until received message(s) are processed and more demand is generated by the downstream Subscriber.
- suspendReceiving() - Method in class org.springframework.web.reactive.socket.adapter.JettyWebSocketSession
- suspendReceiving() - Method in class org.springframework.web.reactive.socket.adapter.StandardWebSocketSession
- suspendReceiving() - Method in class org.springframework.web.reactive.socket.adapter.TomcatWebSocketSession
- suspendReceiving() - Method in class org.springframework.web.reactive.socket.adapter.UndertowWebSocketSession
- syncBody(Object) - Method in interface org.springframework.web.reactive.function.client.WebClient.RequestBodySpec
-
Deprecated.as of Spring Framework 5.2 in favor of
WebClient.RequestBodySpec.bodyValue(Object)
- syncBody(Object) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder
-
Deprecated.as of Spring Framework 5.2 in favor of
ServerResponse.BodyBuilder.bodyValue(Object)
- SyncHandlerMethodArgumentResolver - Interface in org.springframework.web.reactive.result.method
-
An extension of
HandlerMethodArgumentResolver
for implementations that are synchronous in nature and do not block to resolve values. - SyncInvocableHandlerMethod - Class in org.springframework.web.reactive.result.method
-
Extension of
HandlerMethod
that invokes the underlying method viaInvocableHandlerMethod
but uses sync argument resolvers only and thus can return directly aHandlerResult
with no async wrappers. - SyncInvocableHandlerMethod(Object, Method) - Constructor for class org.springframework.web.reactive.result.method.SyncInvocableHandlerMethod
- SyncInvocableHandlerMethod(HandlerMethod) - Constructor for class org.springframework.web.reactive.result.method.SyncInvocableHandlerMethod
T
- temporaryRedirect(URI) - Static method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Create a builder with a 307 Temporary Redirect status and a location header set to the given URI.
- test(Object, ServerWebExchange) - Method in class org.springframework.web.reactive.socket.server.support.WebSocketUpgradeHandlerPredicate
- test(ServerRequest) - Method in interface org.springframework.web.reactive.function.server.RequestPredicate
-
Evaluate this predicate on the given request.
- TEXT - Enum constant in enum class org.springframework.web.reactive.socket.WebSocketMessage.Type
-
Text WebSocket message.
- textMessage(String) - Method in class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
- textMessage(String) - Method in interface org.springframework.web.reactive.socket.WebSocketSession
-
Factory method to create a text
WebSocketMessage
using theWebSocketSession.bufferFactory()
for the session. - TLS_HANDSHAKE_FAILURE - Static variable in class org.springframework.web.reactive.socket.CloseStatus
-
"1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
- toAbsolutePath(String, ServerWebExchange) - Method in class org.springframework.web.reactive.resource.ResourceTransformerSupport
-
Transform the given relative request path to an absolute path, taking the path of the given request as a point of reference.
- toBodilessEntity() - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Return this response as a delayed
ResponseEntity
containing status and headers, but no body. - toBodilessEntity() - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- toBodilessEntity() - Method in interface org.springframework.web.reactive.function.client.WebClient.ResponseSpec
-
Return a
ResponseEntity
without a body. - toDataBuffers() - Static method in class org.springframework.web.reactive.function.BodyExtractors
-
Extractor that returns the raw
DataBuffers
. - toEntity(Class<T>) - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Return this response as a delayed
ResponseEntity
. - toEntity(Class<T>) - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- toEntity(Class<T>) - Method in interface org.springframework.web.reactive.function.client.WebClient.ResponseSpec
-
Return a
ResponseEntity
with the body decoded to an Object of the given type. - toEntity(ParameterizedTypeReference<T>) - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Return this response as a delayed
ResponseEntity
. - toEntity(ParameterizedTypeReference<T>) - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- toEntity(ParameterizedTypeReference<T>) - Method in interface org.springframework.web.reactive.function.client.WebClient.ResponseSpec
-
Variant of
WebClient.ResponseSpec.bodyToMono(Class)
with aParameterizedTypeReference
. - toEntityFlux(Class<T>) - Method in interface org.springframework.web.reactive.function.client.WebClient.ResponseSpec
-
Return a
ResponseEntity
with the body decoded to aFlux
of elements of the given type. - toEntityFlux(ParameterizedTypeReference<T>) - Method in interface org.springframework.web.reactive.function.client.WebClient.ResponseSpec
-
Variant of
WebClient.ResponseSpec.toEntityFlux(Class)
with aParameterizedTypeReference
. - toEntityFlux(BodyExtractor<Flux<T>, ? super ClientHttpResponse>) - Method in interface org.springframework.web.reactive.function.client.WebClient.ResponseSpec
-
Variant of
WebClient.ResponseSpec.toEntityFlux(Class)
with aBodyExtractor
. - toEntityList(Class<T>) - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Return this response as a delayed list of
ResponseEntity
s. - toEntityList(Class<T>) - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- toEntityList(Class<T>) - Method in interface org.springframework.web.reactive.function.client.WebClient.ResponseSpec
-
Return a
ResponseEntity
with the body decoded to aList
of elements of the given type. - toEntityList(ParameterizedTypeReference<T>) - Method in interface org.springframework.web.reactive.function.client.ClientResponse
-
Return this response as a delayed list of
ResponseEntity
s. - toEntityList(ParameterizedTypeReference<T>) - Method in class org.springframework.web.reactive.function.client.support.ClientResponseWrapper
- toEntityList(ParameterizedTypeReference<T>) - Method in interface org.springframework.web.reactive.function.client.WebClient.ResponseSpec
-
Variant of
WebClient.ResponseSpec.toEntity(Class)
with aParameterizedTypeReference
. - toFlux(Class<? extends T>) - Static method in class org.springframework.web.reactive.function.BodyExtractors
-
Extractor to decode the input content into
Flux<T>
. - toFlux(ParameterizedTypeReference<T>) - Static method in class org.springframework.web.reactive.function.BodyExtractors
-
Variant of
BodyExtractors.toFlux(Class)
for type information with generics. - toFormData() - Static method in class org.springframework.web.reactive.function.BodyExtractors
-
Extractor to read form data into
MultiValueMap<String, String>
. - toFrame(WebSocketMessage) - Method in class org.springframework.web.reactive.socket.adapter.Netty5WebSocketSessionSupport
- toFrame(WebSocketMessage) - Method in class org.springframework.web.reactive.socket.adapter.NettyWebSocketSessionSupport
- toHttpHandler(RouterFunction<?>) - Static method in class org.springframework.web.reactive.function.server.RouterFunctions
-
Convert the given router function into a
HttpHandler
. - toHttpHandler(RouterFunction<?>, HandlerStrategies) - Static method in class org.springframework.web.reactive.function.server.RouterFunctions
-
Convert the given router function into a
HttpHandler
, using the given strategies. - TomcatRequestUpgradeStrategy - Class in org.springframework.web.reactive.socket.server.upgrade
-
A WebSocket
RequestUpgradeStrategy
for Apache Tomcat. - TomcatRequestUpgradeStrategy() - Constructor for class org.springframework.web.reactive.socket.server.upgrade.TomcatRequestUpgradeStrategy
- TomcatWebSocketClient - Class in org.springframework.web.reactive.socket.client
-
WebSocketClient
implementation for use with Tomcat, based on the Jakarta WebSocket API. - TomcatWebSocketClient() - Constructor for class org.springframework.web.reactive.socket.client.TomcatWebSocketClient
- TomcatWebSocketClient(WebSocketContainer) - Constructor for class org.springframework.web.reactive.socket.client.TomcatWebSocketClient
- TomcatWebSocketSession - Class in org.springframework.web.reactive.socket.adapter
-
Spring
WebSocketSession
adapter for Tomcat'sSession
. - TomcatWebSocketSession(Session, HandshakeInfo, DataBufferFactory) - Constructor for class org.springframework.web.reactive.socket.adapter.TomcatWebSocketSession
- TomcatWebSocketSession(Session, HandshakeInfo, DataBufferFactory, Sinks.Empty<Void>) - Constructor for class org.springframework.web.reactive.socket.adapter.TomcatWebSocketSession
- toMessage(WebSocketFrame) - Method in class org.springframework.web.reactive.socket.adapter.NettyWebSocketSessionSupport
- toMessage(WebSocketFrame) - Method in class org.springframework.web.reactive.socket.adapter.Netty5WebSocketSessionSupport
- toMono(Class<? extends T>) - Static method in class org.springframework.web.reactive.function.BodyExtractors
-
Extractor to decode the input content into
Mono<T>
. - toMono(ParameterizedTypeReference<T>) - Static method in class org.springframework.web.reactive.function.BodyExtractors
-
Variant of
BodyExtractors.toMono(Class)
for type information with generics. - toMultipartData() - Static method in class org.springframework.web.reactive.function.BodyExtractors
-
Extractor to read multipart data into a
MultiValueMap<String, Part>
. - TOO_BIG_TO_PROCESS - Static variable in class org.springframework.web.reactive.socket.CloseStatus
-
"1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process."
- toParts() - Static method in class org.springframework.web.reactive.function.BodyExtractors
-
Extractor to read multipart data into
Flux<Part>
. - toString() - Method in class org.springframework.web.reactive.resource.ResourceWebHandler
- toString() - Method in class org.springframework.web.reactive.result.condition.AbstractRequestCondition
- toString() - Method in class org.springframework.web.reactive.result.method.RequestMappingInfo
- toString() - Method in class org.springframework.web.reactive.result.view.AbstractUrlBasedView
- toString() - Method in class org.springframework.web.reactive.result.view.AbstractView
- toString() - Method in class org.springframework.web.reactive.result.view.BindStatus
- toString() - Method in class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
- toString() - Method in class org.springframework.web.reactive.socket.CloseStatus
- toString() - Method in class org.springframework.web.reactive.socket.HandshakeInfo
- toString() - Method in class org.springframework.web.reactive.socket.WebSocketMessage
- toWebHandler(RouterFunction<?>) - Static method in class org.springframework.web.reactive.function.server.RouterFunctions
-
Convert the given router function into a
WebHandler
. - toWebHandler(RouterFunction<?>, HandlerStrategies) - Static method in class org.springframework.web.reactive.function.server.RouterFunctions
-
Convert the given router function into a
WebHandler
, using the given strategies. - transform(ServerWebExchange, Resource) - Method in interface org.springframework.web.reactive.resource.ResourceTransformerChain
-
Transform the given resource.
- transform(ServerWebExchange, Resource, ResourceTransformerChain) - Method in class org.springframework.web.reactive.resource.CachingResourceTransformer
- transform(ServerWebExchange, Resource, ResourceTransformerChain) - Method in class org.springframework.web.reactive.resource.CssLinkResourceTransformer
- transform(ServerWebExchange, Resource, ResourceTransformerChain) - Method in interface org.springframework.web.reactive.resource.ResourceTransformer
-
Transform the given resource.
- TransformedResource - Class in org.springframework.web.reactive.resource
-
An extension of
ByteArrayResource
that aResourceTransformer
can use to represent an original resource preserving all other information except the content. - TransformedResource(Resource, byte[]) - Constructor for class org.springframework.web.reactive.resource.TransformedResource
U
- UndertowRequestUpgradeStrategy - Class in org.springframework.web.reactive.socket.server.upgrade
-
A WebSocket
RequestUpgradeStrategy
for Undertow. - UndertowRequestUpgradeStrategy() - Constructor for class org.springframework.web.reactive.socket.server.upgrade.UndertowRequestUpgradeStrategy
- UndertowWebSocketClient - Class in org.springframework.web.reactive.socket.client
-
Undertow based implementation of
WebSocketClient
. - UndertowWebSocketClient(XnioWorker) - Constructor for class org.springframework.web.reactive.socket.client.UndertowWebSocketClient
-
Constructor with the
XnioWorker
to pass toWebSocketClient.connectionBuilder(org.xnio.XnioWorker, io.undertow.connector.ByteBufferPool, java.net.URI)
. - UndertowWebSocketClient(XnioWorker, ByteBufferPool, Consumer<WebSocketClient.ConnectionBuilder>) - Constructor for class org.springframework.web.reactive.socket.client.UndertowWebSocketClient
-
Alternate constructor providing additional control over the
WebSocketClient.ConnectionBuilder
for each WebSocket connection. - UndertowWebSocketClient(XnioWorker, Consumer<WebSocketClient.ConnectionBuilder>) - Constructor for class org.springframework.web.reactive.socket.client.UndertowWebSocketClient
-
Alternate constructor providing additional control over the
WebSocketClient.ConnectionBuilder
for each WebSocket connection. - UndertowWebSocketHandlerAdapter - Class in org.springframework.web.reactive.socket.adapter
-
Undertow
WebSocketConnectionCallback
implementation that adapts and delegates to a SpringWebSocketHandler
. - UndertowWebSocketHandlerAdapter(UndertowWebSocketSession) - Constructor for class org.springframework.web.reactive.socket.adapter.UndertowWebSocketHandlerAdapter
- UndertowWebSocketSession - Class in org.springframework.web.reactive.socket.adapter
-
Spring
WebSocketSession
implementation that adapts to an UndertowWebSocketChannel
. - UndertowWebSocketSession(WebSocketChannel, HandshakeInfo, DataBufferFactory) - Constructor for class org.springframework.web.reactive.socket.adapter.UndertowWebSocketSession
- UndertowWebSocketSession(WebSocketChannel, HandshakeInfo, DataBufferFactory, Sinks.Empty<Void>) - Constructor for class org.springframework.web.reactive.socket.adapter.UndertowWebSocketSession
- unknown(RequestPredicate) - Method in interface org.springframework.web.reactive.function.server.RequestPredicates.Visitor
-
Receive first notification of an unknown predicate.
- unknown(RouterFunction<?>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Visitor
-
Receive notification of an unknown router function.
- UnknownHttpStatusCodeException - Exception in org.springframework.web.reactive.function.client
-
Exception thrown when an unknown (or custom) HTTP status code is received.
- UnknownHttpStatusCodeException(int, HttpHeaders, byte[], Charset) - Constructor for exception org.springframework.web.reactive.function.client.UnknownHttpStatusCodeException
-
Create a new instance of the
UnknownHttpStatusCodeException
with the given parameters. - UnknownHttpStatusCodeException(int, HttpHeaders, byte[], Charset, HttpRequest) - Constructor for exception org.springframework.web.reactive.function.client.UnknownHttpStatusCodeException
-
Create a new instance of the
UnknownHttpStatusCodeException
with the given parameters. - UnknownHttpStatusCodeException(HttpStatusCode, HttpHeaders, byte[], Charset, HttpRequest) - Constructor for exception org.springframework.web.reactive.function.client.UnknownHttpStatusCodeException
-
Create a new instance of the
UnknownHttpStatusCodeException
with the given parameters. - unprocessableEntity() - Static method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Create a builder with an 422 Unprocessable Entity status.
- unregisterMapping(T) - Method in class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
-
Un-register the given mapping.
- UnsupportedMediaTypeException - Exception in org.springframework.web.reactive.function
-
Exception thrown to indicate that a
Content-Type
is not supported. - UnsupportedMediaTypeException(String) - Constructor for exception org.springframework.web.reactive.function.UnsupportedMediaTypeException
-
Constructor for when the specified Content-Type is invalid.
- UnsupportedMediaTypeException(MediaType, List<MediaType>) - Constructor for exception org.springframework.web.reactive.function.UnsupportedMediaTypeException
-
Constructor for when the Content-Type can be parsed but is not supported.
- UnsupportedMediaTypeException(MediaType, List<MediaType>, ResolvableType) - Constructor for exception org.springframework.web.reactive.function.UnsupportedMediaTypeException
-
Constructor for when trying to encode from or decode to a specific Java type.
- upgrade(ServerWebExchange, WebSocketHandler, String, Supplier<HandshakeInfo>) - Method in interface org.springframework.web.reactive.socket.server.RequestUpgradeStrategy
-
Upgrade to a WebSocket session and handle it with the given handler.
- upgrade(ServerWebExchange, WebSocketHandler, String, Supplier<HandshakeInfo>) - Method in class org.springframework.web.reactive.socket.server.upgrade.JettyRequestUpgradeStrategy
- upgrade(ServerWebExchange, WebSocketHandler, String, Supplier<HandshakeInfo>) - Method in class org.springframework.web.reactive.socket.server.upgrade.ReactorNetty2RequestUpgradeStrategy
- upgrade(ServerWebExchange, WebSocketHandler, String, Supplier<HandshakeInfo>) - Method in class org.springframework.web.reactive.socket.server.upgrade.ReactorNettyRequestUpgradeStrategy
- upgrade(ServerWebExchange, WebSocketHandler, String, Supplier<HandshakeInfo>) - Method in class org.springframework.web.reactive.socket.server.upgrade.StandardWebSocketUpgradeStrategy
- upgrade(ServerWebExchange, WebSocketHandler, String, Supplier<HandshakeInfo>) - Method in class org.springframework.web.reactive.socket.server.upgrade.UndertowRequestUpgradeStrategy
- upgradeHttpToWebSocket(HttpServletRequest, HttpServletResponse, ServerEndpointConfig, Map<String, String>) - Method in class org.springframework.web.reactive.socket.server.upgrade.StandardWebSocketUpgradeStrategy
- upgradeHttpToWebSocket(HttpServletRequest, HttpServletResponse, ServerEndpointConfig, Map<String, String>) - Method in class org.springframework.web.reactive.socket.server.upgrade.TomcatRequestUpgradeStrategy
- uri() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get the request URI.
- uri() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- uri(String, Object...) - Method in interface org.springframework.web.reactive.function.client.WebClient.UriSpec
-
Specify the URI for the request using a URI template and URI variables.
- uri(String, Function<UriBuilder, URI>) - Method in interface org.springframework.web.reactive.function.client.WebClient.UriSpec
-
Specify the URI starting with a URI template and finishing off with a
UriBuilder
created from the template. - uri(String, Map<String, ?>) - Method in interface org.springframework.web.reactive.function.client.WebClient.UriSpec
-
Specify the URI for the request using a URI template and URI variables.
- uri(URI) - Method in interface org.springframework.web.reactive.function.client.WebClient.UriSpec
-
Specify the URI using an absolute, fully constructed
URI
. - uri(URI) - Method in interface org.springframework.web.reactive.function.server.ServerRequest.Builder
-
Set the URI of the request.
- uri(Function<UriBuilder, URI>) - Method in interface org.springframework.web.reactive.function.client.WebClient.UriSpec
-
Specify the URI by through a
UriBuilder
. - uri(ClientRequestObservationContext) - Method in class org.springframework.web.reactive.function.client.DefaultClientRequestObservationConvention
- URI - Enum constant in enum class org.springframework.web.reactive.function.client.ClientHttpObservationDocumentation.LowCardinalityKeyNames
-
URI template used for HTTP request, or "none" if none was provided.
- URI_TEMPLATE_VARIABLES_ATTRIBUTE - Static variable in class org.springframework.web.reactive.function.server.RouterFunctions
-
Name of the
ServerWebExchange
attribute that contains the URI templates map, mapping variable names to values. - URI_TEMPLATE_VARIABLES_ATTRIBUTE - Static variable in interface org.springframework.web.reactive.HandlerMapping
-
Name of the
attribute
that contains the URI templates map mapping variable names to values. - uriBuilder() - Method in interface org.springframework.web.reactive.function.server.ServerRequest
-
Get a
UriBuilderComponents
from the URI associated with thisServerRequest
. - uriBuilder() - Method in class org.springframework.web.reactive.function.server.support.ServerRequestWrapper
- uriBuilderFactory(UriBuilderFactory) - Method in interface org.springframework.web.reactive.function.client.WebClient.Builder
-
Provide a pre-configured
UriBuilderFactory
instance. - url() - Method in interface org.springframework.web.reactive.function.client.ClientRequest
-
Return the request URI.
- url(URI) - Method in interface org.springframework.web.reactive.function.client.ClientRequest.Builder
-
Set the url of the request.
- UrlBasedViewResolver - Class in org.springframework.web.reactive.result.view
-
A
ViewResolver
that allows direct resolution of symbolic view names to URLs without explicit mapping definitions. - UrlBasedViewResolver() - Constructor for class org.springframework.web.reactive.result.view.UrlBasedViewResolver
- UrlBasedViewResolverRegistration - Class in org.springframework.web.reactive.config
-
Assist with configuring properties of a
UrlBasedViewResolver
. - UrlBasedViewResolverRegistration(UrlBasedViewResolver) - Constructor for class org.springframework.web.reactive.config.UrlBasedViewResolverRegistration
V
- validateHandler(Object, ServerWebExchange) - Method in class org.springframework.web.reactive.handler.AbstractUrlHandlerMapping
-
Validate the given handler against the current request.
- valueOf(String) - Static method in enum class org.springframework.web.reactive.function.client.ClientHttpObservationDocumentation.HighCardinalityKeyNames
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.web.reactive.function.client.ClientHttpObservationDocumentation.LowCardinalityKeyNames
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.web.reactive.function.client.ClientHttpObservationDocumentation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.web.reactive.socket.WebSocketMessage.Type
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.springframework.web.reactive.function.client.ClientHttpObservationDocumentation.HighCardinalityKeyNames
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.web.reactive.function.client.ClientHttpObservationDocumentation.LowCardinalityKeyNames
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.web.reactive.function.client.ClientHttpObservationDocumentation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.web.reactive.socket.WebSocketMessage.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- varyBy(String...) - Method in interface org.springframework.web.reactive.function.server.EntityResponse.Builder
-
Configure one or more request header names (e.g.
- varyBy(String...) - Method in interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder
-
Configure one or more request header names (e.g.
- VersionResourceResolver - Class in org.springframework.web.reactive.resource
-
Resolves request paths containing a version string that can be used as part of an HTTP caching strategy in which a resource is cached with a date in the distant future (e.g.
- VersionResourceResolver() - Constructor for class org.springframework.web.reactive.resource.VersionResourceResolver
- VersionStrategy - Interface in org.springframework.web.reactive.resource
-
A strategy to determine the version of a static resource and to apply and/or extract it from the URL path.
- view() - Method in interface org.springframework.web.reactive.result.view.Rendering
- view(String) - Static method in interface org.springframework.web.reactive.result.view.Rendering
-
Create a new builder for response rendering based on the given view name.
- View - Interface in org.springframework.web.reactive.result.view
-
Contract to render
HandlerResult
to the HTTP response. - viewClass(Class<?>) - Method in class org.springframework.web.reactive.config.UrlBasedViewResolverRegistration
-
Set the view class that should be used to create views.
- viewNames(String...) - Method in class org.springframework.web.reactive.config.UrlBasedViewResolverRegistration
-
Set the view names (or name patterns) that can be handled by this view resolver.
- viewResolutionResultHandler(ReactiveAdapterRegistry, RequestedContentTypeResolver) - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- ViewResolutionResultHandler - Class in org.springframework.web.reactive.result.view
-
HandlerResultHandler
that encapsulates the view resolution algorithm supporting the following return types:Void
or no value -- default view nameString
-- view name unless@ModelAttribute
-annotatedView
-- View to render withModel
-- attributes to add to the modelMap
-- attributes to add to the modelRendering
-- use case driven API for view resolution@ModelAttribute
-- attribute for the model Non-simple value -- attribute for the model - ViewResolutionResultHandler(List<ViewResolver>, RequestedContentTypeResolver) - Constructor for class org.springframework.web.reactive.result.view.ViewResolutionResultHandler
-
Basic constructor with a default
ReactiveAdapterRegistry
. - ViewResolutionResultHandler(List<ViewResolver>, RequestedContentTypeResolver, ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.view.ViewResolutionResultHandler
-
Constructor with an
ReactiveAdapterRegistry
instance. - viewResolver(ViewResolver) - Method in class org.springframework.web.reactive.config.ViewResolverRegistry
-
Register a
ViewResolver
bean instance. - viewResolver(ViewResolver) - Method in interface org.springframework.web.reactive.function.server.HandlerStrategies.Builder
-
Add the given view resolver to this builder.
- ViewResolver - Interface in org.springframework.web.reactive.result.view
-
Contract to resolve a view name to a
View
instance. - ViewResolverRegistry - Class in org.springframework.web.reactive.config
-
Assist with the configuration of a chain of
ViewResolver
's supporting different template mechanisms. - ViewResolverRegistry(ApplicationContext) - Constructor for class org.springframework.web.reactive.config.ViewResolverRegistry
- viewResolvers() - Method in interface org.springframework.web.reactive.function.server.HandlerStrategies
-
Return the
ViewResolvers
to be used for view name resolution. - viewResolvers() - Method in interface org.springframework.web.reactive.function.server.ServerResponse.Context
-
Return the
ViewResolvers
to be used for view name resolution. - ViewResolverSupport - Class in org.springframework.web.reactive.result.view
-
Base class for
ViewResolver
implementations with shared properties. - ViewResolverSupport() - Constructor for class org.springframework.web.reactive.result.view.ViewResolverSupport
W
- WebClient - Interface in org.springframework.web.reactive.function.client
-
Non-blocking, reactive client to perform HTTP requests, exposing a fluent, reactive API over underlying HTTP client libraries such as Reactor Netty.
- WebClient.Builder - Interface in org.springframework.web.reactive.function.client
-
A mutable builder for creating a
WebClient
. - WebClient.RequestBodySpec - Interface in org.springframework.web.reactive.function.client
-
Contract for specifying request headers and body leading up to the exchange.
- WebClient.RequestBodyUriSpec - Interface in org.springframework.web.reactive.function.client
-
Contract for specifying request headers, body and URI for a request.
- WebClient.RequestHeadersSpec<S extends WebClient.RequestHeadersSpec<S>> - Interface in org.springframework.web.reactive.function.client
-
Contract for specifying request headers leading up to the exchange.
- WebClient.RequestHeadersUriSpec<S extends WebClient.RequestHeadersSpec<S>> - Interface in org.springframework.web.reactive.function.client
-
Contract for specifying request headers and URI for a request.
- WebClient.ResponseSpec - Interface in org.springframework.web.reactive.function.client
-
Contract for specifying response operations following the exchange.
- WebClient.UriSpec<S extends WebClient.RequestHeadersSpec<?>> - Interface in org.springframework.web.reactive.function.client
-
Contract for specifying the URI for a request.
- WebClientAdapter - Class in org.springframework.web.reactive.function.client.support
- WebClientException - Exception in org.springframework.web.reactive.function.client
-
Abstract base class for exception published by
WebClient
in case of errors. - WebClientException(String) - Constructor for exception org.springframework.web.reactive.function.client.WebClientException
-
Construct a new instance of
WebClientException
with the given message. - WebClientException(String, Throwable) - Constructor for exception org.springframework.web.reactive.function.client.WebClientException
-
Construct a new instance of
WebClientException
with the given message and exception. - WebClientRequestException - Exception in org.springframework.web.reactive.function.client
-
Exceptions that contain actual HTTP request data.
- WebClientRequestException(Throwable, HttpMethod, URI, HttpHeaders) - Constructor for exception org.springframework.web.reactive.function.client.WebClientRequestException
-
Constructor for throwable.
- WebClientResponseException - Exception in org.springframework.web.reactive.function.client
-
Exceptions that contain actual HTTP response data.
- WebClientResponseException(int, String, HttpHeaders, byte[], Charset) - Constructor for exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Constructor with response data only, and a default message.
- WebClientResponseException(int, String, HttpHeaders, byte[], Charset, HttpRequest) - Constructor for exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Constructor with response data only, and a default message.
- WebClientResponseException(String, int, String, HttpHeaders, byte[], Charset) - Constructor for exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Constructor with a prepared message.
- WebClientResponseException(String, int, String, HttpHeaders, byte[], Charset, HttpRequest) - Constructor for exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Constructor with a prepared message.
- WebClientResponseException(String, HttpStatusCode, String, HttpHeaders, byte[], Charset, HttpRequest) - Constructor for exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Constructor with a prepared message.
- WebClientResponseException(HttpStatusCode, String, HttpHeaders, byte[], Charset, HttpRequest) - Constructor for exception org.springframework.web.reactive.function.client.WebClientResponseException
-
Constructor with response data only, and a default message.
- WebClientResponseException.BadGateway - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for HTTP status 502 Bad Gateway. - WebClientResponseException.BadRequest - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for status HTTP 400 Bad Request. - WebClientResponseException.Conflict - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for status HTTP 409 Conflict. - WebClientResponseException.Forbidden - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for status HTTP 403 Forbidden. - WebClientResponseException.GatewayTimeout - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for status HTTP 504 Gateway Timeout. - WebClientResponseException.Gone - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for status HTTP 410 Gone. - WebClientResponseException.InternalServerError - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for status HTTP 500 Internal Server Error. - WebClientResponseException.MethodNotAllowed - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for status HTTP 405 Method Not Allowed. - WebClientResponseException.NotAcceptable - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for status HTTP 406 Not Acceptable. - WebClientResponseException.NotFound - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for status HTTP 404 Not Found. - WebClientResponseException.NotImplemented - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for status HTTP 501 Not Implemented. - WebClientResponseException.ServiceUnavailable - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for status HTTP 503 Service Unavailable. - WebClientResponseException.TooManyRequests - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for status HTTP 429 Too Many Requests. - WebClientResponseException.Unauthorized - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for status HTTP 401 Unauthorized. - WebClientResponseException.UnprocessableEntity - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for status HTTP 422 Unprocessable Entity. - WebClientResponseException.UnsupportedMediaType - Exception in org.springframework.web.reactive.function.client
-
WebClientResponseException
for status HTTP 415 Unsupported Media Type. - webFilter(WebFilter) - Method in interface org.springframework.web.reactive.function.server.HandlerStrategies.Builder
-
Add the given web filter to this builder.
- webFilters() - Method in interface org.springframework.web.reactive.function.server.HandlerStrategies
-
Return the
WebFilters
to be used for filtering the request and response. - webFluxAdapterRegistry() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Return a
ReactiveAdapterRegistry
to adapting reactive types. - WebFluxConfigurationSupport - Class in org.springframework.web.reactive.config
-
The main class for Spring WebFlux configuration.
- WebFluxConfigurationSupport() - Constructor for class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- WebFluxConfigurer - Interface in org.springframework.web.reactive.config
-
Defines callback methods to customize the configuration for WebFlux applications enabled via
@EnableWebFlux
. - WebFluxConfigurerComposite - Class in org.springframework.web.reactive.config
-
A
WebFluxConfigurer
that delegates to one or more others. - WebFluxConfigurerComposite() - Constructor for class org.springframework.web.reactive.config.WebFluxConfigurerComposite
- webFluxContentTypeResolver() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- webFluxConversionService() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Return a
FormattingConversionService
for use with annotated controllers. - WebFluxResponseStatusExceptionHandler - Class in org.springframework.web.reactive.handler
-
Common WebFlux exception handler that detects instances of
ResponseStatusException
(inherited from the base class) as well as exceptions annotated with@ResponseStatus
by determining the HTTP status for them and updating the status of the response accordingly. - WebFluxResponseStatusExceptionHandler() - Constructor for class org.springframework.web.reactive.handler.WebFluxResponseStatusExceptionHandler
- webFluxValidator() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
-
Return a global
Validator
instance for example for validating@RequestBody
method arguments. - webFluxWebSocketHandlerAdapter() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- webHandler() - Method in class org.springframework.web.reactive.config.WebFluxConfigurationSupport
- WebJarsResourceResolver - Class in org.springframework.web.reactive.resource
-
A
ResourceResolver
that delegates to the chain to locate a resource and then attempts to find a matching versioned resource contained in a WebJar JAR file. - WebJarsResourceResolver() - Constructor for class org.springframework.web.reactive.resource.WebJarsResourceResolver
-
Create a
WebJarsResourceResolver
with a defaultWebJarAssetLocator
instance. - WebJarsResourceResolver(WebJarAssetLocator) - Constructor for class org.springframework.web.reactive.resource.WebJarsResourceResolver
-
Create a
WebJarsResourceResolver
with a customWebJarAssetLocator
instance, e.g. - WebSessionMethodArgumentResolver - Class in org.springframework.web.reactive.result.method.annotation
-
Resolves method argument value of type
WebSession
. - WebSessionMethodArgumentResolver(ReactiveAdapterRegistry) - Constructor for class org.springframework.web.reactive.result.method.annotation.WebSessionMethodArgumentResolver
- WebSocketClient - Interface in org.springframework.web.reactive.socket.client
-
Contract for reactive-style handling of a WebSocket session.
- WebSocketConnection(WebsocketInbound, WebsocketOutbound) - Constructor for class org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession.WebSocketConnection
- WebSocketConnection(WebsocketInbound, WebsocketOutbound) - Constructor for class org.springframework.web.reactive.socket.adapter.ReactorNetty2WebSocketSession.WebSocketConnection
- WebSocketHandler - Interface in org.springframework.web.reactive.socket
-
Handler for a WebSocket session.
- WebSocketHandlerAdapter - Class in org.springframework.web.reactive.socket.server.support
-
HandlerAdapter
that allowsDispatcherHandler
to support handlers of typeWebSocketHandler
with such handlers mapped to URL patterns viaSimpleUrlHandlerMapping
. - WebSocketHandlerAdapter() - Constructor for class org.springframework.web.reactive.socket.server.support.WebSocketHandlerAdapter
-
Default constructor that creates and uses a
HandshakeWebSocketService
. - WebSocketHandlerAdapter(WebSocketService) - Constructor for class org.springframework.web.reactive.socket.server.support.WebSocketHandlerAdapter
-
Alternative constructor with the
WebSocketService
to use. - WebSocketMessage - Class in org.springframework.web.reactive.socket
-
Representation of a WebSocket message.
- WebSocketMessage(WebSocketMessage.Type, DataBuffer) - Constructor for class org.springframework.web.reactive.socket.WebSocketMessage
-
Constructor for a WebSocketMessage.
- WebSocketMessage(WebSocketMessage.Type, DataBuffer, Object) - Constructor for class org.springframework.web.reactive.socket.WebSocketMessage
-
Constructor for an inbound message with access to the underlying message.
- WebSocketMessage.Type - Enum Class in org.springframework.web.reactive.socket
-
WebSocket message types.
- WebSocketService - Interface in org.springframework.web.reactive.socket.server
-
A service to delegate WebSocket-related HTTP requests to.
- WebSocketSession - Interface in org.springframework.web.reactive.socket
-
Represents a WebSocket session.
- WebSocketUpgradeHandlerPredicate - Class in org.springframework.web.reactive.socket.server.support
-
A predicate for use with
AbstractUrlHandlerMapping.setHandlerPredicate(java.util.function.BiPredicate<java.lang.Object, org.springframework.web.server.ServerWebExchange>)
to ensure only WebSocket handshake requests are matched to handlers of typeWebSocketHandler
. - WebSocketUpgradeHandlerPredicate() - Constructor for class org.springframework.web.reactive.socket.server.support.WebSocketUpgradeHandlerPredicate
- with(String, T) - Method in interface org.springframework.web.reactive.function.BodyInserters.FormInserter
-
Adds the specified key-value pair to the form.
- with(MultiValueMap<String, T>) - Method in interface org.springframework.web.reactive.function.BodyInserters.FormInserter
-
Adds the specified values to the form.
- withAttribute(String, Object) - Method in interface org.springframework.web.reactive.function.server.RouterFunction
-
Return a new routing function with the given attribute.
- withAttribute(String, Object) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Add an attribute with the given name and value to the last route built with this builder.
- withAttributes(Consumer<Map<String, Object>>) - Method in interface org.springframework.web.reactive.function.server.RouterFunction
-
Return a new routing function with attributes manipulated with the given consumer.
- withAttributes(Consumer<Map<String, Object>>) - Method in interface org.springframework.web.reactive.function.server.RouterFunctions.Builder
-
Manipulate the attributes of the last route built with the given consumer.
- withDefaults() - Static method in interface org.springframework.web.reactive.function.client.ExchangeStrategies
-
Return an
ExchangeStrategies
instance with default configuration provided byClientCodecConfigurer
. - withDefaults() - Static method in interface org.springframework.web.reactive.function.server.HandlerStrategies
-
Return a new
HandlerStrategies
with default initialization. - withPublisher(String, P, Class<T>) - Method in interface org.springframework.web.reactive.function.BodyInserters.MultipartInserter
-
Add an asynchronous part with
Publisher
-based content. - withPublisher(String, P, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.reactive.function.BodyInserters.MultipartInserter
-
Variant of
BodyInserters.MultipartInserter.withPublisher(String, Publisher, Class)
that accepts aParameterizedTypeReference
for the element type, which allows specifying generic type information. - withReason(String) - Method in class org.springframework.web.reactive.socket.CloseStatus
-
Create a new
CloseStatus
from this one with the specified reason. - write(WebSocketMessage) - Method in class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession.WebSocketSendProcessor
- writeBody(Object, MethodParameter, MethodParameter, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.AbstractMessageWriterResultHandler
-
Write a given body to the response with
HttpMessageWriter
. - writeBody(Object, MethodParameter, ServerWebExchange) - Method in class org.springframework.web.reactive.result.method.annotation.AbstractMessageWriterResultHandler
-
Write a given body to the response with
HttpMessageWriter
. - writeTo(ClientHttpRequest, ExchangeStrategies) - Method in interface org.springframework.web.reactive.function.client.ClientRequest
-
Write this request to the given
ClientHttpRequest
. - writeTo(ServerWebExchange, ServerResponse.Context) - Method in interface org.springframework.web.reactive.function.server.ServerResponse
-
Write this response to the given web exchange.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form