Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractClientHttpRequest - Class in org.springframework.http.client
-
Abstract base for
ClientHttpRequest
that makes sure that headers and body are not written multiple times. - AbstractClientHttpRequest - Class in org.springframework.http.client.reactive
-
Base class for
ClientHttpRequest
implementations. - AbstractClientHttpRequest() - Constructor for class org.springframework.http.client.AbstractClientHttpRequest
- AbstractClientHttpRequest() - Constructor for class org.springframework.http.client.reactive.AbstractClientHttpRequest
- AbstractClientHttpRequest(HttpHeaders) - Constructor for class org.springframework.http.client.reactive.AbstractClientHttpRequest
- AbstractClientHttpRequestFactoryWrapper - Class in org.springframework.http.client
-
Abstract base class for
ClientHttpRequestFactory
implementations that decorate another delegate request factory. - AbstractClientHttpRequestFactoryWrapper(ClientHttpRequestFactory) - Constructor for class org.springframework.http.client.AbstractClientHttpRequestFactoryWrapper
-
Create a
AbstractClientHttpRequestFactoryWrapper
wrapping the given request factory. - AbstractClientHttpResponse - Class in org.springframework.http.client
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0, with no direct replacement; scheduled for removal in 6.2
- AbstractClientHttpResponse - Class in org.springframework.http.client.reactive
-
Base class for
ClientHttpResponse
implementations. - AbstractClientHttpResponse() - Constructor for class org.springframework.http.client.AbstractClientHttpResponse
-
Deprecated.
- AbstractClientHttpResponse(HttpStatusCode, HttpHeaders, MultiValueMap<String, ResponseCookie>, Flux<DataBuffer>) - Constructor for class org.springframework.http.client.reactive.AbstractClientHttpResponse
- AbstractContextLoaderInitializer - Class in org.springframework.web.context
-
Convenient base class for
WebApplicationInitializer
implementations that register aContextLoaderListener
in the servlet context. - AbstractContextLoaderInitializer() - Constructor for class org.springframework.web.context.AbstractContextLoaderInitializer
- AbstractCookieValueMethodArgumentResolver - Class in org.springframework.web.method.annotation
-
A base abstract class to resolve method arguments annotated with
@CookieValue
. - AbstractCookieValueMethodArgumentResolver(ConfigurableBeanFactory) - Constructor for class org.springframework.web.method.annotation.AbstractCookieValueMethodArgumentResolver
-
Crate a new
AbstractCookieValueMethodArgumentResolver
instance. - AbstractGenericHttpMessageConverter<T> - Class in org.springframework.http.converter
-
Abstract base class for most
GenericHttpMessageConverter
implementations. - AbstractGenericHttpMessageConverter() - Constructor for class org.springframework.http.converter.AbstractGenericHttpMessageConverter
-
Construct an
AbstractGenericHttpMessageConverter
with no supported media types. - AbstractGenericHttpMessageConverter(MediaType) - Constructor for class org.springframework.http.converter.AbstractGenericHttpMessageConverter
-
Construct an
AbstractGenericHttpMessageConverter
with one supported media type. - AbstractGenericHttpMessageConverter(MediaType...) - Constructor for class org.springframework.http.converter.AbstractGenericHttpMessageConverter
-
Construct an
AbstractGenericHttpMessageConverter
with multiple supported media type. - AbstractHttpMessageConverter<T> - Class in org.springframework.http.converter
-
Abstract base class for most
HttpMessageConverter
implementations. - AbstractHttpMessageConverter() - Constructor for class org.springframework.http.converter.AbstractHttpMessageConverter
-
Construct an
AbstractHttpMessageConverter
with no supported media types. - AbstractHttpMessageConverter(Charset, MediaType...) - Constructor for class org.springframework.http.converter.AbstractHttpMessageConverter
-
Construct an
AbstractHttpMessageConverter
with a default charset and multiple supported media types. - AbstractHttpMessageConverter(MediaType) - Constructor for class org.springframework.http.converter.AbstractHttpMessageConverter
-
Construct an
AbstractHttpMessageConverter
with one supported media type. - AbstractHttpMessageConverter(MediaType...) - Constructor for class org.springframework.http.converter.AbstractHttpMessageConverter
-
Construct an
AbstractHttpMessageConverter
with multiple supported media types. - AbstractJackson2Decoder - Class in org.springframework.http.codec.json
-
Abstract base class for Jackson 2.x decoding, leveraging non-blocking parsing.
- AbstractJackson2Decoder(ObjectMapper, MimeType...) - Constructor for class org.springframework.http.codec.json.AbstractJackson2Decoder
-
Constructor with a Jackson
ObjectMapper
to use. - AbstractJackson2Encoder - Class in org.springframework.http.codec.json
-
Base class providing support methods for Jackson 2.x encoding.
- AbstractJackson2Encoder(ObjectMapper, MimeType...) - Constructor for class org.springframework.http.codec.json.AbstractJackson2Encoder
-
Constructor with a Jackson
ObjectMapper
to use. - AbstractJackson2HttpMessageConverter - Class in org.springframework.http.converter.json
-
Abstract base class for Jackson based and content type independent
HttpMessageConverter
implementations. - AbstractJackson2HttpMessageConverter(ObjectMapper) - Constructor for class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
- AbstractJackson2HttpMessageConverter(ObjectMapper, MediaType) - Constructor for class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
- AbstractJackson2HttpMessageConverter(ObjectMapper, MediaType...) - Constructor for class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
- AbstractJaxb2HttpMessageConverter<T> - Class in org.springframework.http.converter.xml
-
Abstract base class for
HttpMessageConverters
that use JAXB2. - AbstractJaxb2HttpMessageConverter() - Constructor for class org.springframework.http.converter.xml.AbstractJaxb2HttpMessageConverter
- AbstractJsonHttpMessageConverter - Class in org.springframework.http.converter.json
-
Common base class for plain JSON converters, e.g.
- AbstractJsonHttpMessageConverter() - Constructor for class org.springframework.http.converter.json.AbstractJsonHttpMessageConverter
- AbstractKotlinSerializationHttpMessageConverter<T extends kotlinx.serialization.SerialFormat> - Class in org.springframework.http.converter
-
Abstract base class for
HttpMessageConverter
implementations that use Kotlin serialization. - AbstractKotlinSerializationHttpMessageConverter(T, MediaType...) - Constructor for class org.springframework.http.converter.AbstractKotlinSerializationHttpMessageConverter
-
Construct an
AbstractKotlinSerializationHttpMessageConverter
with multiple supported media type and format. - AbstractListenerReadPublisher<T> - Class in org.springframework.http.server.reactive
-
Abstract base class for
Publisher
implementations that bridge between event-listener read APIs and Reactive Streams. - AbstractListenerReadPublisher() - Constructor for class org.springframework.http.server.reactive.AbstractListenerReadPublisher
- AbstractListenerReadPublisher(String) - Constructor for class org.springframework.http.server.reactive.AbstractListenerReadPublisher
-
Create an instance with the given log prefix.
- AbstractListenerServerHttpResponse - Class in org.springframework.http.server.reactive
-
Abstract base class for listener-based server responses.
- AbstractListenerServerHttpResponse(DataBufferFactory) - Constructor for class org.springframework.http.server.reactive.AbstractListenerServerHttpResponse
- AbstractListenerServerHttpResponse(DataBufferFactory, HttpHeaders) - Constructor for class org.springframework.http.server.reactive.AbstractListenerServerHttpResponse
- AbstractListenerWriteFlushProcessor<T> - Class in org.springframework.http.server.reactive
-
An alternative to
AbstractListenerWriteProcessor
but instead writing aPublisher<Publisher<T>>
with flush boundaries enforces after the completion of each nested Publisher. - AbstractListenerWriteFlushProcessor() - Constructor for class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
- AbstractListenerWriteFlushProcessor(String) - Constructor for class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
-
Create an instance with the given log prefix.
- AbstractListenerWriteProcessor<T> - Class in org.springframework.http.server.reactive
-
Abstract base class for
Processor
implementations that bridge between event-listener write APIs and Reactive Streams. - AbstractListenerWriteProcessor() - Constructor for class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
- AbstractListenerWriteProcessor(String) - Constructor for class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
-
Create an instance with the given log prefix.
- AbstractMappingContentNegotiationStrategy - Class in org.springframework.web.accept
-
Base class for
ContentNegotiationStrategy
implementations with the steps to resolve a request to media types. - AbstractMappingContentNegotiationStrategy(Map<String, MediaType>) - Constructor for class org.springframework.web.accept.AbstractMappingContentNegotiationStrategy
-
Create an instance with the given map of file extensions and media types.
- AbstractMultipartHttpServletRequest - Class in org.springframework.web.multipart.support
-
Abstract base implementation of the
MultipartHttpServletRequest
interface. - AbstractMultipartHttpServletRequest(HttpServletRequest) - Constructor for class org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest
-
Wrap the given HttpServletRequest in a MultipartHttpServletRequest.
- AbstractNamedValueArgumentResolver - Class in org.springframework.web.service.invoker
-
Base class for arguments that resolve to a named request value such as a request header, path variable, cookie, and others.
- AbstractNamedValueArgumentResolver() - Constructor for class org.springframework.web.service.invoker.AbstractNamedValueArgumentResolver
-
Constructor for a resolver to an Object value, without conversion.
- AbstractNamedValueArgumentResolver(ConversionService) - Constructor for class org.springframework.web.service.invoker.AbstractNamedValueArgumentResolver
-
Constructor for a resolver to a String value.
- AbstractNamedValueArgumentResolver.NamedValueInfo - Class in org.springframework.web.service.invoker
-
Info about a request value, typically extracted from a method parameter annotation.
- AbstractNamedValueMethodArgumentResolver - Class in org.springframework.web.method.annotation
-
Abstract base class for resolving method arguments from a named value.
- AbstractNamedValueMethodArgumentResolver() - Constructor for class org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver
- AbstractNamedValueMethodArgumentResolver(ConfigurableBeanFactory) - Constructor for class org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver
-
Create a new
AbstractNamedValueMethodArgumentResolver
instance. - AbstractNamedValueMethodArgumentResolver.NamedValueInfo - Class in org.springframework.web.method.annotation
-
Represents the information about a named value, including name, whether it's required and a default value.
- AbstractReactiveWebInitializer - Class in org.springframework.web.server.adapter
-
Base class for a
WebApplicationInitializer
that installs a Spring Reactive Web Application on a Servlet container. - AbstractReactiveWebInitializer() - Constructor for class org.springframework.web.server.adapter.AbstractReactiveWebInitializer
- AbstractReactorHttpExchangeAdapter - Class in org.springframework.web.service.invoker
-
Convenient base class for a
ReactorHttpExchangeAdapter
implementation adapting to the synchronousHttpExchangeAdapter
contract. - AbstractReactorHttpExchangeAdapter() - Constructor for class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
-
Protected constructor, for subclasses.
- AbstractRefreshableWebApplicationContext - Class in org.springframework.web.context.support
-
AbstractRefreshableApplicationContext
subclass which implements theConfigurableWebApplicationContext
interface for web environments. - AbstractRefreshableWebApplicationContext() - Constructor for class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
- AbstractRequestAttributes - Class in org.springframework.web.context.request
-
Abstract support class for RequestAttributes implementations, offering a request completion mechanism for request-specific destruction callbacks and for updating accessed session attributes.
- AbstractRequestAttributes() - Constructor for class org.springframework.web.context.request.AbstractRequestAttributes
- AbstractRequestAttributesScope - Class in org.springframework.web.context.request
-
Abstract
Scope
implementation that reads from a particular scope in the current thread-boundRequestAttributes
object. - AbstractRequestAttributesScope() - Constructor for class org.springframework.web.context.request.AbstractRequestAttributesScope
- AbstractRequestLoggingFilter - Class in org.springframework.web.filter
-
Base class for
Filter
s that perform logging operations before and after a request is processed. - AbstractRequestLoggingFilter() - Constructor for class org.springframework.web.filter.AbstractRequestLoggingFilter
- AbstractServerHttpRequest - Class in org.springframework.http.server.reactive
-
Common base class for
ServerHttpRequest
implementations. - AbstractServerHttpRequest(HttpMethod, URI, String, MultiValueMap<String, String>) - Constructor for class org.springframework.http.server.reactive.AbstractServerHttpRequest
-
Constructor with the method, URI and headers for the request.
- AbstractServerHttpResponse - Class in org.springframework.http.server.reactive
-
Base class for
ServerHttpResponse
implementations. - AbstractServerHttpResponse(DataBufferFactory) - Constructor for class org.springframework.http.server.reactive.AbstractServerHttpResponse
- AbstractServerHttpResponse(DataBufferFactory, HttpHeaders) - Constructor for class org.springframework.http.server.reactive.AbstractServerHttpResponse
- AbstractWebArgumentResolverAdapter - Class in org.springframework.web.method.annotation
-
An abstract base class adapting a
WebArgumentResolver
to theHandlerMethodArgumentResolver
contract. - AbstractWebArgumentResolverAdapter(WebArgumentResolver) - Constructor for class org.springframework.web.method.annotation.AbstractWebArgumentResolverAdapter
-
Create a new instance.
- AbstractWireFeedHttpMessageConverter<T extends com.rometools.rome.feed.WireFeed> - Class in org.springframework.http.converter.feed
-
Abstract base class for Atom and RSS Feed message converters, using the ROME tools project.
- AbstractWireFeedHttpMessageConverter(MediaType) - Constructor for class org.springframework.http.converter.feed.AbstractWireFeedHttpMessageConverter
- AbstractXmlHttpMessageConverter<T> - Class in org.springframework.http.converter.xml
-
Abstract base class for
HttpMessageConverters
that convert from/to XML. - AbstractXmlHttpMessageConverter() - Constructor for class org.springframework.http.converter.xml.AbstractXmlHttpMessageConverter
-
Protected constructor that sets the
supportedMediaTypes
totext/xml
andapplication/xml
, andapplication/*+xml
. - accept() - Element in annotation interface org.springframework.web.service.annotation.DeleteExchange
-
Alias for
HttpExchange.accept()
. - accept() - Element in annotation interface org.springframework.web.service.annotation.GetExchange
-
Alias for
HttpExchange.accept()
. - accept() - Element in annotation interface org.springframework.web.service.annotation.HttpExchange
-
The media types for the
"Accept"
header. - accept() - Element in annotation interface org.springframework.web.service.annotation.PatchExchange
-
Alias for
HttpExchange.accept()
. - accept() - Element in annotation interface org.springframework.web.service.annotation.PostExchange
-
Alias for
HttpExchange.accept()
. - accept() - Element in annotation interface org.springframework.web.service.annotation.PutExchange
-
Alias for
HttpExchange.accept()
. - accept(MediaType...) - Method in interface org.springframework.http.RequestEntity.HeadersBuilder
-
Set the list of acceptable media types, as specified by the
Accept
header. - accept(MediaType...) - Method in interface org.springframework.web.client.RestClient.RequestHeadersSpec
-
Set the list of acceptable media types, as specified by the
Accept
header. - ACCEPT - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Accept
header field name. - ACCEPT_CHARSET - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Accept-Charset
header field name. - ACCEPT_ENCODING - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Accept-Encoding
header field name. - ACCEPT_LANGUAGE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Accept-Language
header field name. - ACCEPT_PATCH - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Accept-Patch
header field name. - ACCEPT_RANGES - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Accept-Ranges
header field name. - acceptCharset(Charset...) - Method in interface org.springframework.http.RequestEntity.HeadersBuilder
-
Set the list of acceptable charsets, as specified by the
Accept-Charset
header. - acceptCharset(Charset...) - Method in interface org.springframework.web.client.RestClient.RequestHeadersSpec
-
Set the list of acceptable charsets, as specified by the
Accept-Charset
header. - accepted() - Static method in class org.springframework.http.ResponseEntity
-
Create a builder with an ACCEPTED status.
- ACCEPTED - Enum constant in enum class org.springframework.http.HttpStatus
-
202 Accepted
. - AcceptHeaderLocaleContextResolver - Class in org.springframework.web.server.i18n
-
LocaleContextResolver
implementation that looks for a match between locales in theAccept-Language
header and a list of configured supported locales. - AcceptHeaderLocaleContextResolver() - Constructor for class org.springframework.web.server.i18n.AcceptHeaderLocaleContextResolver
- acceptHeaderRequestCallback(Class<T>) - Method in class org.springframework.web.client.RestTemplate
-
Return a
RequestCallback
that sets the requestAccept
header based on the given response type, cross-checked against the configured message converters. - ACCESS_CONTROL_ALLOW_CREDENTIALS - Static variable in class org.springframework.http.HttpHeaders
-
The CORS
Access-Control-Allow-Credentials
response header field name. - ACCESS_CONTROL_ALLOW_HEADERS - Static variable in class org.springframework.http.HttpHeaders
-
The CORS
Access-Control-Allow-Headers
response header field name. - ACCESS_CONTROL_ALLOW_METHODS - Static variable in class org.springframework.http.HttpHeaders
-
The CORS
Access-Control-Allow-Methods
response header field name. - ACCESS_CONTROL_ALLOW_ORIGIN - Static variable in class org.springframework.http.HttpHeaders
-
The CORS
Access-Control-Allow-Origin
response header field name. - ACCESS_CONTROL_EXPOSE_HEADERS - Static variable in class org.springframework.http.HttpHeaders
-
The CORS
Access-Control-Expose-Headers
response header field name. - ACCESS_CONTROL_MAX_AGE - Static variable in class org.springframework.http.HttpHeaders
-
The CORS
Access-Control-Max-Age
response header field name. - ACCESS_CONTROL_REQUEST_HEADERS - Static variable in class org.springframework.http.HttpHeaders
-
The CORS
Access-Control-Request-Headers
request header field name. - ACCESS_CONTROL_REQUEST_METHOD - Static variable in class org.springframework.http.HttpHeaders
-
The CORS
Access-Control-Request-Method
request header field name. - adaptEmptyArrayIndices(MutablePropertyValues) - Method in class org.springframework.web.bind.WebDataBinder
-
Check for property values with names that end on
"[]"
. - adaptFromForwardedHeaders(URI, HttpHeaders) - Static method in class org.springframework.web.util.ForwardedHeaderUtils
- add(String, String) - Method in class org.springframework.http.HttpHeaders
-
Add the given, single header value under the given name.
- add(String, String) - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- add(String, String) - Method in class org.springframework.http.support.JettyHeadersAdapter
- add(String, String) - Method in class org.springframework.http.support.Netty4HeadersAdapter
- add(String, String) - Method in class org.springframework.http.support.Netty5HeadersAdapter
- addAll(String, List<? extends String>) - Method in class org.springframework.http.HttpHeaders
- addAll(String, List<? extends String>) - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- addAll(String, List<? extends String>) - Method in class org.springframework.http.support.JettyHeadersAdapter
- addAll(String, List<? extends String>) - Method in class org.springframework.http.support.Netty4HeadersAdapter
- addAll(String, List<? extends String>) - Method in class org.springframework.http.support.Netty5HeadersAdapter
- addAll(MultiValueMap<String, String>) - Method in class org.springframework.http.HttpHeaders
- addAll(MultiValueMap<String, String>) - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- addAll(MultiValueMap<String, String>) - Method in class org.springframework.http.support.JettyHeadersAdapter
- addAll(MultiValueMap<String, String>) - Method in class org.springframework.http.support.Netty4HeadersAdapter
- addAll(MultiValueMap<String, String>) - Method in class org.springframework.http.support.Netty5HeadersAdapter
- addAllAttributes(Map<String, ?>) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Copy all attributes to the underlying model.
- addAllErrors(Errors) - Method in class org.springframework.web.bind.EscapedErrors
- addAllErrors(Errors) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- addAllowedHeader(String) - Method in class org.springframework.web.cors.CorsConfiguration
-
Variant of
CorsConfiguration.setAllowedHeaders(List)
for adding one allowed header at a time. - addAllowedMethod(String) - Method in class org.springframework.web.cors.CorsConfiguration
-
Variant of
CorsConfiguration.setAllowedMethods(java.util.List<java.lang.String>)
for adding one allowed method at a time. - addAllowedMethod(HttpMethod) - Method in class org.springframework.web.cors.CorsConfiguration
-
Variant of
CorsConfiguration.setAllowedMethods(java.util.List<java.lang.String>)
for adding one allowed method at a time. - addAllowedOrigin(String) - Method in class org.springframework.web.cors.CorsConfiguration
-
Variant of
CorsConfiguration.setAllowedOrigins(java.util.List<java.lang.String>)
for adding one origin at a time. - addAllowedOriginPattern(String) - Method in class org.springframework.web.cors.CorsConfiguration
-
Variant of
CorsConfiguration.setAllowedOriginPatterns(java.util.List<java.lang.String>)
for adding one origin at a time. - addAttribute(Object) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Add the supplied attribute to the underlying model.
- addAttribute(String, Object) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Add the supplied attribute to the underlying model.
- addAttribute(String, Object) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Configure an attribute to associate with the request.
- addAttribute(String, Object) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- addBindValue(Map<String, Object>, String, List<?>) - Static method in class org.springframework.web.bind.support.WebExchangeDataBinder
- addBindValues(MutablePropertyValues, ServletRequest) - Method in class org.springframework.web.bind.ServletRequestDataBinder
-
Extension point that subclasses can use to add extra bind values for a request.
- addCompletionHandler(Runnable) - Method in interface org.springframework.web.context.request.async.AsyncWebRequest
-
Add a handler to invoke when request processing completes.
- addCompletionHandler(Runnable) - Method in class org.springframework.web.context.request.async.StandardServletAsyncWebRequest
- addCookie(HttpServletResponse, String) - Method in class org.springframework.web.util.CookieGenerator
-
Deprecated.Add a cookie with the given value to the response, using the cookie descriptor settings of this generator.
- addCookie(String, String...) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Add the given cookie name and values.
- addCookie(String, String...) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- addCookie(ResponseCookie) - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
- addCookie(ResponseCookie) - Method in interface org.springframework.http.server.reactive.ServerHttpResponse
-
Add the given
ResponseCookie
. - addCookie(ResponseCookie) - Method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
- addCookieInitializer(Consumer<ResponseCookie.ResponseCookieBuilder>) - Method in class org.springframework.web.server.session.CookieWebSessionIdResolver
-
Add a
Consumer
to further initialize the session id cookie afterCookieWebSessionIdResolver.getCookieName()
andCookieWebSessionIdResolver.getCookieMaxAge()
are applied. - addDefaultHeaders(HttpHeaders, String, MediaType) - Method in class org.springframework.http.converter.StringHttpMessageConverter
- addDefaultHeaders(HttpHeaders, T, MediaType) - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
-
Add default headers to the output message.
- addDefaultHeaders(HttpOutputMessage, Resource, MediaType) - Method in class org.springframework.http.converter.ResourceHttpMessageConverter
-
Adds the default headers for the given resource to the given message.
- addDefaultHeaders(ReactiveHttpOutputMessage, Resource, MediaType, Map<String, Object>) - Method in class org.springframework.http.codec.ResourceHttpMessageWriter
-
Adds the default headers for the given resource to the given message.
- addError(ObjectError) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- addErrorHandler(Consumer<Throwable>) - Method in interface org.springframework.web.context.request.async.AsyncWebRequest
-
Add a handler to invoke when an error occurred while concurrent handling of a request.
- addErrorHandler(Consumer<Throwable>) - Method in class org.springframework.web.context.request.async.StandardServletAsyncWebRequest
- addExposedHeader(String) - Method in class org.springframework.web.cors.CorsConfiguration
-
Variant of
CorsConfiguration.setExposedHeaders(java.util.List<java.lang.String>)
for adding one exposed header at a time. - addFileExtensionResolvers(MediaTypeFileExtensionResolver...) - Method in class org.springframework.web.accept.ContentNegotiationManager
-
Register more
MediaTypeFileExtensionResolver
instances in addition to those detected at construction. - addGlobalResourcesConsumer(Consumer<HttpResources>) - Method in class org.springframework.http.client.ReactorResourceFactory
-
Add a Consumer for configuring the global Reactor Netty resources on startup.
- addGlobalResourcesConsumer(Consumer<HttpResources>) - Method in class org.springframework.http.client.reactive.ReactorNetty2ResourceFactory
-
Add a Consumer for configuring the global Reactor Netty resources on startup.
- addHandler(HandlerMethodReturnValueHandler) - Method in class org.springframework.web.method.support.HandlerMethodReturnValueHandlerComposite
-
Add the given
HandlerMethodReturnValueHandler
. - addHandlers(List<? extends HandlerMethodReturnValueHandler>) - Method in class org.springframework.web.method.support.HandlerMethodReturnValueHandlerComposite
-
Add the given
HandlerMethodReturnValueHandlers
. - addHeader(String, String) - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- addHeader(String, String...) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Add the given header name and values.
- addHeader(String, String...) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- addHeaders(ReactiveHttpOutputMessage, Resource, MediaType, Map<String, Object>) - Method in class org.springframework.http.codec.ResourceHttpMessageWriter
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.1, in favor of
ResourceHttpMessageWriter.addDefaultHeaders(ReactiveHttpOutputMessage, Resource, MediaType, Map)
, for removal = 6.2 - addIntHeader(String, int) - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- addMapping(String, MediaType) - Method in class org.springframework.web.accept.MappingMediaTypeFileExtensionResolver
-
Map an extension to a MediaType.
- addMediaType(String, MediaType) - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
An alternative to
ContentNegotiationManagerFactoryBean.setMediaTypes(java.util.Properties)
for programmatic registrations. - addMediaTypes(Map<String, MediaType>) - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
An alternative to
ContentNegotiationManagerFactoryBean.setMediaTypes(java.util.Properties)
for programmatic registrations. - addPartConverter(HttpMessageConverter<?>) - Method in class org.springframework.http.converter.FormHttpMessageConverter
-
Add a message body converter.
- addRequestParameter(String, String...) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Add the given request parameter name and values.
- addRequestParameter(String, String...) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- addRequestPart(String, Object) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Add a part for a multipart request.
- addRequestPart(String, Object) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
-
Add a part to a multipart request.
- addRequestPart(String, P, ResolvableType) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of
ReactiveHttpRequestValues.Builder.addRequestPartPublisher(java.lang.String, P, org.springframework.core.ParameterizedTypeReference<T>)
; to be removed in 6.2 - addRequestPart(String, P, ResolvableType) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- addRequestPartPublisher(String, P, ParameterizedTypeReference<T>) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
-
Variant of
ReactiveHttpRequestValues.Builder.addRequestPart(String, Object)
that allows the part value to be produced by aPublisher
. - addRequestValue(String, Object, MethodParameter, HttpRequestValues.Builder) - Method in class org.springframework.web.service.invoker.AbstractNamedValueArgumentResolver
-
Add the given, single request value.
- addRequestValue(String, Object, MethodParameter, HttpRequestValues.Builder) - Method in class org.springframework.web.service.invoker.CookieValueArgumentResolver
- addRequestValue(String, Object, MethodParameter, HttpRequestValues.Builder) - Method in class org.springframework.web.service.invoker.PathVariableArgumentResolver
- addRequestValue(String, Object, MethodParameter, HttpRequestValues.Builder) - Method in class org.springframework.web.service.invoker.RequestAttributeArgumentResolver
- addRequestValue(String, Object, MethodParameter, HttpRequestValues.Builder) - Method in class org.springframework.web.service.invoker.RequestHeaderArgumentResolver
- addRequestValue(String, Object, MethodParameter, HttpRequestValues.Builder) - Method in class org.springframework.web.service.invoker.RequestParamArgumentResolver
- addRequestValue(String, Object, MethodParameter, HttpRequestValues.Builder) - Method in class org.springframework.web.service.invoker.RequestPartArgumentResolver
- addRequiredProperty(String) - Method in class org.springframework.web.filter.GenericFilterBean
-
Subclasses can invoke this method to specify that this property (which must match a JavaBean property they expose) is mandatory, and must be supplied as a config parameter.
- addResolver(HandlerMethodArgumentResolver) - Method in class org.springframework.web.method.support.HandlerMethodArgumentResolverComposite
-
Add the given
HandlerMethodArgumentResolver
. - addResolvers(List<? extends HandlerMethodArgumentResolver>) - Method in class org.springframework.web.method.support.HandlerMethodArgumentResolverComposite
-
Add the given
HandlerMethodArgumentResolvers
. - addResolvers(HandlerMethodArgumentResolver...) - Method in class org.springframework.web.method.support.HandlerMethodArgumentResolverComposite
-
Add the given
HandlerMethodArgumentResolvers
. - addSupportedMediaTypes(MediaType...) - Method in class org.springframework.http.converter.FormHttpMessageConverter
-
Add
MediaType
objects to be supported by this converter. - addTimeoutHandler(Runnable) - Method in interface org.springframework.web.context.request.async.AsyncWebRequest
-
Add a handler to invoke when concurrent handling has timed out.
- addTimeoutHandler(Runnable) - Method in class org.springframework.web.context.request.async.StandardServletAsyncWebRequest
- addUrlTransformer(Function<String, String>) - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- addUrlTransformer(Function<String, String>) - Method in interface org.springframework.web.server.ServerWebExchange
-
Register an additional URL transformation function for use with
ServerWebExchange.transformUrl(java.lang.String)
. - addUrlTransformer(Function<String, String>) - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- afterCompletion(NativeWebRequest, Callable<T>) - Method in interface org.springframework.web.context.request.async.CallableProcessingInterceptor
-
Invoked from a container thread when async processing completes for any reason including timeout or network error.
- afterCompletion(NativeWebRequest, DeferredResult<T>) - Method in interface org.springframework.web.context.request.async.DeferredResultProcessingInterceptor
-
Invoked from a container thread when an async request completed for any reason including timeout and network error.
- afterCompletion(WebRequest, Exception) - Method in interface org.springframework.web.context.request.WebRequestInterceptor
-
Callback after completion of request processing, that is, after rendering the view.
- afterConcurrentHandlingStarted(WebRequest) - Method in interface org.springframework.web.context.request.AsyncWebRequestInterceptor
-
Called instead of
postHandle
andafterCompletion
, when the handler started handling the request concurrently. - afterPhase(PhaseEvent) - Method in class org.springframework.web.jsf.DelegatingPhaseListenerMulticaster
- afterPropertiesSet() - Method in class org.springframework.http.client.JettyClientHttpRequestFactory
- afterPropertiesSet() - Method in class org.springframework.http.client.reactive.JdkHttpClientResourceFactory
- afterPropertiesSet() - Method in class org.springframework.http.client.reactive.JettyResourceFactory
- afterPropertiesSet() - Method in class org.springframework.http.client.reactive.ReactorNetty2ResourceFactory
- afterPropertiesSet() - Method in class org.springframework.http.client.ReactorResourceFactory
- afterPropertiesSet() - Method in class org.springframework.http.client.support.ProxyFactoryBean
- afterPropertiesSet() - Method in class org.springframework.http.converter.json.GsonFactoryBean
- afterPropertiesSet() - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
- afterPropertiesSet() - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
- afterPropertiesSet() - Method in class org.springframework.web.filter.GenericFilterBean
-
Calls the
initFilterBean()
method that might contain custom initialization of a subclass. - afterPropertiesSet() - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
This method must be invoked after all properties have been set to complete initialization.
- afterRequest(HttpServletRequest, String) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Concrete subclasses should implement this method to write a log message after the request is processed.
- afterRequest(HttpServletRequest, String) - Method in class org.springframework.web.filter.CommonsRequestLoggingFilter
-
Writes a log message after the request is processed.
- afterRequest(HttpServletRequest, String) - Method in class org.springframework.web.filter.ServletContextRequestLoggingFilter
-
Writes a log message after the request is processed.
- AGE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Age
header field name. - ALL - Static variable in class org.springframework.http.MediaType
-
Public constant media type that includes all media ranges (i.e.
- ALL - Static variable in class org.springframework.web.cors.CorsConfiguration
-
Wildcard representing all origins, methods, or headers.
- ALL_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.ALL
. - AllEncompassingFormHttpMessageConverter - Class in org.springframework.http.converter.support
-
Extension of
FormHttpMessageConverter
, adding support for XML and JSON-based parts. - AllEncompassingFormHttpMessageConverter() - Constructor for class org.springframework.http.converter.support.AllEncompassingFormHttpMessageConverter
- allow(HttpMethod...) - Method in interface org.springframework.http.ResponseEntity.HeadersBuilder
-
Set the set of allowed
HTTP methods
, as specified by theAllow
header. - ALLOW - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Allow
header field name. - allowCredentials() - Element in annotation interface org.springframework.web.bind.annotation.CrossOrigin
-
Whether the browser should send credentials, such as cookies along with cross domain requests, to the annotated endpoint.
- allowedHeaders() - Element in annotation interface org.springframework.web.bind.annotation.CrossOrigin
-
The list of request headers that are permitted in actual requests, possibly
"*"
to allow all headers. - allowPrivateNetwork() - Element in annotation interface org.springframework.web.bind.annotation.CrossOrigin
-
Whether private network access is supported.
- ALREADY_FILTERED_SUFFIX - Static variable in class org.springframework.web.filter.OncePerRequestFilter
-
Suffix that gets appended to the filter name for the "already filtered" request attribute.
- ALREADY_REPORTED - Enum constant in enum class org.springframework.http.HttpStatus
-
208 Already Reported
. - annotation(Class<? extends Annotation>...) - Method in class org.springframework.web.method.HandlerTypePredicate.Builder
-
Match types that are annotated with one of the given annotations.
- AnnotationConfigWebApplicationContext - Class in org.springframework.web.context.support
-
WebApplicationContext
implementation which accepts component classes as input — in particular@Configuration
classes, but also plain@Component
classes as well as JSR-330 compliant classes usingjakarta.inject
annotations. - AnnotationConfigWebApplicationContext() - Constructor for class org.springframework.web.context.support.AnnotationConfigWebApplicationContext
- annotationIntrospector(AnnotationIntrospector) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Set an
AnnotationIntrospector
for both serialization and deserialization. - annotationIntrospector(Function<AnnotationIntrospector, AnnotationIntrospector>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Alternative to
Jackson2ObjectMapperBuilder.annotationIntrospector(AnnotationIntrospector)
that allows combining with rather than replacing the currently set introspector, e.g. - annotations() - Element in annotation interface org.springframework.web.bind.annotation.ControllerAdvice
-
Array of annotation types.
- annotations() - Element in annotation interface org.springframework.web.bind.annotation.RestControllerAdvice
-
Array of annotations.
- APPLICATION_ATOM_XML - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
application/atom+xml
. - APPLICATION_ATOM_XML_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.APPLICATION_ATOM_XML
. - APPLICATION_CBOR - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
application/cbor
. - APPLICATION_CBOR_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.APPLICATION_CBOR
. - APPLICATION_CONTEXT_ID_PREFIX - Static variable in interface org.springframework.web.context.ConfigurableWebApplicationContext
-
Prefix for ApplicationContext ids that refer to context path and/or servlet name.
- APPLICATION_FORM_URLENCODED - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
application/x-www-form-urlencoded
. - APPLICATION_FORM_URLENCODED_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.APPLICATION_FORM_URLENCODED
. - APPLICATION_GRAPHQL - Static variable in class org.springframework.http.MediaType
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0.3, in favor of
MediaType.APPLICATION_GRAPHQL_RESPONSE
- APPLICATION_GRAPHQL_RESPONSE - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
application/graphql-response+json
. - APPLICATION_GRAPHQL_RESPONSE_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.APPLICATION_GRAPHQL_RESPONSE
. - APPLICATION_GRAPHQL_VALUE - Static variable in class org.springframework.http.MediaType
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0.3, in favor of
MediaType.APPLICATION_GRAPHQL_RESPONSE_VALUE
- APPLICATION_JSON - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
application/json
. - APPLICATION_JSON_UTF8 - Static variable in class org.springframework.http.MediaType
-
Deprecated.as of 5.2 in favor of
MediaType.APPLICATION_JSON
since major browsers like Chrome now comply with the specification and interpret correctly UTF-8 special characters without requiring acharset=UTF-8
parameter. - APPLICATION_JSON_UTF8_VALUE - Static variable in class org.springframework.http.MediaType
-
Deprecated.as of 5.2 in favor of
MediaType.APPLICATION_JSON_VALUE
since major browsers like Chrome now comply with the specification and interpret correctly UTF-8 special characters without requiring acharset=UTF-8
parameter. - APPLICATION_JSON_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.APPLICATION_JSON
. - APPLICATION_NDJSON - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
application/x-ndjson
. - APPLICATION_NDJSON_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.APPLICATION_NDJSON
. - APPLICATION_OCTET_STREAM - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
application/octet-stream
. - APPLICATION_OCTET_STREAM_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.APPLICATION_OCTET_STREAM
. - APPLICATION_PDF - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
application/pdf
. - APPLICATION_PDF_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.APPLICATION_PDF
. - APPLICATION_PROBLEM_JSON - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
application/problem+json
. - APPLICATION_PROBLEM_JSON_UTF8 - Static variable in class org.springframework.http.MediaType
-
Deprecated.as of 5.2 in favor of
MediaType.APPLICATION_PROBLEM_JSON
since major browsers like Chrome now comply with the specification and interpret correctly UTF-8 special characters without requiring acharset=UTF-8
parameter. - APPLICATION_PROBLEM_JSON_UTF8_VALUE - Static variable in class org.springframework.http.MediaType
-
Deprecated.as of 5.2 in favor of
MediaType.APPLICATION_PROBLEM_JSON_VALUE
since major browsers like Chrome now comply with the specification and interpret correctly UTF-8 special characters without requiring acharset=UTF-8
parameter. - APPLICATION_PROBLEM_JSON_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.APPLICATION_PROBLEM_JSON
. - APPLICATION_PROBLEM_XML - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
application/problem+xml
. - APPLICATION_PROBLEM_XML_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.APPLICATION_PROBLEM_XML
. - APPLICATION_PROTOBUF - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
application/x-protobuf
. - APPLICATION_PROTOBUF_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.APPLICATION_PROTOBUF
. - APPLICATION_RSS_XML - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
application/rss+xml
. - APPLICATION_RSS_XML_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.APPLICATION_RSS_XML
. - APPLICATION_STREAM_JSON - Static variable in class org.springframework.http.MediaType
-
Deprecated.as of 5.3, see notice on
MediaType.APPLICATION_STREAM_JSON_VALUE
. - APPLICATION_STREAM_JSON_VALUE - Static variable in class org.springframework.http.MediaType
-
Deprecated.as of 5.3 since it originates from the W3C Activity Streams specification which has a more specific purpose and has been since replaced with a different mime type. Use
MediaType.APPLICATION_NDJSON
as a replacement or any other line-delimited JSON format (e.g. JSON Lines, JSON Text Sequences). - APPLICATION_XHTML_XML - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
application/xhtml+xml
. - APPLICATION_XHTML_XML_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.APPLICATION_XHTML_XML
. - APPLICATION_XML - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
application/xml
. - APPLICATION_XML_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.APPLICATION_XML
. - applicationContext(ApplicationContext) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Set the Spring
ApplicationContext
in order to autowire Jackson handlers (JsonSerializer
,JsonDeserializer
,KeyDeserializer
,TypeResolverBuilder
andTypeIdResolver
). - applicationContext(ApplicationContext) - Static method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Static factory method to create a new builder instance by detecting beans in an
ApplicationContext
. - ApplicationScope - Annotation Interface in org.springframework.web.context.annotation
-
@ApplicationScope
is a specialization of@Scope
for a component whose lifecycle is bound to the current web application. - apply(Consumer<RestClient.Builder>) - Method in interface org.springframework.web.client.RestClient.Builder
-
Apply the given
Consumer
to this builder instance. - apply(ServerHttpRequest) - Method in class org.springframework.web.server.adapter.ForwardedHeaderTransformer
-
Apply and remove, or remove Forwarded type headers.
- apply(HttpServerRequest, HttpServerResponse) - Method in class org.springframework.http.server.reactive.ReactorHttpHandlerAdapter
- apply(HttpServerRequest, HttpServerResponse) - Method in class org.springframework.http.server.reactive.ReactorNetty2HttpHandlerAdapter
- applyArgumentValidation(Object, Method, MethodParameter[], Object[], Class<?>[]) - Method in class org.springframework.web.method.annotation.HandlerMethodValidator
- applyCookies() - Method in class org.springframework.http.client.reactive.AbstractClientHttpRequest
-
Add cookies from
AbstractClientHttpRequest.getHeaders()
to the underlying request. - applyCookies() - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
-
Add cookies from
AbstractServerHttpResponse.getHeaders()
to the underlying response. - applyHeaders() - Method in class org.springframework.http.client.reactive.AbstractClientHttpRequest
-
Apply header changes from
AbstractClientHttpRequest.getHeaders()
to the underlying request. - applyHeaders() - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
-
Invoked when the response is getting committed allowing subclasses to make apply header values to the underlying response.
- applyPermitDefaultValues() - Method in class org.springframework.web.cors.CorsConfiguration
-
By default
CorsConfiguration
does not permit any cross-origin requests and must be configured explicitly. - applyReturnValueValidation(Object, Method, MethodParameter, Object, Class<?>[]) - Method in class org.springframework.web.method.annotation.HandlerMethodValidator
- applyStatusCode() - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
-
Write the status code to the underlying response.
- applyTo(BlockHound.Builder) - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder.SpringWebBlockHoundIntegration
- asHttpMethod() - Method in enum class org.springframework.web.bind.annotation.RequestMethod
-
Return the
HttpMethod
corresponding to thisRequestMethod
. - asMediaType(MimeType) - Static method in class org.springframework.http.MediaType
-
Re-create the given mime type as a media type.
- asMediaTypes(List<MimeType>) - Static method in class org.springframework.http.MediaType
-
Re-create the given mime types as media types.
- asReactorExchangeAdapter() - Method in interface org.springframework.web.service.invoker.HttpClientAdapter
-
Deprecated.Adapt this instance to
ReactorHttpExchangeAdapter
. - assertHasAncestorOfType(Tag, Class<?>, String, String) - Static method in class org.springframework.web.util.TagUtils
-
Determine whether the supplied
Tag
has any ancestor tag of the supplied type, throwing anIllegalStateException
if not. - assertNotExecuted() - Method in class org.springframework.http.client.AbstractClientHttpRequest
-
Assert that this request has not been executed yet.
- assertTargetBean(Method, Object, Object[]) - Method in class org.springframework.web.method.HandlerMethod
-
Assert that the target bean class is an instance of the class where the given method is declared.
- assignableType(Class<?>...) - Method in class org.springframework.web.method.HandlerTypePredicate.Builder
-
Match handlers that are assignable to a given type.
- assignableTypes() - Element in annotation interface org.springframework.web.bind.annotation.ControllerAdvice
-
Array of classes.
- assignableTypes() - Element in annotation interface org.springframework.web.bind.annotation.RestControllerAdvice
-
Array of classes.
- AsyncHandlerMethodReturnValueHandler - Interface in org.springframework.web.method.support
-
A return value handler that supports async types.
- asyncPart(String, P, Class<T>) - Method in class org.springframework.http.client.MultipartBodyBuilder
-
Add a part from
Publisher
content. - asyncPart(String, P, ParameterizedTypeReference<T>) - Method in class org.springframework.http.client.MultipartBodyBuilder
-
Variant of
MultipartBodyBuilder.asyncPart(String, Publisher, Class)
with aParameterizedTypeReference
for the element type information. - AsyncRequestNotUsableException - Exception in org.springframework.web.context.request.async
-
Raised when the response for an asynchronous request becomes unusable as indicated by a write failure, or a Servlet container error notification, or after the async request has completed.
- AsyncRequestNotUsableException(String) - Constructor for exception org.springframework.web.context.request.async.AsyncRequestNotUsableException
- AsyncRequestNotUsableException(String, Throwable) - Constructor for exception org.springframework.web.context.request.async.AsyncRequestNotUsableException
- AsyncRequestTimeoutException - Exception in org.springframework.web.context.request.async
-
Exception to be thrown when an async request times out.
- AsyncRequestTimeoutException() - Constructor for exception org.springframework.web.context.request.async.AsyncRequestTimeoutException
- AsyncWebRequest - Interface in org.springframework.web.context.request.async
-
Extends
NativeWebRequest
with methods for asynchronous request processing. - AsyncWebRequestInterceptor - Interface in org.springframework.web.context.request
-
Extends
WebRequestInterceptor
with a callback method invoked during asynchronous request handling. - AtomFeedHttpMessageConverter - Class in org.springframework.http.converter.feed
-
Implementation of
HttpMessageConverter
that can read and write Atom feeds. - AtomFeedHttpMessageConverter() - Constructor for class org.springframework.http.converter.feed.AtomFeedHttpMessageConverter
- attachment() - Static method in class org.springframework.http.ContentDisposition
-
Return a builder for a
ContentDisposition
of type "attachment". - AUTHORIZATION - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Authorization
header field name. - autoDetectFields(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Shortcut for
MapperFeature.AUTO_DETECT_FIELDS
option. - autoDetectGettersSetters(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
B
- BAD_GATEWAY - Enum constant in enum class org.springframework.http.HttpStatus
-
502 Bad Gateway
. - BAD_REQUEST - Enum constant in enum class org.springframework.http.HttpStatus
-
400 Bad Request
. - BADLY_FORMED_CAPTURE_THE_REST - Enum constant in enum class org.springframework.web.util.pattern.PatternParseException.PatternMessage
- badRequest() - Static method in class org.springframework.http.ResponseEntity
-
Create a builder with a BAD_REQUEST status.
- BANDWIDTH_LIMIT_EXCEEDED - Enum constant in enum class org.springframework.http.HttpStatus
-
509 Bandwidth Limit Exceeded
- basePackage(String...) - Method in class org.springframework.web.method.HandlerTypePredicate.Builder
-
Match handlers declared under a base package, e.g.
- basePackageClass(Class<?>...) - Method in class org.springframework.web.method.HandlerTypePredicate.Builder
-
Type-safe alternative to
HandlerTypePredicate.forBasePackage(String...)
to specify a base package through a class. - basePackageClasses() - Element in annotation interface org.springframework.web.bind.annotation.ControllerAdvice
-
Type-safe alternative to
ControllerAdvice.basePackages()
for specifying the packages in which to select controllers to be advised by the@ControllerAdvice
annotated class. - basePackageClasses() - Element in annotation interface org.springframework.web.bind.annotation.RestControllerAdvice
-
Type-safe alternative to
RestControllerAdvice.basePackages()
for specifying the packages in which to select controllers to be advised by the@RestControllerAdvice
annotated class. - basePackages() - Element in annotation interface org.springframework.web.bind.annotation.ControllerAdvice
-
Array of base packages.
- basePackages() - Element in annotation interface org.springframework.web.bind.annotation.RestControllerAdvice
-
Array of base packages.
- baseUrl(String) - Method in interface org.springframework.web.client.RestClient.Builder
-
Configure a base URL for requests.
- BasicAuthenticationInterceptor - Class in org.springframework.http.client.support
-
ClientHttpRequestInterceptor
to apply a given HTTP Basic Authentication username/password pair, unless a customAuthorization
header has already been set. - BasicAuthenticationInterceptor(String, String) - Constructor for class org.springframework.http.client.support.BasicAuthenticationInterceptor
-
Create a new interceptor which adds Basic Authentication for the given username and password.
- BasicAuthenticationInterceptor(String, String, Charset) - Constructor for class org.springframework.http.client.support.BasicAuthenticationInterceptor
-
Create a new interceptor which adds Basic Authentication for the given username and password, encoded using the specified charset.
- beforeCommit(Supplier<? extends Mono<Void>>) - Method in class org.springframework.http.client.reactive.AbstractClientHttpRequest
- beforeCommit(Supplier<? extends Mono<Void>>) - Method in class org.springframework.http.client.reactive.ClientHttpRequestDecorator
- beforeCommit(Supplier<? extends Mono<Void>>) - Method in interface org.springframework.http.ReactiveHttpOutputMessage
-
Register an action to apply just before the HttpOutputMessage is committed.
- beforeCommit(Supplier<? extends Mono<Void>>) - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
- beforeCommit(Supplier<? extends Mono<Void>>) - Method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
- beforeConcurrentHandling(NativeWebRequest, Callable<T>) - Method in interface org.springframework.web.context.request.async.CallableProcessingInterceptor
-
Invoked before the start of concurrent handling in the original thread in which the
Callable
is submitted for concurrent handling. - beforeConcurrentHandling(NativeWebRequest, DeferredResult<T>) - Method in interface org.springframework.web.context.request.async.DeferredResultProcessingInterceptor
-
Invoked immediately before the start of concurrent handling, in the same thread that started it.
- beforePhase(PhaseEvent) - Method in class org.springframework.web.jsf.DelegatingPhaseListenerMulticaster
- beforeRequest(HttpServletRequest, String) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Concrete subclasses should implement this method to write a log message before the request is processed.
- beforeRequest(HttpServletRequest, String) - Method in class org.springframework.web.filter.CommonsRequestLoggingFilter
-
Writes a log message before the request is processed.
- beforeRequest(HttpServletRequest, String) - Method in class org.springframework.web.filter.ServletContextRequestLoggingFilter
-
Writes a log message before the request is processed.
- bind(ServletRequest) - Method in class org.springframework.web.bind.ServletRequestDataBinder
-
Bind the parameters of the given request to this binder's target, also binding multipart files in case of a multipart request.
- bind(WebRequest) - Method in class org.springframework.web.bind.support.WebRequestDataBinder
-
Bind the parameters of the given request to this binder's target, also binding multipart files in case of a multipart request.
- bind(ServerWebExchange) - Method in class org.springframework.web.bind.support.WebExchangeDataBinder
-
Bind query parameters, form data, or multipart form data to the binder target.
- BindErrorUtils - Class in org.springframework.web.util
-
Utility methods to resolve a list of
MessageSourceResolvable
s, and optionally join them. - BindErrorUtils() - Constructor for class org.springframework.web.util.BindErrorUtils
- binding() - Element in annotation interface org.springframework.web.bind.annotation.ModelAttribute
-
Allows data binding to be disabled directly on an
@ModelAttribute
method parameter or on the attribute returned from an@ModelAttribute
method, both of which would prevent data binding for that attribute. - bindMultipart(Map<String, List<MultipartFile>>, MutablePropertyValues) - Method in class org.springframework.web.bind.WebDataBinder
-
Bind all multipart files contained in the given request, if any (in case of a multipart request).
- BindParam - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation to bind values from a web request such as request parameters or path variables to fields of a Java object.
- BindParamNameResolver - Class in org.springframework.web.bind.support
-
DataBinder.NameResolver
that determines the bind value name from a@BindParam
method parameter annotation. - BindParamNameResolver() - Constructor for class org.springframework.web.bind.support.BindParamNameResolver
- bindParts(HttpServletRequest, MutablePropertyValues, boolean) - Static method in class org.springframework.web.multipart.support.StandardServletPartUtils
-
Bind all parts from the given servlet request.
- bindRequestParameters(WebDataBinder, NativeWebRequest) - Method in class org.springframework.web.method.annotation.ModelAttributeMethodProcessor
-
Extension point to bind the request to the target object via setters/fields.
- blockTimeout(Duration) - Method in class org.springframework.web.service.invoker.HttpServiceProxyFactory.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of setting the same directly on the
HttpExchangeAdapter
- body(Class<T>) - Method in interface org.springframework.web.client.RestClient.ResponseSpec
-
Extract the body as an object of the given type.
- body(Object) - Method in interface org.springframework.web.client.RestClient.RequestBodySpec
-
Set the body of the request to the given
Object
. - body(ParameterizedTypeReference<T>) - Method in interface org.springframework.web.client.RestClient.ResponseSpec
-
Extract the body as an object of the given type.
- body(StreamingHttpOutputMessage.Body) - Method in interface org.springframework.web.client.RestClient.RequestBodySpec
-
Set the body of the request to the given function that writes to an
OutputStream
. - body(T) - Method in interface org.springframework.http.RequestEntity.BodyBuilder
-
Set the body of the request entity and build the RequestEntity.
- body(T) - Method in interface org.springframework.http.ResponseEntity.BodyBuilder
-
Set the body of the response entity and returns it.
- body(T, Type) - Method in interface org.springframework.http.RequestEntity.BodyBuilder
-
Set the body and type of the request entity and build the RequestEntity.
- body(T, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.client.RestClient.RequestBodySpec
-
Set the body of the request to the given
Object
. - bodyTo(Class<T>) - Method in interface org.springframework.web.client.RestClient.RequestHeadersSpec.ConvertibleClientHttpResponse
-
Extract the response body as an object of the given type.
- bodyTo(ParameterizedTypeReference<T>) - Method in interface org.springframework.web.client.RestClient.RequestHeadersSpec.ConvertibleClientHttpResponse
-
Extract the response body as an object of the given type.
- BufferedImageHttpMessageConverter - Class in org.springframework.http.converter
-
Implementation of
HttpMessageConverter
that can read and writeBufferedImages
. - BufferedImageHttpMessageConverter() - Constructor for class org.springframework.http.converter.BufferedImageHttpMessageConverter
- bufferFactory() - Method in class org.springframework.http.client.reactive.ClientHttpRequestDecorator
- bufferFactory() - Method in interface org.springframework.http.ReactiveHttpOutputMessage
-
Return a
DataBufferFactory
that can be used to create the body. - bufferFactory() - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
- bufferFactory() - Method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
- BufferingClientHttpRequestFactory - Class in org.springframework.http.client
-
Wrapper for a
ClientHttpRequestFactory
that buffers all outgoing and incoming streams in memory. - BufferingClientHttpRequestFactory(ClientHttpRequestFactory) - Constructor for class org.springframework.http.client.BufferingClientHttpRequestFactory
-
Create a buffering wrapper for the given
ClientHttpRequestFactory
. - build() - Method in class org.springframework.http.client.MultipartBodyBuilder
-
Return a
MultiValueMap
with the configured parts. - build() - Method in interface org.springframework.http.codec.ServerSentEvent.Builder
-
Builds the event.
- build() - Method in interface org.springframework.http.ContentDisposition.Builder
-
Build the content disposition.
- build() - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Build a new
ObjectMapper
instance. - build() - Method in interface org.springframework.http.RequestEntity.HeadersBuilder
-
Builds the request entity with no body.
- build() - Method in interface org.springframework.http.ResponseCookie.ResponseCookieBuilder
-
Create the HttpCookie.
- build() - Method in interface org.springframework.http.ResponseEntity.HeadersBuilder
-
Build the response entity with no body.
- build() - Method in interface org.springframework.http.server.reactive.ServerHttpRequest.Builder
-
Build a
ServerHttpRequest
decorator with the mutated properties. - build() - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
Create and initialize a
ContentNegotiationManager
instance. - build() - Method in interface org.springframework.web.client.RestClient.Builder
-
Build the
RestClient
instance. - build() - Method in interface org.springframework.web.ErrorResponse.Builder
-
Build the
ErrorResponse
instance. - build() - Method in class org.springframework.web.method.HandlerTypePredicate.Builder
- build() - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Build the
HttpHandler
. - build() - Method in interface org.springframework.web.server.ServerWebExchange.Builder
-
Build a
ServerWebExchange
decorator with the mutated properties. - build() - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Build the
HttpRequestValues
instance. - build() - Method in class org.springframework.web.service.invoker.HttpServiceProxyFactory.Builder
-
Build the
HttpServiceProxyFactory
instance. - build() - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- build() - Method in class org.springframework.web.util.UriComponentsBuilder
-
Build a
UriComponents
instance from the various components contained in this builder. - build(boolean) - Method in class org.springframework.web.util.UriComponentsBuilder
-
Variant of
UriComponentsBuilder.build()
to create aUriComponents
instance when components are already fully encoded. - build(Object...) - Method in interface org.springframework.web.util.UriBuilder
-
Build a
URI
instance and replaces URI template variables with the values from an array. - build(Object...) - Method in class org.springframework.web.util.UriComponentsBuilder
- build(Map<String, ?>) - Method in interface org.springframework.web.util.UriBuilder
-
Build a
URI
instance and replaces URI template variables with the values from a map. - build(Map<String, ?>) - Method in class org.springframework.web.util.UriComponentsBuilder
- build(MessageSource, Locale) - Method in interface org.springframework.web.ErrorResponse.Builder
-
Build the
ErrorResponse
instance and also resolve the "detail" and "title" through the givenMessageSource
. - buildAndExpand(Object...) - Method in class org.springframework.web.util.UriComponentsBuilder
-
Build a
UriComponents
instance and replaces URI template variables with the values from an array. - buildAndExpand(Map<String, ?>) - Method in class org.springframework.web.util.UriComponentsBuilder
-
Build a
UriComponents
instance and replaces URI template variables with the values from a map. - builder() - Static method in class org.springframework.http.codec.ServerSentEvent
-
Return a builder for a
SseEvent
. - builder() - Static method in interface org.springframework.web.client.RestClient
-
Obtain a
RestClient
builder. - builder() - Static method in class org.springframework.web.method.HandlerTypePredicate
-
Return a builder for a
HandlerTypePredicate
. - builder() - Static method in class org.springframework.web.service.invoker.HttpRequestValues
- builder() - Static method in class org.springframework.web.service.invoker.HttpServiceProxyFactory
-
Return an empty builder, with the client to be provided to builder.
- builder() - Static method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues
- builder() - Method in class org.springframework.web.util.DefaultUriBuilderFactory
- builder() - Method in interface org.springframework.web.util.UriBuilderFactory
-
Create a URI builder with default settings.
- builder(String) - Static method in class org.springframework.http.ContentDisposition
-
Return a builder for a
ContentDisposition
. - builder(Throwable, HttpStatusCode, String) - Static method in interface org.springframework.web.ErrorResponse
-
Return a builder to create an
ErrorResponse
instance. - builder(Throwable, ProblemDetail) - Static method in interface org.springframework.web.ErrorResponse
-
Variant of
ErrorResponse.builder(Throwable, HttpStatusCode, String)
for use with a customProblemDetail
instance. - builder(RestTemplate) - Static method in interface org.springframework.web.client.RestClient
-
Obtain a
RestClient
builder based on the configuration of the givenRestTemplate
. - builder(HttpClientAdapter) - Static method in class org.springframework.web.service.invoker.HttpServiceProxyFactory
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of
HttpServiceProxyFactory.builderFor(HttpExchangeAdapter)
; to be removed in 6.2. - builder(T) - Static method in class org.springframework.http.codec.ServerSentEvent
-
Return a builder for a
SseEvent
, populated with the given data. - Builder() - Constructor for class org.springframework.web.method.HandlerTypePredicate.Builder
- Builder() - Constructor for class org.springframework.web.service.invoker.HttpRequestValues.Builder
- Builder() - Constructor for class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- builderFor(HttpExchangeAdapter) - Static method in class org.springframework.web.service.invoker.HttpServiceProxyFactory
-
Return a builder that's initialized with the given client.
- buildMultipartBody() - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
- buildMultipartBody() - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- ByteArrayHttpMessageConverter - Class in org.springframework.http.converter
-
Implementation of
HttpMessageConverter
that can read and write byte arrays. - ByteArrayHttpMessageConverter() - Constructor for class org.springframework.http.converter.ByteArrayHttpMessageConverter
-
Create a new instance of the
ByteArrayHttpMessageConverter
. - ByteArrayMultipartFileEditor - Class in org.springframework.web.multipart.support
-
Custom
PropertyEditor
for convertingMultipartFiles
to byte arrays. - ByteArrayMultipartFileEditor() - Constructor for class org.springframework.web.multipart.support.ByteArrayMultipartFileEditor
C
- CACHE_CONTROL - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Cache-Control
header field name. - cacheControl(CacheControl) - Method in interface org.springframework.http.ResponseEntity.HeadersBuilder
-
Set the caching directives for the resource, as specified by the HTTP 1.1
Cache-Control
header. - CacheControl - Class in org.springframework.http
-
A builder for creating "Cache-Control" HTTP response headers.
- CacheControl() - Constructor for class org.springframework.http.CacheControl
-
Create an empty CacheControl instance.
- cachePrivate() - Method in class org.springframework.http.CacheControl
-
Add a "private" directive.
- cachePublic() - Method in class org.springframework.http.CacheControl
-
Add a "public" directive.
- CallableProcessingInterceptor - Interface in org.springframework.web.context.request.async
-
Intercepts concurrent request handling, where the concurrent result is obtained by executing a
Callable
on behalf of the application with anAsyncTaskExecutor
. - callNextHandlerInChain(FacesContext, String, String, NavigationHandler) - Method in class org.springframework.web.jsf.DecoratingNavigationHandler
-
Method to be called by subclasses when intending to delegate to the next handler in the NavigationHandler chain.
- cancel() - Method in class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
-
Cancel the upstream chain of "write" Publishers only, for example due to Servlet container error/completion notifications.
- cancel() - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
-
Cancel the upstream "write" Publisher only, for example due to Servlet container error/completion notifications.
- canDecode(ResolvableType, MimeType) - Method in class org.springframework.http.codec.json.AbstractJackson2Decoder
- canDecode(ResolvableType, MimeType) - Method in class org.springframework.http.codec.KotlinSerializationBinaryDecoder
- canDecode(ResolvableType, MimeType) - Method in class org.springframework.http.codec.KotlinSerializationStringDecoder
- canDecode(ResolvableType, MimeType) - Method in class org.springframework.http.codec.protobuf.ProtobufDecoder
- canDecode(ResolvableType, MimeType) - Method in class org.springframework.http.codec.xml.Jaxb2XmlDecoder
- canEncode(ResolvableType, MimeType) - Method in class org.springframework.http.codec.json.AbstractJackson2Encoder
- canEncode(ResolvableType, MimeType) - Method in class org.springframework.http.codec.KotlinSerializationBinaryEncoder
- canEncode(ResolvableType, MimeType) - Method in class org.springframework.http.codec.KotlinSerializationStringEncoder
- canEncode(ResolvableType, MimeType) - Method in class org.springframework.http.codec.protobuf.ProtobufEncoder
- canEncode(ResolvableType, MimeType) - Method in class org.springframework.http.codec.xml.Jaxb2XmlEncoder
- CANNOT_HAVE_ADJACENT_CAPTURES - Enum constant in enum class org.springframework.web.util.pattern.PatternParseException.PatternMessage
- canRead(Class<?>, MediaType) - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
-
This implementation checks if the given class is supported, and if the supported media types include the given media type.
- canRead(Class<?>, MediaType) - Method in class org.springframework.http.converter.BufferedImageHttpMessageConverter
- canRead(Class<?>, MediaType) - Method in class org.springframework.http.converter.FormHttpMessageConverter
- canRead(Class<?>, MediaType) - Method in interface org.springframework.http.converter.HttpMessageConverter
-
Indicates whether the given class can be read by this converter.
- canRead(Class<?>, MediaType) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
- canRead(Class<?>, MediaType) - Method in class org.springframework.http.converter.ObjectToStringHttpMessageConverter
- canRead(Class<?>, MediaType) - Method in class org.springframework.http.converter.ResourceRegionHttpMessageConverter
- canRead(Class<?>, MediaType) - Method in class org.springframework.http.converter.xml.Jaxb2CollectionHttpMessageConverter
-
Always returns
false
since Jaxb2CollectionHttpMessageConverter required generic type information in order to read a Collection. - canRead(Class<?>, MediaType) - Method in class org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter
- canRead(Class<?>, MediaType) - Method in class org.springframework.http.converter.xml.MarshallingHttpMessageConverter
- canRead(Type, Class<?>, MediaType) - Method in class org.springframework.http.converter.AbstractGenericHttpMessageConverter
- canRead(Type, Class<?>, MediaType) - Method in class org.springframework.http.converter.AbstractKotlinSerializationHttpMessageConverter
- canRead(Type, Class<?>, MediaType) - Method in interface org.springframework.http.converter.GenericHttpMessageConverter
-
Indicates whether the given type can be read by this converter.
- canRead(Type, Class<?>, MediaType) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
- canRead(Type, Class<?>, MediaType) - Method in class org.springframework.http.converter.ResourceRegionHttpMessageConverter
- canRead(Type, Class<?>, MediaType) - Method in class org.springframework.http.converter.xml.Jaxb2CollectionHttpMessageConverter
-
Indicates whether the given type can be read by this converter.
- canRead(ResolvableType, MediaType) - Method in class org.springframework.http.codec.DecoderHttpMessageReader
- canRead(ResolvableType, MediaType) - Method in class org.springframework.http.codec.FormHttpMessageReader
- canRead(ResolvableType, MediaType) - Method in interface org.springframework.http.codec.HttpMessageReader
-
Whether the given object type is supported by this reader.
- canRead(ResolvableType, MediaType) - Method in class org.springframework.http.codec.multipart.DefaultPartHttpMessageReader
- canRead(ResolvableType, MediaType) - Method in class org.springframework.http.codec.multipart.MultipartHttpMessageReader
- canRead(ResolvableType, MediaType) - Method in class org.springframework.http.codec.multipart.PartEventHttpMessageReader
- canRead(ResolvableType, MediaType) - Method in class org.springframework.http.codec.ServerSentEventHttpMessageReader
- canRead(MediaType) - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
- canSerialize(ResolvableType, MimeType) - Method in class org.springframework.http.codec.KotlinSerializationSupport
-
Indicates whether the given type can be serialized using Kotlin serialization.
- canWrite(Class<?>, MediaType) - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
- canWrite(Class<?>, MediaType) - Method in class org.springframework.http.converter.BufferedImageHttpMessageConverter
- canWrite(Class<?>, MediaType) - Method in class org.springframework.http.converter.FormHttpMessageConverter
- canWrite(Class<?>, MediaType) - Method in interface org.springframework.http.converter.HttpMessageConverter
-
Indicates whether the given class can be written by this converter.
- canWrite(Class<?>, MediaType) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
- canWrite(Class<?>, MediaType) - Method in class org.springframework.http.converter.ObjectToStringHttpMessageConverter
- canWrite(Class<?>, MediaType) - Method in class org.springframework.http.converter.ResourceRegionHttpMessageConverter
- canWrite(Class<?>, MediaType) - Method in class org.springframework.http.converter.xml.Jaxb2CollectionHttpMessageConverter
-
Always returns
false
since Jaxb2CollectionHttpMessageConverter does not convert collections to XML. - canWrite(Class<?>, MediaType) - Method in class org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter
- canWrite(Class<?>, MediaType) - Method in class org.springframework.http.converter.xml.MarshallingHttpMessageConverter
- canWrite(Type, Class<?>, MediaType) - Method in class org.springframework.http.converter.AbstractGenericHttpMessageConverter
- canWrite(Type, Class<?>, MediaType) - Method in class org.springframework.http.converter.AbstractKotlinSerializationHttpMessageConverter
- canWrite(Type, Class<?>, MediaType) - Method in interface org.springframework.http.converter.GenericHttpMessageConverter
-
Indicates whether the given class can be written by this converter.
- canWrite(Type, Class<?>, MediaType) - Method in class org.springframework.http.converter.ResourceRegionHttpMessageConverter
- canWrite(Type, Class<?>, MediaType) - Method in class org.springframework.http.converter.xml.Jaxb2CollectionHttpMessageConverter
-
Always returns
false
since Jaxb2CollectionHttpMessageConverter does not convert collections to XML. - canWrite(ResolvableType, MediaType) - Method in class org.springframework.http.codec.EncoderHttpMessageWriter
- canWrite(ResolvableType, MediaType) - Method in class org.springframework.http.codec.FormHttpMessageWriter
- canWrite(ResolvableType, MediaType) - Method in interface org.springframework.http.codec.HttpMessageWriter
-
Whether the given object type is supported by this writer.
- canWrite(ResolvableType, MediaType) - Method in class org.springframework.http.codec.multipart.MultipartHttpMessageWriter
- canWrite(ResolvableType, MediaType) - Method in class org.springframework.http.codec.multipart.PartEventHttpMessageWriter
- canWrite(ResolvableType, MediaType) - Method in class org.springframework.http.codec.multipart.PartHttpMessageWriter
- canWrite(ResolvableType, MediaType) - Method in class org.springframework.http.codec.ResourceHttpMessageWriter
- canWrite(ResolvableType, MediaType) - Method in class org.springframework.http.codec.ServerSentEventHttpMessageWriter
- canWrite(MediaType) - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
-
Returns
true
if the given media type includes any of the supported media types. - canWrite(MediaType) - Method in class org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter
- CAPTURE_ALL_IS_STANDALONE_CONSTRUCT - Enum constant in enum class org.springframework.web.util.pattern.PatternParseException.PatternMessage
- cbor() - Static method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Obtain a
Jackson2ObjectMapperBuilder
instance in order to build a CBOR data formatObjectMapper
instance. - changeSessionId() - Method in interface org.springframework.web.server.WebSession
-
Generate a new id for the session and update the underlying session storage to reflect the new id.
- ChannelSendOperator<T> - Class in org.springframework.http.server.reactive
-
Given a write function that accepts a source
Publisher<T>
to write with and returnsPublisher<Void>
for the result, this operator helps to defer the invocation of the write function, until we know if the source publisher will begin publishing without an error. - ChannelSendOperator(Publisher<? extends T>, Function<Publisher<T>, Publisher<Void>>) - Constructor for class org.springframework.http.server.reactive.ChannelSendOperator
- CharacterEncodingFilter - Class in org.springframework.web.filter
-
Servlet Filter that allows one to specify a character encoding for requests.
- CharacterEncodingFilter() - Constructor for class org.springframework.web.filter.CharacterEncodingFilter
-
Create a default
CharacterEncodingFilter
, with the encoding to be set viaCharacterEncodingFilter.setEncoding(java.lang.String)
. - CharacterEncodingFilter(String) - Constructor for class org.springframework.web.filter.CharacterEncodingFilter
-
Create a
CharacterEncodingFilter
for the given encoding. - CharacterEncodingFilter(String, boolean) - Constructor for class org.springframework.web.filter.CharacterEncodingFilter
-
Create a
CharacterEncodingFilter
for the given encoding. - CharacterEncodingFilter(String, boolean, boolean) - Constructor for class org.springframework.web.filter.CharacterEncodingFilter
-
Create a
CharacterEncodingFilter
for the given encoding. - checkAndLogClientDisconnectedException(Throwable) - Method in class org.springframework.web.util.DisconnectedClientHelper
-
Check via
DisconnectedClientHelper.isClientDisconnectedException(java.lang.Throwable)
if the exception indicates the remote client disconnected, and if so log a single line message when DEBUG is on, and a full stacktrace when TRACE is on for the configured logger. - checkFieldDefaults(MutablePropertyValues) - Method in class org.springframework.web.bind.WebDataBinder
-
Check the given property values for field defaults, i.e.
- checkFieldMarkers(MutablePropertyValues) - Method in class org.springframework.web.bind.WebDataBinder
-
Check the given property values for field markers, i.e.
- checkHeaders(List<String>) - Method in class org.springframework.web.cors.CorsConfiguration
-
Check the supplied request headers (or the headers listed in the
Access-Control-Request-Headers
of a pre-flight request) against the configured allowed headers. - checkHeaders(CorsConfiguration, List<String>) - Method in class org.springframework.web.cors.DefaultCorsProcessor
-
Check the headers and determine the headers for the response of a pre-flight request.
- checkHeaders(CorsConfiguration, List<String>) - Method in class org.springframework.web.cors.reactive.DefaultCorsProcessor
-
Check the headers and determine the headers for the response of a pre-flight request.
- checkHttpMethod(HttpMethod) - Method in class org.springframework.web.cors.CorsConfiguration
-
Check the HTTP request method (or the method from the
Access-Control-Request-Method
header on a pre-flight request) against the configured allowed methods. - checkMethods(CorsConfiguration, HttpMethod) - Method in class org.springframework.web.cors.DefaultCorsProcessor
-
Check the HTTP method and determine the methods for the response of a pre-flight request.
- checkMethods(CorsConfiguration, HttpMethod) - Method in class org.springframework.web.cors.reactive.DefaultCorsProcessor
-
Check the HTTP method and determine the methods for the response of a pre-flight request.
- checkNotModified(long) - Method in class org.springframework.web.context.request.FacesWebRequest
- checkNotModified(long) - Method in class org.springframework.web.context.request.ServletWebRequest
- checkNotModified(long) - Method in interface org.springframework.web.context.request.WebRequest
-
Check whether the requested resource has been modified given the supplied last-modified timestamp (as determined by the application).
- checkNotModified(String) - Method in class org.springframework.web.context.request.FacesWebRequest
- checkNotModified(String) - Method in class org.springframework.web.context.request.ServletWebRequest
- checkNotModified(String) - Method in interface org.springframework.web.context.request.WebRequest
-
Check whether the requested resource has been modified given the supplied
ETag
(entity tag), as determined by the application. - checkNotModified(String) - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- checkNotModified(String) - Method in interface org.springframework.web.server.ServerWebExchange
-
An overloaded variant of
ServerWebExchange.checkNotModified(String, Instant)
with anETag
(entity tag) value only. - checkNotModified(String) - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- checkNotModified(String, long) - Method in class org.springframework.web.context.request.FacesWebRequest
- checkNotModified(String, long) - Method in class org.springframework.web.context.request.ServletWebRequest
- checkNotModified(String, long) - Method in interface org.springframework.web.context.request.WebRequest
-
Check whether the requested resource has been modified given the supplied
ETag
(entity tag) and last-modified timestamp, as determined by the application. - checkNotModified(String, Instant) - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- checkNotModified(String, Instant) - Method in interface org.springframework.web.server.ServerWebExchange
-
Check whether the requested resource has been modified given the supplied
ETag
(entity tag) and last-modified timestamp as determined by the application. - checkNotModified(String, Instant) - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- checkNotModified(Instant) - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- checkNotModified(Instant) - Method in interface org.springframework.web.server.ServerWebExchange
-
An overloaded variant of
ServerWebExchange.checkNotModified(String, Instant)
with a last-modified timestamp only. - checkNotModified(Instant) - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- checkOnDataAvailable() - Method in class org.springframework.http.server.reactive.AbstractListenerReadPublisher
-
Check if data is available and either call
AbstractListenerReadPublisher.onDataAvailable()
immediately or schedule a notification. - checkOrigin(String) - Method in class org.springframework.web.cors.CorsConfiguration
-
Check the origin of the request against the configured allowed origins.
- checkOrigin(CorsConfiguration, String) - Method in class org.springframework.web.cors.DefaultCorsProcessor
-
Check the origin and determine the origin for the response.
- checkOrigin(CorsConfiguration, String) - Method in class org.springframework.web.cors.reactive.DefaultCorsProcessor
-
Check the origin and determine the origin for the response.
- checkParameters(String, String) - Method in class org.springframework.http.MediaType
- CHECKPOINT - Enum constant in enum class org.springframework.http.HttpStatus
-
Deprecated.in favor of
HttpStatus.EARLY_HINTS
which will be returned fromHttpStatus.valueOf(103)
- cleanupAttribute(WebRequest, String) - Method in class org.springframework.web.bind.support.DefaultSessionAttributeStore
- cleanupAttribute(WebRequest, String) - Method in interface org.springframework.web.bind.support.SessionAttributeStore
-
Clean up the specified attribute in the backend session.
- cleanupAttributes(WebRequest) - Method in class org.springframework.web.method.annotation.SessionAttributesHandler
-
Remove "known" attributes from the session, i.e.
- cleanupMultipart() - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- cleanupMultipart() - Method in interface org.springframework.web.server.ServerWebExchange
-
Cleans up any storage used for multipart handling.
- cleanupMultipart() - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- cleanupMultipart(MultipartHttpServletRequest) - Method in interface org.springframework.web.multipart.MultipartResolver
-
Clean up any resources used for the multipart handling, like a storage for the uploaded files.
- cleanupMultipart(MultipartHttpServletRequest) - Method in class org.springframework.web.multipart.support.StandardServletMultipartResolver
- clear() - Method in class org.springframework.http.HttpHeaders
- clear() - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- clear() - Method in class org.springframework.http.support.JettyHeadersAdapter
- clear() - Method in class org.springframework.http.support.Netty4HeadersAdapter
- clear() - Method in class org.springframework.http.support.Netty5HeadersAdapter
- clear() - Method in class org.springframework.web.method.support.HandlerMethodArgumentResolverComposite
-
Clear the list of configured resolvers and the resolver cache.
- clearConcurrentResult() - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Clear concurrentResult and concurrentResultContext.
- clearContentHeaders() - Method in class org.springframework.http.HttpHeaders
-
Remove the well-known
"Content-*"
HTTP headers. - clearErrorRequestAttributes(HttpServletRequest) - Static method in class org.springframework.web.util.WebUtils
-
Clear the Servlet spec's error attributes as
HttpServletRequest
attributes under the keys defined in the Servlet 2.3 specification:jakarta.servlet.error.status_code
,jakarta.servlet.error.exception_type
,jakarta.servlet.error.message
,jakarta.servlet.error.exception
,jakarta.servlet.error.request_uri
,jakarta.servlet.error.servlet_name
. - clearParsedRequestPath(ServletRequest) - Static method in class org.springframework.web.util.ServletRequestPathUtils
-
Remove the request attribute
ServletRequestPathUtils.PATH_ATTRIBUTE
that holds apreviously
parsed and cachedRequestPath
. - CLIENT_ERROR - Enum constant in enum class org.springframework.http.HttpStatus.Series
- CLIENT_NAME - Enum constant in enum class org.springframework.http.client.observation.ClientHttpObservationDocumentation.HighCardinalityKeyNames
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of
ClientHttpObservationDocumentation.LowCardinalityKeyNames.CLIENT_NAME
; scheduled for removal in 6.2. This will be available both as a low and high cardinality key value. - CLIENT_NAME - Enum constant in enum class org.springframework.http.client.observation.ClientHttpObservationDocumentation.LowCardinalityKeyNames
-
Client name derived from the request URI host.
- clientAdapter(HttpClientAdapter) - Method in class org.springframework.web.service.invoker.HttpServiceProxyFactory.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of
HttpServiceProxyFactory.Builder.exchangeAdapter(HttpExchangeAdapter)
; to be removed in 6.2 - ClientCodecConfigurer - Interface in org.springframework.http.codec
-
Extension of
CodecConfigurer
for HTTP message reader and writer options relevant on the client side. - ClientCodecConfigurer.ClientDefaultCodecs - Interface in org.springframework.http.codec
-
CodecConfigurer.DefaultCodecs
extension with extra client-side options. - ClientHttpConnector - Interface in org.springframework.http.client.reactive
-
Abstraction over HTTP clients driving the underlying HTTP client to connect to the origin server and provide all necessary infrastructure to send a
ClientHttpRequest
and receive aClientHttpResponse
. - ClientHttpObservationDocumentation - Enum Class in org.springframework.http.client.observation
-
Documented
KeyValues
forHTTP client
observations. - ClientHttpObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.http.client.observation
- ClientHttpObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.http.client.observation
- ClientHttpRequest - Interface in org.springframework.http.client
-
Represents a client-side HTTP request.
- ClientHttpRequest - Interface in org.springframework.http.client.reactive
-
Represents a client-side reactive HTTP request.
- ClientHttpRequestDecorator - Class in org.springframework.http.client.reactive
-
Wraps another
ClientHttpRequest
and delegates all methods to it. - ClientHttpRequestDecorator(ClientHttpRequest) - Constructor for class org.springframework.http.client.reactive.ClientHttpRequestDecorator
- ClientHttpRequestExecution - Interface in org.springframework.http.client
-
Represents the context of a client-side HTTP request execution.
- ClientHttpRequestFactory - Interface in org.springframework.http.client
-
Factory for
ClientHttpRequest
objects. - ClientHttpRequestInitializer - Interface in org.springframework.http.client
-
Callback interface for initializing a
ClientHttpRequest
prior to it being used. - ClientHttpRequestInterceptor - Interface in org.springframework.http.client
-
Contract to intercept client-side HTTP requests.
- ClientHttpResponse - Interface in org.springframework.http.client
-
Represents a client-side HTTP response.
- ClientHttpResponse - Interface in org.springframework.http.client.reactive
-
Represents a client-side reactive HTTP response.
- ClientHttpResponseDecorator - Class in org.springframework.http.client.reactive
-
Wraps another
ClientHttpResponse
and delegates all methods to it. - ClientHttpResponseDecorator(ClientHttpResponse) - Constructor for class org.springframework.http.client.reactive.ClientHttpResponseDecorator
- clientName(ClientRequestObservationContext) - Method in class org.springframework.http.client.observation.DefaultClientRequestObservationConvention
- ClientRequestObservationContext - Class in org.springframework.http.client.observation
-
Context that holds information for metadata collection during the
client HTTP exchanges
observations. - ClientRequestObservationContext(ClientHttpRequest) - Constructor for class org.springframework.http.client.observation.ClientRequestObservationContext
-
Create an observation context for
ClientHttpRequest
observations. - ClientRequestObservationConvention - Interface in org.springframework.http.client.observation
-
Interface for an
ObservationConvention
forclient HTTP exchanges
. - clone() - Method in interface org.springframework.http.codec.ClientCodecConfigurer
-
Create a copy of this
CodecConfigurer
. - clone() - Method in interface org.springframework.http.codec.CodecConfigurer
-
Create a copy of this
CodecConfigurer
. - clone() - Method in interface org.springframework.http.codec.ServerCodecConfigurer
-
Create a copy of this
CodecConfigurer
. - clone() - Method in class org.springframework.http.codec.support.DefaultClientCodecConfigurer
- clone() - Method in class org.springframework.http.codec.support.DefaultServerCodecConfigurer
- clone() - Method in interface org.springframework.web.client.RestClient.Builder
-
Clone this
RestClient.Builder
. - clone() - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Clone this
WebHttpHandlerBuilder
. - clone() - Method in class org.springframework.web.util.UriComponentsBuilder
-
Public declaration of Object's
clone()
method. - cloneBuilder() - Method in class org.springframework.web.util.UriComponentsBuilder
-
Clone this
UriComponentsBuilder
. - cloneDefaultCodecs() - Method in class org.springframework.http.codec.support.DefaultClientCodecConfigurer
- cloneDefaultCodecs() - Method in class org.springframework.http.codec.support.DefaultServerCodecConfigurer
- close() - Method in interface org.springframework.http.client.ClientHttpResponse
-
Close this response, freeing any resources created.
- close() - Method in class org.springframework.http.client.reactive.HttpComponentsClientHttpConnector
- close() - Method in class org.springframework.http.server.DelegatingServerHttpResponse
- close() - Method in interface org.springframework.http.server.ServerHttpResponse
-
Close this response, freeing any resources created.
- close() - Method in class org.springframework.http.server.ServletServerHttpResponse
- closeNoCatch() - Method in class org.springframework.web.bind.ServletRequestDataBinder
-
Treats errors as fatal.
- closeNoCatch() - Method in class org.springframework.web.bind.support.WebRequestDataBinder
-
Treats errors as fatal.
- closeWebApplicationContext(ServletContext) - Method in class org.springframework.web.context.ContextLoader
-
Close Spring's web application context for the given servlet context.
- code() - Element in annotation interface org.springframework.web.bind.annotation.ResponseStatus
-
The status code to use for the response.
- codecConfigurer(ServerCodecConfigurer) - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Configure the
ServerCodecConfigurer
to set on theWebServerExchange
. - CodecConfigurer - Interface in org.springframework.http.codec
-
Defines a common interface for configuring either client or server HTTP message readers and writers.
- CodecConfigurer.CustomCodecs - Interface in org.springframework.http.codec
-
Registry for custom HTTP message readers and writers.
- CodecConfigurer.DefaultCodecConfig - Interface in org.springframework.http.codec
-
Exposes the values of properties configured through
CodecConfigurer.defaultCodecs()
that are applied to default codecs. - CodecConfigurer.DefaultCodecs - Interface in org.springframework.http.codec
-
Customize or replace the HTTP message readers and writers registered by default.
- CodecConfigurer.MultipartCodecs - Interface in org.springframework.http.codec
-
Registry and container for multipart HTTP message writers.
- combine(String, String) - Method in class org.springframework.web.util.pattern.PathPatternRouteMatcher
- combine(CorsConfiguration) - Method in class org.springframework.web.cors.CorsConfiguration
-
Combine the non-null properties of the supplied
CorsConfiguration
with this one. - combine(PathPattern) - Method in class org.springframework.web.util.pattern.PathPattern
-
Combine this pattern with another.
- comment() - Method in class org.springframework.http.codec.ServerSentEvent
-
Return the comment of this event, if available.
- comment(String) - Method in interface org.springframework.http.codec.ServerSentEvent.Builder
-
Set SSE comment.
- CommonsRequestLoggingFilter - Class in org.springframework.web.filter
-
Simple request logging filter that writes the request URI (and optionally the query string) to the Commons Log.
- CommonsRequestLoggingFilter() - Constructor for class org.springframework.web.filter.CommonsRequestLoggingFilter
- compareTo(HttpMethod) - Method in class org.springframework.http.HttpMethod
- compareTo(PathPattern) - Method in class org.springframework.web.util.pattern.PathPattern
-
Compare this pattern with a supplied pattern: return -1,0,+1 if this pattern is more specific, the same or less specific than the supplied pattern.
- complete() - Method in interface org.springframework.http.server.ServerHttpAsyncRequestControl
-
Mark asynchronous request processing as completed.
- complete() - Method in class org.springframework.http.server.ServletServerHttpAsyncRequestControl
- CompositeFilter - Class in org.springframework.web.filter
-
A generic composite servlet
Filter
that just delegates its behavior to a chain (list) of user-supplied filters, achieving the functionality of aFilterChain
, but conveniently using onlyFilter
instances. - CompositeFilter() - Constructor for class org.springframework.web.filter.CompositeFilter
- CompositeUriComponentsContributor - Class in org.springframework.web.method.support
-
A
UriComponentsContributor
containing a list of other contributors to delegate to and also encapsulating a specificConversionService
to use for formatting method argument values as Strings. - CompositeUriComponentsContributor(Collection<?>) - Constructor for class org.springframework.web.method.support.CompositeUriComponentsContributor
-
Create an instance from a collection of
UriComponentsContributors
orHandlerMethodArgumentResolvers
. - CompositeUriComponentsContributor(Collection<?>, ConversionService) - Constructor for class org.springframework.web.method.support.CompositeUriComponentsContributor
-
Create an instance from a collection of
UriComponentsContributors
orHandlerMethodArgumentResolvers
. - CompositeUriComponentsContributor(UriComponentsContributor...) - Constructor for class org.springframework.web.method.support.CompositeUriComponentsContributor
-
Create an instance from a collection of
UriComponentsContributors
orHandlerMethodArgumentResolvers
. - CONFIG_LOCATION_PARAM - Static variable in class org.springframework.web.context.ContextLoader
-
Name of servlet context parameter (i.e., "contextConfigLocation") that can specify the config location for the root context, falling back to the implementation's default otherwise.
- ConfigurableWebApplicationContext - Interface in org.springframework.web.context
-
Interface to be implemented by configurable web application contexts.
- ConfigurableWebBindingInitializer - Class in org.springframework.web.bind.support
-
Convenient
WebBindingInitializer
for declarative configuration in a Spring application context. - ConfigurableWebBindingInitializer() - Constructor for class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
- ConfigurableWebEnvironment - Interface in org.springframework.web.context
-
Specialization of
ConfigurableEnvironment
allowing initialization of servlet-relatedPropertySource
objects at the earliest moment that theServletContext
and (optionally)ServletConfig
become available. - configure(ObjectMapper) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Configure an existing
ObjectMapper
instance with this builder's settings. - configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext, ServletContext) - Method in class org.springframework.web.context.ContextLoader
- configureDefaultCodec(Consumer<Object>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Register a consumer to apply to default config instances.
- CONFLICT - Enum constant in enum class org.springframework.http.HttpStatus
-
409 Conflict
. - connect(HttpMethod, URI, Function<? super ClientHttpRequest, Mono<Void>>) - Method in interface org.springframework.http.client.reactive.ClientHttpConnector
-
Connect to the origin server using the given
HttpMethod
andURI
and apply the givenrequestCallback
when the HTTP request of the underlying API can be initialized and written to. - connect(HttpMethod, URI, Function<? super ClientHttpRequest, Mono<Void>>) - Method in class org.springframework.http.client.reactive.HttpComponentsClientHttpConnector
- connect(HttpMethod, URI, Function<? super ClientHttpRequest, Mono<Void>>) - Method in class org.springframework.http.client.reactive.JdkClientHttpConnector
- connect(HttpMethod, URI, Function<? super ClientHttpRequest, Mono<Void>>) - Method in class org.springframework.http.client.reactive.JettyClientHttpConnector
- connect(HttpMethod, URI, Function<? super ClientHttpRequest, Mono<Void>>) - Method in class org.springframework.http.client.reactive.ReactorClientHttpConnector
- connect(HttpMethod, URI, Function<? super ClientHttpRequest, Mono<Void>>) - Method in class org.springframework.http.client.reactive.ReactorNetty2ClientHttpConnector
- CONNECTION - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Connection
header field name. - construct(ServletRequest) - Method in class org.springframework.web.bind.ServletRequestDataBinder
-
Use a default or single data constructor to create the target by binding request parameters, multipart files, or parts to constructor args.
- construct(WebRequest) - Method in class org.springframework.web.bind.support.WebRequestDataBinder
-
Use a default or single data constructor to create the target by binding request parameters, multipart files, or parts to constructor args.
- construct(ServerWebExchange) - Method in class org.springframework.web.bind.support.WebExchangeDataBinder
-
Use a default or single data constructor to create the target by binding request parameters, multipart files, or parts to constructor args.
- constructAttribute(WebDataBinder, NativeWebRequest) - Method in class org.springframework.web.method.annotation.ModelAttributeMethodProcessor
-
Extension point to create the attribute, binding the request to constructor args.
- consumes() - Element in annotation interface org.springframework.web.bind.annotation.DeleteMapping
-
Alias for
RequestMapping.consumes()
. - consumes() - Element in annotation interface org.springframework.web.bind.annotation.GetMapping
-
Alias for
RequestMapping.consumes()
. - consumes() - Element in annotation interface org.springframework.web.bind.annotation.PatchMapping
-
Alias for
RequestMapping.consumes()
. - consumes() - Element in annotation interface org.springframework.web.bind.annotation.PostMapping
-
Alias for
RequestMapping.consumes()
. - consumes() - Element in annotation interface org.springframework.web.bind.annotation.PutMapping
-
Alias for
RequestMapping.consumes()
. - consumes() - Element in annotation interface org.springframework.web.bind.annotation.RequestMapping
-
Narrows the primary mapping by media types that can be consumed by the mapped handler.
- containsAttribute(String) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Whether the underlying model contains the given attribute name.
- containsHeader(String) - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- containsKey(Object) - Method in class org.springframework.http.HttpHeaders
- containsKey(Object) - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- containsKey(Object) - Method in class org.springframework.http.support.JettyHeadersAdapter
- containsKey(Object) - Method in class org.springframework.http.support.Netty4HeadersAdapter
- containsKey(Object) - Method in class org.springframework.http.support.Netty5HeadersAdapter
- containsValue(Object) - Method in class org.springframework.http.HttpHeaders
- containsValue(Object) - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- containsValue(Object) - Method in class org.springframework.http.support.JettyHeadersAdapter
- containsValue(Object) - Method in class org.springframework.http.support.Netty4HeadersAdapter
- containsValue(Object) - Method in class org.springframework.http.support.Netty5HeadersAdapter
- content() - Method in interface org.springframework.http.codec.multipart.Part
-
Return the content for this part.
- content() - Method in interface org.springframework.http.codec.multipart.PartEvent
-
Return the content of this event.
- CONTENT_DISPOSITION - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Content-Disposition
header field name. - CONTENT_ENCODING - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Content-Encoding
header field name. - CONTENT_LANGUAGE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Content-Language
header field name. - CONTENT_LENGTH - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Content-Length
header field name. - CONTENT_LOCATION - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Content-Location
header field name. - CONTENT_RANGE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Content-Range
header field name. - CONTENT_TYPE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Content-Type
header field name. - CONTENT_TYPE_CHARSET_PREFIX - Static variable in class org.springframework.web.util.WebUtils
-
Prefix of the charset clause in a content type String: ";charset=".
- ContentCachingRequestWrapper - Class in org.springframework.web.util
-
HttpServletRequest
wrapper that caches all content read from the input stream and reader, and allows this content to be retrieved via abyte array
. - ContentCachingRequestWrapper(HttpServletRequest) - Constructor for class org.springframework.web.util.ContentCachingRequestWrapper
-
Create a new ContentCachingRequestWrapper for the given servlet request.
- ContentCachingRequestWrapper(HttpServletRequest, int) - Constructor for class org.springframework.web.util.ContentCachingRequestWrapper
-
Create a new ContentCachingRequestWrapper for the given servlet request.
- ContentCachingResponseWrapper - Class in org.springframework.web.util
-
HttpServletResponse
wrapper that caches all content written to the output stream and writer, and allows this content to be retrieved via a byte array. - ContentCachingResponseWrapper(HttpServletResponse) - Constructor for class org.springframework.web.util.ContentCachingResponseWrapper
-
Create a new ContentCachingResponseWrapper for the given servlet response.
- ContentDisposition - Class in org.springframework.http
-
Representation of the Content-Disposition type and parameters as defined in RFC 6266.
- ContentDisposition.Builder - Interface in org.springframework.http
-
A mutable builder for
ContentDisposition
. - contentLength(long) - Method in interface org.springframework.http.RequestEntity.BodyBuilder
-
Set the length of the body in bytes, as specified by the
Content-Length
header. - contentLength(long) - Method in interface org.springframework.http.ResponseEntity.BodyBuilder
-
Set the length of the body in bytes, as specified by the
Content-Length
header. - contentLength(long) - Method in interface org.springframework.web.client.RestClient.RequestBodySpec
-
Set the length of the body in bytes, as specified by the
Content-Length
header. - ContentNegotiationManager - Class in org.springframework.web.accept
-
Central class to determine requested media types for a request.
- ContentNegotiationManager() - Constructor for class org.springframework.web.accept.ContentNegotiationManager
-
Create a default instance with a
HeaderContentNegotiationStrategy
. - ContentNegotiationManager(Collection<ContentNegotiationStrategy>) - Constructor for class org.springframework.web.accept.ContentNegotiationManager
-
A collection-based alternative to
ContentNegotiationManager(ContentNegotiationStrategy...)
. - ContentNegotiationManager(ContentNegotiationStrategy...) - Constructor for class org.springframework.web.accept.ContentNegotiationManager
-
Create an instance with the given list of
ContentNegotiationStrategy
strategies each of which may also be an instance ofMediaTypeFileExtensionResolver
. - ContentNegotiationManagerFactoryBean - Class in org.springframework.web.accept
-
Factory to create a
ContentNegotiationManager
and configure it withContentNegotiationStrategy
instances. - ContentNegotiationManagerFactoryBean() - Constructor for class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
- ContentNegotiationStrategy - Interface in org.springframework.web.accept
-
A strategy for resolving the requested media types for a request.
- contentType() - Element in annotation interface org.springframework.web.service.annotation.DeleteExchange
-
Alias for
HttpExchange.contentType()
. - contentType() - Element in annotation interface org.springframework.web.service.annotation.HttpExchange
-
The media type for the
"Content-Type"
header. - contentType() - Element in annotation interface org.springframework.web.service.annotation.PatchExchange
-
Alias for
HttpExchange.contentType()
. - contentType() - Element in annotation interface org.springframework.web.service.annotation.PostExchange
-
Alias for
HttpExchange.contentType()
. - contentType() - Element in annotation interface org.springframework.web.service.annotation.PutExchange
-
Alias for
HttpExchange.contentType()
. - contentType(MediaType) - Method in interface org.springframework.http.client.MultipartBodyBuilder.PartBuilder
-
Set the media type of the part.
- contentType(MediaType) - Method in interface org.springframework.http.RequestEntity.BodyBuilder
-
Set the media type of the body, as specified by the
Content-Type
header. - contentType(MediaType) - Method in interface org.springframework.http.ResponseEntity.BodyBuilder
-
Set the media type of the body, as specified by the
Content-Type
header. - contentType(MediaType) - Method in interface org.springframework.web.client.RestClient.RequestBodySpec
-
Set the media type of the body, as specified by the
Content-Type
header. - CONTEXT_ATTRIBUTES_BEAN_NAME - Static variable in interface org.springframework.web.context.WebApplicationContext
-
Name of the ServletContext attributes environment bean in the factory.
- CONTEXT_CLASS_PARAM - Static variable in class org.springframework.web.context.ContextLoader
-
Config param for the root WebApplicationContext implementation class to use: "contextClass".
- CONTEXT_ID_PARAM - Static variable in class org.springframework.web.context.ContextLoader
-
Config param for the root WebApplicationContext id, to be used as serialization id for the underlying BeanFactory: "contextId".
- CONTEXT_INITIALIZER_CLASSES_PARAM - Static variable in class org.springframework.web.context.ContextLoader
-
Config param for
ApplicationContextInitializer
classes to use for initializing the root web application context: "contextInitializerClasses". - CONTEXT_PARAMETERS_BEAN_NAME - Static variable in interface org.springframework.web.context.WebApplicationContext
-
Name of the ServletContext init-params environment bean in the factory.
- ContextCleanupListener - Class in org.springframework.web.context
-
Web application listener that cleans up remaining disposable attributes in the ServletContext, i.e.
- ContextCleanupListener() - Constructor for class org.springframework.web.context.ContextCleanupListener
- contextDestroyed(ServletContextEvent) - Method in class org.springframework.web.context.ContextCleanupListener
- contextDestroyed(ServletContextEvent) - Method in class org.springframework.web.context.ContextLoaderListener
-
Close the root web application context.
- contextDestroyed(ServletContextEvent) - Method in class org.springframework.web.util.IntrospectorCleanupListener
- contextDestroyed(ServletContextEvent) - Method in class org.springframework.web.util.WebAppRootListener
- ContextExposingHttpServletRequest - Class in org.springframework.web.context.support
-
HttpServletRequest decorator that makes all Spring beans in a given WebApplicationContext accessible as request attributes, through lazy checking once an attribute gets accessed.
- ContextExposingHttpServletRequest(HttpServletRequest, WebApplicationContext) - Constructor for class org.springframework.web.context.support.ContextExposingHttpServletRequest
-
Create a new ContextExposingHttpServletRequest for the given request.
- ContextExposingHttpServletRequest(HttpServletRequest, WebApplicationContext, Set<String>) - Constructor for class org.springframework.web.context.support.ContextExposingHttpServletRequest
-
Create a new ContextExposingHttpServletRequest for the given request.
- contextInitialized(ServletContextEvent) - Method in class org.springframework.web.context.ContextCleanupListener
- contextInitialized(ServletContextEvent) - Method in class org.springframework.web.context.ContextLoaderListener
-
Initialize the root web application context.
- contextInitialized(ServletContextEvent) - Method in class org.springframework.web.util.IntrospectorCleanupListener
- contextInitialized(ServletContextEvent) - Method in class org.springframework.web.util.WebAppRootListener
- ContextLoader - Class in org.springframework.web.context
-
Performs the actual initialization work for the root application context.
- ContextLoader() - Constructor for class org.springframework.web.context.ContextLoader
-
Create a new
ContextLoader
that will create a web application context based on the "contextClass" and "contextConfigLocation" servlet context-params. - ContextLoader(WebApplicationContext) - Constructor for class org.springframework.web.context.ContextLoader
-
Create a new
ContextLoader
with the given application context. - ContextLoaderListener - Class in org.springframework.web.context
-
Bootstrap listener to start up and shut down Spring's root
WebApplicationContext
. - ContextLoaderListener() - Constructor for class org.springframework.web.context.ContextLoaderListener
-
Create a new
ContextLoaderListener
that will create a web application context based on the "contextClass" and "contextConfigLocation" servlet context-params. - ContextLoaderListener(WebApplicationContext) - Constructor for class org.springframework.web.context.ContextLoaderListener
-
Create a new
ContextLoaderListener
with the given application context. - contextPath() - Method in interface org.springframework.http.server.RequestPath
-
Returns the portion of the URL path that represents the application.
- contextPath(String) - Method in interface org.springframework.http.server.reactive.ServerHttpRequest.Builder
-
Set the contextPath to use.
- ContextPathCompositeHandler - Class in org.springframework.http.server.reactive
-
HttpHandler
delegating requests to one of severalHttpHandler
's based on simple, prefix-based mappings. - ContextPathCompositeHandler(Map<String, ? extends HttpHandler>) - Constructor for class org.springframework.http.server.reactive.ContextPathCompositeHandler
- CONTINUE - Enum constant in enum class org.springframework.http.HttpStatus
-
100 Continue
. - contributeMethodArgument(MethodParameter, Object, UriComponentsBuilder, Map<String, Object>) - Method in class org.springframework.web.method.support.CompositeUriComponentsContributor
-
An overloaded method that uses the ConversionService created at construction.
- contributeMethodArgument(MethodParameter, Object, UriComponentsBuilder, Map<String, Object>, ConversionService) - Method in class org.springframework.web.method.annotation.RequestParamMethodArgumentResolver
- contributeMethodArgument(MethodParameter, Object, UriComponentsBuilder, Map<String, Object>, ConversionService) - Method in class org.springframework.web.method.support.CompositeUriComponentsContributor
- contributeMethodArgument(MethodParameter, Object, UriComponentsBuilder, Map<String, Object>, ConversionService) - Method in interface org.springframework.web.method.support.UriComponentsContributor
-
Process the given method argument and either update the
UriComponentsBuilder
or add to the map with URI variables to use to expand the URI after all arguments are processed. - ControllerAdvice - Annotation Interface in org.springframework.web.bind.annotation
-
Specialization of
@Component
for classes that declare@ExceptionHandler
,@InitBinder
, or@ModelAttribute
methods to be shared across multiple@Controller
classes. - ControllerAdviceBean - Class in org.springframework.web.method
-
Encapsulates information about an
@ControllerAdvice
Spring-managed bean without necessarily requiring it to be instantiated. - ControllerAdviceBean(Object) - Constructor for class org.springframework.web.method.ControllerAdviceBean
-
Create a
ControllerAdviceBean
using the given bean instance. - ControllerAdviceBean(String, BeanFactory) - Constructor for class org.springframework.web.method.ControllerAdviceBean
-
Create a
ControllerAdviceBean
using the given bean name andBeanFactory
. - ControllerAdviceBean(String, BeanFactory, ControllerAdvice) - Constructor for class org.springframework.web.method.ControllerAdviceBean
-
Create a
ControllerAdviceBean
using the given bean name,BeanFactory
, and@ControllerAdvice
annotation. - conversionService(ConversionService) - Method in class org.springframework.web.service.invoker.HttpServiceProxyFactory.Builder
-
Set the
ConversionService
to use where input values need to be formatted as Strings. - converterInstance(MapperConfig<?>, Annotated, Class<?>) - Method in class org.springframework.http.converter.json.SpringHandlerInstantiator
- COOKIE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Cookie
header field name. - CookieGenerator - Class in org.springframework.web.util
-
Deprecated.as of 6.0 in favor of
ResponseCookie
- CookieGenerator() - Constructor for class org.springframework.web.util.CookieGenerator
-
Deprecated.
- cookieValue(CookieValue, ParameterValidationResult) - Method in interface org.springframework.web.method.annotation.HandlerMethodValidationException.Visitor
-
Handle results for
@CookieValue
method parameters. - CookieValue - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation to indicate that a method parameter is bound to an HTTP cookie.
- CookieValueArgumentResolver - Class in org.springframework.web.service.invoker
-
HttpServiceArgumentResolver
for@CookieValue
annotated arguments. - CookieValueArgumentResolver(ConversionService) - Constructor for class org.springframework.web.service.invoker.CookieValueArgumentResolver
- CookieWebSessionIdResolver - Class in org.springframework.web.server.session
-
Cookie-based
WebSessionIdResolver
. - CookieWebSessionIdResolver() - Constructor for class org.springframework.web.server.session.CookieWebSessionIdResolver
- copyBodyToResponse() - Method in class org.springframework.web.util.ContentCachingResponseWrapper
-
Copy the complete cached body content to the response.
- copyBodyToResponse(boolean) - Method in class org.springframework.web.util.ContentCachingResponseWrapper
-
Copy the cached body content to the response.
- copyQualityValue(MediaType) - Method in class org.springframework.http.MediaType
-
Return a replica of this instance with the quality value of the given
MediaType
. - copyToUriComponentsBuilder(UriComponentsBuilder) - Method in class org.springframework.web.util.UriComponents
-
Set all components of the given UriComponentsBuilder.
- CorsConfiguration - Class in org.springframework.web.cors
-
A container for CORS configuration along with methods to check against the actual origin, HTTP methods, and headers of a given request.
- CorsConfiguration() - Constructor for class org.springframework.web.cors.CorsConfiguration
-
Construct a new
CorsConfiguration
instance with no cross-origin requests allowed for any origin by default. - CorsConfiguration(CorsConfiguration) - Constructor for class org.springframework.web.cors.CorsConfiguration
-
Construct a new
CorsConfiguration
instance by copying all values from the suppliedCorsConfiguration
. - CorsConfigurationSource - Interface in org.springframework.web.cors
-
Interface to be implemented by classes (usually HTTP request handlers) that provides a
CorsConfiguration
instance based on the provided request. - CorsConfigurationSource - Interface in org.springframework.web.cors.reactive
-
Interface to be implemented by classes (usually HTTP request handlers) that provides a
CorsConfiguration
instance based on the provided reactive request. - CorsFilter - Class in org.springframework.web.filter
-
Filter
to handle CORS pre-flight requests and intercept CORS simple and actual requests with aCorsProcessor
, and to update the response, e.g. - CorsFilter(CorsConfigurationSource) - Constructor for class org.springframework.web.filter.CorsFilter
-
Constructor accepting a
CorsConfigurationSource
used by the filter to find theCorsConfiguration
to use for each incoming request. - CorsProcessor - Interface in org.springframework.web.cors
-
A strategy that takes a request and a
CorsConfiguration
and updates the response. - CorsProcessor - Interface in org.springframework.web.cors.reactive
-
A strategy to apply CORS validation checks and updates to a
ServerWebExchange
, either rejecting through the response or adding CORS related headers, based on a pre-selectedCorsConfiguration
. - CorsUtils - Class in org.springframework.web.cors
-
Utility class for CORS request handling based on the CORS W3C recommendation.
- CorsUtils - Class in org.springframework.web.cors.reactive
-
Utility class for CORS reactive request handling based on the CORS W3C recommendation.
- CorsUtils() - Constructor for class org.springframework.web.cors.CorsUtils
- CorsUtils() - Constructor for class org.springframework.web.cors.reactive.CorsUtils
- CorsWebFilter - Class in org.springframework.web.cors.reactive
-
WebFilter
that handles CORS preflight requests and intercepts CORS simple and actual requests thanks to aCorsProcessor
implementation (DefaultCorsProcessor
by default) in order to add the relevant CORS response headers (likeAccess-Control-Allow-Origin
) using the providedCorsConfigurationSource
(for example anUrlBasedCorsConfigurationSource
instance. - CorsWebFilter(CorsConfigurationSource) - Constructor for class org.springframework.web.cors.reactive.CorsWebFilter
-
Constructor accepting a
CorsConfigurationSource
used by the filter to find theCorsConfiguration
to use for each incoming request. - CorsWebFilter(CorsConfigurationSource, CorsProcessor) - Constructor for class org.springframework.web.cors.reactive.CorsWebFilter
-
Constructor accepting a
CorsConfigurationSource
used by the filter to find theCorsConfiguration
to use for each incoming request and a customCorsProcessor
to use to apply the matchedCorsConfiguration
for a request. - create() - Static method in interface org.springframework.http.codec.ClientCodecConfigurer
-
Static factory method for a
ClientCodecConfigurer
. - create() - Static method in interface org.springframework.http.codec.ServerCodecConfigurer
-
Static factory method for a
ServerCodecConfigurer
. - create() - Static method in interface org.springframework.web.client.RestClient
-
Create a new
RestClient
. - create(char, boolean) - Static method in class org.springframework.http.server.PathContainer.Options
-
Create an
PathContainer.Options
instance with the given settings. - create(String) - Static method in interface org.springframework.web.client.RestClient
-
Variant of
RestClient.create()
that accepts a default base URL. - create(String, String) - Static method in interface org.springframework.http.codec.multipart.FormPartEvent
- create(String, String, Consumer<HttpHeaders>) - Static method in interface org.springframework.http.codec.multipart.FormPartEvent
- create(String, String, MediaType, Flux<DataBuffer>) - Static method in interface org.springframework.http.codec.multipart.FilePartEvent
-
Creates a stream of
FilePartEvent
objects based on the given name, FilePartEvent.filename(), content-type, and contents. - create(String, String, MediaType, Flux<DataBuffer>, Consumer<HttpHeaders>) - Static method in interface org.springframework.http.codec.multipart.FilePartEvent
-
Creates a stream of
FilePartEvent
objects based on the given name, FilePartEvent.filename(), content-type, and contents. - create(String, Path) - Static method in interface org.springframework.http.codec.multipart.FilePartEvent
-
Creates a stream of
FilePartEvent
objects based on the given name and file path. - create(String, Path, Consumer<HttpHeaders>) - Static method in interface org.springframework.http.codec.multipart.FilePartEvent
-
Creates a stream of
FilePartEvent
objects based on the given name and file path. - create(String, Resource) - Static method in interface org.springframework.http.codec.multipart.FilePartEvent
-
Creates a stream of
FilePartEvent
objects based on the given name and resource. - create(String, Resource, Consumer<HttpHeaders>) - Static method in interface org.springframework.http.codec.multipart.FilePartEvent
-
Creates a stream of
FilePartEvent
objects based on the given name and resource. - create(String, HttpStatusCode, String, HttpHeaders, byte[], Charset) - Static method in exception org.springframework.web.client.HttpClientErrorException
-
Variant of
HttpClientErrorException.create(HttpStatusCode, String, HttpHeaders, byte[], Charset)
with an optional prepared message. - create(String, HttpStatusCode, String, HttpHeaders, byte[], Charset) - Static method in exception org.springframework.web.client.HttpServerErrorException
-
Variant of
HttpServerErrorException.create(String, HttpStatusCode, String, HttpHeaders, byte[], Charset)
with an optional prepared message. - create(Throwable, HttpStatusCode, String) - Static method in interface org.springframework.web.ErrorResponse
-
Static factory method to build an instance via
ErrorResponse.builder(Throwable, HttpStatusCode, String)
. - create(HttpStatusCode, String, HttpHeaders, byte[], Charset) - Static method in exception org.springframework.web.client.HttpClientErrorException
-
Create
HttpClientErrorException
or an HTTP status specific subclass. - create(HttpStatusCode, String, HttpHeaders, byte[], Charset) - Static method in exception org.springframework.web.client.HttpServerErrorException
-
Create an
HttpServerErrorException
or an HTTP status specific subclass. - create(RestClient) - Static method in class org.springframework.web.client.support.RestClientAdapter
-
Create a
RestClientAdapter
for the givenRestClient
. - create(RestTemplate) - Static method in interface org.springframework.web.client.RestClient
-
Create a new
RestClient
based on the configuration of the givenRestTemplate
. - create(RestTemplate) - Static method in class org.springframework.web.client.support.RestTemplateAdapter
-
Create a
RestTemplateAdapter
for the givenRestTemplate
. - createApplicationContext() - Method in class org.springframework.web.server.adapter.AbstractReactiveWebInitializer
-
Return the Spring configuration that contains application beans including the ones detected by
WebHttpHandlerBuilder.applicationContext
. - createAsyncWebRequest(HttpServletRequest, HttpServletResponse) - Static method in class org.springframework.web.context.request.async.WebAsyncUtils
-
Create an AsyncWebRequest instance.
- createAttribute(String, MethodParameter, WebDataBinderFactory, NativeWebRequest) - Method in class org.springframework.web.method.annotation.ModelAttributeMethodProcessor
-
Extension point to create the model attribute if not found in the model, with subsequent parameter binding through bean properties (unless suppressed).
- createBinder(NativeWebRequest, Object, String) - Method in class org.springframework.web.bind.support.DefaultDataBinderFactory
-
Create a new
WebDataBinder
for the given target object and initialize it through aWebBindingInitializer
. - createBinder(NativeWebRequest, Object, String) - Method in interface org.springframework.web.bind.support.WebDataBinderFactory
-
Create a
WebDataBinder
for the given object. - createBinder(NativeWebRequest, Object, String, ResolvableType) - Method in class org.springframework.web.bind.support.DefaultDataBinderFactory
-
Variant of
WebDataBinderFactory.createBinder(NativeWebRequest, Object, String)
with aResolvableType
for which theDataBinder
is created. - createBinder(NativeWebRequest, Object, String, ResolvableType) - Method in interface org.springframework.web.bind.support.WebDataBinderFactory
-
Variant of
WebDataBinderFactory.createBinder(NativeWebRequest, Object, String)
with aResolvableType
for which theDataBinder
is created. - createBinderInstance(Object, String, NativeWebRequest) - Method in class org.springframework.web.bind.support.DefaultDataBinderFactory
-
Extension point to create the WebDataBinder instance.
- createBodyFlushProcessor() - Method in class org.springframework.http.server.reactive.AbstractListenerServerHttpResponse
-
Abstract template method to create a
Processor<Publisher<DataBuffer>, Void>
that will write the response body with flushes to the underlying output. - createByteRange(long) - Static method in class org.springframework.http.HttpRange
-
Create an
HttpRange
from the given position to the end. - createByteRange(long, long) - Static method in class org.springframework.http.HttpRange
-
Create a
HttpRange
from the given fist to last position. - createClient(Class<S>) - Method in class org.springframework.web.service.invoker.HttpServiceProxyFactory
-
Return a proxy that implements the given HTTP service interface to perform HTTP requests and retrieve responses through an HTTP client.
- createCollection(Class<?>) - Method in class org.springframework.http.converter.xml.Jaxb2CollectionHttpMessageConverter
-
Create a Collection of the given type, with the given initial capacity (if supported by the Collection type).
- createCookie(String) - Method in class org.springframework.web.util.CookieGenerator
-
Deprecated.Create a cookie with the given value, using the cookie descriptor settings of this generator (except for "cookieMaxAge").
- created(URI) - Static method in class org.springframework.http.ResponseEntity
-
Create a new builder with a CREATED status and a location header set to the given URI.
- CREATED - Enum constant in enum class org.springframework.http.HttpStatus
-
201 Created
. - createEnvironment() - Method in class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
-
Create and return a new
StandardServletEnvironment
. - createEnvironment() - Method in class org.springframework.web.context.support.GenericWebApplicationContext
-
Create and return a new
StandardServletEnvironment
. - createEnvironment() - Method in class org.springframework.web.context.support.StaticWebApplicationContext
-
Create and return a new
StandardServletEnvironment
. - createEnvironment() - Method in class org.springframework.web.filter.GenericFilterBean
-
Create and return a new
StandardServletEnvironment
. - createExchange(ServerHttpRequest, ServerHttpResponse) - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
- createHttpContext(HttpMethod, URI) - Method in class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Template methods that creates a
HttpContext
for the given HTTP method and URI. - createHttpUriRequest(HttpMethod, URI) - Method in class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Create a Commons HttpMethodBase object for the given HTTP method and URI specification.
- createMarshaller(Class<?>) - Method in class org.springframework.http.converter.xml.AbstractJaxb2HttpMessageConverter
-
Create a new
Marshaller
for the given class. - createMessage(HttpServletRequest, String, String) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Create a log message for the given request, prefix and suffix.
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.method.annotation.AbstractCookieValueMethodArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver
-
Create the
AbstractNamedValueMethodArgumentResolver.NamedValueInfo
object for the given method parameter. - createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.method.annotation.ExpressionValueMethodArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.method.annotation.RequestHeaderMethodArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.method.annotation.RequestParamMethodArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.service.invoker.AbstractNamedValueArgumentResolver
-
Return information about the request value, or
null
if the parameter does not represent a request value of interest. - createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.service.invoker.CookieValueArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.service.invoker.PathVariableArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.service.invoker.RequestAttributeArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.service.invoker.RequestHeaderArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.service.invoker.RequestParamArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.web.service.invoker.RequestPartArgumentResolver
- createRelative(String) - Method in class org.springframework.web.context.support.ServletContextResource
-
This implementation creates a ServletContextResource, applying the given path relative to the path of the underlying file of this resource descriptor.
- createRequest(HttpServletRequest, AsyncContext) - Method in class org.springframework.http.server.reactive.ServletHttpHandlerAdapter
- createRequest(HttpServletRequest, AsyncContext) - Method in class org.springframework.http.server.reactive.TomcatHttpHandlerAdapter
- createRequest(URI, HttpMethod) - Method in class org.springframework.http.client.AbstractClientHttpRequestFactoryWrapper
-
This implementation simply calls
AbstractClientHttpRequestFactoryWrapper.createRequest(URI, HttpMethod, ClientHttpRequestFactory)
with the wrapped request factory provided to the constructor. - createRequest(URI, HttpMethod) - Method in interface org.springframework.http.client.ClientHttpRequestFactory
-
Create a new
ClientHttpRequest
for the specified URI and HTTP method. - createRequest(URI, HttpMethod) - Method in class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
- createRequest(URI, HttpMethod) - Method in class org.springframework.http.client.JdkClientHttpRequestFactory
- createRequest(URI, HttpMethod) - Method in class org.springframework.http.client.JettyClientHttpRequestFactory
- createRequest(URI, HttpMethod) - Method in class org.springframework.http.client.OkHttp3ClientHttpRequestFactory
-
Deprecated.
- createRequest(URI, HttpMethod) - Method in class org.springframework.http.client.ReactorNettyClientRequestFactory
- createRequest(URI, HttpMethod) - Method in class org.springframework.http.client.SimpleClientHttpRequestFactory
- createRequest(URI, HttpMethod) - Method in class org.springframework.http.client.support.HttpAccessor
-
Create a new
ClientHttpRequest
via this template'sClientHttpRequestFactory
. - createRequest(URI, HttpMethod, ClientHttpRequestFactory) - Method in class org.springframework.http.client.AbstractClientHttpRequestFactoryWrapper
-
Create a new
ClientHttpRequest
for the specified URI and HTTP method by using the passed-on request factory. - createRequest(URI, HttpMethod, ClientHttpRequestFactory) - Method in class org.springframework.http.client.BufferingClientHttpRequestFactory
- createRequest(URI, HttpMethod, ClientHttpRequestFactory) - Method in class org.springframework.http.client.InterceptingClientHttpRequestFactory
- createRequestConfig(Object) - Method in class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Create a default
RequestConfig
to use with the given client. - createRequestValues(HttpMethod, URI, String, Map<String, String>, HttpHeaders, MultiValueMap<String, String>, Map<String, Object>, Object) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.in favour of
HttpRequestValues.Builder.createRequestValues(HttpMethod, URI, UriBuilderFactory, String, Map, HttpHeaders, MultiValueMap, Map, Object)
to be removed in 6.2. - createRequestValues(HttpMethod, URI, UriBuilderFactory, String, Map<String, String>, HttpHeaders, MultiValueMap<String, String>, Map<String, Object>, Object) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Create
HttpRequestValues
from values passed to theHttpRequestValues.Builder
. - createRequestValues(HttpMethod, URI, UriBuilderFactory, String, Map<String, String>, HttpHeaders, MultiValueMap<String, String>, Map<String, Object>, Object) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- createResponse(HttpServletResponse, AsyncContext, ServletServerHttpRequest) - Method in class org.springframework.http.server.reactive.JettyHttpHandlerAdapter
- createResponse(HttpServletResponse, AsyncContext, ServletServerHttpRequest) - Method in class org.springframework.http.server.reactive.ServletHttpHandlerAdapter
- createResponse(HttpServletResponse, AsyncContext, ServletServerHttpRequest) - Method in class org.springframework.http.server.reactive.TomcatHttpHandlerAdapter
- createRootApplicationContext() - Method in class org.springframework.web.context.AbstractContextLoaderInitializer
-
Create the "root" application context to be provided to the
ContextLoaderListener
. - createSuffixRange(long) - Static method in class org.springframework.http.HttpRange
-
Create an
HttpRange
that ranges over the last given number of bytes. - createUnmarshaller(Class<?>) - Method in class org.springframework.http.converter.xml.AbstractJaxb2HttpMessageConverter
-
Create a new
Unmarshaller
for the given class. - createValueResolver(ServletRequest) - Method in class org.springframework.web.bind.ServletRequestDataBinder
-
Allow subclasses to create the
DataBinder.ValueResolver
instance to use. - createWebApplicationContext(ServletContext) - Method in class org.springframework.web.context.ContextLoader
-
Instantiate the root WebApplicationContext for this loader, either the default context class or a custom context class if specified.
- createWebSession() - Method in class org.springframework.web.server.session.InMemoryWebSessionStore
- createWebSession() - Method in interface org.springframework.web.server.session.WebSessionStore
-
Create a new WebSession.
- createWithResolvedBean() - Method in class org.springframework.web.method.HandlerMethod
-
If the provided instance contains a bean name rather than an object instance, the bean name is resolved before a
HandlerMethod
is created and returned. - createWithValidateFlags() - Method in class org.springframework.web.method.HandlerMethod
-
Re-create the HandlerMethod and initialize
HandlerMethod.shouldValidateArguments()
andHandlerMethod.shouldValidateReturnValue()
. - createWriteProcessor() - Method in class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
-
Create a new processor for the current flush boundary.
- createXmlInputFactory() - Method in class org.springframework.http.converter.xml.Jaxb2CollectionHttpMessageConverter
-
Create an
XMLInputFactory
that this converter will use to createXMLStreamReader
andXMLEventReader
objects. - createXmlMapper(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
If set to
true
, anXmlMapper
will be created using its default constructor. - creationDate(ZonedDateTime) - Method in interface org.springframework.http.ContentDisposition.Builder
-
Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.
- CrossOrigin - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation for permitting cross-origin requests on specific handler classes and/or handler methods.
- CURRENT_OBSERVATION_CONTEXT_ATTRIBUTE - Static variable in class org.springframework.http.server.reactive.observation.ServerRequestObservationContext
-
Name of the request attribute holding the
context
for the current observation. - CURRENT_OBSERVATION_CONTEXT_ATTRIBUTE - Static variable in class org.springframework.web.filter.reactive.ServerHttpObservationFilter
-
Deprecated.Name of the request attribute holding the
context
for the current observation. - CURRENT_OBSERVATION_CONTEXT_ATTRIBUTE - Static variable in class org.springframework.web.filter.ServerHttpObservationFilter
-
Name of the request attribute holding the
context
for the current observation. - currentRequestAttributes() - Static method in class org.springframework.web.context.request.RequestContextHolder
-
Return the RequestAttributes currently bound to the thread.
- customArgumentResolver(HttpServiceArgumentResolver) - Method in class org.springframework.web.service.invoker.HttpServiceProxyFactory.Builder
-
Register a custom argument resolver, invoked ahead of default resolvers.
- customCodecs - Variable in class org.springframework.http.codec.support.DefaultClientCodecConfigurer
- customCodecs() - Method in interface org.springframework.http.codec.CodecConfigurer
-
Register custom HTTP message readers or writers in addition to the ones registered by default.
- customCodecs() - Method in class org.springframework.http.codec.support.DefaultClientCodecConfigurer
- customizeContext(ServletContext, ConfigurableWebApplicationContext) - Method in class org.springframework.web.context.ContextLoader
-
Customize the
ConfigurableWebApplicationContext
created by this ContextLoader after config locations have been supplied to the context but before the context is refreshed. - customizeMarshaller(Marshaller) - Method in class org.springframework.http.converter.xml.AbstractJaxb2HttpMessageConverter
-
Customize the
Marshaller
created by this message converter before using it to write the object to the output. - customizePropertySources(MutablePropertySources) - Method in class org.springframework.web.context.support.StandardServletEnvironment
-
Customize the set of property sources with those contributed by superclasses as well as those appropriate for standard servlet-based environments: "servletConfigInitParams" "servletContextInitParams" "jndiProperties"
- customizeReader(ObjectReader, JavaType) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
-
Subclasses can use this method to customize
ObjectReader
used for reading values. - customizeReader(ObjectReader, ResolvableType, Map<String, Object>) - Method in class org.springframework.http.codec.json.AbstractJackson2Decoder
-
Subclasses can use this method to customize
ObjectReader
used for reading values. - customizeUnmarshaller(Unmarshaller) - Method in class org.springframework.http.converter.xml.AbstractJaxb2HttpMessageConverter
-
Customize the
Unmarshaller
created by this message converter before using it to read the object from the input. - customizeWriter(ObjectWriter, JavaType, MediaType) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
-
Subclasses can use this method to customize
ObjectWriter
used for writing values. - customizeWriter(ObjectWriter, MimeType, ResolvableType, Map<String, Object>) - Method in class org.springframework.http.codec.json.AbstractJackson2Encoder
-
Subclasses can use this method to customize the
ObjectWriter
used for writing values. - customizeWriter(ObjectWriter, MimeType, ResolvableType, Map<String, Object>) - Method in class org.springframework.http.codec.json.Jackson2JsonEncoder
D
- data() - Method in class org.springframework.http.codec.ServerSentEvent
-
Return the
data
field of this event, if available. - data(T) - Method in interface org.springframework.http.codec.ServerSentEvent.Builder
-
Set the value of the
data
field. - dataReceived(T) - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
-
Template method invoked after a data item to write is received via
Subscriber.onNext(Object)
. - DATE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Date
header field name. - dateFormat(DateFormat) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Define the format for date/time with the given
DateFormat
. - decode(String, String) - Static method in class org.springframework.web.util.UriUtils
-
Decode the given encoded URI component.
- decode(String, Charset) - Static method in class org.springframework.web.util.UriUtils
-
Decode the given encoded URI component.
- decode(Publisher<DataBuffer>, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.cbor.Jackson2CborDecoder
- decode(Publisher<DataBuffer>, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.json.AbstractJackson2Decoder
- decode(Publisher<DataBuffer>, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.KotlinSerializationBinaryDecoder
- decode(Publisher<DataBuffer>, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.KotlinSerializationStringDecoder
- decode(Publisher<DataBuffer>, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.protobuf.ProtobufDecoder
- decode(Publisher<DataBuffer>, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.xml.Jaxb2XmlDecoder
- decode(Publisher<DataBuffer>, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.xml.XmlEventDecoder
- decode(DataBuffer, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.json.AbstractJackson2Decoder
- decode(DataBuffer, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.protobuf.ProtobufDecoder
- decode(DataBuffer, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.xml.Jaxb2XmlDecoder
- decodeMatrixVariables(HttpServletRequest, MultiValueMap<String, String>) - Method in class org.springframework.web.util.UrlPathHelper
-
Decode the given matrix variables via
UrlPathHelper.decodeRequestString(jakarta.servlet.http.HttpServletRequest, java.lang.String)
unlessUrlPathHelper.setUrlDecode(boolean)
is set totrue
in which case it is assumed the URL path from which the variables were extracted is already decoded through a call toUrlPathHelper.getLookupPathForRequest(HttpServletRequest)
. - decodePathVariables(HttpServletRequest, Map<String, String>) - Method in class org.springframework.web.util.UrlPathHelper
-
Decode the given URI path variables via
UrlPathHelper.decodeRequestString(jakarta.servlet.http.HttpServletRequest, java.lang.String)
unlessUrlPathHelper.setUrlDecode(boolean)
is set totrue
in which case it is assumed the URL path from which the variables were extracted is already decoded through a call toUrlPathHelper.getLookupPathForRequest(HttpServletRequest)
. - decoder(Decoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.CustomCodecs
-
Deprecated.as of 5.1.13, use
CodecConfigurer.CustomCodecs.register(Object)
orCodecConfigurer.CustomCodecs.registerWithDefaultConfig(Object)
instead. - decodeRequestString(HttpServletRequest, String) - Method in class org.springframework.web.util.UrlPathHelper
-
Decode the given source string with a URLDecoder.
- DecoderHttpMessageReader<T> - Class in org.springframework.http.codec
-
HttpMessageReader
that wraps and delegates to aDecoder
. - DecoderHttpMessageReader(Decoder<T>) - Constructor for class org.springframework.http.codec.DecoderHttpMessageReader
-
Create an instance wrapping the given
Decoder
. - decodeToMono(Publisher<DataBuffer>, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.json.AbstractJackson2Decoder
- decodeToMono(Publisher<DataBuffer>, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.KotlinSerializationBinaryDecoder
- decodeToMono(Publisher<DataBuffer>, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.KotlinSerializationStringDecoder
- decodeToMono(Publisher<DataBuffer>, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.protobuf.ProtobufDecoder
- decodeToMono(Publisher<DataBuffer>, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.xml.Jaxb2XmlDecoder
- DecoratingNavigationHandler - Class in org.springframework.web.jsf
-
Base class for JSF NavigationHandler implementations that want to be capable of decorating an original NavigationHandler.
- DecoratingNavigationHandler() - Constructor for class org.springframework.web.jsf.DecoratingNavigationHandler
-
Create a DecoratingNavigationHandler without fixed original NavigationHandler.
- DecoratingNavigationHandler(NavigationHandler) - Constructor for class org.springframework.web.jsf.DecoratingNavigationHandler
-
Create a DecoratingNavigationHandler with fixed original NavigationHandler.
- DEFAULT_AFTER_MESSAGE_PREFIX - Static variable in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
The default value prepended to the log message written after a request is processed.
- DEFAULT_AFTER_MESSAGE_SUFFIX - Static variable in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
The default value appended to the log message written after a request is processed.
- DEFAULT_BEFORE_MESSAGE_PREFIX - Static variable in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
The default value prepended to the log message written before a request is processed.
- DEFAULT_BEFORE_MESSAGE_SUFFIX - Static variable in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
The default value appended to the log message written before a request is processed.
- DEFAULT_CHARACTER_ENCODING - Static variable in class org.springframework.web.util.WebUtils
-
Default character encoding to use when
request.getCharacterEncoding
returnsnull
, according to the Servlet spec. - DEFAULT_CHARSET - Static variable in class org.springframework.http.codec.FormHttpMessageReader
-
The default charset used by the reader.
- DEFAULT_CHARSET - Static variable in class org.springframework.http.codec.FormHttpMessageWriter
-
The default charset used by the writer.
- DEFAULT_CHARSET - Static variable in class org.springframework.http.codec.multipart.MultipartWriterSupport
-
THe default charset used by the writer.
- DEFAULT_CHARSET - Static variable in class org.springframework.http.converter.feed.AbstractWireFeedHttpMessageConverter
-
The default charset used by the converter.
- DEFAULT_CHARSET - Static variable in class org.springframework.http.converter.FormHttpMessageConverter
-
The default charset used by the converter.
- DEFAULT_CHARSET - Static variable in class org.springframework.http.converter.json.AbstractJsonHttpMessageConverter
-
The default charset used by the converter.
- DEFAULT_CHARSET - Static variable in class org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter
-
The default charset used by the converter.
- DEFAULT_CHARSET - Static variable in class org.springframework.http.converter.StringHttpMessageConverter
-
The default charset used by the converter.
- DEFAULT_CONFIG_LOCATION - Static variable in class org.springframework.web.context.support.GroovyWebApplicationContext
-
Default config location for the root context.
- DEFAULT_CONFIG_LOCATION - Static variable in class org.springframework.web.context.support.XmlWebApplicationContext
-
Default config location for the root context.
- DEFAULT_CONFIG_LOCATION_PREFIX - Static variable in class org.springframework.web.context.support.GroovyWebApplicationContext
-
Default prefix for building a config location for a namespace.
- DEFAULT_CONFIG_LOCATION_PREFIX - Static variable in class org.springframework.web.context.support.XmlWebApplicationContext
-
Default prefix for building a config location for a namespace.
- DEFAULT_CONFIG_LOCATION_SUFFIX - Static variable in class org.springframework.web.context.support.GroovyWebApplicationContext
-
Default suffix for building a config location for a namespace.
- DEFAULT_CONFIG_LOCATION_SUFFIX - Static variable in class org.springframework.web.context.support.XmlWebApplicationContext
-
Default suffix for building a config location for a namespace.
- DEFAULT_COOKIE_PATH - Static variable in class org.springframework.web.util.CookieGenerator
-
Deprecated.Default path that cookies will be visible to: "/", i.e.
- DEFAULT_FIELD_DEFAULT_PREFIX - Static variable in class org.springframework.web.bind.WebDataBinder
-
Default prefix that field default parameters start with, followed by the field name: e.g.
- DEFAULT_FIELD_MARKER_PREFIX - Static variable in class org.springframework.web.bind.WebDataBinder
-
Default prefix that field marker parameters start with, followed by the field name: e.g.
- DEFAULT_HEADER_NAME - Static variable in class org.springframework.web.server.session.HeaderWebSessionIdResolver
-
Default value for
HeaderWebSessionIdResolver.setHeaderName(String)
. - DEFAULT_MESSAGE_MAX_SIZE - Static variable in class org.springframework.http.codec.protobuf.ProtobufDecoder
-
The default max size for aggregating messages.
- DEFAULT_METHOD_PARAM - Static variable in class org.springframework.web.filter.HiddenHttpMethodFilter
-
Default method parameter:
_method
. - DEFAULT_METHOD_PARAMETER_NAME - Static variable in class org.springframework.web.filter.reactive.HiddenHttpMethodFilter
-
Default name of the form parameter with the HTTP method to use.
- DEFAULT_MULTIPART_RESOLVER_BEAN_NAME - Static variable in class org.springframework.web.multipart.support.MultipartFilter
-
The default name for the multipart resolver bean.
- DEFAULT_NONE - Static variable in interface org.springframework.web.bind.annotation.ValueConstants
-
Constant defining a value for no default - as a replacement for
null
which we cannot use in annotation attributes. - DEFAULT_PREFIX_SEPARATOR - Static variable in class org.springframework.web.bind.ServletRequestParameterPropertyValues
-
Default prefix separator.
- DEFAULT_SERVLET_NAME - Static variable in class org.springframework.web.server.adapter.AbstractReactiveWebInitializer
-
The default servlet name to use.
- DEFAULT_TARGET_BEAN_NAME - Static variable in class org.springframework.web.jsf.DelegatingNavigationHandlerProxy
-
Default name of the target bean in the Spring application context: "jsfNavigationHandler".
- DEFAULT_WEB_APP_ROOT_KEY - Static variable in class org.springframework.web.util.WebUtils
-
Default web app root key: "webapp.root".
- DefaultClientCodecConfigurer - Class in org.springframework.http.codec.support
-
Default implementation of
ClientCodecConfigurer
. - DefaultClientCodecConfigurer() - Constructor for class org.springframework.http.codec.support.DefaultClientCodecConfigurer
- DefaultClientRequestObservationConvention - Class in org.springframework.http.client.observation
-
Default implementation for a
ClientRequestObservationConvention
, extracting information from theClientRequestObservationContext
. - DefaultClientRequestObservationConvention() - Constructor for class org.springframework.http.client.observation.DefaultClientRequestObservationConvention
-
Create a convention with the default name
"http.client.requests"
. - DefaultClientRequestObservationConvention(String) - Constructor for class org.springframework.http.client.observation.DefaultClientRequestObservationConvention
-
Create a convention with a custom name.
- defaultCodecs - Variable in class org.springframework.http.codec.support.DefaultClientCodecConfigurer
- defaultCodecs() - Method in interface org.springframework.http.codec.ClientCodecConfigurer
-
Provides a way to customize or replace HTTP message readers and writers registered by default.
- defaultCodecs() - Method in interface org.springframework.http.codec.CodecConfigurer
-
Provides a way to customize or replace HTTP message readers and writers registered by default.
- defaultCodecs() - Method in interface org.springframework.http.codec.ServerCodecConfigurer
-
Provides a way to customize or replace HTTP message readers and writers registered by default.
- defaultCodecs() - Method in class org.springframework.http.codec.support.DefaultClientCodecConfigurer
- defaultCodecs() - Method in class org.springframework.http.codec.support.DefaultServerCodecConfigurer
- DefaultCorsProcessor - Class in org.springframework.web.cors
-
The default implementation of
CorsProcessor
, as defined by the CORS W3C recommendation. - DefaultCorsProcessor - Class in org.springframework.web.cors.reactive
-
The default implementation of
CorsProcessor
, as defined by the CORS W3C recommendation. - DefaultCorsProcessor() - Constructor for class org.springframework.web.cors.DefaultCorsProcessor
- DefaultCorsProcessor() - Constructor for class org.springframework.web.cors.reactive.DefaultCorsProcessor
- DefaultDataBinderFactory - Class in org.springframework.web.bind.support
-
Create a
WebRequestDataBinder
instance and initialize it with aWebBindingInitializer
. - DefaultDataBinderFactory(WebBindingInitializer) - Constructor for class org.springframework.web.bind.support.DefaultDataBinderFactory
-
Create a new
DefaultDataBinderFactory
instance. - defaultHeader(String, String...) - Method in interface org.springframework.web.client.RestClient.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.client.RestClient.Builder
-
Provide a consumer to access to every default header declared so far, with the possibility to add, replace, or remove.
- defaultInstance - Static variable in class org.springframework.web.util.pattern.PathPatternParser
-
Shared, read-only instance of
PathPatternParser
. - defaultInstance - Static variable in class org.springframework.web.util.UrlPathHelper
-
Shared, read-only instance with defaults.
- DefaultMultipartHttpServletRequest - Class in org.springframework.web.multipart.support
-
Default implementation of the
MultipartHttpServletRequest
interface. - DefaultMultipartHttpServletRequest(HttpServletRequest) - Constructor for class org.springframework.web.multipart.support.DefaultMultipartHttpServletRequest
-
Wrap the given HttpServletRequest in a MultipartHttpServletRequest.
- DefaultMultipartHttpServletRequest(HttpServletRequest, MultiValueMap<String, MultipartFile>, Map<String, String[]>, Map<String, String>) - Constructor for class org.springframework.web.multipart.support.DefaultMultipartHttpServletRequest
-
Wrap the given HttpServletRequest in a MultipartHttpServletRequest.
- defaultObjectMapper - Variable in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
- DefaultPartHttpMessageReader - Class in org.springframework.http.codec.multipart
- DefaultPartHttpMessageReader() - Constructor for class org.springframework.http.codec.multipart.DefaultPartHttpMessageReader
- defaultRequest(Consumer<RestClient.RequestHeadersSpec<?>>) - Method in interface org.springframework.web.client.RestClient.Builder
-
Provide a consumer to customize every request being built.
- DefaultResponseErrorHandler - Class in org.springframework.web.client
-
Spring's default implementation of the
ResponseErrorHandler
interface. - DefaultResponseErrorHandler() - Constructor for class org.springframework.web.client.DefaultResponseErrorHandler
- DefaultServerCodecConfigurer - Class in org.springframework.http.codec.support
-
Default implementation of
ServerCodecConfigurer
. - DefaultServerCodecConfigurer() - Constructor for class org.springframework.http.codec.support.DefaultServerCodecConfigurer
- DefaultServerRequestObservationConvention - Class in org.springframework.http.server.observation
-
Default
ServerRequestObservationConvention
. - DefaultServerRequestObservationConvention - Class in org.springframework.http.server.reactive.observation
-
Default
ServerRequestObservationConvention
. - DefaultServerRequestObservationConvention() - Constructor for class org.springframework.http.server.observation.DefaultServerRequestObservationConvention
-
Create a convention with the default name
"http.server.requests"
. - DefaultServerRequestObservationConvention() - Constructor for class org.springframework.http.server.reactive.observation.DefaultServerRequestObservationConvention
-
Create a convention with the default name
"http.server.requests"
. - DefaultServerRequestObservationConvention(String) - Constructor for class org.springframework.http.server.observation.DefaultServerRequestObservationConvention
-
Create a convention with a custom name.
- DefaultServerRequestObservationConvention(String) - Constructor for class org.springframework.http.server.reactive.observation.DefaultServerRequestObservationConvention
-
Create a convention with a custom name.
- DefaultServerWebExchange - Class in org.springframework.web.server.adapter
-
Default implementation of
ServerWebExchange
. - DefaultServerWebExchange(ServerHttpRequest, ServerHttpResponse, WebSessionManager, ServerCodecConfigurer, LocaleContextResolver) - Constructor for class org.springframework.web.server.adapter.DefaultServerWebExchange
- DefaultSessionAttributeStore - Class in org.springframework.web.bind.support
-
Default implementation of the
SessionAttributeStore
interface, storing the attributes in the WebRequest session (i.e. - DefaultSessionAttributeStore() - Constructor for class org.springframework.web.bind.support.DefaultSessionAttributeStore
- defaultStatusHandler(Predicate<HttpStatusCode>, RestClient.ResponseSpec.ErrorHandler) - Method in interface org.springframework.web.client.RestClient.Builder
-
Register a default status handler to apply to every response.
- defaultStatusHandler(ResponseErrorHandler) - Method in interface org.springframework.web.client.RestClient.Builder
-
Register a default status handler to apply to every response.
- defaultTyping(TypeResolverBuilder<?>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Specify a
TypeResolverBuilder
to use for Jackson's default typing. - DefaultUriBuilderFactory - Class in org.springframework.web.util
-
UriBuilderFactory
that relies onUriComponentsBuilder
for the actual building of the URI. - DefaultUriBuilderFactory() - Constructor for class org.springframework.web.util.DefaultUriBuilderFactory
-
Default constructor without a base URI.
- DefaultUriBuilderFactory(String) - Constructor for class org.springframework.web.util.DefaultUriBuilderFactory
-
Constructor with a base URI.
- DefaultUriBuilderFactory(UriComponentsBuilder) - Constructor for class org.springframework.web.util.DefaultUriBuilderFactory
-
Variant of
DefaultUriBuilderFactory(String)
with aUriComponentsBuilder
. - DefaultUriBuilderFactory.EncodingMode - Enum Class in org.springframework.web.util
-
Enum to represent multiple URI encoding strategies.
- defaultUriVariables(Map<String, ?>) - Method in interface org.springframework.web.client.RestClient.Builder
-
Configure default URL variable values to use when expanding URI templates with a
Map
. - defaultUseWrapper(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Define if a wrapper will be used for indexed (List, array) properties or not by default (only applies to
XmlMapper
). - defaultValue() - Element in annotation interface org.springframework.web.bind.annotation.CookieValue
-
The default value to use as a fallback.
- defaultValue() - Element in annotation interface org.springframework.web.bind.annotation.MatrixVariable
-
The default value to use as a fallback.
- defaultValue() - Element in annotation interface org.springframework.web.bind.annotation.RequestHeader
-
The default value to use as a fallback.
- defaultValue() - Element in annotation interface org.springframework.web.bind.annotation.RequestParam
-
The default value to use as a fallback when the request parameter is not provided or has an empty value.
- defaultViewInclusion(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Shortcut for
MapperFeature.DEFAULT_VIEW_INCLUSION
option. - DefaultWebFilterChain - Class in org.springframework.web.server.handler
-
Default implementation of
WebFilterChain
. - DefaultWebFilterChain(WebHandler, List<WebFilter>) - Constructor for class org.springframework.web.server.handler.DefaultWebFilterChain
-
Public constructor with the list of filters and the target handler to use.
- DefaultWebSessionManager - Class in org.springframework.web.server.session
-
Default implementation of
WebSessionManager
delegating to aWebSessionIdResolver
for session id resolution and to aWebSessionStore
. - DefaultWebSessionManager() - Constructor for class org.springframework.web.server.session.DefaultWebSessionManager
- DeferredResult<T> - Class in org.springframework.web.context.request.async
-
DeferredResult
provides an alternative to using aCallable
for asynchronous request processing. - DeferredResult() - Constructor for class org.springframework.web.context.request.async.DeferredResult
-
Create a DeferredResult.
- DeferredResult(Long) - Constructor for class org.springframework.web.context.request.async.DeferredResult
-
Create a DeferredResult with a custom timeout value.
- DeferredResult(Long, Object) - Constructor for class org.springframework.web.context.request.async.DeferredResult
-
Create a DeferredResult with a timeout value and a default result to use in case of timeout.
- DeferredResult(Long, Supplier<?>) - Constructor for class org.springframework.web.context.request.async.DeferredResult
-
Variant of
DeferredResult(Long, Object)
that accepts a dynamic fallback value based on aSupplier
. - DeferredResult.DeferredResultHandler - Interface in org.springframework.web.context.request.async
-
Handles a DeferredResult value when set.
- DeferredResultProcessingInterceptor - Interface in org.springframework.web.context.request.async
-
Intercepts concurrent request handling, where the concurrent result is obtained by waiting for a
DeferredResult
to be set from a thread chosen by the application (e.g. - DelegatingFilterProxy - Class in org.springframework.web.filter
-
Proxy for a standard Servlet Filter, delegating to a Spring-managed bean that implements the Filter interface.
- DelegatingFilterProxy() - Constructor for class org.springframework.web.filter.DelegatingFilterProxy
-
Create a new
DelegatingFilterProxy
. - DelegatingFilterProxy(Filter) - Constructor for class org.springframework.web.filter.DelegatingFilterProxy
-
Create a new
DelegatingFilterProxy
with the givenFilter
delegate. - DelegatingFilterProxy(String) - Constructor for class org.springframework.web.filter.DelegatingFilterProxy
-
Create a new
DelegatingFilterProxy
that will retrieve the named target bean from the SpringWebApplicationContext
found in theServletContext
(either the 'root' application context or the context named byDelegatingFilterProxy.setContextAttribute(java.lang.String)
). - DelegatingFilterProxy(String, WebApplicationContext) - Constructor for class org.springframework.web.filter.DelegatingFilterProxy
-
Create a new
DelegatingFilterProxy
that will retrieve the named target bean from the given SpringWebApplicationContext
. - DelegatingNavigationHandlerProxy - Class in org.springframework.web.jsf
-
JSF NavigationHandler implementation that delegates to a NavigationHandler bean obtained from the Spring root WebApplicationContext.
- DelegatingNavigationHandlerProxy() - Constructor for class org.springframework.web.jsf.DelegatingNavigationHandlerProxy
-
Create a new DelegatingNavigationHandlerProxy.
- DelegatingNavigationHandlerProxy(NavigationHandler) - Constructor for class org.springframework.web.jsf.DelegatingNavigationHandlerProxy
-
Create a new DelegatingNavigationHandlerProxy.
- DelegatingPhaseListenerMulticaster - Class in org.springframework.web.jsf
-
JSF PhaseListener implementation that delegates to one or more Spring-managed PhaseListener beans coming from the Spring root WebApplicationContext.
- DelegatingPhaseListenerMulticaster() - Constructor for class org.springframework.web.jsf.DelegatingPhaseListenerMulticaster
- DelegatingServerHttpResponse - Class in org.springframework.http.server
-
Implementation of
ServerHttpResponse
that delegates all calls to a given targetServerHttpResponse
. - DelegatingServerHttpResponse(ServerHttpResponse) - Constructor for class org.springframework.http.server.DelegatingServerHttpResponse
-
Create a new
DelegatingServerHttpResponse
. - delete() - Method in interface org.springframework.http.codec.multipart.Part
-
Return a mono that, when subscribed to, deletes the underlying storage for this part.
- delete() - Method in interface org.springframework.web.client.RestClient
-
Start building an HTTP DELETE request.
- delete(String, Object...) - Static method in class org.springframework.http.RequestEntity
-
Create an HTTP DELETE builder with the given string base uri template.
- delete(String, Object...) - Method in interface org.springframework.web.client.RestOperations
-
Delete the resources at the specified URI.
- delete(String, Object...) - Method in class org.springframework.web.client.RestTemplate
- delete(String, Map<String, ?>) - Method in interface org.springframework.web.client.RestOperations
-
Delete the resources at the specified URI.
- delete(String, Map<String, ?>) - Method in class org.springframework.web.client.RestTemplate
- delete(URI) - Static method in class org.springframework.http.RequestEntity
-
Create an HTTP DELETE builder with the given url.
- delete(URI) - Method in interface org.springframework.web.client.RestOperations
-
Delete the resources at the specified URL.
- delete(URI) - Method in class org.springframework.web.client.RestTemplate
- DELETE - Enum constant in enum class org.springframework.web.bind.annotation.RequestMethod
- DELETE - Static variable in class org.springframework.http.HttpMethod
-
The HTTP method
DELETE
. - DeleteExchange - Annotation Interface in org.springframework.web.service.annotation
-
Shortcut for
@HttpExchange
for HTTP DELETE requests. - DeleteMapping - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation for mapping HTTP
DELETE
requests onto specific handler methods. - deserializerByType(Class<?>, JsonDeserializer<?>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Configure a custom deserializer for the given type.
- deserializerInstance(DeserializationConfig, Annotated, Class<?>) - Method in class org.springframework.http.converter.json.SpringHandlerInstantiator
- deserializers(JsonDeserializer<?>...) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Configure custom deserializers.
- deserializersByType(Map<Class<?>, JsonDeserializer<?>>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Configure custom deserializers for the given types.
- DESTINATION_LOCKED - Enum constant in enum class org.springframework.http.HttpStatus
-
Deprecated.
- destroy() - Method in class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Shutdown hook that closes the underlying
ClientConnectionManager
's connection pool, if any. - destroy() - Method in class org.springframework.http.client.JettyClientHttpRequestFactory
- destroy() - Method in class org.springframework.http.client.OkHttp3ClientHttpRequestFactory
-
Deprecated.
- destroy() - Method in class org.springframework.http.client.reactive.JdkHttpClientResourceFactory
- destroy() - Method in class org.springframework.http.client.reactive.JettyResourceFactory
- destroy() - Method in class org.springframework.http.client.reactive.ReactorNetty2ResourceFactory
- destroy() - Method in class org.springframework.http.client.ReactorResourceFactory
- destroy() - Method in class org.springframework.http.server.reactive.ServletHttpHandlerAdapter
- destroy() - Method in class org.springframework.web.context.support.ServletContextScope
-
Invoke all registered destruction callbacks.
- destroy() - Method in class org.springframework.web.filter.CompositeFilter
-
Clean up all the filters supplied, calling each one's destroy method in turn, but in reverse order.
- destroy() - Method in class org.springframework.web.filter.DelegatingFilterProxy
- destroy() - Method in class org.springframework.web.filter.GenericFilterBean
-
Subclasses may override this to perform custom filter shutdown.
- destroyDelegate(Filter) - Method in class org.springframework.web.filter.DelegatingFilterProxy
-
Destroy the Filter delegate.
- DESTRUCTION_CALLBACK_NAME_PREFIX - Static variable in class org.springframework.web.context.request.ServletRequestAttributes
-
Constant identifying the
String
prefixed to the name of a destruction callback when it is stored in aHttpSession
. - DestructionCallbackBindingListener - Class in org.springframework.web.context.request
-
Adapter that implements the Servlet HttpSessionBindingListener interface, wrapping a session destruction callback.
- DestructionCallbackBindingListener(Runnable) - Constructor for class org.springframework.web.context.request.DestructionCallbackBindingListener
-
Create a new DestructionCallbackBindingListener for the given callback.
- detail(String) - Method in interface org.springframework.web.ErrorResponse.Builder
-
Set the underlying
detail
. - detailMessageArguments(Object...) - Method in interface org.springframework.web.ErrorResponse.Builder
-
Set the arguments to provide to the
MessageSource
lookup forErrorResponse.Builder.detailMessageCode(String)
. - detailMessageCode(String) - Method in interface org.springframework.web.ErrorResponse.Builder
-
Customize the
MessageSource
code to use to resolve the value for theErrorResponse.Builder.detail(String)
. - determineContextClass(ServletContext) - Method in class org.springframework.web.context.ContextLoader
-
Return the WebApplicationContext implementation class to use, either the default XmlWebApplicationContext or a custom context class if specified.
- determineContextInitializerClasses(ServletContext) - Method in class org.springframework.web.context.ContextLoader
-
Return the
ApplicationContextInitializer
implementation classes to use if any have been specified byContextLoader.CONTEXT_INITIALIZER_CLASSES_PARAM
. - determineEncoding(HttpServletRequest) - Method in class org.springframework.web.util.UrlPathHelper
-
Determine the encoding for the given request.
- determineRawStatusCode(Throwable) - Method in class org.springframework.web.server.handler.ResponseStatusExceptionHandler
-
Deprecated.as of 6.0, in favor of
ResponseStatusExceptionHandler.determineStatus(Throwable)
- determineStatus(Throwable) - Method in class org.springframework.web.server.handler.ResponseStatusExceptionHandler
-
Determine the HTTP status for the given exception.
- determineValidationGroups(Object, Method) - Method in class org.springframework.web.method.annotation.HandlerMethodValidator
- disableContentCaching(ServletRequest) - Static method in class org.springframework.web.filter.ShallowEtagHeaderFilter
-
This method can be used to suppress the content caching response wrapper of the ShallowEtagHeaderFilter.
- discardData() - Method in class org.springframework.http.server.reactive.AbstractListenerReadPublisher
-
Invoked after an I/O read error from the underlying server or after a cancellation signal from the downstream consumer to allow subclasses to discard any current cached data they might have.
- discardData(T) - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
-
Invoked after any error (either from the upstream write Publisher, or from I/O operations to the underlying server) and cancellation to discard in-flight data that was in the process of being written when the error took place.
- DisconnectedClientHelper - Class in org.springframework.web.util
-
Utility methods to assist with identifying and logging exceptions that indicate the client has gone away.
- DisconnectedClientHelper(String) - Constructor for class org.springframework.web.util.DisconnectedClientHelper
- dispatch() - Method in interface org.springframework.web.context.request.async.AsyncWebRequest
-
Dispatch the request to the container in order to resume processing after concurrent execution in an application thread.
- dispatch() - Method in class org.springframework.web.context.request.async.StandardServletAsyncWebRequest
- doBind(MutablePropertyValues) - Method in class org.springframework.web.bind.WebDataBinder
-
This implementation performs a field default and marker check before delegating to the superclass binding process.
- doCommit() - Method in class org.springframework.http.client.reactive.AbstractClientHttpRequest
-
A variant of
AbstractClientHttpRequest.doCommit(Supplier)
for a request without body. - doCommit() - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
-
A variant of
AbstractServerHttpResponse.doCommit(Supplier)
for a response without a body. - doCommit(Supplier<? extends Publisher<Void>>) - Method in class org.springframework.http.client.reactive.AbstractClientHttpRequest
-
Apply
beforeCommit
actions, apply the request headers/cookies, and write the request body. - doCommit(Supplier<? extends Mono<Void>>) - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
-
Apply
beforeCommit
actions, apply the response status and headers/cookies, and write the response body. - doExecute(URI, String, HttpMethod, RequestCallback, ResponseExtractor<T>) - Method in class org.springframework.web.client.RestTemplate
-
Execute the given method on the provided URI.
- doExecute(URI, HttpMethod, RequestCallback, ResponseExtractor<T>) - Method in class org.springframework.web.client.RestTemplate
-
Deprecated.
- doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.springframework.web.filter.CompositeFilter
-
Forms a temporary chain from the list of delegate filters supplied (
CompositeFilter.setFilters(java.util.List<? extends jakarta.servlet.Filter>)
) and executes them in order. - doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.springframework.web.filter.DelegatingFilterProxy
- doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.springframework.web.filter.OncePerRequestFilter
-
This
doFilter
implementation stores a request attribute for "already filtered", proceeding without filtering again if the attribute is already there. - doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.springframework.web.filter.ServletRequestPathFilter
- doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Forwards the request to the next filter in the chain and delegates down to the subclasses to perform the actual request logging both before and after the request is processed.
- doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.springframework.web.filter.CharacterEncodingFilter
- doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.springframework.web.filter.CorsFilter
- doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.springframework.web.filter.FormContentFilter
- doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.springframework.web.filter.ForwardedHeaderFilter
- doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.springframework.web.filter.HiddenHttpMethodFilter
- doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.springframework.web.filter.OncePerRequestFilter
-
Same contract as for
doFilter
, but guaranteed to be just invoked once per request within a single request thread. - doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.springframework.web.filter.RelativeRedirectFilter
- doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.springframework.web.filter.RequestContextFilter
- doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.springframework.web.filter.ServerHttpObservationFilter
- doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.springframework.web.filter.ShallowEtagHeaderFilter
- doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.springframework.web.multipart.support.MultipartFilter
-
Check for a multipart request via this filter's MultipartResolver, and wrap the original request with a MultipartHttpServletRequest if appropriate.
- doFilterNestedErrorDispatch(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.springframework.web.filter.ForwardedHeaderFilter
- doFilterNestedErrorDispatch(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.springframework.web.filter.OncePerRequestFilter
-
Typically an ERROR dispatch happens after the REQUEST dispatch completes, and the filter chain starts anew.
- doFindPathMatchingFileResources(Resource, String) - Method in class org.springframework.web.context.support.ServletContextResourcePatternResolver
-
Overridden version which checks for ServletContextResource and uses
ServletContext.getResourcePaths
to find matching resources below the web application root directory. - doInvoke(Object...) - Method in class org.springframework.web.method.support.InvocableHandlerMethod
-
Invoke the handler method with the given argument values.
- domain(String) - Method in interface org.springframework.http.ResponseCookie.ResponseCookieBuilder
-
Set the cookie "Domain" attribute.
- doRetrieveMatchingServletContextResources(ServletContext, String, String, Set<Resource>) - Method in class org.springframework.web.context.support.ServletContextResourcePatternResolver
-
Recursively retrieve ServletContextResources that match the given pattern, adding them to the given result set.
- doWithRequest(ClientHttpRequest) - Method in interface org.springframework.web.client.RequestCallback
E
- EARLY_HINTS - Enum constant in enum class org.springframework.http.HttpStatus
-
103 Early Hints
. - elements() - Method in interface org.springframework.http.server.PathContainer
-
The contained path elements, either
PathContainer.Separator
orPathContainer.PathSegment
. - embeddedValueResolver(StringValueResolver) - Method in class org.springframework.web.service.invoker.HttpServiceProxyFactory.Builder
-
Set the
StringValueResolver
to use for resolving placeholders and expressions embedded inHttpExchange.url()
. - empty() - Static method in class org.springframework.http.CacheControl
-
Return an empty directive.
- empty() - Static method in class org.springframework.http.ContentDisposition
-
Return an empty content disposition.
- EMPTY - Static variable in class org.springframework.http.HttpEntity
-
The empty
HttpEntity
, with no body or headers. - EMPTY - Static variable in class org.springframework.http.HttpHeaders
-
An empty
HttpHeaders
instance (immutable). - enableLoggingRequestDetails(boolean) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Whether to log form data at DEBUG level, and headers at TRACE level.
- encode() - Method in class org.springframework.web.util.UriComponents
-
Invoke this after expanding URI variables to encode the resulting URI component values.
- encode() - Method in class org.springframework.web.util.UriComponentsBuilder
-
Request to have the URI template pre-encoded at build time, and URI variables encoded separately when expanded.
- encode(Object, DataBufferFactory, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.xml.Jaxb2XmlEncoder
- encode(String, String) - Static method in class org.springframework.web.util.UriUtils
-
Variant of
UriUtils.encode(String, Charset)
with a String charset. - encode(String, Charset) - Static method in class org.springframework.web.util.UriUtils
-
Encode all characters that are either illegal, or have any reserved meaning, anywhere within a URI, as defined in RFC 3986.
- encode(Charset) - Method in class org.springframework.web.util.UriComponents
-
A variant of
UriComponents.encode()
with a charset other than "UTF-8". - encode(Charset) - Method in class org.springframework.web.util.UriComponentsBuilder
-
A variant of
UriComponentsBuilder.encode()
with a charset other than "UTF-8". - encode(Publisher<?>, DataBufferFactory, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.cbor.Jackson2CborEncoder
- encode(Publisher<?>, DataBufferFactory, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.json.AbstractJackson2Encoder
- encode(Publisher<?>, DataBufferFactory, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.KotlinSerializationBinaryEncoder
- encode(Publisher<?>, DataBufferFactory, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.KotlinSerializationStringEncoder
- encode(Publisher<? extends Message>, DataBufferFactory, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.protobuf.ProtobufEncoder
- encodeAuthority(String, String) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI authority with the given encoding.
- encodeAuthority(String, Charset) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI authority with the given encoding.
- encodeBasicAuth(String, String, Charset) - Static method in class org.springframework.http.HttpHeaders
-
Encode the given username and password into Basic Authentication credentials.
- encodeFragment(String, String) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI fragment with the given encoding.
- encodeFragment(String, Charset) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI fragment with the given encoding.
- encodeHost(String, String) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI host with the given encoding.
- encodeHost(String, Charset) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI host with the given encoding.
- encodePath(String, String) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI path with the given encoding.
- encodePath(String, Charset) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI path with the given encoding.
- encodePathSegment(String, String) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI path segment with the given encoding.
- encodePathSegment(String, Charset) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI path segment with the given encoding.
- encodePort(String, String) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI port with the given encoding.
- encodePort(String, Charset) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI port with the given encoding.
- encodeQuery(String, String) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI query with the given encoding.
- encodeQuery(String, Charset) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI query with the given encoding.
- encodeQueryParam(String, String) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI query parameter with the given encoding.
- encodeQueryParam(String, Charset) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI query parameter with the given encoding.
- encodeQueryParams(MultiValueMap<String, String>) - Static method in class org.springframework.web.util.UriUtils
-
Encode the query parameters from the given
MultiValueMap
with UTF-8. - encoder(Encoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.CustomCodecs
-
Deprecated.as of 5.1.13, use
CodecConfigurer.CustomCodecs.register(Object)
orCodecConfigurer.CustomCodecs.registerWithDefaultConfig(Object)
instead. - encoder(Encoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.MultipartCodecs
-
Add a Part
Encoder
, internally wrapped withEncoderHttpMessageWriter
. - EncoderHttpMessageWriter<T> - Class in org.springframework.http.codec
-
HttpMessageWriter
that wraps and delegates to anEncoder
. - EncoderHttpMessageWriter(Encoder<T>) - Constructor for class org.springframework.http.codec.EncoderHttpMessageWriter
-
Create an instance wrapping the given
Encoder
. - encodeScheme(String, String) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI scheme with the given encoding.
- encodeScheme(String, Charset) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI scheme with the given encoding.
- encodeUriVariables(Object...) - Static method in class org.springframework.web.util.UriUtils
-
Convenience method to apply
UriUtils.encode(String, Charset)
to all given URI variable values. - encodeUriVariables(Map<String, ?>) - Static method in class org.springframework.web.util.UriUtils
-
Convenience method to apply
UriUtils.encode(String, Charset)
to all given URI variable values. - encodeUserInfo(String, String) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI user info with the given encoding.
- encodeUserInfo(String, Charset) - Static method in class org.springframework.web.util.UriUtils
-
Encode the given URI user info with the given encoding.
- encodeValue(Message, DataBufferFactory, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.protobuf.ProtobufEncoder
- encodeValue(Object, DataBufferFactory, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.json.AbstractJackson2Encoder
- encodeValue(Object, DataBufferFactory, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.KotlinSerializationBinaryEncoder
- encodeValue(Object, DataBufferFactory, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.KotlinSerializationStringEncoder
- encodeValue(Object, DataBufferFactory, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.xml.Jaxb2XmlEncoder
- entrySet() - Method in class org.springframework.http.HttpHeaders
- entrySet() - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- entrySet() - Method in class org.springframework.http.support.JettyHeadersAdapter
- entrySet() - Method in class org.springframework.http.support.Netty4HeadersAdapter
- entrySet() - Method in class org.springframework.http.support.Netty5HeadersAdapter
- equals(Object) - Method in class org.springframework.http.ContentDisposition
- equals(Object) - Method in class org.springframework.http.HttpCookie
- equals(Object) - Method in class org.springframework.http.HttpEntity
- equals(Object) - Method in class org.springframework.http.HttpHeaders
- equals(Object) - Method in class org.springframework.http.HttpMethod
- equals(Object) - Method in class org.springframework.http.ProblemDetail
- equals(Object) - Method in class org.springframework.http.RequestEntity
- equals(Object) - Method in class org.springframework.http.RequestEntity.UriTemplateRequestEntity
- equals(Object) - Method in class org.springframework.http.ResponseCookie
- equals(Object) - Method in class org.springframework.http.ResponseEntity
- equals(Object) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- equals(Object) - Method in class org.springframework.web.context.support.ServletContextResource
-
This implementation compares the underlying ServletContext resource locations.
- equals(Object) - Method in class org.springframework.web.method.ControllerAdviceBean
- equals(Object) - Method in class org.springframework.web.method.HandlerMethod
- equals(Object) - Method in class org.springframework.web.util.pattern.PathPattern
- ERROR_EXCEPTION_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.3+ spec request attribute for error page exception.
- ERROR_EXCEPTION_TYPE_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.3+ spec request attribute for error page exception type.
- ERROR_MESSAGE_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.3+ spec request attribute for error page message.
- ERROR_REQUEST_URI_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.3+ spec request attribute for error page request URI.
- ERROR_SERVLET_NAME_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.3+ spec request attribute for error page servlet name.
- ERROR_STATUS_CODE_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.3+ spec request attribute for error page status code.
- ErrorResponse - Interface in org.springframework.web
-
Representation of a complete RFC 7807 error response including status, headers, and an RFC 7807 formatted
ProblemDetail
body. - ErrorResponse.Builder - Interface in org.springframework.web
-
Builder for an
ErrorResponse
. - ErrorResponseException - Exception in org.springframework.web
-
RuntimeException
that implementsErrorResponse
to expose an HTTP status, response headers, and a body formatted as an RFC 7807ProblemDetail
. - ErrorResponseException(HttpStatusCode) - Constructor for exception org.springframework.web.ErrorResponseException
-
Constructor with an
HttpStatusCode
. - ErrorResponseException(HttpStatusCode, Throwable) - Constructor for exception org.springframework.web.ErrorResponseException
-
Constructor with an
HttpStatusCode
and an optional cause. - ErrorResponseException(HttpStatusCode, ProblemDetail, Throwable) - Constructor for exception org.springframework.web.ErrorResponseException
-
Constructor with a given
ProblemDetail
instance, possibly a subclass ofProblemDetail
with extended fields. - ErrorResponseException(HttpStatusCode, ProblemDetail, Throwable, String, Object[]) - Constructor for exception org.springframework.web.ErrorResponseException
-
Constructor with a given
ProblemDetail
, and aMessageSource
code and arguments to resolve the detail message with. - ErrorsMethodArgumentResolver - Class in org.springframework.web.method.annotation
-
Resolves
Errors
method arguments. - ErrorsMethodArgumentResolver() - Constructor for class org.springframework.web.method.annotation.ErrorsMethodArgumentResolver
- errorsToStringList(List<? extends ObjectError>) - Static method in exception org.springframework.web.bind.MethodArgumentNotValidException
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of using
BindErrorUtils
andBindException.getAllErrors()
, to be removed in 6.2 - errorsToStringList(List<? extends ObjectError>, MessageSource, Locale) - Static method in exception org.springframework.web.bind.MethodArgumentNotValidException
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of
BindErrorUtils
, to be removed in 6.2 - EscapedErrors - Class in org.springframework.web.bind
-
Errors wrapper that adds automatic HTML escaping to the wrapped instance, for convenient usage in HTML views.
- EscapedErrors(Errors) - Constructor for class org.springframework.web.bind.EscapedErrors
-
Create a new EscapedErrors instance for the given source instance.
- eTag(String) - Method in interface org.springframework.http.ResponseEntity.HeadersBuilder
-
Set the entity tag of the body, as specified by the
ETag
header. - ETAG - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
ETag
header field name. - event() - Method in class org.springframework.http.codec.ServerSentEvent
-
Return the
event
field of this event, if available. - event(String) - Method in interface org.springframework.http.codec.ServerSentEvent.Builder
-
Set the value of the
event
field. - exception(ClientRequestObservationContext) - Method in class org.springframework.http.client.observation.DefaultClientRequestObservationConvention
- exception(ServerRequestObservationContext) - Method in class org.springframework.http.server.observation.DefaultServerRequestObservationConvention
- exception(ServerRequestObservationContext) - Method in class org.springframework.http.server.reactive.observation.DefaultServerRequestObservationConvention
- EXCEPTION - Enum constant in enum class org.springframework.http.client.observation.ClientHttpObservationDocumentation.LowCardinalityKeyNames
-
Name of the exception thrown during the exchange, or "none" if no exception happened.
- EXCEPTION - Enum constant in enum class org.springframework.http.server.observation.ServerHttpObservationDocumentation.LowCardinalityKeyNames
-
Name of the exception thrown during the exchange, or "none"} if no exception happened.
- EXCEPTION - Enum constant in enum class org.springframework.http.server.reactive.observation.ServerHttpObservationDocumentation.LowCardinalityKeyNames
-
Name of the exception thrown during the exchange, or "none" if no exception happened.
- EXCEPTION_HANDLER_METHODS - Static variable in class org.springframework.web.method.annotation.ExceptionHandlerMethodResolver
-
A filter for selecting
@ExceptionHandler
methods. - exceptionHandler(WebExceptionHandler...) - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Add the given exception handler(s).
- ExceptionHandler - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation for handling exceptions in specific handler classes and/or handler methods.
- ExceptionHandlerMethodResolver - Class in org.springframework.web.method.annotation
-
Discovers @ExceptionHandler methods in a given class, including all of its superclasses, and helps to resolve a given
Exception
to the exception types supported by a givenMethod
. - ExceptionHandlerMethodResolver(Class<?>) - Constructor for class org.springframework.web.method.annotation.ExceptionHandlerMethodResolver
-
A constructor that finds
ExceptionHandler
methods in the given type. - exceptionHandlers(Consumer<List<WebExceptionHandler>>) - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Manipulate the "live" list of currently configured exception handlers.
- ExceptionHandlingWebHandler - Class in org.springframework.web.server.handler
-
WebHandler decorator that invokes one or more
WebExceptionHandlers
after the delegateWebHandler
. - ExceptionHandlingWebHandler(WebHandler, List<WebExceptionHandler>) - Constructor for class org.springframework.web.server.handler.ExceptionHandlingWebHandler
-
Create an
ExceptionHandlingWebHandler
for the given delegate. - exchange(String, HttpMethod, HttpEntity<?>, Class<T>, Object...) - Method in interface org.springframework.web.client.RestOperations
-
Execute the HTTP method to the given URI template, writing the given request entity to the request, and return the response as
ResponseEntity
. - exchange(String, HttpMethod, HttpEntity<?>, Class<T>, Object...) - Method in class org.springframework.web.client.RestTemplate
- exchange(String, HttpMethod, HttpEntity<?>, Class<T>, Map<String, ?>) - Method in interface org.springframework.web.client.RestOperations
-
Execute the HTTP method to the given URI template, writing the given request entity to the request, and return the response as
ResponseEntity
. - exchange(String, HttpMethod, HttpEntity<?>, Class<T>, Map<String, ?>) - Method in class org.springframework.web.client.RestTemplate
- exchange(String, HttpMethod, HttpEntity<?>, ParameterizedTypeReference<T>, Object...) - Method in interface org.springframework.web.client.RestOperations
-
Execute the HTTP method to the given URI template, writing the given request entity to the request, and return the response as
ResponseEntity
. - exchange(String, HttpMethod, HttpEntity<?>, ParameterizedTypeReference<T>, Object...) - Method in class org.springframework.web.client.RestTemplate
- exchange(String, HttpMethod, HttpEntity<?>, ParameterizedTypeReference<T>, Map<String, ?>) - Method in interface org.springframework.web.client.RestOperations
-
Execute the HTTP method to the given URI template, writing the given request entity to the request, and return the response as
ResponseEntity
. - exchange(String, HttpMethod, HttpEntity<?>, ParameterizedTypeReference<T>, Map<String, ?>) - Method in class org.springframework.web.client.RestTemplate
- exchange(URI, HttpMethod, HttpEntity<?>, Class<T>) - Method in interface org.springframework.web.client.RestOperations
-
Execute the HTTP method to the given URI template, writing the given request entity to the request, and return the response as
ResponseEntity
. - exchange(URI, HttpMethod, HttpEntity<?>, Class<T>) - Method in class org.springframework.web.client.RestTemplate
- exchange(URI, HttpMethod, HttpEntity<?>, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.client.RestOperations
-
Execute the HTTP method to the given URI template, writing the given request entity to the request, and return the response as
ResponseEntity
. - exchange(URI, HttpMethod, HttpEntity<?>, ParameterizedTypeReference<T>) - Method in class org.springframework.web.client.RestTemplate
- exchange(HttpRequest, RestClient.RequestHeadersSpec.ConvertibleClientHttpResponse) - Method in interface org.springframework.web.client.RestClient.RequestHeadersSpec.ExchangeFunction
-
Exchange the given response into a type
T
. - exchange(RequestEntity<?>, Class<T>) - Method in interface org.springframework.web.client.RestOperations
-
Execute the request specified in the given
RequestEntity
and return the response asResponseEntity
. - exchange(RequestEntity<?>, Class<T>) - Method in class org.springframework.web.client.RestTemplate
- exchange(RequestEntity<?>, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.client.RestOperations
-
Execute the request specified in the given
RequestEntity
and return the response asResponseEntity
. - exchange(RequestEntity<?>, ParameterizedTypeReference<T>) - Method in class org.springframework.web.client.RestTemplate
- exchange(RestClient.RequestHeadersSpec.ExchangeFunction<T>) - Method in interface org.springframework.web.client.RestClient.RequestHeadersSpec
-
Exchange the
ClientHttpResponse
for a typeT
. - exchange(RestClient.RequestHeadersSpec.ExchangeFunction<T>, boolean) - Method in interface org.springframework.web.client.RestClient.RequestHeadersSpec
-
Exchange the
ClientHttpResponse
for a typeT
. - exchange(HttpRequestValues) - Method in class org.springframework.web.client.support.RestClientAdapter
- exchange(HttpRequestValues) - Method in class org.springframework.web.client.support.RestTemplateAdapter
- exchange(HttpRequestValues) - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
- exchange(HttpRequestValues) - Method in interface org.springframework.web.service.invoker.HttpExchangeAdapter
-
Perform the given request, and release the response content, if any.
- EXCHANGE_CONTEXT_ATTRIBUTE - Static variable in class org.springframework.web.filter.reactive.ServerWebExchangeContextFilter
-
Attribute name under which the exchange is saved in the context.
- exchangeAdapter(HttpExchangeAdapter) - Method in class org.springframework.web.service.invoker.HttpServiceProxyFactory.Builder
-
Provide the HTTP client to perform requests through.
- exchangeForBodilessEntity(HttpRequestValues) - Method in class org.springframework.web.client.support.RestClientAdapter
- exchangeForBodilessEntity(HttpRequestValues) - Method in class org.springframework.web.client.support.RestTemplateAdapter
- exchangeForBodilessEntity(HttpRequestValues) - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
- exchangeForBodilessEntity(HttpRequestValues) - Method in interface org.springframework.web.service.invoker.HttpExchangeAdapter
-
Variant of
HttpExchangeAdapter.exchange(HttpRequestValues)
with additional access to the response status and headers. - exchangeForBodilessEntityMono(HttpRequestValues) - Method in interface org.springframework.web.service.invoker.ReactorHttpExchangeAdapter
-
Variant of
ReactorHttpExchangeAdapter.exchangeForMono(HttpRequestValues)
with additional access to the response status and headers. - exchangeForBody(HttpRequestValues, ParameterizedTypeReference<T>) - Method in class org.springframework.web.client.support.RestClientAdapter
- exchangeForBody(HttpRequestValues, ParameterizedTypeReference<T>) - Method in class org.springframework.web.client.support.RestTemplateAdapter
- exchangeForBody(HttpRequestValues, ParameterizedTypeReference<T>) - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
- exchangeForBody(HttpRequestValues, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.service.invoker.HttpExchangeAdapter
-
Perform the given request and decode the response content to the given type.
- exchangeForBodyFlux(HttpRequestValues, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.service.invoker.ReactorHttpExchangeAdapter
-
Perform the given request and decode the response content to a stream with elements of the given type.
- exchangeForBodyMono(HttpRequestValues, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.service.invoker.ReactorHttpExchangeAdapter
-
Perform the given request and decode the response content to the given type.
- exchangeForEntity(HttpRequestValues, ParameterizedTypeReference<T>) - Method in class org.springframework.web.client.support.RestClientAdapter
- exchangeForEntity(HttpRequestValues, ParameterizedTypeReference<T>) - Method in class org.springframework.web.client.support.RestTemplateAdapter
- exchangeForEntity(HttpRequestValues, ParameterizedTypeReference<T>) - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
- exchangeForEntity(HttpRequestValues, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.service.invoker.HttpExchangeAdapter
-
Variant of
HttpExchangeAdapter.exchangeForBody(HttpRequestValues, ParameterizedTypeReference)
with additional access to the response status and headers. - exchangeForEntityFlux(HttpRequestValues, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.service.invoker.ReactorHttpExchangeAdapter
-
Variant of
ReactorHttpExchangeAdapter.exchangeForBodyFlux(HttpRequestValues, ParameterizedTypeReference)
with additional access to the response status and headers. - exchangeForEntityMono(HttpRequestValues, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.service.invoker.ReactorHttpExchangeAdapter
-
Variant of
ReactorHttpExchangeAdapter.exchangeForBodyMono(HttpRequestValues, ParameterizedTypeReference)
with additional access to the response status and headers. - exchangeForHeaders(HttpRequestValues) - Method in class org.springframework.web.client.support.RestClientAdapter
- exchangeForHeaders(HttpRequestValues) - Method in class org.springframework.web.client.support.RestTemplateAdapter
- exchangeForHeaders(HttpRequestValues) - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
- exchangeForHeaders(HttpRequestValues) - Method in interface org.springframework.web.service.invoker.HttpExchangeAdapter
-
Perform the given request, release the response content, and return the response headers.
- exchangeForHeadersMono(HttpRequestValues) - Method in interface org.springframework.web.service.invoker.ReactorHttpExchangeAdapter
-
Perform the given request, release the response content, and return the response headers.
- exchangeForMono(HttpRequestValues) - Method in interface org.springframework.web.service.invoker.ReactorHttpExchangeAdapter
-
Perform the given request, and release the response content, if any.
- execute() - Method in class org.springframework.http.client.AbstractClientHttpRequest
- execute() - Method in interface org.springframework.http.client.ClientHttpRequest
-
Execute this request, resulting in a
ClientHttpResponse
that can be read. - execute(String, HttpMethod, RequestCallback, ResponseExtractor<T>, Object...) - Method in interface org.springframework.web.client.RestOperations
-
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback
, and reading the response with aResponseExtractor
. - execute(String, HttpMethod, RequestCallback, ResponseExtractor<T>, Object...) - Method in class org.springframework.web.client.RestTemplate
-
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback
, and reading the response with aResponseExtractor
. - execute(String, HttpMethod, RequestCallback, ResponseExtractor<T>, Map<String, ?>) - Method in interface org.springframework.web.client.RestOperations
-
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback
, and reading the response with aResponseExtractor
. - execute(String, HttpMethod, RequestCallback, ResponseExtractor<T>, Map<String, ?>) - Method in class org.springframework.web.client.RestTemplate
-
Execute the HTTP method to the given URI template, preparing the request with the
RequestCallback
, and reading the response with aResponseExtractor
. - execute(URI, HttpMethod, RequestCallback, ResponseExtractor<T>) - Method in interface org.springframework.web.client.RestOperations
-
Execute the HTTP method to the given URL, preparing the request with the
RequestCallback
, and reading the response with aResponseExtractor
. - execute(URI, HttpMethod, RequestCallback, ResponseExtractor<T>) - Method in class org.springframework.web.client.RestTemplate
-
Execute the HTTP method to the given URL, preparing the request with the
RequestCallback
, and reading the response with aResponseExtractor
. - execute(HttpRequest, byte[]) - Method in interface org.springframework.http.client.ClientHttpRequestExecution
-
Execute the request with the given request attributes and body, and return the response.
- executeInternal(HttpHeaders) - Method in class org.springframework.http.client.AbstractClientHttpRequest
-
Abstract template method that writes the given headers and content to the HTTP request.
- exists() - Method in class org.springframework.web.context.support.ServletContextResource
-
This implementation checks
ServletContext.getResource
. - expand(Object...) - Method in class org.springframework.web.util.UriComponents
-
Replace all URI template variables with the values from a given array.
- expand(Object...) - Method in class org.springframework.web.util.UriTemplate
-
Given an array of variables, expand this template into a full URI.
- expand(String, Object...) - Method in class org.springframework.web.util.DefaultUriBuilderFactory
- expand(String, Object...) - Method in interface org.springframework.web.util.UriTemplateHandler
-
Expand the given URI template with an array of URI variables.
- expand(String, Map<String, ?>) - Method in class org.springframework.web.util.DefaultUriBuilderFactory
- expand(String, Map<String, ?>) - Method in interface org.springframework.web.util.UriTemplateHandler
-
Expand the given URI template with a map of URI variables.
- expand(Map<String, ?>) - Method in class org.springframework.web.util.UriComponents
-
Replace all URI template variables with the values from a given map.
- expand(Map<String, ?>) - Method in class org.springframework.web.util.UriTemplate
-
Given the Map of variables, expands this template into a URI.
- expand(UriComponents.UriTemplateVariables) - Method in class org.springframework.web.util.UriComponents
-
Replace all URI template variables with the values from the given
UriComponents.UriTemplateVariables
. - EXPECT - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Expect
header field name. - EXPECTATION_FAILED - Enum constant in enum class org.springframework.http.HttpStatus
-
417 Expectation Failed
. - EXPIRES - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Expires
header field name. - expireSession(ServerWebExchange) - Method in class org.springframework.web.server.session.CookieWebSessionIdResolver
- expireSession(ServerWebExchange) - Method in class org.springframework.web.server.session.HeaderWebSessionIdResolver
- expireSession(ServerWebExchange) - Method in interface org.springframework.web.server.session.WebSessionIdResolver
-
Instruct the client to end the current session.
- exposedHeaders() - Element in annotation interface org.springframework.web.bind.annotation.CrossOrigin
-
The List of response headers that the user-agent will allow the client to access on an actual response, possibly
"*"
to expose all headers. - exposeErrorRequestAttributes(HttpServletRequest, Throwable, String) - Static method in class org.springframework.web.util.WebUtils
-
Expose the Servlet spec's error attributes as
HttpServletRequest
attributes under the keys defined in the Servlet 2.3 specification, for error pages that are rendered directly rather than through the Servlet container's error page resolution:jakarta.servlet.error.status_code
,jakarta.servlet.error.exception_type
,jakarta.servlet.error.message
,jakarta.servlet.error.exception
,jakarta.servlet.error.request_uri
,jakarta.servlet.error.servlet_name
. - ExpressionValueMethodArgumentResolver - Class in org.springframework.web.method.annotation
-
Resolves method arguments annotated with
@Value
. - ExpressionValueMethodArgumentResolver(ConfigurableBeanFactory) - Constructor for class org.springframework.web.method.annotation.ExpressionValueMethodArgumentResolver
-
Create a new
ExpressionValueMethodArgumentResolver
instance. - extractData(ClientHttpResponse) - Method in class org.springframework.web.client.HttpMessageConverterExtractor
- extractData(ClientHttpResponse) - Method in interface org.springframework.web.client.ResponseExtractor
-
Extract data from the given
ClientHttpResponse
and return it. - extractFileExtension(String) - Static method in class org.springframework.web.util.UriUtils
-
Extract the file extension from the given URI path.
- ExtractingResponseErrorHandler - Class in org.springframework.web.client
-
Implementation of
ResponseErrorHandler
that usesHttpMessageConverters
to convert HTTP error responses toRestClientExceptions
. - ExtractingResponseErrorHandler() - Constructor for class org.springframework.web.client.ExtractingResponseErrorHandler
-
Create a new, empty
ExtractingResponseErrorHandler
. - ExtractingResponseErrorHandler(List<HttpMessageConverter<?>>) - Constructor for class org.springframework.web.client.ExtractingResponseErrorHandler
-
Create a new
ExtractingResponseErrorHandler
with the givenHttpMessageConverter
instances. - extractPathWithinPattern(PathContainer) - Method in class org.springframework.web.util.pattern.PathPattern
-
Determine the pattern-mapped part for the given path.
- extractValuesToBind(ServerWebExchange) - Static method in class org.springframework.web.bind.support.WebExchangeDataBinder
-
Combine query params and form data for multipart form data from the body of the request into a
Map<String, Object>
of values to use for data binding purposes.
F
- FacesContextUtils - Class in org.springframework.web.jsf
-
Convenience methods to retrieve Spring's root
WebApplicationContext
for a given JSFFacesContext
. - FacesContextUtils() - Constructor for class org.springframework.web.jsf.FacesContextUtils
- FacesRequestAttributes - Class in org.springframework.web.context.request
-
RequestAttributes
adapter for a JSFFacesContext
. - FacesRequestAttributes(FacesContext) - Constructor for class org.springframework.web.context.request.FacesRequestAttributes
-
Create a new FacesRequestAttributes adapter for the given FacesContext.
- FacesWebRequest - Class in org.springframework.web.context.request
-
WebRequest
adapter for a JSFFacesContext
. - FacesWebRequest(FacesContext) - Constructor for class org.springframework.web.context.request.FacesWebRequest
-
Create a new FacesWebRequest adapter for the given FacesContext.
- factory(JsonFactory) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Define the
JsonFactory
to be used to create theObjectMapper
instance. - FAILED_DEPENDENCY - Enum constant in enum class org.springframework.http.HttpStatus
-
424 Failed Dependency
. - failOnEmptyBeans(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Shortcut for
SerializationFeature.FAIL_ON_EMPTY_BEANS
option. - failOnUnknownProperties(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Shortcut for
DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES
option. - featuresToDisable(Object...) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Specify features to disable.
- featuresToEnable(Object...) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Specify features to enable.
- filename() - Method in interface org.springframework.http.codec.multipart.FilePart
-
Return the original filename in the client's filesystem.
- filename() - Method in interface org.springframework.http.codec.multipart.FilePartEvent
-
Return the original filename in the client's filesystem.
- filename(String) - Method in interface org.springframework.http.client.MultipartBodyBuilder.PartBuilder
-
Set the filename parameter for a file part.
- filename(String) - Method in interface org.springframework.http.ContentDisposition.Builder
-
Set the value of the filename parameter.
- filename(String, Charset) - Method in interface org.springframework.http.ContentDisposition.Builder
-
Set the value of the
filename
that will be encoded as defined in RFC 5987. - FilePart - Interface in org.springframework.http.codec.multipart
-
Specialization of
Part
that represents an uploaded file received in a multipart request. - FilePartEvent - Interface in org.springframework.http.codec.multipart
-
Represents an event triggered for a file upload.
- filter(ServerWebExchange) - Method in class org.springframework.web.server.handler.DefaultWebFilterChain
- filter(ServerWebExchange) - Method in interface org.springframework.web.server.WebFilterChain
-
Delegate to the next
WebFilter
in the chain. - filter(ServerWebExchange, WebFilterChain) - Method in class org.springframework.web.cors.reactive.CorsWebFilter
- filter(ServerWebExchange, WebFilterChain) - Method in class org.springframework.web.cors.reactive.PreFlightRequestWebFilter
- filter(ServerWebExchange, WebFilterChain) - Method in class org.springframework.web.filter.reactive.HiddenHttpMethodFilter
-
Transform an HTTP POST into another method based on
methodParamName
. - filter(ServerWebExchange, WebFilterChain) - Method in class org.springframework.web.filter.reactive.ServerHttpObservationFilter
-
Deprecated.
- filter(ServerWebExchange, WebFilterChain) - Method in class org.springframework.web.filter.reactive.ServerWebExchangeContextFilter
- filter(ServerWebExchange, WebFilterChain) - Method in interface org.springframework.web.server.WebFilter
-
Process the Web request and (optionally) delegate to the next
WebFilter
through the givenWebFilterChain
. - filter(WebFilter...) - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Add the given filter(s).
- FilteringWebHandler - Class in org.springframework.web.server.handler
- FilteringWebHandler(WebHandler, List<WebFilter>) - Constructor for class org.springframework.web.server.handler.FilteringWebHandler
-
Constructor.
- filters(FilterProvider) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Set the global filters to use in order to support
@JsonFilter
annotated POJO. - filters(Consumer<List<WebFilter>>) - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Manipulate the "live" list of currently configured filters.
- findAnnotatedBeans(ApplicationContext) - Static method in class org.springframework.web.method.ControllerAdviceBean
-
Find beans annotated with
@ControllerAdvice
in the givenApplicationContext
and wrap them asControllerAdviceBean
instances. - findCurrent(Map<String, Object>) - Static method in class org.springframework.http.server.reactive.observation.ServerRequestObservationContext
-
Get the current
observation context
from the given attributes, if available. - findEditor(String, Class) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- findModulesViaServiceLoader(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Set whether to let Jackson find available modules via the JDK ServiceLoader, based on META-INF metadata in the classpath.
- findObservationContext(HttpServletRequest) - Static method in class org.springframework.web.filter.ServerHttpObservationFilter
-
Get the current
observation context
from the given request, if available. - findObservationContext(ServerWebExchange) - Static method in class org.springframework.web.filter.reactive.ServerHttpObservationFilter
-
Deprecated.Get the current
observation context
from the given request, if available. - findParameterValue(ServletRequest, String) - Static method in class org.springframework.web.util.WebUtils
-
Obtain a named parameter from the given request parameters.
- findParameterValue(Map<String, ?>, String) - Static method in class org.springframework.web.util.WebUtils
-
Obtain a named parameter from the given request parameters.
- findWebApplicationContext() - Method in class org.springframework.web.filter.DelegatingFilterProxy
-
Return the
WebApplicationContext
passed in at construction time, if available. - findWebApplicationContext(ServletContext) - Static method in class org.springframework.web.context.support.WebApplicationContextUtils
-
Find a unique
WebApplicationContext
for this web app: either the root web app context (preferred) or a uniqueWebApplicationContext
among the registeredServletContext
attributes (typically coming from a singleDispatcherServlet
in the current web application). - FixedContentNegotiationStrategy - Class in org.springframework.web.accept
-
A
ContentNegotiationStrategy
that returns a fixed content type. - FixedContentNegotiationStrategy(List<MediaType>) - Constructor for class org.springframework.web.accept.FixedContentNegotiationStrategy
-
Constructor with an ordered List of default
MediaType
's to return for use in applications that support a variety of content types. - FixedContentNegotiationStrategy(MediaType) - Constructor for class org.springframework.web.accept.FixedContentNegotiationStrategy
-
Constructor with a single default
MediaType
. - FixedLocaleContextResolver - Class in org.springframework.web.server.i18n
-
LocaleContextResolver
implementation that always returns a fixed locale and optionally time zone. - FixedLocaleContextResolver() - Constructor for class org.springframework.web.server.i18n.FixedLocaleContextResolver
-
Create a default FixedLocaleResolver, exposing a configured default locale (or the JVM's default locale as fallback).
- FixedLocaleContextResolver(Locale) - Constructor for class org.springframework.web.server.i18n.FixedLocaleContextResolver
-
Create a FixedLocaleResolver that exposes the given locale.
- FixedLocaleContextResolver(Locale, TimeZone) - Constructor for class org.springframework.web.server.i18n.FixedLocaleContextResolver
-
Create a FixedLocaleResolver that exposes the given locale and time zone.
- flush() - Method in class org.springframework.http.server.DelegatingServerHttpResponse
- flush() - Method in class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
-
Flush the output if ready, or otherwise
AbstractListenerWriteFlushProcessor.isFlushPending()
should return true after. - flush() - Method in interface org.springframework.http.server.ServerHttpResponse
-
Ensure that the headers and the content of the response are written out.
- flush() - Method in class org.springframework.http.server.ServletServerHttpResponse
- flushBuffer() - Method in class org.springframework.web.util.ContentCachingResponseWrapper
-
This method neither flushes content to the client nor commits the underlying response, since the content has not yet been copied to the response.
- flushingFailed(Throwable) - Method in class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
-
Invoked when an error happens while flushing.
- forAnnotation(Class<? extends Annotation>...) - Static method in class org.springframework.web.method.HandlerTypePredicate
-
Match handlers annotated with a specific annotation.
- forAnyHandlerType() - Static method in class org.springframework.web.method.HandlerTypePredicate
-
Predicate
that applies to any handlers. - forAssignableType(Class<?>...) - Static method in class org.springframework.web.method.HandlerTypePredicate
-
Match handlers that are assignable to a given type.
- forBasePackage(String...) - Static method in class org.springframework.web.method.HandlerTypePredicate
-
Match handlers declared under a base package, e.g.
- forBasePackageClass(Class<?>...) - Static method in class org.springframework.web.method.HandlerTypePredicate
-
Type-safe alternative to
HandlerTypePredicate.forBasePackage(String...)
to specify a base package through a class. - FORBIDDEN - Enum constant in enum class org.springframework.http.HttpStatus
-
403 Forbidden
. - forEach(BiConsumer<? super String, ? super List<String>>) - Method in class org.springframework.http.HttpHeaders
- forLog(Log) - Static method in class org.springframework.http.HttpLogging
-
Wrap the given primary logger with a composite logger that delegates to it or to the fallback logger "org.springframework.web.HttpLogging", if the primary is not enabled.
- forLogName(Class<?>) - Static method in class org.springframework.http.HttpLogging
-
Create a primary logger for the given class and wrap it with a composite that delegates to it or to the fallback logger "org.springframework.web.HttpLogging", if the primary is not enabled.
- FORM_CHARSET - Static variable in class org.springframework.http.server.ServletServerHttpRequest
- format() - Method in class org.springframework.http.codec.KotlinSerializationSupport
-
Returns the format.
- formatHeaders(MultiValueMap<String, String>) - Static method in class org.springframework.http.HttpHeaders
-
Helps to format HTTP header values, as HTTP header values themselves can contain comma-separated values, can become confusing with regular
Map
formatting that also uses commas between entries. - formatInvokeError(String, Object[]) - Method in class org.springframework.web.method.HandlerMethod
- formatMessage(Object...) - Method in enum class org.springframework.web.util.pattern.PatternParseException.PatternMessage
- formatRequest(HttpServletRequest) - Method in class org.springframework.web.filter.ForwardedHeaderFilter
-
Format the request for logging purposes including HTTP method and URL.
- formatRequest(ServerHttpRequest) - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
Format the request for logging purposes including HTTP method and URL.
- formatUriValue(ConversionService, TypeDescriptor, Object) - Method in class org.springframework.web.method.annotation.RequestParamMethodArgumentResolver
- FormContentFilter - Class in org.springframework.web.filter
-
Filter
that parses form data for HTTP PUT, PATCH, and DELETE requests and exposes it as Servlet request parameters. - FormContentFilter() - Constructor for class org.springframework.web.filter.FormContentFilter
- formData() - Static method in class org.springframework.http.ContentDisposition
-
Return a builder for a
ContentDisposition
of type "form-data". - FormFieldPart - Interface in org.springframework.http.codec.multipart
-
Specialization of
Part
for a form field. - FormHttpMessageConverter - Class in org.springframework.http.converter
-
Implementation of
HttpMessageConverter
to read and write 'normal' HTML forms and also to write (but not read) multipart data (e.g. - FormHttpMessageConverter() - Constructor for class org.springframework.http.converter.FormHttpMessageConverter
- FormHttpMessageReader - Class in org.springframework.http.codec
-
Implementation of an
HttpMessageReader
to read HTML form data, i.e. - FormHttpMessageReader() - Constructor for class org.springframework.http.codec.FormHttpMessageReader
- FormHttpMessageWriter - Class in org.springframework.http.codec
-
HttpMessageWriter
for writing aMultiValueMap<String, String>
as HTML form data, i.e. - FormHttpMessageWriter() - Constructor for class org.springframework.http.codec.FormHttpMessageWriter
- FormPartEvent - Interface in org.springframework.http.codec.multipart
-
Represents an event triggered for a form field.
- forStatus(int) - Static method in class org.springframework.http.ProblemDetail
-
Create a
ProblemDetail
instance with the given status value. - forStatus(HttpStatusCode) - Static method in class org.springframework.http.ProblemDetail
-
Create a
ProblemDetail
instance with the given status code. - forStatusAndDetail(HttpStatusCode, String) - Static method in class org.springframework.http.ProblemDetail
-
Create a
ProblemDetail
instance with the given status and detail. - FORWARD_CONTEXT_PATH_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.4+ spec request attribute for forward context path.
- FORWARD_PATH_INFO_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.4+ spec request attribute for forward path info.
- FORWARD_QUERY_STRING_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.4+ spec request attribute for forward query string.
- FORWARD_REQUEST_URI_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.4+ spec request attribute for forward request URI.
- FORWARD_SERVLET_PATH_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.4+ spec request attribute for forward servlet path.
- FORWARDED_HEADER_TRANSFORMER_BEAN_NAME - Static variable in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Well-known name for the ForwardedHeaderTransformer in the bean factory.
- ForwardedHeaderFilter - Class in org.springframework.web.filter
-
Extract values from "Forwarded" and "X-Forwarded-*" headers, wrap the request and response, and make they reflect the client-originated protocol and address in the following methods:
getServerName()
getServerPort()
getScheme()
isSecure()
sendRedirect(String)
. - ForwardedHeaderFilter() - Constructor for class org.springframework.web.filter.ForwardedHeaderFilter
- forwardedHeaderTransformer(ForwardedHeaderTransformer) - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Configure the
ForwardedHeaderTransformer
for extracting and/or removing forwarded headers. - ForwardedHeaderTransformer - Class in org.springframework.web.server.adapter
-
Extract values from "Forwarded" and "X-Forwarded-*" headers to override the request URI (i.e.
- ForwardedHeaderTransformer() - Constructor for class org.springframework.web.server.adapter.ForwardedHeaderTransformer
- ForwardedHeaderUtils - Class in org.springframework.web.util
-
Utility class to assist with processing "Forwarded" and "X-Forwarded-*" headers.
- ForwardedHeaderUtils() - Constructor for class org.springframework.web.util.ForwardedHeaderUtils
- FOUND - Enum constant in enum class org.springframework.http.HttpStatus
-
302 Found
. - fragment(String) - Method in interface org.springframework.web.util.UriBuilder
-
Set the URI fragment.
- fragment(String) - Method in class org.springframework.web.util.UriComponentsBuilder
- from(String) - Static method in class org.springframework.http.ResponseCookie
-
Factory method to obtain a builder for a server-defined cookie, given its name only, and where the value as well as other attributes can be set later via builder methods.
- from(String, String) - Static method in class org.springframework.http.ResponseCookie
-
Factory method to obtain a builder for a server-defined cookie that starts with a name-value pair and may also include attributes.
- from(WebBindingInitializer, ParameterNameDiscoverer, Predicate<MethodParameter>, Predicate<MethodParameter>) - Static method in class org.springframework.web.method.annotation.HandlerMethodValidator
-
Static factory method to create a
HandlerMethodValidator
when Bean Validation is enabled for use viaConfigurableWebBindingInitializer
, for example in Spring MVC or WebFlux config. - FROM - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
From
header field name. - fromClientResponse(String, String) - Static method in class org.springframework.http.ResponseCookie
-
Factory method to obtain a builder for a server-defined cookie.
- fromHttpRequest(HttpRequest) - Static method in class org.springframework.web.util.UriComponentsBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of
ForwardedHeaderUtils.adaptFromForwardedHeaders(java.net.URI, org.springframework.http.HttpHeaders)
; to be removed in 6.2 - fromHttpUrl(String) - Static method in class org.springframework.web.util.UriComponentsBuilder
-
Create a URI components builder from the given HTTP URL String.
- fromOriginHeader(String) - Static method in class org.springframework.web.util.UriComponentsBuilder
-
Create an instance by parsing the "Origin" header of an HTTP request.
- fromPath(String) - Static method in class org.springframework.web.util.UriComponentsBuilder
-
Create a builder that is initialized with the given path.
- fromUri(URI) - Static method in class org.springframework.web.util.UriComponentsBuilder
-
Create a builder that is initialized from the given
URI
. - fromUriString(String) - Static method in class org.springframework.web.util.UriComponentsBuilder
-
Create a builder that is initialized with the given URI string.
G
- GATEWAY_TIMEOUT - Enum constant in enum class org.springframework.http.HttpStatus
-
504 Gateway Timeout
. - generateBoundaryLine(byte[], DataBufferFactory) - Method in class org.springframework.http.codec.multipart.MultipartWriterSupport
- generateETagHeaderValue(InputStream, boolean) - Method in class org.springframework.web.filter.ShallowEtagHeaderFilter
-
Generate the ETag header value from the given response body byte array.
- generateLastLine(byte[], DataBufferFactory) - Method in class org.springframework.http.codec.multipart.MultipartWriterSupport
- generateMultipartBoundary() - Method in class org.springframework.http.codec.multipart.MultipartWriterSupport
-
Generate a multipart boundary.
- generateMultipartBoundary() - Method in class org.springframework.http.converter.FormHttpMessageConverter
-
Generate a multipart boundary.
- generateNewLine(DataBufferFactory) - Method in class org.springframework.http.codec.multipart.MultipartWriterSupport
- generatePartHeaders(HttpHeaders, DataBufferFactory) - Method in class org.springframework.http.codec.multipart.MultipartWriterSupport
- GenericFilterBean - Class in org.springframework.web.filter
-
Simple base implementation of
Filter
which treats its config parameters (init-param
entries within thefilter
tag inweb.xml
) as bean properties. - GenericFilterBean() - Constructor for class org.springframework.web.filter.GenericFilterBean
- GenericHttpMessageConverter<T> - Interface in org.springframework.http.converter
-
A specialization of
HttpMessageConverter
that can convert an HTTP request into a target object of a specified generic type and a source object of a specified generic type into an HTTP response. - GenericWebApplicationContext - Class in org.springframework.web.context.support
-
Subclass of
GenericApplicationContext
, suitable for web environments. - GenericWebApplicationContext() - Constructor for class org.springframework.web.context.support.GenericWebApplicationContext
-
Create a new
GenericWebApplicationContext
. - GenericWebApplicationContext(ServletContext) - Constructor for class org.springframework.web.context.support.GenericWebApplicationContext
-
Create a new
GenericWebApplicationContext
for the givenServletContext
. - GenericWebApplicationContext(DefaultListableBeanFactory) - Constructor for class org.springframework.web.context.support.GenericWebApplicationContext
-
Create a new
GenericWebApplicationContext
with the givenDefaultListableBeanFactory
. - GenericWebApplicationContext(DefaultListableBeanFactory, ServletContext) - Constructor for class org.springframework.web.context.support.GenericWebApplicationContext
-
Create a new
GenericWebApplicationContext
with the givenDefaultListableBeanFactory
andServletContext
. - get() - Method in interface org.springframework.web.client.RestClient
-
Start building an HTTP GET request.
- get(Object) - Method in class org.springframework.http.HttpHeaders
- get(Object) - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- get(Object) - Method in class org.springframework.http.support.JettyHeadersAdapter
- get(Object) - Method in class org.springframework.http.support.Netty4HeadersAdapter
- get(Object) - Method in class org.springframework.http.support.Netty5HeadersAdapter
- get(String, Object...) - Static method in class org.springframework.http.RequestEntity
-
Create an HTTP GET builder with the given string base uri template.
- get(String, ObjectFactory<?>) - Method in class org.springframework.web.context.request.AbstractRequestAttributesScope
- get(String, ObjectFactory<?>) - Method in class org.springframework.web.context.request.SessionScope
- get(String, ObjectFactory<?>) - Method in class org.springframework.web.context.support.ServletContextScope
- get(URI) - Static method in class org.springframework.http.RequestEntity
-
Create an HTTP GET builder with the given url.
- get(Context) - Static method in class org.springframework.web.filter.reactive.ServerWebExchangeContextFilter
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of using
ServerWebExchangeContextFilter.getExchange(ContextView)
which accepts aContextView
instead ofContext
, reflecting the fact that theContextView
is needed only for reading. - GET - Enum constant in enum class org.springframework.web.bind.annotation.RequestMethod
- GET - Static variable in class org.springframework.http.HttpMethod
-
The HTTP method
GET
. - getAccept() - Method in class org.springframework.http.HttpHeaders
-
Return the list of acceptable media types, as specified by the
Accept
header. - getAcceptCharset() - Method in class org.springframework.http.HttpHeaders
-
Return the list of acceptable charsets, as specified by the
Accept-Charset
header. - getAcceptedCharsets() - Method in class org.springframework.http.converter.StringHttpMessageConverter
-
Return the list of supported
Charsets
. - getAcceptLanguage() - Method in class org.springframework.http.HttpHeaders
-
Return the language ranges from the "Accept-Language" header.
- getAcceptLanguageAsLocales() - Method in class org.springframework.http.HttpHeaders
- getAcceptPatch() - Method in class org.springframework.http.HttpHeaders
-
Return the list of acceptable media types for
PATCH
methods, as specified by theAccept-Patch
header. - getAccessControlAllowCredentials() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
Access-Control-Allow-Credentials
response header. - getAccessControlAllowHeaders() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
Access-Control-Allow-Headers
response header. - getAccessControlAllowMethods() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
Access-Control-Allow-Methods
response header. - getAccessControlAllowOrigin() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
Access-Control-Allow-Origin
response header. - getAccessControlExposeHeaders() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
Access-Control-Expose-Headers
response header. - getAccessControlMaxAge() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
Access-Control-Max-Age
response header. - getAccessControlRequestHeaders() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
Access-Control-Request-Headers
request header. - getAccessControlRequestMethod() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
Access-Control-Request-Method
request header. - getActualParams() - Method in exception org.springframework.web.bind.UnsatisfiedServletRequestParameterException
-
Return the actual parameter Map associated with the ServletRequest.
- getAllErrors() - Method in class org.springframework.web.bind.EscapedErrors
- getAllErrors() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getAllFileExtensions() - Method in class org.springframework.web.accept.ContentNegotiationManager
-
Get all registered file extensions.
- getAllFileExtensions() - Method in class org.springframework.web.accept.MappingMediaTypeFileExtensionResolver
- getAllFileExtensions() - Method in interface org.springframework.web.accept.MediaTypeFileExtensionResolver
-
Get all registered file extensions.
- getAllMediaTypes() - Method in class org.springframework.web.accept.MappingMediaTypeFileExtensionResolver
- getAllow() - Method in class org.springframework.http.HttpHeaders
-
Return the set of allowed
HTTP methods
, as specified by theAllow
header. - getAllowCredentials() - Method in class org.springframework.web.cors.CorsConfiguration
-
Return the configured
allowCredentials
flag, ornull
if none. - getAllowedHeaders() - Method in class org.springframework.web.cors.CorsConfiguration
-
Return the allowed actual request headers, or
null
if none. - getAllowedMethods() - Method in class org.springframework.web.cors.CorsConfiguration
-
Return the allowed HTTP methods, or
null
in which case only"GET"
and"HEAD"
allowed. - getAllowedOriginPatterns() - Method in class org.springframework.web.cors.CorsConfiguration
-
Return the configured origins patterns to allow, or
null
if none. - getAllowedOrigins() - Method in class org.springframework.web.cors.CorsConfiguration
-
Return the configured origins to allow, or
null
if none. - getAllowPrivateNetwork() - Method in class org.springframework.web.cors.CorsConfiguration
-
Return the configured
allowPrivateNetwork
flag, ornull
if none. - getAllValidationResults() - Method in exception org.springframework.web.method.annotation.HandlerMethodValidationException
- getAlreadyFilteredAttributeName() - Method in class org.springframework.web.filter.OncePerRequestFilter
-
Return the name of the request attribute that identifies that a request is already filtered.
- getAnnotatedBeanDefinitionReader(DefaultListableBeanFactory) - Method in class org.springframework.web.context.support.AnnotationConfigWebApplicationContext
-
Build an
AnnotatedBeanDefinitionReader
for the given bean factory. - getAnnotation(MethodParameter, Class<A>) - Method in class org.springframework.http.codec.json.AbstractJackson2Decoder
- getAnnotation(MethodParameter, Class<A>) - Method in class org.springframework.http.codec.json.AbstractJackson2Encoder
- getAnnotation(MethodParameter, Class<A>) - Method in class org.springframework.http.codec.json.Jackson2CodecSupport
- getApplicationContext() - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- getApplicationContext() - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
Return the configured
ApplicationContext
, if any. - getApplicationContext() - Method in interface org.springframework.web.server.ServerWebExchange
-
Return the
ApplicationContext
associated with the web application, if it was initialized with one viaWebHttpHandlerBuilder.applicationContext(ApplicationContext)
. - getApplicationContext() - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- getApplicationName() - Method in class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
- getApplicationName() - Method in class org.springframework.web.context.support.GenericWebApplicationContext
- getArgumentResolver(MethodParameter) - Method in class org.springframework.web.method.support.HandlerMethodArgumentResolverComposite
-
Find a registered
HandlerMethodArgumentResolver
that supports the given method parameter. - getAsText() - Method in class org.springframework.http.MediaTypeEditor
- getAsText() - Method in class org.springframework.web.multipart.support.ByteArrayMultipartFileEditor
- getAsyncManager(ServletRequest) - Static method in class org.springframework.web.context.request.async.WebAsyncUtils
-
Obtain the
WebAsyncManager
for the current request, or if not found, create and associate it with the request. - getAsyncManager(WebRequest) - Static method in class org.springframework.web.context.request.async.WebAsyncUtils
-
Obtain the
WebAsyncManager
for the current request, or if not found, create and associate it with the request. - getAsyncRequestControl(ServerHttpResponse) - Method in interface org.springframework.http.server.ServerHttpRequest
-
Return a control that allows putting the request in asynchronous mode so the response remains open until closed explicitly from the current or another thread.
- getAsyncRequestControl(ServerHttpResponse) - Method in class org.springframework.http.server.ServletServerHttpRequest
- getAsyncWebRequest() - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Return the current
AsyncWebRequest
. - getAttribute(String) - Method in class org.springframework.web.context.support.ContextExposingHttpServletRequest
- getAttribute(String) - Method in interface org.springframework.web.server.ServerWebExchange
-
Return the request attribute value if present.
- getAttribute(String) - Method in interface org.springframework.web.server.WebSession
-
Return the session attribute value if present.
- getAttribute(String, int) - Method in class org.springframework.web.context.request.FacesRequestAttributes
- getAttribute(String, int) - Method in interface org.springframework.web.context.request.RequestAttributes
-
Return the value for the scoped attribute of the given name, if any.
- getAttribute(String, int) - Method in class org.springframework.web.context.request.ServletRequestAttributes
- getAttributeMap(int) - Method in class org.springframework.web.context.request.FacesRequestAttributes
-
Return the JSF attribute Map for the specified scope.
- getAttributeNameInSession(WebRequest, String) - Method in class org.springframework.web.bind.support.DefaultSessionAttributeStore
-
Calculate the attribute name in the backend session.
- getAttributeNames(int) - Method in class org.springframework.web.context.request.FacesRequestAttributes
- getAttributeNames(int) - Method in interface org.springframework.web.context.request.RequestAttributes
-
Retrieve the names of all attributes in the scope.
- getAttributeNames(int) - Method in class org.springframework.web.context.request.ServletRequestAttributes
- getAttributeOrDefault(String, T) - Method in interface org.springframework.web.server.ServerWebExchange
-
Return the request attribute value, or a default, fallback value.
- getAttributeOrDefault(String, T) - Method in interface org.springframework.web.server.WebSession
-
Return the session attribute value, or a default, fallback value.
- getAttributes() - Method in class org.springframework.http.server.reactive.observation.ServerRequestObservationContext
-
Return an immutable map of the current request attributes.
- getAttributes() - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- getAttributes() - Method in interface org.springframework.web.server.ServerWebExchange
-
Return a mutable map of request attributes for the current exchange.
- getAttributes() - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- getAttributes() - Method in interface org.springframework.web.server.WebSession
-
Return a map that holds session attributes.
- getAttributes() - Method in class org.springframework.web.service.invoker.HttpRequestValues
-
Return the attributes associated with the request, or an empty map.
- getBean() - Method in class org.springframework.web.method.HandlerMethod
-
Return the bean for this handler method.
- getBeanFactory(FacesContext) - Method in class org.springframework.web.jsf.DelegatingNavigationHandlerProxy
-
Retrieve the Spring BeanFactory to delegate bean name resolution to.
- getBeanFactory(FacesContext) - Method in class org.springframework.web.jsf.DelegatingPhaseListenerMulticaster
-
Retrieve the Spring BeanFactory to delegate bean name resolution to.
- getBeanNameGenerator() - Method in class org.springframework.web.context.support.AnnotationConfigWebApplicationContext
-
Return the custom
BeanNameGenerator
for use withAnnotatedBeanDefinitionReader
and/orClassPathBeanDefinitionScanner
, if any. - getBeanType() - Method in class org.springframework.web.method.ControllerAdviceBean
-
Return the type of the contained bean.
- getBeanType() - Method in class org.springframework.web.method.HandlerMethod
-
This method returns the type of the handler for this handler method.
- getBindingErrorProcessor() - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Return the strategy to use for processing binding errors.
- getBindingResult() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
-
Return the BindingResult that this BindException wraps.
- getBlockTimeout() - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
- getBlockTimeout() - Method in interface org.springframework.web.service.invoker.ReactorHttpExchangeAdapter
-
Return the configured time to block for the response from an HTTP service method with a synchronous (blocking) method signature.
- getBody() - Method in class org.springframework.http.client.AbstractClientHttpRequest
- getBody() - Method in class org.springframework.http.client.reactive.AbstractClientHttpResponse
- getBody() - Method in class org.springframework.http.client.reactive.ClientHttpResponseDecorator
- getBody() - Method in class org.springframework.http.converter.json.MappingJacksonInputMessage
- getBody() - Method in class org.springframework.http.HttpEntity
-
Returns the body of this entity.
- getBody() - Method in interface org.springframework.http.HttpInputMessage
-
Return the body of the message as an input stream.
- getBody() - Method in interface org.springframework.http.HttpOutputMessage
-
Return the body of the message as an output stream.
- getBody() - Method in interface org.springframework.http.ReactiveHttpInputMessage
-
Return the body of the message as a
Publisher
. - getBody() - Method in class org.springframework.http.server.DelegatingServerHttpResponse
- getBody() - Method in class org.springframework.http.server.reactive.ServerHttpRequestDecorator
- getBody() - Method in class org.springframework.http.server.ServletServerHttpRequest
- getBody() - Method in class org.springframework.http.server.ServletServerHttpResponse
- getBody() - Method in exception org.springframework.web.bind.MethodArgumentNotValidException
- getBody() - Method in exception org.springframework.web.bind.ServletRequestBindingException
- getBody() - Method in exception org.springframework.web.context.request.async.AsyncRequestTimeoutException
- getBody() - Method in interface org.springframework.web.ErrorResponse
-
Return the body for the response, formatted as an RFC 7807
ProblemDetail
whosestatus
should match the response status. - getBody() - Method in exception org.springframework.web.ErrorResponseException
-
Return the body for the response.
- getBody() - Method in exception org.springframework.web.HttpMediaTypeException
- getBody() - Method in exception org.springframework.web.HttpRequestMethodNotSupportedException
- getBody() - Method in exception org.springframework.web.multipart.MaxUploadSizeExceededException
- getBody() - Method in exception org.springframework.web.multipart.support.MissingServletRequestPartException
-
Return the body for the response, formatted as an RFC 7807
ProblemDetail
whosestatus
should match the response status. - getBody() - Method in class org.springframework.web.multipart.support.RequestPartServletServerHttpRequest
- getBody() - Method in class org.springframework.web.service.invoker.HttpRequestValues
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of
ReactiveHttpRequestValues.getBodyPublisher()
; to be removed in 6.2 - getBody() - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues
-
Return the request body as a Publisher.
- getBodyElementType() - Method in class org.springframework.web.service.invoker.HttpRequestValues
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of
ReactiveHttpRequestValues.getBodyPublisherElementType()
; to be removed in 6.2 - getBodyElementType() - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues
-
Return the element type for a Publisher body.
- getBodyInternal(HttpHeaders) - Method in class org.springframework.http.client.AbstractClientHttpRequest
-
Abstract template method that returns the body.
- getBodyPublisher() - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues
-
Return a
Publisher
that will produce for the request body. - getBodyPublisherElementType() - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues
-
Return the element type for a Publisher body.
- getBodyType() - Method in exception org.springframework.web.server.UnsupportedMediaTypeStatusException
-
Return the body type in the context of which this exception was generated.
- getBodyValue() - Method in class org.springframework.web.service.invoker.HttpRequestValues
-
Return the request body as a value to be serialized, if set.
- getBooleanParameter(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get a Boolean parameter, or
null
if not present. - getBooleanParameter(ServletRequest, String, boolean) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get a boolean parameter, with a fallback value.
- getBooleanParameters(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get an array of boolean parameters, return an empty array if not found.
- getBufferSize() - Method in class org.springframework.http.server.reactive.ServletHttpHandlerAdapter
-
Return the configured input buffer size.
- getByteBufferPool() - Method in class org.springframework.http.client.reactive.JettyResourceFactory
-
Return the configured
ByteBufferPool
. - getBytes() - Method in interface org.springframework.web.multipart.MultipartFile
-
Return the contents of the file as an array of bytes.
- getCacheControl() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
Cache-Control
header. - getCachedPath(ServletRequest) - Static method in class org.springframework.web.util.ServletRequestPathUtils
- getCachedPathValue(ServletRequest) - Static method in class org.springframework.web.util.ServletRequestPathUtils
-
Variant of
ServletRequestPathUtils.getCachedPath(ServletRequest)
that returns the path for request mapping as a String. - getCallable() - Method in class org.springframework.web.context.request.async.WebAsyncTask
-
Return the
Callable
to use for concurrent handling (nevernull
). - getCallableInterceptor(Object) - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Get the
CallableProcessingInterceptor
registered under the given key. - getCharacterEncoding() - Method in class org.springframework.web.util.ContentCachingRequestWrapper
- getCharset() - Method in class org.springframework.http.codec.multipart.MultipartWriterSupport
-
Return the configured charset for part headers.
- getCharset() - Method in class org.springframework.http.ContentDisposition
-
Return the charset defined in filename* parameter, or
null
if not defined. - getCharset(ClientHttpResponse) - Method in class org.springframework.web.client.DefaultResponseErrorHandler
-
Determine the charset of the response (for inclusion in a status exception).
- getCharset(MediaType) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
-
Determine the charset to use for JSON input.
- getClassPathBeanDefinitionScanner(DefaultListableBeanFactory) - Method in class org.springframework.web.context.support.AnnotationConfigWebApplicationContext
-
Build a
ClassPathBeanDefinitionScanner
for the given bean factory. - getClientAddress() - Method in class org.springframework.web.context.support.ServletRequestHandledEvent
-
Return the IP address that the request came from.
- getClientHttpRequestInitializers() - Method in class org.springframework.http.client.support.HttpAccessor
-
Get the request initializers that this accessor uses.
- getClock() - Method in class org.springframework.web.server.session.InMemoryWebSessionStore
-
Return the configured clock for session lastAccessTime calculations.
- getCodecConfigurer() - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
Return the configured
ServerCodecConfigurer
. - getCommonPropertyType(ELContext, Object) - Method in class org.springframework.web.jsf.el.SpringBeanFacesELResolver
- getCommonPropertyType(ELContext, Object) - Method in class org.springframework.web.jsf.el.WebApplicationContextFacesELResolver
- getConcurrentResult() - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Get the result from concurrent handling.
- getConcurrentResultContext() - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Get the additional processing context saved at the start of concurrent handling.
- getConditions() - Method in exception org.springframework.web.server.UnsatisfiedRequestParameterException
-
Return String representations of the unsatisfied condition(s).
- getConfigClasses() - Method in class org.springframework.web.server.adapter.AbstractReactiveWebInitializer
-
Specify
@Configuration
and/or@Component
classes that make up the application configuration. - getConfigLocations() - Method in interface org.springframework.web.context.ConfigurableWebApplicationContext
-
Return the config locations for this web application context, or
null
if none specified. - getConfigLocations() - Method in class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
- getConfigLocations() - Method in class org.springframework.web.context.support.GenericWebApplicationContext
- getConfigLocations() - Method in class org.springframework.web.context.support.StaticWebApplicationContext
- getConnection() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
Connection
header. - getConnectionProvider() - Method in class org.springframework.http.client.reactive.ReactorNetty2ResourceFactory
-
Return the configured
ConnectionProvider
. - getConnectionProvider() - Method in class org.springframework.http.client.ReactorResourceFactory
-
Return the configured
ConnectionProvider
. - getContainingClass() - Method in class org.springframework.web.method.HandlerMethod
- getContentAsByteArray() - Method in class org.springframework.web.util.ContentCachingRequestWrapper
-
Return the cached request content as a byte array.
- getContentAsByteArray() - Method in class org.springframework.web.util.ContentCachingResponseWrapper
-
Return the cached response content as a byte array.
- getContentAsString() - Method in class org.springframework.web.util.ContentCachingRequestWrapper
-
Return the cached request content as a String, using the configured
Charset
. - getContentDisposition() - Method in class org.springframework.http.HttpHeaders
-
Return a parsed representation of the Content-Disposition header.
- getContentInputStream() - Method in class org.springframework.web.util.ContentCachingResponseWrapper
-
Return an
InputStream
to the cached content. - getContentLanguage() - Method in class org.springframework.http.HttpHeaders
-
Get the first
Locale
of the content languages, as specified by theContent-Language
header. - getContentLength() - Method in class org.springframework.http.HttpHeaders
-
Return the length of the body in bytes, as specified by the
Content-Length
header. - getContentLength(byte[], MediaType) - Method in class org.springframework.http.converter.ByteArrayHttpMessageConverter
- getContentLength(Object, MediaType) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
- getContentLength(Object, MediaType) - Method in class org.springframework.http.converter.ObjectToStringHttpMessageConverter
- getContentLength(String, MediaType) - Method in class org.springframework.http.converter.StringHttpMessageConverter
- getContentLength(Resource, MediaType) - Method in class org.springframework.http.converter.ResourceHttpMessageConverter
- getContentLength(T, MediaType) - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
-
Returns the content length for the given type.
- getContentLength(T, MediaType) - Method in class org.springframework.http.converter.xml.SourceHttpMessageConverter
- getContentSize() - Method in class org.springframework.web.util.ContentCachingResponseWrapper
-
Return the current size of the cached content.
- getContentType() - Method in class org.springframework.http.HttpHeaders
-
Return the media type of the body, as specified by the
Content-Type
header. - getContentType() - Method in exception org.springframework.web.client.UnknownContentTypeException
-
Return the content type of the response, or "application/octet-stream".
- getContentType() - Method in exception org.springframework.web.HttpMediaTypeNotSupportedException
-
Return the HTTP request content type method that caused the failure.
- getContentType() - Method in interface org.springframework.web.multipart.MultipartFile
-
Return the content type of the file.
- getContentType() - Method in exception org.springframework.web.server.UnsupportedMediaTypeStatusException
-
Return the request Content-Type header if it was parsed successfully, or
null
otherwise. - getContentType(ClientHttpResponse) - Method in class org.springframework.web.client.HttpMessageConverterExtractor
-
Determine the Content-Type of the response based on the "Content-Type" header or otherwise default to
MediaType.APPLICATION_OCTET_STREAM
. - getContentType(HttpMessage) - Method in class org.springframework.http.codec.DecoderHttpMessageReader
-
Determine the Content-Type of the HTTP message based on the "Content-Type" header or otherwise default to
MediaType.APPLICATION_OCTET_STREAM
. - getContentTypes() - Method in class org.springframework.web.accept.FixedContentNegotiationStrategy
-
Return the configured list of media types.
- getContextAttribute() - Method in class org.springframework.web.filter.DelegatingFilterProxy
-
Return the name of the ServletContext attribute which should be used to retrieve the
WebApplicationContext
from which to load the delegateFilter
bean. - getContextPath() - Method in class org.springframework.web.context.request.FacesWebRequest
- getContextPath() - Method in class org.springframework.web.context.request.ServletWebRequest
- getContextPath() - Method in interface org.springframework.web.context.request.WebRequest
-
Return the context path for this request (usually the base path that the current web application is mapped to).
- getContextPath(HttpServletRequest) - Method in class org.springframework.web.util.UrlPathHelper
-
Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include.
- getContextualName(ClientRequestObservationContext) - Method in class org.springframework.http.client.observation.DefaultClientRequestObservationConvention
- getContextualName(ServerRequestObservationContext) - Method in class org.springframework.http.server.observation.DefaultServerRequestObservationConvention
- getContextualName(ServerRequestObservationContext) - Method in class org.springframework.http.server.reactive.observation.DefaultServerRequestObservationConvention
- getConversationId() - Method in class org.springframework.web.context.request.RequestScope
-
There is no conversation id concept for a request, so this method returns
null
. - getConversationId() - Method in class org.springframework.web.context.request.SessionScope
- getConversationId() - Method in class org.springframework.web.context.support.ServletContextScope
- getConversionService() - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Return the ConversionService which will apply to every DataBinder.
- getCookie(HttpServletRequest, String) - Static method in class org.springframework.web.util.WebUtils
-
Retrieve the first cookie with the given name.
- getCookieDomain() - Method in class org.springframework.web.util.CookieGenerator
-
Deprecated.Return the domain for cookies created by this generator, if any.
- getCookieMaxAge() - Method in class org.springframework.web.server.session.CookieWebSessionIdResolver
-
Get the configured "Max-Age" for the session id cookie.
- getCookieMaxAge() - Method in class org.springframework.web.util.CookieGenerator
-
Deprecated.Return the maximum age for cookies created by this generator.
- getCookieName() - Method in exception org.springframework.web.bind.MissingRequestCookieException
-
Return the expected name of the request cookie.
- getCookieName() - Method in class org.springframework.web.server.session.CookieWebSessionIdResolver
-
Get the configured cookie name.
- getCookieName() - Method in class org.springframework.web.util.CookieGenerator
-
Deprecated.Return the given name for cookies created by this generator.
- getCookiePath() - Method in class org.springframework.web.util.CookieGenerator
-
Deprecated.Return the path for cookies created by this generator.
- getCookies() - Method in class org.springframework.http.client.reactive.AbstractClientHttpRequest
- getCookies() - Method in class org.springframework.http.client.reactive.AbstractClientHttpResponse
- getCookies() - Method in interface org.springframework.http.client.reactive.ClientHttpRequest
-
Return a mutable map of request cookies to send to the server.
- getCookies() - Method in class org.springframework.http.client.reactive.ClientHttpRequestDecorator
- getCookies() - Method in interface org.springframework.http.client.reactive.ClientHttpResponse
-
Return a read-only map of response cookies received from the server.
- getCookies() - Method in class org.springframework.http.client.reactive.ClientHttpResponseDecorator
- getCookies() - Method in class org.springframework.http.server.reactive.AbstractServerHttpRequest
- getCookies() - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
- getCookies() - Method in interface org.springframework.http.server.reactive.ServerHttpRequest
-
Return a read-only map of cookies sent by the client.
- getCookies() - Method in class org.springframework.http.server.reactive.ServerHttpRequestDecorator
- getCookies() - Method in interface org.springframework.http.server.reactive.ServerHttpResponse
-
Return a mutable map with the cookies to send to the server.
- getCookies() - Method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
- getCookies() - Method in class org.springframework.web.service.invoker.HttpRequestValues
-
Return the cookies for the request, or an empty map.
- getCorsConfiguration(HttpServletRequest) - Method in interface org.springframework.web.cors.CorsConfigurationSource
-
Return a
CorsConfiguration
based on the incoming request. - getCorsConfiguration(HttpServletRequest) - Method in class org.springframework.web.cors.UrlBasedCorsConfigurationSource
- getCorsConfiguration(ServerWebExchange) - Method in interface org.springframework.web.cors.reactive.CorsConfigurationSource
-
Return a
CorsConfiguration
based on the incoming request. - getCorsConfiguration(ServerWebExchange) - Method in class org.springframework.web.cors.reactive.UrlBasedCorsConfigurationSource
- getCorsConfigurations() - Method in class org.springframework.web.cors.UrlBasedCorsConfigurationSource
-
Return all configured CORS mappings.
- getCreationDate() - Method in class org.springframework.http.ContentDisposition
-
Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.
- getCreationTime() - Method in interface org.springframework.web.server.WebSession
-
Return the time when the session was created.
- getCurrentWebApplicationContext() - Static method in class org.springframework.web.context.ContextLoader
-
Obtain the Spring root web application context for the current thread (i.e.
- getDataBufferFactory() - Method in class org.springframework.http.server.reactive.ServletHttpHandlerAdapter
- getDataBufferFactory() - Method in class org.springframework.http.server.reactive.UndertowHttpHandlerAdapter
- getDate() - Method in class org.springframework.http.HttpHeaders
-
Return the date and time at which the message was created, as specified by the
Date
header. - getDecodableMimeTypes() - Method in class org.springframework.http.codec.json.AbstractJackson2Decoder
- getDecodableMimeTypes() - Method in class org.springframework.http.codec.KotlinSerializationBinaryDecoder
- getDecodableMimeTypes() - Method in class org.springframework.http.codec.KotlinSerializationStringDecoder
- getDecodableMimeTypes() - Method in class org.springframework.http.codec.protobuf.ProtobufDecoder
- getDecodableMimeTypes(ResolvableType) - Method in class org.springframework.http.codec.json.AbstractJackson2Decoder
- getDecodableMimeTypes(ResolvableType) - Method in class org.springframework.http.codec.KotlinSerializationBinaryDecoder
- getDecodableMimeTypes(ResolvableType) - Method in class org.springframework.http.codec.KotlinSerializationStringDecoder
- getDecodeHints(ResolvableType, ResolvableType, ServerHttpRequest, ServerHttpResponse) - Method in interface org.springframework.http.codec.HttpMessageDecoder
-
Get decoding hints based on the server request or annotations on the target controller method parameter.
- getDecodeHints(ResolvableType, ResolvableType, ServerHttpRequest, ServerHttpResponse) - Method in class org.springframework.http.codec.json.AbstractJackson2Decoder
- getDecoder() - Method in class org.springframework.http.codec.DecoderHttpMessageReader
-
Return the
Decoder
of this reader. - getDecoder() - Method in class org.springframework.http.codec.ServerSentEventHttpMessageReader
-
Return the configured
Decoder
. - getDecoratedNavigationHandler() - Method in class org.springframework.web.jsf.DecoratingNavigationHandler
-
Return the fixed original NavigationHandler decorated by this handler, if any (that is, if passed in through the constructor).
- getDefaultCharset() - Method in class org.springframework.http.codec.FormHttpMessageReader
-
Return the configured default charset.
- getDefaultCharset() - Method in class org.springframework.http.codec.FormHttpMessageWriter
-
Return the configured default charset.
- getDefaultCharset() - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
-
Return the default character set, if any.
- getDefaultConfigLocations() - Method in class org.springframework.web.context.support.GroovyWebApplicationContext
-
The default location for the root context is "/WEB-INF/applicationContext.groovy", and "/WEB-INF/test-servlet.groovy" for a context with the namespace "test-servlet" (like for a DispatcherServlet instance with the servlet-name "test").
- getDefaultConfigLocations() - Method in class org.springframework.web.context.support.XmlWebApplicationContext
-
The default location for the root context is "/WEB-INF/applicationContext.xml", and "/WEB-INF/test-servlet.xml" for a context with the namespace "test-servlet" (like for a DispatcherServlet instance with the servlet-name "test").
- getDefaultContentType() - Method in class org.springframework.http.converter.BufferedImageHttpMessageConverter
-
Returns the default
Content-Type
to be used for writing. - getDefaultContentType(Message) - Method in class org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter
- getDefaultContentType(Object) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
- getDefaultContentType(Object) - Method in class org.springframework.http.converter.ResourceRegionHttpMessageConverter
- getDefaultContentType(Resource) - Method in class org.springframework.http.converter.ResourceHttpMessageConverter
- getDefaultContentType(T) - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
-
Returns the default content type for the given type.
- getDefaultDetailMessageCode(Class<?>, String) - Static method in interface org.springframework.web.ErrorResponse
-
Build a message code for the "detail" field, for the given exception type.
- getDefaultEncoding() - Method in class org.springframework.web.util.UrlPathHelper
-
Return the default character encoding to use for URL decoding.
- getDefaultHtmlEscape(ServletContext) - Static method in class org.springframework.web.util.WebUtils
-
Return whether default HTML escaping is enabled for the web application, i.e.
- getDefaultLocale() - Method in class org.springframework.web.server.i18n.AcceptHeaderLocaleContextResolver
-
The configured default locale, if any.
- getDefaultModel() - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Return the "default" model created at instantiation.
- getDefaultTitleMessageCode(Class<?>) - Static method in interface org.springframework.web.ErrorResponse
-
Build a message code for the "title" field, for the given exception type.
- getDefaultTypeMessageCode(Class<?>) - Static method in interface org.springframework.web.ErrorResponse
-
Build a message code for the "type" field, for the given exception type.
- getDefaultUriVariables() - Method in class org.springframework.web.util.DefaultUriBuilderFactory
-
Return the configured default URI variable values.
- getDeferredResultInterceptor(Object) - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Get the
DeferredResultProcessingInterceptor
registered under the given key. - getDelegate() - Method in class org.springframework.http.client.AbstractClientHttpRequestFactoryWrapper
-
Return the delegate request factory.
- getDelegate() - Method in class org.springframework.http.client.reactive.ClientHttpRequestDecorator
- getDelegate() - Method in class org.springframework.http.client.reactive.ClientHttpResponseDecorator
- getDelegate() - Method in class org.springframework.http.server.DelegatingServerHttpResponse
-
Returns the target response that this response delegates to.
- getDelegate() - Method in class org.springframework.http.server.reactive.ServerHttpRequestDecorator
- getDelegate() - Method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
- getDelegate() - Method in class org.springframework.web.server.handler.WebHandlerDecorator
-
Return the wrapped delegate.
- getDelegate() - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- getDelegate(FacesContext) - Method in class org.springframework.web.jsf.DelegatingNavigationHandlerProxy
-
Return the target NavigationHandler to delegate to.
- getDelegates(FacesContext) - Method in class org.springframework.web.jsf.DelegatingPhaseListenerMulticaster
-
Obtain the delegate PhaseListener beans from the Spring root WebApplicationContext.
- getDescription() - Method in class org.springframework.web.context.support.RequestHandledEvent
-
Return a full description of this event, involving all available context data.
- getDescription() - Method in class org.springframework.web.context.support.ServletContextResource
-
This implementation returns a description that includes the ServletContext resource location.
- getDescription() - Method in class org.springframework.web.context.support.ServletRequestHandledEvent
- getDescription(boolean) - Method in class org.springframework.web.context.request.FacesWebRequest
- getDescription(boolean) - Method in class org.springframework.web.context.request.ServletWebRequest
- getDescription(boolean) - Method in interface org.springframework.web.context.request.WebRequest
-
Get a short description of this request, typically containing request URI and session id.
- getDeserializationView() - Method in class org.springframework.http.converter.json.MappingJacksonInputMessage
- getDetail() - Method in interface org.springframework.http.converter.json.ProblemDetailJacksonXmlMixin
- getDetail() - Method in class org.springframework.http.ProblemDetail
-
Return the configured
problem detail
. - getDetailMessageArguments() - Method in exception org.springframework.web.bind.MethodArgumentNotValidException
- getDetailMessageArguments() - Method in exception org.springframework.web.bind.ServletRequestBindingException
- getDetailMessageArguments() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getDetailMessageArguments() - Method in interface org.springframework.web.ErrorResponse
-
Return arguments to use along with a
message code
to resolve the problem "detail" for this exception through aMessageSource
. - getDetailMessageArguments() - Method in exception org.springframework.web.ErrorResponseException
- getDetailMessageArguments() - Method in exception org.springframework.web.HttpMediaTypeException
- getDetailMessageArguments() - Method in exception org.springframework.web.HttpRequestMethodNotSupportedException
- getDetailMessageArguments() - Method in exception org.springframework.web.method.annotation.HandlerMethodValidationException
- getDetailMessageArguments() - Method in exception org.springframework.web.multipart.support.MissingServletRequestPartException
- getDetailMessageArguments(MessageSource, Locale) - Method in exception org.springframework.web.bind.MethodArgumentNotValidException
- getDetailMessageArguments(MessageSource, Locale) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getDetailMessageArguments(MessageSource, Locale) - Method in interface org.springframework.web.ErrorResponse
-
Variant of
ErrorResponse.getDetailMessageArguments()
that uses the givenMessageSource
for resolving the message argument values. - getDetailMessageArguments(MessageSource, Locale) - Method in exception org.springframework.web.method.annotation.HandlerMethodValidationException
- getDetailMessageCode() - Method in exception org.springframework.web.bind.ServletRequestBindingException
- getDetailMessageCode() - Method in interface org.springframework.web.ErrorResponse
-
Return a code to use to resolve the problem "detail" for this exception through a
MessageSource
. - getDetailMessageCode() - Method in exception org.springframework.web.ErrorResponseException
- getDetailMessageCode() - Method in exception org.springframework.web.HttpMediaTypeException
- getDomain() - Method in class org.springframework.http.ResponseCookie
-
Return the cookie "Domain" attribute, or
null
if not set. - getDoubleParameter(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get a Double parameter, or
null
if not present. - getDoubleParameter(ServletRequest, String, double) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get a double parameter, with a fallback value.
- getDoubleParameters(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get an array of double parameters, return an empty array if not found.
- getEmptyValue(Class<?>) - Method in class org.springframework.web.bind.WebDataBinder
-
Determine an empty value for the specified field.
- getEmptyValue(String, Class<?>) - Method in class org.springframework.web.bind.WebDataBinder
-
Determine an empty value for the specified field.
- getEncodableMimeTypes() - Method in class org.springframework.http.codec.json.AbstractJackson2Encoder
- getEncodableMimeTypes() - Method in class org.springframework.http.codec.KotlinSerializationBinaryEncoder
- getEncodableMimeTypes() - Method in class org.springframework.http.codec.KotlinSerializationStringEncoder
- getEncodableMimeTypes() - Method in class org.springframework.http.codec.protobuf.ProtobufEncoder
- getEncodableMimeTypes(ResolvableType) - Method in class org.springframework.http.codec.json.AbstractJackson2Encoder
- getEncodableMimeTypes(ResolvableType) - Method in class org.springframework.http.codec.KotlinSerializationBinaryEncoder
- getEncodableMimeTypes(ResolvableType) - Method in class org.springframework.http.codec.KotlinSerializationStringEncoder
- getEncodeHints(ResolvableType, ResolvableType, MediaType, ServerHttpRequest, ServerHttpResponse) - Method in interface org.springframework.http.codec.HttpMessageEncoder
-
Get decoding hints based on the server request or annotations on the target controller method parameter.
- getEncodeHints(ResolvableType, ResolvableType, MediaType, ServerHttpRequest, ServerHttpResponse) - Method in class org.springframework.http.codec.json.AbstractJackson2Encoder
- getEncoder() - Method in class org.springframework.http.codec.EncoderHttpMessageWriter
-
Return the
Encoder
of this writer. - getEncoder() - Method in class org.springframework.http.codec.ServerSentEventHttpMessageWriter
-
Return the configured
Encoder
, if any. - getEncoding() - Method in class org.springframework.web.filter.CharacterEncodingFilter
-
Return the configured encoding for requests and/or responses.
- getEncodingMode() - Method in class org.springframework.web.util.DefaultUriBuilderFactory
-
Return the configured encoding mode.
- getEnvironment() - Method in class org.springframework.web.filter.GenericFilterBean
-
Return the
Environment
associated with this filter. - getErrorCount() - Method in class org.springframework.web.bind.EscapedErrors
- getErrorCount() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getErrorHandler() - Method in class org.springframework.web.client.RestTemplate
-
Return the error handler.
- getETag() - Method in class org.springframework.http.HttpHeaders
-
Return the entity tag of the body, as specified by the
ETag
header. - getETagValuesAsList(String) - Method in class org.springframework.http.HttpHeaders
-
Retrieve a combined result from the field values of the ETag header.
- getExceptionHandlers() - Method in class org.springframework.web.server.handler.ExceptionHandlingWebHandler
-
Return a read-only list of the configured exception handlers.
- getExchange(ContextView) - Static method in class org.springframework.web.filter.reactive.ServerWebExchangeContextFilter
-
Access the
ServerWebExchange
from a ReactorContextView
, if available, which is generally the case whenServerWebExchangeContextFilter
is present in the filter chain. - GetExchange - Annotation Interface in org.springframework.web.service.annotation
-
Shortcut for
@HttpExchange
for HTTP GET requests. - getExecutor() - Method in class org.springframework.http.client.reactive.JdkHttpClientResourceFactory
-
Return the configured
Executor
. - getExecutor() - Method in class org.springframework.http.client.reactive.JettyResourceFactory
-
Return the configured
Executor
. - getExecutor() - Method in class org.springframework.web.context.request.async.WebAsyncTask
-
Return the AsyncTaskExecutor to use for concurrent handling, or
null
if none specified. - getExpectedAttribute() - Method in exception org.springframework.web.HttpSessionRequiredException
-
Return the name of the expected session attribute, if any.
- getExpires() - Method in class org.springframework.http.HttpHeaders
-
Return the date and time at which the message is no longer valid, as specified by the
Expires
header. - getExposedHeaders() - Method in class org.springframework.web.cors.CorsConfiguration
-
Return the configured response headers to expose, or
null
if none. - getExternalContext() - Method in class org.springframework.web.context.request.FacesRequestAttributes
-
Return the JSF ExternalContext that this adapter operates on.
- getFacesContext() - Method in class org.springframework.web.context.request.FacesRequestAttributes
-
Return the JSF FacesContext that this adapter operates on.
- getFailureCause() - Method in class org.springframework.web.context.support.RequestHandledEvent
-
Return the cause of failure, if any.
- getFeatureDescriptors(ELContext, Object) - Method in class org.springframework.web.jsf.el.SpringBeanFacesELResolver
- getFeatureDescriptors(ELContext, Object) - Method in class org.springframework.web.jsf.el.WebApplicationContextFacesELResolver
- getFieldDefaultPrefix() - Method in class org.springframework.web.bind.WebDataBinder
-
Return the prefix for parameters that mark default fields.
- getFieldError() - Method in class org.springframework.web.bind.EscapedErrors
- getFieldError() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getFieldError(String) - Method in class org.springframework.web.bind.EscapedErrors
- getFieldError(String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getFieldErrorCount() - Method in class org.springframework.web.bind.EscapedErrors
- getFieldErrorCount() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getFieldErrorCount(String) - Method in class org.springframework.web.bind.EscapedErrors
- getFieldErrorCount(String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getFieldErrors() - Method in class org.springframework.web.bind.EscapedErrors
- getFieldErrors() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getFieldErrors(String) - Method in class org.springframework.web.bind.EscapedErrors
- getFieldErrors(String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getFieldMarkerPrefix() - Method in class org.springframework.web.bind.WebDataBinder
-
Return the prefix for parameters that mark potentially empty fields.
- getFieldType(String) - Method in class org.springframework.web.bind.EscapedErrors
- getFieldType(String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getFieldValue(String) - Method in class org.springframework.web.bind.EscapedErrors
- getFieldValue(String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getFieldValues(String) - Method in class org.springframework.http.HttpHeaders
-
Retrieve a combined result from the field values of multivalued headers.
- getFile() - Method in class org.springframework.web.context.support.ServletContextResource
-
This implementation resolves "file:" URLs or alternatively delegates to
ServletContext.getRealPath
, throwing a FileNotFoundException if not found or not resolvable. - getFile(String) - Method in interface org.springframework.web.multipart.MultipartRequest
-
Return the contents plus description of an uploaded file in this request, or
null
if it does not exist. - getFile(String) - Method in class org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest
- getFileMap() - Method in interface org.springframework.web.multipart.MultipartRequest
-
Return a
Map
of the multipart files contained in this request. - getFileMap() - Method in class org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest
- getFilename() - Method in class org.springframework.http.ContentDisposition
-
Return the value of the filename parameter, possibly decoded from BASE64 encoding based on RFC 2047, or of the filename* parameter, possibly decoded as defined in the RFC 5987.
- getFilename() - Method in class org.springframework.web.context.support.ServletContextResource
-
This implementation returns the name of the file that this ServletContext resource refers to.
- getFilename(Object) - Method in class org.springframework.http.converter.FormHttpMessageConverter
-
Return the filename of the given multipart part.
- getFileNames() - Method in interface org.springframework.web.multipart.MultipartRequest
-
Return an
Iterator
of String objects containing the parameter names of the multipart files contained in this request. - getFileNames() - Method in class org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest
- getFiles(String) - Method in interface org.springframework.web.multipart.MultipartRequest
-
Return the contents plus description of uploaded files in this request, or an empty list if it does not exist.
- getFiles(String) - Method in class org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest
- getFilterConfig() - Method in class org.springframework.web.filter.GenericFilterBean
-
Make the FilterConfig of this filter available, if any.
- getFilterName() - Method in class org.springframework.web.filter.GenericFilterBean
-
Make the name of this filter available to subclasses.
- getFilters() - Method in class org.springframework.http.converter.json.MappingJacksonValue
-
Return the Jackson filter provider to use.
- getFilters() - Method in class org.springframework.web.server.handler.DefaultWebFilterChain
- getFilters() - Method in class org.springframework.web.server.handler.FilteringWebHandler
-
Return a read-only list of the configured filters.
- getFirst(String) - Method in class org.springframework.http.HttpHeaders
-
Return the first header value for the given header name, if any.
- getFirst(String) - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- getFirst(String) - Method in class org.springframework.http.support.JettyHeadersAdapter
- getFirst(String) - Method in class org.springframework.http.support.Netty4HeadersAdapter
- getFirst(String) - Method in class org.springframework.http.support.Netty5HeadersAdapter
- getFirstDate(String) - Method in class org.springframework.http.HttpHeaders
-
Parse the first header value for the given header name as a date, return -1 if there is no value, or raise
IllegalArgumentException
if the value cannot be parsed as a date. - getFirstZonedDateTime(String) - Method in class org.springframework.http.HttpHeaders
-
Parse the first header value for the given header name as a date, return
null
if there is no value, or raiseIllegalArgumentException
if the value cannot be parsed as a date. - getFloatParameter(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get a Float parameter, or
null
if not present. - getFloatParameter(ServletRequest, String, float) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get a float parameter, with a fallback value.
- getFloatParameters(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get an array of float parameters, return an empty array if not found.
- getForEntity(String, Class<T>, Object...) - Method in interface org.springframework.web.client.RestOperations
-
Retrieve an entity by doing a GET on the specified URL.
- getForEntity(String, Class<T>, Object...) - Method in class org.springframework.web.client.RestTemplate
- getForEntity(String, Class<T>, Map<String, ?>) - Method in interface org.springframework.web.client.RestOperations
-
Retrieve a representation by doing a GET on the URI template.
- getForEntity(String, Class<T>, Map<String, ?>) - Method in class org.springframework.web.client.RestTemplate
- getForEntity(URI, Class<T>) - Method in interface org.springframework.web.client.RestOperations
-
Retrieve a representation by doing a GET on the URL.
- getForEntity(URI, Class<T>) - Method in class org.springframework.web.client.RestTemplate
- getFormContentType(MediaType) - Method in class org.springframework.http.converter.FormHttpMessageConverter
-
Return the content type used to write forms, given the preferred content type.
- getFormData() - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- getFormData() - Method in interface org.springframework.web.server.ServerWebExchange
-
Return the form data from the body of the request if the Content-Type is
"application/x-www-form-urlencoded"
or an empty map otherwise. - getFormData() - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- getFormWriter() - Method in class org.springframework.http.codec.multipart.MultipartHttpMessageWriter
-
Return the configured form writer.
- getForObject(String, Class<T>, Object...) - Method in interface org.springframework.web.client.RestOperations
-
Retrieve a representation by doing a GET on the specified URL.
- getForObject(String, Class<T>, Object...) - Method in class org.springframework.web.client.RestTemplate
- getForObject(String, Class<T>, Map<String, ?>) - Method in interface org.springframework.web.client.RestOperations
-
Retrieve a representation by doing a GET on the URI template.
- getForObject(String, Class<T>, Map<String, ?>) - Method in class org.springframework.web.client.RestTemplate
- getForObject(URI, Class<T>) - Method in interface org.springframework.web.client.RestOperations
-
Retrieve a representation by doing a GET on the URL.
- getForObject(URI, Class<T>) - Method in class org.springframework.web.client.RestTemplate
- getForwardedHeaderTransformer() - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
Return the configured
ForwardedHeaderTransformer
. - getFragment() - Method in class org.springframework.web.util.UriComponents
-
Return the fragment.
- getGlobalError() - Method in class org.springframework.web.bind.EscapedErrors
- getGlobalError() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getGlobalErrorCount() - Method in class org.springframework.web.bind.EscapedErrors
- getGlobalErrorCount() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getGlobalErrors() - Method in class org.springframework.web.bind.EscapedErrors
- getGlobalErrors() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getGson() - Method in class org.springframework.http.converter.json.GsonHttpMessageConverter
-
Return the configured
Gson
instance for this converter. - getHandler() - Method in class org.springframework.web.server.handler.DefaultWebFilterChain
- getHandlerMethod() - Method in exception org.springframework.web.server.ServerErrorException
-
Return the handler method associated with the error, if any.
- getHandlers() - Method in class org.springframework.web.method.support.HandlerMethodReturnValueHandlerComposite
-
Return a read-only list with the registered handlers, or an empty list.
- getHeader(String) - Method in class org.springframework.web.context.request.FacesWebRequest
- getHeader(String) - Method in class org.springframework.web.context.request.ServletWebRequest
- getHeader(String) - Method in interface org.springframework.web.context.request.WebRequest
-
Return the request header of the given name, or
null
if none. - getHeader(String) - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- getHeaderName() - Method in exception org.springframework.web.bind.MissingRequestHeaderException
-
Return the expected name of the request header.
- getHeaderName() - Method in class org.springframework.web.server.session.HeaderWebSessionIdResolver
-
Get the configured header name.
- getHeaderNames() - Method in class org.springframework.web.context.request.FacesWebRequest
- getHeaderNames() - Method in class org.springframework.web.context.request.ServletWebRequest
- getHeaderNames() - Method in interface org.springframework.web.context.request.WebRequest
-
Return an Iterator over request header names.
- getHeaderNames() - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- getHeaderPredicate() - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
The configured
headerPredicate
. - getHeaders() - Method in class org.springframework.http.client.AbstractClientHttpRequest
- getHeaders() - Method in class org.springframework.http.client.reactive.AbstractClientHttpRequest
- getHeaders() - Method in class org.springframework.http.client.reactive.AbstractClientHttpResponse
- getHeaders() - Method in class org.springframework.http.client.reactive.ClientHttpRequestDecorator
- getHeaders() - Method in class org.springframework.http.client.reactive.ClientHttpResponseDecorator
- getHeaders() - Method in class org.springframework.http.client.support.HttpRequestWrapper
-
Return the headers of the wrapped request.
- getHeaders() - Method in class org.springframework.http.converter.json.MappingJacksonInputMessage
- getHeaders() - Method in class org.springframework.http.HttpEntity
-
Returns the headers of this entity.
- getHeaders() - Method in interface org.springframework.http.HttpMessage
-
Return the headers of this message.
- getHeaders() - Method in class org.springframework.http.server.DelegatingServerHttpResponse
- getHeaders() - Method in class org.springframework.http.server.reactive.AbstractServerHttpRequest
- getHeaders() - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
- getHeaders() - Method in class org.springframework.http.server.reactive.ServerHttpRequestDecorator
- getHeaders() - Method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
- getHeaders() - Method in class org.springframework.http.server.ServletServerHttpRequest
- getHeaders() - Method in class org.springframework.http.server.ServletServerHttpResponse
- getHeaders() - Method in interface org.springframework.web.ErrorResponse
-
Return headers to use for the response.
- getHeaders() - Method in exception org.springframework.web.ErrorResponseException
- getHeaders() - Method in exception org.springframework.web.HttpMediaTypeNotAcceptableException
- getHeaders() - Method in exception org.springframework.web.HttpMediaTypeNotSupportedException
- getHeaders() - Method in exception org.springframework.web.HttpRequestMethodNotSupportedException
- getHeaders() - Method in class org.springframework.web.multipart.support.RequestPartServletServerHttpRequest
- getHeaders() - Method in exception org.springframework.web.server.MethodNotAllowedException
-
Return HttpHeaders with an "Allow" header that documents the allowed HTTP methods for this URL, if available, or an empty instance otherwise.
- getHeaders() - Method in exception org.springframework.web.server.NotAcceptableStatusException
-
Return HttpHeaders with an "Accept" header that documents the supported media types, if available, or an empty instance otherwise.
- getHeaders() - Method in exception org.springframework.web.server.ResponseStatusException
-
Return headers to add to the error response, e.g.
- getHeaders() - Method in exception org.springframework.web.server.UnsupportedMediaTypeStatusException
-
Return HttpHeaders with an "Accept" header that documents the supported media types, if available, or an empty instance otherwise.
- getHeaders() - Method in class org.springframework.web.service.invoker.HttpRequestValues
-
Return the headers for the request, if any.
- getHeaders(String) - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- getHeaderValue() - Method in class org.springframework.http.CacheControl
-
Return the "Cache-Control" header value, if any.
- getHeaderValues(String) - Method in class org.springframework.web.context.request.FacesWebRequest
- getHeaderValues(String) - Method in class org.springframework.web.context.request.ServletWebRequest
- getHeaderValues(String) - Method in interface org.springframework.web.context.request.WebRequest
-
Return the request header values for the given header name, or
null
if none. - getHighCardinalityKeyValues(ClientRequestObservationContext) - Method in class org.springframework.http.client.observation.DefaultClientRequestObservationConvention
- getHighCardinalityKeyValues(ServerRequestObservationContext) - Method in class org.springframework.http.server.observation.DefaultServerRequestObservationConvention
- getHighCardinalityKeyValues(ServerRequestObservationContext) - Method in class org.springframework.http.server.reactive.observation.DefaultServerRequestObservationConvention
- getHints(ResolvableType) - Method in class org.springframework.http.codec.json.Jackson2CodecSupport
- getHost() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
Host
header, if available. - getHost() - Method in class org.springframework.web.util.UriComponents
-
Return the host.
- getHttpClient() - Method in class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Return the
HttpClient
used for synchronous execution. - getHttpEntity(Object) - Method in class org.springframework.http.converter.FormHttpMessageConverter
-
Return an
HttpEntity
for the given part Object. - getHttpInputMessage() - Method in exception org.springframework.http.converter.HttpMessageNotReadableException
-
Return the original HTTP message.
- getHttpMethod() - Method in class org.springframework.web.context.request.ServletWebRequest
-
Return the HTTP method of the request.
- getHttpMethod() - Method in exception org.springframework.web.server.MethodNotAllowedException
-
Return the HTTP method for the failed request.
- getHttpMethod() - Method in class org.springframework.web.service.invoker.HttpRequestValues
-
Return the HTTP method to use for the request.
- getId() - Method in interface org.springframework.http.client.reactive.ClientHttpResponse
-
Return an id that represents the underlying connection, if available, or the request for the purpose of correlating log messages.
- getId() - Method in class org.springframework.http.client.reactive.ClientHttpResponseDecorator
- getId() - Method in class org.springframework.http.server.reactive.AbstractServerHttpRequest
- getId() - Method in interface org.springframework.http.server.reactive.ServerHttpRequest
-
Return an id that represents the underlying connection, if available, or the request for the purpose of correlating log messages.
- getId() - Method in class org.springframework.http.server.reactive.ServerHttpRequestDecorator
- getId() - Method in interface org.springframework.web.server.WebSession
-
Return a unique session identifier.
- getIfMatch() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
If-Match
header. - getIfModifiedSince() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
If-Modified-Since
header. - getIfNoneMatch() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
If-None-Match
header. - getIfUnmodifiedSince() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
If-Unmodified-Since
header. - getInputStream() - Method in class org.springframework.web.context.support.ServletContextResource
-
This implementation delegates to
ServletContext.getResourceAsStream
, but throws a FileNotFoundException if no resource found. - getInputStream() - Method in interface org.springframework.web.multipart.MultipartFile
-
Return an InputStream to read the contents of the file from.
- getInputStream() - Method in class org.springframework.web.util.ContentCachingRequestWrapper
- getInserts() - Method in exception org.springframework.web.util.pattern.PatternParseException
- getInstance() - Method in interface org.springframework.http.converter.json.ProblemDetailJacksonXmlMixin
- getInstance() - Method in class org.springframework.http.ProblemDetail
-
Return the configured
problem instance
. - getInstance(Class<T>) - Method in class org.springframework.web.bind.support.SpringWebConstraintValidatorFactory
- getInterceptors() - Method in class org.springframework.http.client.support.InterceptingHttpAccessor
-
Get the request interceptors that this accessor uses.
- getIntParameter(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get an Integer parameter, or
null
if not present. - getIntParameter(ServletRequest, String, int) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get an int parameter, with a fallback value.
- getIntParameters(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get an array of int parameters, return an empty array if not found.
- getJavaType(Type, Class<?>) - Method in class org.springframework.http.codec.json.Jackson2CodecSupport
- getJavaType(Type, Class<?>) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
-
Return the Jackson
JavaType
for the specified type and context class. - getJaxbContext(Class<?>) - Method in class org.springframework.http.converter.xml.AbstractJaxb2HttpMessageConverter
-
Return a
JAXBContext
for the given class. - getJsonb() - Method in class org.springframework.http.converter.json.JsonbHttpMessageConverter
-
Return the configured
Jsonb
instance for this converter. - getJsonEncoding(MediaType) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
-
Determine the JSON encoding to use for the given content type.
- getJsonEncoding(MimeType) - Method in class org.springframework.http.codec.json.AbstractJackson2Encoder
-
Determine the JSON encoding to use for the given mime type.
- getLabel() - Method in exception org.springframework.web.server.MissingRequestValueException
-
Return a label that describes the request value, e.g.
- getLastAccessTime() - Method in interface org.springframework.web.server.WebSession
-
Return the last time of session access as a result of user activity such as an HTTP request.
- getLastModified() - Method in class org.springframework.http.HttpHeaders
-
Return the time the resource was last changed, as specified by the
Last-Modified
header. - getLocalAddress() - Method in interface org.springframework.http.server.reactive.ServerHttpRequest
-
Return the local address the request was accepted on, if available.
- getLocalAddress() - Method in class org.springframework.http.server.reactive.ServerHttpRequestDecorator
- getLocalAddress() - Method in interface org.springframework.http.server.ServerHttpRequest
-
Return the address on which the request was received.
- getLocalAddress() - Method in class org.springframework.http.server.ServletServerHttpRequest
- getLocale() - Method in class org.springframework.web.context.request.FacesWebRequest
- getLocale() - Method in class org.springframework.web.context.request.ServletWebRequest
- getLocale() - Method in interface org.springframework.web.context.request.WebRequest
-
Return the primary Locale for this request.
- getLocaleContext() - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- getLocaleContext() - Method in interface org.springframework.web.server.ServerWebExchange
-
Return the
LocaleContext
using the configuredLocaleContextResolver
. - getLocaleContext() - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- getLocaleContextResolver() - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
Return the configured
LocaleContextResolver
. - getLocation() - Method in class org.springframework.http.HttpHeaders
-
Return the (new) location of a resource as specified by the
Location
header. - getLogPrefix() - Method in class org.springframework.http.server.reactive.AbstractListenerReadPublisher
-
Return the configured log message prefix.
- getLogPrefix() - Method in class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
-
Create an instance with the given log prefix.
- getLogPrefix() - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
-
Get the configured log prefix.
- getLogPrefix() - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- getLogPrefix() - Method in interface org.springframework.web.server.ServerWebExchange
-
Return a log message prefix to use to correlate messages for this exchange.
- getLogPrefix() - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- getLongParameter(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get a Long parameter, or
null
if not present. - getLongParameter(ServletRequest, String, long) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get a long parameter, with a fallback value.
- getLongParameters(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get an array of long parameters, return an empty array if not found.
- getLookupPathForRequest(HttpServletRequest) - Method in class org.springframework.web.util.UrlPathHelper
-
Return the mapping lookup path for the given request, within the current servlet mapping if applicable, else within the web application.
- getLookupPathForRequest(HttpServletRequest, String) - Method in class org.springframework.web.util.UrlPathHelper
-
Deprecated.as of 5.3 in favor of using
UrlPathHelper.resolveAndCacheLookupPath(HttpServletRequest)
andUrlPathHelper.getResolvedLookupPath(ServletRequest)
. - getLoopResources() - Method in class org.springframework.http.client.reactive.ReactorNetty2ResourceFactory
-
Return the configured
LoopResources
. - getLoopResources() - Method in class org.springframework.http.client.ReactorResourceFactory
-
Return the configured
LoopResources
. - getLowCardinalityKeyValues(ClientRequestObservationContext) - Method in class org.springframework.http.client.observation.DefaultClientRequestObservationConvention
- getLowCardinalityKeyValues(ServerRequestObservationContext) - Method in class org.springframework.http.server.observation.DefaultServerRequestObservationConvention
- getLowCardinalityKeyValues(ServerRequestObservationContext) - Method in class org.springframework.http.server.reactive.observation.DefaultServerRequestObservationConvention
- GetMapping - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation for mapping HTTP
GET
requests onto specific handler methods. - getMarshallerProcessor() - Method in class org.springframework.http.codec.xml.Jaxb2XmlEncoder
-
Return the configured processor for customizing Marshaller instances.
- getMatrixVariables() - Method in class org.springframework.web.util.pattern.PathPattern.PathMatchInfo
-
Return maps of matrix variables per path segment, keyed off by URI variable name.
- getMatrixVariables() - Method in class org.springframework.web.util.pattern.PathPattern.PathRemainingMatchInfo
-
Return the path parameters for each bound variable.
- getMaxAge() - Method in class org.springframework.http.ResponseCookie
-
Return the cookie "Max-Age" attribute in seconds.
- getMaxAge() - Method in class org.springframework.web.cors.CorsConfiguration
-
Return the configured
maxAge
value, ornull
if none. - getMaxIdleTime() - Method in interface org.springframework.web.server.WebSession
-
Return the maximum time after the
lastAccessTime
before a session expires. - getMaxInMemorySize() - Method in class org.springframework.http.codec.FormHttpMessageReader
-
Return the
configured
byte count limit. - getMaxInMemorySize() - Method in class org.springframework.http.codec.json.AbstractJackson2Decoder
-
Return the
configured
byte count limit. - getMaxInMemorySize() - Method in class org.springframework.http.codec.KotlinSerializationBinaryDecoder
-
Return the
configured
byte count limit. - getMaxInMemorySize() - Method in class org.springframework.http.codec.KotlinSerializationStringDecoder
-
Return the
configured
byte count limit. - getMaxInMemorySize() - Method in class org.springframework.http.codec.multipart.DefaultPartHttpMessageReader
-
Get the
configured
maximum in-memory size. - getMaxInMemorySize() - Method in class org.springframework.http.codec.multipart.PartEventHttpMessageReader
-
Get the
configured
maximum in-memory size. - getMaxInMemorySize() - Method in class org.springframework.http.codec.ServerSentEventHttpMessageReader
-
Return the
configured
byte count limit. - getMaxInMemorySize() - Method in class org.springframework.http.codec.xml.Jaxb2XmlDecoder
-
Return the
configured
byte count limit. - getMaxInMemorySize() - Method in class org.springframework.http.codec.xml.XmlEventDecoder
-
Return the
configured
byte count limit. - getMaxMessageSize() - Method in class org.springframework.http.codec.protobuf.ProtobufDecoder
-
Return the
configured
message size limit. - getMaxPayloadLength() - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Return the maximum length of the payload body to be included in the log message.
- getMaxSessions() - Method in class org.springframework.web.server.session.InMemoryWebSessionStore
-
Return the maximum number of sessions that can be stored.
- getMaxUploadSize() - Method in exception org.springframework.web.multipart.MaxUploadSizeExceededException
-
Return the maximum upload size allowed, or -1 if the size limit isn't known.
- getMediaType() - Method in exception org.springframework.http.InvalidMediaTypeException
-
Return the offending media type.
- getMediaType(String) - Static method in class org.springframework.http.MediaTypeFactory
-
Determine a media type for the given file name, if possible.
- getMediaType(Resource) - Static method in class org.springframework.http.MediaTypeFactory
-
Determine a media type for the given resource, if possible.
- getMediaType(MediaType) - Method in class org.springframework.http.codec.FormHttpMessageWriter
- getMediaTypeForResource(Resource) - Method in class org.springframework.web.accept.PathExtensionContentNegotiationStrategy
-
Deprecated.A public method exposing the knowledge of the path extension strategy to resolve file extensions to a
MediaType
in this case for a givenResource
. - getMediaTypeForResource(Resource) - Method in class org.springframework.web.accept.ServletPathExtensionContentNegotiationStrategy
-
Deprecated.Extends the base class
PathExtensionContentNegotiationStrategy.getMediaTypeForResource(org.springframework.core.io.Resource)
with the ability to also look up through the ServletContext. - getMediaTypeKey(NativeWebRequest) - Method in class org.springframework.web.accept.AbstractMappingContentNegotiationStrategy
-
Extract a key from the request to use to look up media types.
- getMediaTypeKey(NativeWebRequest) - Method in class org.springframework.web.accept.ParameterContentNegotiationStrategy
- getMediaTypeKey(NativeWebRequest) - Method in class org.springframework.web.accept.PathExtensionContentNegotiationStrategy
-
Deprecated.
- getMediaTypeMappings() - Method in class org.springframework.web.accept.ContentNegotiationManager
-
Return all registered lookup key to media type mappings by iterating
MediaTypeFileExtensionResolver
s. - getMediaTypes() - Method in class org.springframework.web.accept.MappingMediaTypeFileExtensionResolver
- getMediaTypes(String) - Static method in class org.springframework.http.MediaTypeFactory
-
Determine the media types for the given file name, if possible.
- getMediaTypesForProblemDetail() - Method in class org.springframework.http.codec.json.Jackson2CodecSupport
-
Return the supported media type(s) for
ProblemDetail
. - getMediaTypesForProblemDetail() - Method in class org.springframework.http.codec.json.Jackson2JsonEncoder
- getMediaTypesForProblemDetail() - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
-
Return the supported media type(s) for
ProblemDetail
. - getMediaTypesForProblemDetail() - Method in class org.springframework.http.converter.json.MappingJackson2HttpMessageConverter
- getMediaTypesForProblemDetail() - Method in class org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter
- getMessage() - Method in exception org.springframework.web.bind.MethodArgumentNotValidException
- getMessage() - Method in exception org.springframework.web.bind.MissingMatrixVariableException
- getMessage() - Method in exception org.springframework.web.bind.MissingPathVariableException
- getMessage() - Method in exception org.springframework.web.bind.MissingRequestCookieException
- getMessage() - Method in exception org.springframework.web.bind.MissingRequestHeaderException
- getMessage() - Method in exception org.springframework.web.bind.MissingServletRequestParameterException
- getMessage() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
-
Returns diagnostic information about the errors held in this object.
- getMessage() - Method in exception org.springframework.web.bind.UnsatisfiedServletRequestParameterException
- getMessage() - Method in exception org.springframework.web.ErrorResponseException
- getMessage() - Method in exception org.springframework.web.server.ResponseStatusException
- getMessage() - Method in exception org.springframework.web.util.pattern.PatternParseException
-
Return a formatted message with inserts applied.
- getMessageCodesResolver() - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Return the strategy to use for resolving errors into message codes.
- getMessageConverters() - Method in class org.springframework.web.client.RestTemplate
-
Return the list of message body converters.
- getMessagePayload(HttpServletRequest) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Extracts the message payload portion of the message created by
AbstractRequestLoggingFilter.createMessage(HttpServletRequest, String, String)
whenAbstractRequestLoggingFilter.isIncludePayload()
returns true. - getMessageType() - Method in exception org.springframework.web.util.pattern.PatternParseException
- getMetaClass() - Method in class org.springframework.web.context.support.GroovyWebApplicationContext
- getMethod() - Method in interface org.springframework.http.client.reactive.ClientHttpRequest
-
Return the HTTP method of the request.
- getMethod() - Method in class org.springframework.http.client.reactive.ClientHttpRequestDecorator
- getMethod() - Method in class org.springframework.http.client.support.HttpRequestWrapper
-
Return the method of the wrapped request.
- getMethod() - Method in interface org.springframework.http.HttpRequest
-
Return the HTTP method of the request.
- getMethod() - Method in class org.springframework.http.RequestEntity
-
Return the HTTP method of the request.
- getMethod() - Method in class org.springframework.http.server.reactive.AbstractServerHttpRequest
- getMethod() - Method in class org.springframework.http.server.reactive.ServerHttpRequestDecorator
- getMethod() - Method in class org.springframework.http.server.ServletServerHttpRequest
- getMethod() - Method in class org.springframework.web.context.support.ServletRequestHandledEvent
-
Return the HTTP method of the request (usually GET or POST).
- getMethod() - Method in exception org.springframework.web.HttpRequestMethodNotSupportedException
-
Return the HTTP request method that caused the failure.
- getMethod() - Method in exception org.springframework.web.method.annotation.HandlerMethodValidationException
- getMethodArgumentValues(NativeWebRequest, ModelAndViewContainer, Object...) - Method in class org.springframework.web.method.support.InvocableHandlerMethod
-
Get the method argument values for the current request, checking the provided argument values and falling back to the configured argument resolvers.
- getMethodParameter() - Method in exception org.springframework.web.bind.MissingServletRequestParameterException
-
Return the target
MethodParameter
if the exception was raised for a controller method argument. - getMethodParameter() - Method in exception org.springframework.web.server.ServerErrorException
-
Return the specific method parameter associated with the error, if any.
- getMethodParameter() - Method in exception org.springframework.web.server.ServerWebInputException
-
Return the
MethodParameter
associated with this error, if any. - getMimeTypes() - Method in class org.springframework.http.codec.json.Jackson2CodecSupport
-
Subclasses should expose this as "decodable" or "encodable" mime types.
- getMimeTypes() - Method in class org.springframework.http.codec.protobuf.ProtobufCodecSupport
- getMimeTypes(ResolvableType) - Method in class org.springframework.http.codec.json.Jackson2CodecSupport
- getModel() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getModel() - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Return the model to use -- either the "default" or the "redirect" model.
- getModificationDate() - Method in class org.springframework.http.ContentDisposition
-
Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.
- getMultiFileMap() - Method in interface org.springframework.web.multipart.MultipartRequest
-
Return a
MultiValueMap
of the multipart files contained in this request. - getMultiFileMap() - Method in class org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest
- getMultipartContentType(String) - Method in interface org.springframework.web.multipart.MultipartRequest
-
Determine the content type of the specified request part.
- getMultipartContentType(String) - Method in class org.springframework.web.multipart.support.DefaultMultipartHttpServletRequest
- getMultipartContentType(String) - Method in class org.springframework.web.multipart.support.StandardMultipartHttpServletRequest
- getMultipartData() - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- getMultipartData() - Method in interface org.springframework.web.server.ServerWebExchange
-
Return the parts of a multipart request if the Content-Type is
"multipart/form-data"
or an empty map otherwise. - getMultipartData() - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- getMultipartFiles() - Method in class org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest
-
Obtain the MultipartFile Map for retrieval, lazily initializing it if necessary.
- getMultipartHeaders(String) - Method in interface org.springframework.web.multipart.MultipartHttpServletRequest
-
Return the headers for the specified part of the multipart request.
- getMultipartHeaders(String) - Method in class org.springframework.web.multipart.support.DefaultMultipartHttpServletRequest
- getMultipartHeaders(String) - Method in class org.springframework.web.multipart.support.StandardMultipartHttpServletRequest
- getMultipartMediaType(MediaType, byte[]) - Method in class org.springframework.http.codec.multipart.MultipartWriterSupport
-
Prepare the
MediaType
to use by adding "boundary" and "charset" parameters to the givenmediaType
or "multipart/form-data" otherwise by default. - getMultipartParameterContentTypes() - Method in class org.springframework.web.multipart.support.DefaultMultipartHttpServletRequest
-
Obtain the multipart parameter content type Map for retrieval, lazily initializing it if necessary.
- getMultipartParameters() - Method in class org.springframework.web.multipart.support.DefaultMultipartHttpServletRequest
-
Obtain the multipart parameter Map for retrieval, lazily initializing it if necessary.
- getMultipartResolverBeanName() - Method in class org.springframework.web.multipart.support.MultipartFilter
-
Return the bean name of the MultipartResolver to fetch from Spring's root application context.
- getName() - Method in class org.springframework.http.client.observation.DefaultClientRequestObservationConvention
- getName() - Method in class org.springframework.http.ContentDisposition
-
Return the value of the name parameter, or
null
if not defined. - getName() - Method in class org.springframework.http.HttpCookie
-
Return the cookie name.
- getName() - Method in class org.springframework.http.server.observation.DefaultServerRequestObservationConvention
- getName() - Method in class org.springframework.http.server.reactive.observation.DefaultServerRequestObservationConvention
- getName() - Method in exception org.springframework.web.method.annotation.MethodArgumentConversionNotSupportedException
-
Return the name of the method argument.
- getName() - Method in exception org.springframework.web.method.annotation.MethodArgumentTypeMismatchException
-
Return the name of the method argument.
- getName() - Method in interface org.springframework.web.multipart.MultipartFile
-
Return the name of the parameter in the multipart form.
- getName() - Method in exception org.springframework.web.server.MissingRequestValueException
-
Return the name of the missing value, e.g.
- getNameForParameter(MethodParameter) - Static method in class org.springframework.web.method.annotation.ModelFactory
-
Derive the model attribute name for the given method parameter based on a
@ModelAttribute
parameter annotation (if present) or falling back on parameter type based conventions. - getNameForReturnValue(Object, MethodParameter) - Static method in class org.springframework.web.method.annotation.ModelFactory
-
Derive the model attribute name for the given return value.
- getNames() - Method in class org.springframework.web.bind.ServletRequestDataBinder.ServletRequestValueResolver
- getNamespace() - Method in interface org.springframework.web.context.ConfigurableWebApplicationContext
-
Return the namespace for this web application context, if any.
- getNamespace() - Method in class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
- getNamespace() - Method in class org.springframework.web.context.support.GenericWebApplicationContext
- getNamespace() - Method in class org.springframework.web.context.support.StaticWebApplicationContext
- getNativeRequest() - Method in interface org.springframework.http.client.reactive.ClientHttpRequest
-
Return the request from the underlying HTTP library.
- getNativeRequest() - Method in class org.springframework.http.client.reactive.ClientHttpRequestDecorator
- getNativeRequest() - Method in class org.springframework.http.server.reactive.AbstractServerHttpRequest
-
Return the underlying server response.
- getNativeRequest() - Method in class org.springframework.web.context.request.FacesWebRequest
- getNativeRequest() - Method in interface org.springframework.web.context.request.NativeWebRequest
-
Return the underlying native request object.
- getNativeRequest() - Method in class org.springframework.web.context.request.ServletWebRequest
- getNativeRequest(ServletRequest, Class<T>) - Static method in class org.springframework.web.util.WebUtils
-
Return an appropriate request object of the specified type, if available, unwrapping the given request as far as necessary.
- getNativeRequest(Class<T>) - Method in class org.springframework.web.context.request.FacesWebRequest
- getNativeRequest(Class<T>) - Method in interface org.springframework.web.context.request.NativeWebRequest
-
Return the underlying native request object, if available.
- getNativeRequest(Class<T>) - Method in class org.springframework.web.context.request.ServletWebRequest
- getNativeRequest(ServerHttpRequest) - Static method in class org.springframework.http.server.reactive.ServerHttpRequestDecorator
-
Return the native request of the underlying server API, if possible, also unwrapping
ServerHttpRequestDecorator
if necessary. - getNativeResponse() - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
-
Return the underlying server response.
- getNativeResponse() - Method in class org.springframework.web.context.request.FacesWebRequest
- getNativeResponse() - Method in interface org.springframework.web.context.request.NativeWebRequest
-
Return the underlying native response object, if any.
- getNativeResponse() - Method in class org.springframework.web.context.request.ServletWebRequest
- getNativeResponse(ServletResponse, Class<T>) - Static method in class org.springframework.web.util.WebUtils
-
Return an appropriate response object of the specified type, if available, unwrapping the given response as far as necessary.
- getNativeResponse(Class<T>) - Method in class org.springframework.web.context.request.FacesWebRequest
- getNativeResponse(Class<T>) - Method in interface org.springframework.web.context.request.NativeWebRequest
-
Return the underlying native response object, if available.
- getNativeResponse(Class<T>) - Method in class org.springframework.web.context.request.ServletWebRequest
- getNativeResponse(ServerHttpResponse) - Static method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
-
Return the native response of the underlying server API, if possible, also unwrapping
ServerHttpResponseDecorator
if necessary. - getNestedPath() - Method in class org.springframework.web.bind.EscapedErrors
- getNestedPath() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getObject() - Method in class org.springframework.http.client.support.ProxyFactoryBean
- getObject() - Method in class org.springframework.http.converter.json.GsonFactoryBean
-
Return the created Gson instance.
- getObject() - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Return the singleton ObjectMapper.
- getObject() - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
- getObject() - Method in class org.springframework.web.context.support.ServletContextAttributeFactoryBean
- getObject() - Method in class org.springframework.web.context.support.ServletContextParameterFactoryBean
- getObjectMapper() - Method in class org.springframework.http.codec.json.Jackson2CodecSupport
-
Return the
configured
default ObjectMapper. - getObjectMapper() - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
-
Return the main
ObjectMapper
in use. - getObjectMapperRegistrations() - Method in class org.springframework.http.codec.json.Jackson2CodecSupport
- getObjectMappersForType(Class<?>) - Method in class org.springframework.http.codec.json.Jackson2CodecSupport
-
Return ObjectMapper registrations for the given class, if any.
- getObjectMappersForType(Class<?>) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
-
Return ObjectMapper registrations for the given class, if any.
- getObjectName() - Method in class org.springframework.web.bind.EscapedErrors
- getObjectName() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getObjectType() - Method in class org.springframework.http.client.support.ProxyFactoryBean
- getObjectType() - Method in class org.springframework.http.converter.json.GsonFactoryBean
- getObjectType() - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
- getObjectType() - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
- getObjectType() - Method in class org.springframework.web.context.support.ServletContextAttributeFactoryBean
- getObjectType() - Method in class org.springframework.web.context.support.ServletContextParameterFactoryBean
- getObservationConvention() - Method in class org.springframework.web.client.RestTemplate
-
Return the configured
ClientRequestObservationConvention
, ornull
if not set. - getObservationConvention() - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
Return the Observation convention configured for server exchanges observations.
- getObservationRegistry() - Method in class org.springframework.web.client.RestTemplate
-
Return the configured
ObservationRegistry
. - getObservationRegistry() - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
Return the configured
ObservationRegistry
. - getOrder() - Method in class org.springframework.web.method.ControllerAdviceBean
-
Get the order value for the contained bean.
- getOrEmpty(Object) - Method in class org.springframework.http.HttpHeaders
-
Get the list of header values for the given header name, if any.
- getOrigin() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
Origin
header. - getOriginalFilename() - Method in interface org.springframework.web.multipart.MultipartFile
-
Return the original filename in the client's filesystem.
- getOriginatingContextPath(HttpServletRequest) - Method in class org.springframework.web.util.UrlPathHelper
-
Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include.
- getOriginatingQueryString(HttpServletRequest) - Method in class org.springframework.web.util.UrlPathHelper
-
Return the query string part of the given request's URL.
- getOriginatingRequestUri(HttpServletRequest) - Method in class org.springframework.web.util.UrlPathHelper
-
Return the request URI for the given request.
- getOriginatingServletPath(HttpServletRequest) - Method in class org.springframework.web.util.UrlPathHelper
-
Return the servlet path for the given request, detecting an include request URL if called within a RequestDispatcher include.
- getOutputStream() - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- getParamConditionGroups() - Method in exception org.springframework.web.bind.UnsatisfiedServletRequestParameterException
-
Return all parameter condition groups that have been violated.
- getParamConditions() - Method in exception org.springframework.web.bind.UnsatisfiedServletRequestParameterException
-
Return the parameter conditions that have been violated or the first group in case of multiple groups.
- getParameter() - Method in exception org.springframework.web.bind.MethodArgumentNotValidException
-
Return the method parameter that failed validation.
- getParameter() - Method in exception org.springframework.web.bind.MissingMatrixVariableException
-
Return the method parameter bound to the matrix variable.
- getParameter() - Method in exception org.springframework.web.bind.MissingPathVariableException
-
Return the method parameter bound to the path variable.
- getParameter() - Method in exception org.springframework.web.bind.MissingRequestCookieException
-
Return the method parameter bound to the request cookie.
- getParameter() - Method in exception org.springframework.web.bind.MissingRequestHeaderException
-
Return the method parameter bound to the request header.
- getParameter() - Method in exception org.springframework.web.method.annotation.MethodArgumentConversionNotSupportedException
-
Return the target method parameter.
- getParameter() - Method in exception org.springframework.web.method.annotation.MethodArgumentTypeMismatchException
-
Return the target method parameter.
- getParameter(String) - Method in class org.springframework.web.context.request.FacesWebRequest
- getParameter(String) - Method in class org.springframework.web.context.request.ServletWebRequest
- getParameter(String) - Method in interface org.springframework.web.context.request.WebRequest
-
Return the request parameter of the given name, or
null
if none. - getParameter(String) - Method in class org.springframework.web.multipart.support.DefaultMultipartHttpServletRequest
- getParameter(String) - Method in class org.springframework.web.util.ContentCachingRequestWrapper
- getParameter(ResolvableType) - Method in class org.springframework.http.codec.json.Jackson2CodecSupport
- getParameterMap() - Method in class org.springframework.web.context.request.FacesWebRequest
- getParameterMap() - Method in class org.springframework.web.context.request.ServletWebRequest
- getParameterMap() - Method in interface org.springframework.web.context.request.WebRequest
-
Return an immutable Map of the request parameters, with parameter names as map keys and parameter values as map values.
- getParameterMap() - Method in class org.springframework.web.multipart.support.DefaultMultipartHttpServletRequest
- getParameterMap() - Method in class org.springframework.web.multipart.support.StandardMultipartHttpServletRequest
- getParameterMap() - Method in class org.springframework.web.util.ContentCachingRequestWrapper
- getParameterName() - Method in class org.springframework.web.accept.ParameterContentNegotiationStrategy
- getParameterName() - Method in exception org.springframework.web.bind.MissingServletRequestParameterException
-
Return the name of the offending parameter.
- getParameterNames() - Method in class org.springframework.web.context.request.FacesWebRequest
- getParameterNames() - Method in class org.springframework.web.context.request.ServletWebRequest
- getParameterNames() - Method in interface org.springframework.web.context.request.WebRequest
-
Return an Iterator over request parameter names.
- getParameterNames() - Method in class org.springframework.web.multipart.support.DefaultMultipartHttpServletRequest
- getParameterNames() - Method in class org.springframework.web.multipart.support.StandardMultipartHttpServletRequest
- getParameterNames() - Method in class org.springframework.web.util.ContentCachingRequestWrapper
- getParametersStartingWith(ServletRequest, String) - Static method in class org.springframework.web.util.WebUtils
-
Return a map containing all parameters with the given prefix.
- getParameterType() - Method in exception org.springframework.web.bind.MissingServletRequestParameterException
-
Return the expected type of the offending parameter.
- getParameterValues(String) - Method in class org.springframework.web.context.request.FacesWebRequest
- getParameterValues(String) - Method in class org.springframework.web.context.request.ServletWebRequest
- getParameterValues(String) - Method in interface org.springframework.web.context.request.WebRequest
-
Return the request parameter values for the given parameter name, or
null
if none. - getParameterValues(String) - Method in class org.springframework.web.multipart.support.DefaultMultipartHttpServletRequest
- getParameterValues(String) - Method in class org.springframework.web.util.ContentCachingRequestWrapper
- getParsedRequestPath(ServletRequest) - Static method in class org.springframework.web.util.ServletRequestPathUtils
-
Return a
previously
parsed and cachedRequestPath
. - getPartConverters() - Method in class org.springframework.http.converter.FormHttpMessageConverter
-
Return the configured converters for MIME parts.
- getPartReader() - Method in class org.springframework.http.codec.multipart.MultipartHttpMessageReader
-
Return the configured parts reader.
- getParts(HttpServletRequest) - Static method in class org.springframework.web.multipart.support.StandardServletPartUtils
-
Retrieve all parts from the given servlet request.
- getParts(HttpServletRequest, String) - Static method in class org.springframework.web.multipart.support.StandardServletPartUtils
-
Retrieve all parts with the given name from the given servlet request.
- getPartWriters() - Method in class org.springframework.http.codec.multipart.MultipartHttpMessageWriter
-
Return the configured part writers.
- getPath() - Method in class org.springframework.http.ResponseCookie
-
Return the cookie "Path" attribute, or
null
if not set. - getPath() - Method in class org.springframework.http.server.reactive.AbstractServerHttpRequest
- getPath() - Method in interface org.springframework.http.server.reactive.ServerHttpRequest
-
Returns a structured representation of the full request path up to but not including the
query
. - getPath() - Method in class org.springframework.http.server.reactive.ServerHttpRequestDecorator
- getPath() - Method in class org.springframework.web.context.support.ServletContextResource
-
Return the path for this resource.
- getPath() - Method in class org.springframework.web.util.UriComponents
-
Return the path.
- getPathMatched() - Method in class org.springframework.web.util.pattern.PathPattern.PathRemainingMatchInfo
-
Return the part of a path that was matched by a pattern.
- getPathOptions() - Method in class org.springframework.web.util.pattern.PathPatternParser
-
Get the
configured
pattern parsing options. - getPathPattern() - Method in class org.springframework.http.server.observation.ServerRequestObservationContext
- getPathPattern() - Method in class org.springframework.http.server.reactive.observation.ServerRequestObservationContext
-
Return the path pattern for the handler that matches the current request.
- getPathRemaining() - Method in class org.springframework.web.util.pattern.PathPattern.PathRemainingMatchInfo
-
Return the part of a path that was not matched by a pattern.
- getPathSegments() - Method in class org.springframework.web.util.UriComponents
-
Return the list of path segments.
- getPathWithinApplication(HttpServletRequest) - Method in class org.springframework.web.util.UrlPathHelper
-
Return the path within the web application for the given request.
- getPathWithinContext() - Method in class org.springframework.web.context.support.ServletContextResource
- getPathWithinServletMapping(HttpServletRequest) - Method in class org.springframework.web.util.UrlPathHelper
-
Return the path within the servlet mapping for the given request, i.e.
- getPathWithinServletMapping(HttpServletRequest, String) - Method in class org.springframework.web.util.UrlPathHelper
-
Return the path within the servlet mapping for the given request, i.e.
- getPatternComparator(RouteMatcher.Route) - Method in class org.springframework.web.util.pattern.PathPatternRouteMatcher
- getPatternString() - Method in class org.springframework.web.util.pattern.PathPattern
-
Return the original String that was parsed to create this PathPattern.
- getPeerCertificates() - Method in interface org.springframework.http.server.reactive.SslInfo
-
Return SSL certificates associated with the request, if any.
- getPhase() - Method in class org.springframework.http.client.reactive.ReactorClientHttpConnector
- getPhase() - Method in class org.springframework.http.client.ReactorNettyClientRequestFactory
- getPhaseId() - Method in class org.springframework.web.jsf.DelegatingPhaseListenerMulticaster
- getPort() - Method in class org.springframework.web.util.UriComponents
-
Return the port.
- getPosition() - Method in exception org.springframework.web.util.pattern.PatternParseException
- getPragma() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
Pragma
header. - getPrincipal() - Method in interface org.springframework.http.server.ServerHttpRequest
-
Return a
Principal
instance containing the name of the authenticated user. - getPrincipal() - Method in class org.springframework.http.server.ServletServerHttpRequest
- getPrincipal() - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- getPrincipal() - Method in interface org.springframework.web.server.ServerWebExchange
-
Return the authenticated user for the request, if any.
- getPrincipal() - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- getProcessingTimeMillis() - Method in class org.springframework.web.context.support.RequestHandledEvent
-
Return the processing time of the request in milliseconds.
- getProperties() - Method in interface org.springframework.http.converter.json.ProblemDetailJacksonMixin
- getProperties() - Method in interface org.springframework.http.converter.json.ProblemDetailJacksonXmlMixin
- getProperties() - Method in class org.springframework.http.ProblemDetail
-
Return a generic map of properties that are not known ahead of time, possibly
null
if no properties have been added. - getProperty(String) - Method in class org.springframework.web.context.support.GroovyWebApplicationContext
- getProperty(String) - Method in class org.springframework.web.context.support.ServletConfigPropertySource
- getProperty(String) - Method in class org.springframework.web.context.support.ServletContextPropertySource
- getPropertyEditorRegistrars() - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Return the PropertyEditorRegistrars to be applied to every DataBinder.
- getPropertyEditorRegistry() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getPropertyNames() - Method in class org.springframework.web.context.support.ServletConfigPropertySource
- getPropertyNames() - Method in class org.springframework.web.context.support.ServletContextPropertySource
- getQualityValue() - Method in class org.springframework.http.MediaType
-
Return the quality factor, as indicated by a
q
parameter, if any. - getQuery() - Method in class org.springframework.web.util.UriComponents
-
Return the query.
- getQueryParams() - Method in class org.springframework.http.server.reactive.AbstractServerHttpRequest
- getQueryParams() - Method in interface org.springframework.http.server.reactive.ServerHttpRequest
-
Return a read-only map with parsed and decoded query parameter values.
- getQueryParams() - Method in class org.springframework.http.server.reactive.ServerHttpRequestDecorator
- getQueryParams() - Method in class org.springframework.web.util.UriComponents
-
Return the map of query parameters.
- getRange() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
Range
header. - getRangeEnd(long) - Method in class org.springframework.http.HttpRange
-
Return the end of the range (inclusive) given the total length of a representation.
- getRangeStart(long) - Method in class org.springframework.http.HttpRange
-
Return the start of the range given the total length of a representation.
- getRawFieldValue(String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getRawStatusCode() - Method in interface org.springframework.http.client.ClientHttpResponse
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.0, in favor of
ClientHttpResponse.getStatusCode()
; scheduled for removal in 6.2 - getRawStatusCode() - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
-
Deprecated.
- getRawStatusCode() - Method in interface org.springframework.http.server.reactive.ServerHttpResponse
-
Deprecated.as of 6.0, in favor of
ServerHttpResponse.getStatusCode()
- getRawStatusCode() - Method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
-
Deprecated.
- getRawStatusCode() - Method in exception org.springframework.web.client.RestClientResponseException
-
Deprecated.as of 6.0, in favor of
RestClientResponseException.getStatusCode()
- getRawStatusCode() - Method in exception org.springframework.web.client.UnknownContentTypeException
-
Deprecated.as of 6.0, in favor of
UnknownContentTypeException.getStatusCode()
- getReactiveAdapterRegistry() - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
- getReactiveAdapterRegistry() - Method in interface org.springframework.web.service.invoker.ReactorHttpExchangeAdapter
-
Return the configured
ReactiveAdapterRegistry
. - getReadableMediaTypes() - Method in class org.springframework.http.codec.DecoderHttpMessageReader
- getReadableMediaTypes() - Method in class org.springframework.http.codec.FormHttpMessageReader
- getReadableMediaTypes() - Method in interface org.springframework.http.codec.HttpMessageReader
-
Return the list of media types supported by this reader.
- getReadableMediaTypes() - Method in class org.springframework.http.codec.multipart.DefaultPartHttpMessageReader
- getReadableMediaTypes() - Method in class org.springframework.http.codec.multipart.MultipartHttpMessageReader
- getReadableMediaTypes() - Method in class org.springframework.http.codec.multipart.PartEventHttpMessageReader
- getReadableMediaTypes() - Method in class org.springframework.http.codec.ServerSentEventHttpMessageReader
- getReadableMediaTypes(ResolvableType) - Method in class org.springframework.http.codec.DecoderHttpMessageReader
- getReadableMediaTypes(ResolvableType) - Method in interface org.springframework.http.codec.HttpMessageReader
-
Return the list of media types supported by this Reader for the given type of element.
- getReadDate() - Method in class org.springframework.http.ContentDisposition
-
Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.
- getReader() - Method in class org.springframework.web.util.ContentCachingRequestWrapper
- getReaders() - Method in interface org.springframework.http.codec.CodecConfigurer
-
Obtain the configured HTTP message readers.
- getReaders() - Method in class org.springframework.http.codec.support.DefaultClientCodecConfigurer
- getReadHints(ResolvableType, ResolvableType, ServerHttpRequest, ServerHttpResponse) - Method in class org.springframework.http.codec.DecoderHttpMessageReader
-
Get additional hints for decoding for example based on the server request or annotations from controller method parameters.
- getReadHints(ResolvableType, ResolvableType, ServerHttpRequest, ServerHttpResponse) - Method in class org.springframework.http.codec.ResourceHttpMessageReader
- getReadHints(ResolvableType, ReactiveHttpInputMessage) - Method in class org.springframework.http.codec.DecoderHttpMessageReader
-
Get additional hints for decoding based on the input HTTP message.
- getReadHints(ResolvableType, ReactiveHttpInputMessage) - Method in class org.springframework.http.codec.ResourceHttpMessageReader
- getRealPath(ServletContext, String) - Static method in class org.springframework.web.util.WebUtils
-
Return the real path of the given path within the web application, as provided by the servlet container.
- getReason() - Method in exception org.springframework.web.server.ResponseStatusException
-
The reason explaining the exception (potentially
null
or empty). - getReasonPhrase() - Method in enum class org.springframework.http.HttpStatus
-
Return the reason phrase of this status code.
- getRedirectStatus() - Method in class org.springframework.web.filter.RelativeRedirectFilter
-
Return the configured redirect status.
- getRemoteAddress() - Method in interface org.springframework.http.server.reactive.ServerHttpRequest
-
Return the remote address where this request is connected to, if available.
- getRemoteAddress() - Method in class org.springframework.http.server.reactive.ServerHttpRequestDecorator
- getRemoteAddress() - Method in interface org.springframework.http.server.ServerHttpRequest
-
Return the address of the remote client.
- getRemoteAddress() - Method in class org.springframework.http.server.ServletServerHttpRequest
- getRemoteUser() - Method in class org.springframework.web.context.request.FacesWebRequest
- getRemoteUser() - Method in class org.springframework.web.context.request.ServletWebRequest
- getRemoteUser() - Method in interface org.springframework.web.context.request.WebRequest
-
Return the remote user for this request, if any.
- getRequest() - Method in class org.springframework.http.client.support.HttpRequestWrapper
-
Return the wrapped request.
- getRequest() - Method in class org.springframework.web.bind.ServletRequestDataBinder.ServletRequestValueResolver
- getRequest() - Method in class org.springframework.web.context.request.ServletRequestAttributes
-
Exposes the native
HttpServletRequest
that we're wrapping. - getRequest() - Method in class org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest
- getRequest() - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- getRequest() - Method in interface org.springframework.web.server.ServerWebExchange
-
Return the current HTTP request.
- getRequest() - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- getRequestAttributes() - Static method in class org.springframework.web.context.request.RequestContextHolder
-
Return the RequestAttributes currently bound to the thread.
- getRequestFactory() - Method in class org.springframework.http.client.support.HttpAccessor
-
Return the request factory that this accessor uses for obtaining client request handles.
- getRequestFactory() - Method in class org.springframework.http.client.support.InterceptingHttpAccessor
-
Overridden to expose an
InterceptingClientHttpRequestFactory
if necessary. - getRequestHeaders() - Method in interface org.springframework.web.multipart.MultipartHttpServletRequest
-
Return this request's headers as a convenient HttpHeaders instance.
- getRequestHeaders() - Method in class org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest
- getRequestMethod() - Method in interface org.springframework.web.multipart.MultipartHttpServletRequest
-
Return this request's method as a convenient HttpMethod instance.
- getRequestMethod() - Method in class org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest
- getRequestParameter(String, Class<?>) - Method in class org.springframework.web.bind.ServletRequestDataBinder.ServletRequestValueResolver
- getRequestParams() - Method in exception org.springframework.web.server.UnsatisfiedRequestParameterException
-
Return the actual request parameters.
- getRequestPartName() - Method in exception org.springframework.web.multipart.support.MissingServletRequestPartException
-
Return the name of the offending part of the multipart request.
- getRequestUri(HttpServletRequest) - Method in class org.springframework.web.util.UrlPathHelper
-
Return the request URI for the given request, detecting an include request URL if called within a RequestDispatcher include.
- getRequestUrl() - Method in class org.springframework.web.context.support.ServletRequestHandledEvent
-
Return the URL of the request.
- getRequiredAttribute(String) - Method in interface org.springframework.web.server.ServerWebExchange
-
Return the request attribute value or if not present raise an
IllegalArgumentException
. - getRequiredAttribute(String) - Method in interface org.springframework.web.server.WebSession
-
Return the session attribute value or if not present raise an
IllegalArgumentException
. - getRequiredBooleanParameter(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get a boolean parameter, throwing an exception if it isn't found or isn't a boolean.
- getRequiredBooleanParameters(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get an array of boolean parameters, throwing an exception if not found or one isn't a boolean.
- getRequiredDoubleParameter(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get a double parameter, throwing an exception if it isn't found or isn't a number.
- getRequiredDoubleParameters(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get an array of double parameters, throwing an exception if not found or one is not a number.
- getRequiredFloatParameter(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get a float parameter, throwing an exception if it isn't found or isn't a number.
- getRequiredFloatParameters(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get an array of float parameters, throwing an exception if not found or one is not a number.
- getRequiredIntParameter(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get an int parameter, throwing an exception if it isn't found or isn't a number.
- getRequiredIntParameters(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get an array of int parameters, throwing an exception if not found or one is not a number.
- getRequiredLongParameter(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get a long parameter, throwing an exception if it isn't found or isn't a number.
- getRequiredLongParameters(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get an array of long parameters, throwing an exception if not found or one is not a number.
- getRequiredSessionAttribute(HttpServletRequest, String) - Static method in class org.springframework.web.util.WebUtils
-
Check the given request for a session attribute of the given name.
- getRequiredStringParameter(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get a String parameter, throwing an exception if it isn't found.
- getRequiredStringParameters(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get an array of String parameters, throwing an exception if not found.
- getRequiredWebApplicationContext(FacesContext) - Static method in class org.springframework.web.jsf.FacesContextUtils
-
Find the root
WebApplicationContext
for this web app, typically loaded viaContextLoaderListener
. - getRequiredWebApplicationContext(ServletContext) - Static method in class org.springframework.web.context.support.WebApplicationContextUtils
-
Find the root
WebApplicationContext
for this web app, typically loaded viaContextLoaderListener
. - getResolvedFromHandlerMethod() - Method in class org.springframework.web.method.HandlerMethod
-
Return the HandlerMethod from which this HandlerMethod instance was resolved via
HandlerMethod.createWithResolvedBean()
. - getResolvedLookupPath(ServletRequest) - Static method in class org.springframework.web.util.UrlPathHelper
-
Return a previously
resolved
lookupPath. - getResolvers() - Method in class org.springframework.web.method.support.HandlerMethodArgumentResolverComposite
-
Return a read-only list with the contained resolvers, or an empty list.
- getResource() - Method in interface org.springframework.web.multipart.MultipartFile
-
Return a Resource representation of this MultipartFile.
- getResourceByPath(String) - Method in class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
-
This implementation supports file paths beneath the root of the ServletContext.
- getResourceByPath(String) - Method in class org.springframework.web.context.support.GenericWebApplicationContext
-
This implementation supports file paths beneath the root of the
ServletContext
. - getResourceByPath(String) - Method in class org.springframework.web.context.support.ServletContextResourceLoader
-
This implementation supports file paths beneath the root of the web application.
- getResourceByPath(String) - Method in class org.springframework.web.context.support.StaticWebApplicationContext
-
This implementation supports file paths beneath the root of the ServletContext.
- getResourcePatternResolver() - Method in class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
-
This implementation supports pattern matching in unexpanded WARs too.
- getResourcePatternResolver() - Method in class org.springframework.web.context.support.GenericWebApplicationContext
-
This implementation supports pattern matching in unexpanded WARs too.
- getResourcePatternResolver() - Method in class org.springframework.web.context.support.StaticWebApplicationContext
-
This implementation supports pattern matching in unexpanded WARs too.
- getResponse() - Method in class org.springframework.web.context.request.ServletRequestAttributes
-
Exposes the native
HttpServletResponse
that we're wrapping (if any). - getResponse() - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- getResponse() - Method in interface org.springframework.web.server.ServerWebExchange
-
Return the current HTTP response.
- getResponse() - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- getResponseBody() - Method in exception org.springframework.web.client.UnknownContentTypeException
-
Return the response body as a byte array.
- getResponseBody(ClientHttpResponse) - Method in class org.springframework.web.client.DefaultResponseErrorHandler
-
Read the body of the given response (for inclusion in a status exception).
- getResponseBodyAs(Class<E>) - Method in exception org.springframework.web.client.RestClientResponseException
-
Convert the error response content to the specified type.
- getResponseBodyAs(ParameterizedTypeReference<E>) - Method in exception org.springframework.web.client.RestClientResponseException
-
Variant of
RestClientResponseException.getResponseBodyAs(Class)
withParameterizedTypeReference
. - getResponseBodyAsByteArray() - Method in exception org.springframework.web.client.RestClientResponseException
-
Return the response body as a byte array.
- getResponseBodyAsString() - Method in exception org.springframework.web.client.RestClientResponseException
-
Return the response body converted to String.
- getResponseBodyAsString() - Method in exception org.springframework.web.client.UnknownContentTypeException
-
Return the response body converted to String using the charset from the response "Content-Type" or
"UTF-8"
otherwise. - getResponseBodyAsString(Charset) - Method in exception org.springframework.web.client.RestClientResponseException
-
Return the response body converted to String.
- getResponseEncodedHtmlEscape(ServletContext) - Static method in class org.springframework.web.util.WebUtils
-
Return whether response encoding should be used when HTML escaping characters, thus only escaping XML markup significant characters with UTF-* encodings.
- getResponseHeaders() - Method in exception org.springframework.web.client.RestClientResponseException
-
Return the HTTP response headers.
- getResponseHeaders() - Method in exception org.springframework.web.client.UnknownContentTypeException
-
Return the HTTP response headers.
- getResponseHeaders() - Method in exception org.springframework.web.server.MethodNotAllowedException
-
Deprecated.as of 6.0 in favor of
MethodNotAllowedException.getHeaders()
- getResponseHeaders() - Method in exception org.springframework.web.server.NotAcceptableStatusException
-
Deprecated.as of 6.0 in favor of
NotAcceptableStatusException.getHeaders()
- getResponseHeaders() - Method in exception org.springframework.web.server.ResponseStatusException
-
Deprecated.as of 6.0 in favor of
ResponseStatusException.getHeaders()
- getResponseHeaders() - Method in exception org.springframework.web.server.UnsupportedMediaTypeStatusException
-
Deprecated.as of 6.0 in favor of
UnsupportedMediaTypeStatusException.getHeaders()
- getResponseStatus() - Method in class org.springframework.web.method.HandlerMethod
-
Return the specified response status, if any.
- getResponseStatusReason() - Method in class org.springframework.web.method.HandlerMethod
-
Return the associated response status reason, if any.
- getRestTemplate() - Method in class org.springframework.web.client.support.RestGatewaySupport
-
Returns the
RestTemplate
for the gateway. - getResult() - Method in class org.springframework.web.context.request.async.DeferredResult
-
Return the result, or
null
if the result wasn't set. - getRootApplicationContextInitializers() - Method in class org.springframework.web.context.AbstractContextLoaderInitializer
-
Specify application context initializers to be applied to the root application context that the
ContextLoaderListener
is being created with. - getSameSite() - Method in class org.springframework.http.ResponseCookie
-
Return the cookie "SameSite" attribute, or
null
if not set. - getScheduler() - Method in class org.springframework.http.client.reactive.JettyResourceFactory
-
Return the configured
Scheduler
. - getScheme() - Method in class org.springframework.web.util.UriComponents
-
Return the scheme.
- getSchemeSpecificPart() - Method in class org.springframework.web.util.UriComponents
-
Return the scheme specific part.
- getScope() - Method in class org.springframework.web.context.request.AbstractRequestAttributesScope
-
Template method that determines the actual target scope.
- getScope() - Method in class org.springframework.web.context.request.RequestScope
- getScope() - Method in class org.springframework.web.context.request.SessionScope
- getScope(String) - Static method in class org.springframework.web.util.TagUtils
-
Determines the scope for a given input
String
. - getScopeMetadataResolver() - Method in class org.springframework.web.context.support.AnnotationConfigWebApplicationContext
-
Return the custom
ScopeMetadataResolver
for use withAnnotatedBeanDefinitionReader
and/orClassPathBeanDefinitionScanner
, if any. - getSerializationView() - Method in class org.springframework.http.converter.json.MappingJacksonValue
-
Return the serialization view to use.
- getServletConfig() - Method in class org.springframework.http.server.reactive.ServletHttpHandlerAdapter
- getServletConfig() - Method in interface org.springframework.web.context.ConfigurableWebApplicationContext
-
Return the ServletConfig for this web application context, if any.
- getServletConfig() - Method in class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
- getServletConfig() - Method in class org.springframework.web.context.support.GenericWebApplicationContext
- getServletConfig() - Method in class org.springframework.web.context.support.ServletContextAwareProcessor
-
Returns the
ServletConfig
to be injected ornull
. - getServletConfig() - Method in class org.springframework.web.context.support.StaticWebApplicationContext
- getServletContext() - Method in class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
- getServletContext() - Method in class org.springframework.web.context.support.GenericWebApplicationContext
- getServletContext() - Method in class org.springframework.web.context.support.ServletContextAwareProcessor
-
Returns the
ServletContext
to be injected ornull
. - getServletContext() - Method in class org.springframework.web.context.support.ServletContextResource
-
Return the ServletContext for this resource.
- getServletContext() - Method in class org.springframework.web.context.support.StaticWebApplicationContext
- getServletContext() - Method in class org.springframework.web.context.support.WebApplicationObjectSupport
-
Return the current ServletContext.
- getServletContext() - Method in interface org.springframework.web.context.WebApplicationContext
-
Return the standard Servlet API ServletContext for this application.
- getServletContext() - Method in class org.springframework.web.filter.GenericFilterBean
-
Make the ServletContext of this filter available to subclasses.
- getServletInfo() - Method in class org.springframework.http.server.reactive.ServletHttpHandlerAdapter
- getServletMapping() - Method in class org.springframework.web.server.adapter.AbstractReactiveWebInitializer
-
Return the Servlet mapping to use.
- getServletName() - Method in class org.springframework.web.context.support.ServletRequestHandledEvent
-
Return the name of the servlet that handled the request.
- getServletName() - Method in class org.springframework.web.server.adapter.AbstractReactiveWebInitializer
-
Return the name to use to register the
ServletHttpHandlerAdapter
. - getServletPath() - Method in class org.springframework.http.server.reactive.ServletHttpHandlerAdapter
-
Return the Servlet path under which the Servlet is deployed by checking the Servlet registration from
ServletHttpHandlerAdapter.init(ServletConfig)
. - getServletPath(HttpServletRequest) - Method in class org.springframework.web.util.UrlPathHelper
-
Return the servlet path for the given request, regarding an include request URL if called within a RequestDispatcher include.
- getServletRequest() - Method in class org.springframework.http.server.ServletServerHttpRequest
-
Returns the
HttpServletRequest
this object is based on. - getServletResponse() - Method in class org.springframework.http.server.ServletServerHttpResponse
-
Return the
HttpServletResponse
this object is based on. - getSession() - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- getSession() - Method in interface org.springframework.web.server.ServerWebExchange
-
Return the web session for the current request.
- getSession() - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- getSession(boolean) - Method in class org.springframework.web.context.request.ServletRequestAttributes
-
Exposes the
HttpSession
that we're wrapping. - getSession(ServerWebExchange) - Method in class org.springframework.web.server.session.DefaultWebSessionManager
- getSession(ServerWebExchange) - Method in interface org.springframework.web.server.session.WebSessionManager
-
Return the
WebSession
for the given exchange. - getSessionAttribute(HttpServletRequest, String) - Static method in class org.springframework.web.util.WebUtils
-
Check the given request for a session attribute of the given name.
- getSessionId() - Method in interface org.springframework.http.server.reactive.SslInfo
-
Return the SSL session id, if any.
- getSessionId() - Method in class org.springframework.web.context.request.FacesRequestAttributes
- getSessionId() - Method in interface org.springframework.web.context.request.RequestAttributes
-
Return an id for the current underlying session.
- getSessionId() - Method in class org.springframework.web.context.request.ServletRequestAttributes
- getSessionId() - Method in class org.springframework.web.context.support.RequestHandledEvent
-
Return the id of the HTTP session, if any.
- getSessionId(HttpServletRequest) - Static method in class org.springframework.web.util.WebUtils
-
Determine the session id of the given request, if any.
- getSessionIdResolver() - Method in class org.springframework.web.server.session.DefaultWebSessionManager
-
Return the configured
WebSessionIdResolver
. - getSessionManager() - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
Return the configured
WebSessionManager
. - getSessionMutex() - Method in class org.springframework.web.context.request.FacesRequestAttributes
- getSessionMutex() - Method in interface org.springframework.web.context.request.RequestAttributes
-
Expose the best available mutex for the underlying session: that is, an object to synchronize on for the underlying session.
- getSessionMutex() - Method in class org.springframework.web.context.request.ServletRequestAttributes
- getSessionMutex(FacesContext) - Static method in class org.springframework.web.jsf.FacesContextUtils
-
Return the best available mutex for the given session: that is, an object to synchronize on for the given session.
- getSessionMutex(HttpSession) - Static method in class org.springframework.web.util.WebUtils
-
Return the best available mutex for the given session: that is, an object to synchronize on for the given session.
- getSessions() - Method in class org.springframework.web.server.session.InMemoryWebSessionStore
-
Return the map of sessions with an
unmodifiable
wrapper. - getSessionStatus() - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Return the
SessionStatus
instance to use that can be used to signal that session processing is complete. - getSessionStore() - Method in class org.springframework.web.server.session.DefaultWebSessionManager
-
Return the configured
WebSessionStore
. - getShortDescription() - Method in class org.springframework.web.context.support.RequestHandledEvent
-
Return a short description of this event, only involving the most important context data.
- getShortDescription() - Method in class org.springframework.web.context.support.ServletRequestHandledEvent
- getShortLogMessage() - Method in class org.springframework.web.method.HandlerMethod
-
Return a short representation of this handler method for log message purposes.
- getSize() - Method in class org.springframework.http.ContentDisposition
-
Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.
- getSize() - Method in interface org.springframework.web.multipart.MultipartFile
-
Return the size of the file in bytes.
- getSource() - Method in class org.springframework.web.bind.EscapedErrors
- getSslInfo() - Method in class org.springframework.http.server.reactive.AbstractServerHttpRequest
- getSslInfo() - Method in interface org.springframework.http.server.reactive.ServerHttpRequest
-
Return the SSL session information if the request has been transmitted over a secure protocol including SSL certificates, if available.
- getSslInfo() - Method in class org.springframework.http.server.reactive.ServerHttpRequestDecorator
- getStatus() - Method in interface org.springframework.http.converter.json.ProblemDetailJacksonXmlMixin
- getStatus() - Method in class org.springframework.http.ProblemDetail
-
Return the status associated with the problem, provided either to the constructor or configured via
ProblemDetail.setStatus(int)
. - getStatus() - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Return the configured HTTP status, if any.
- getStatusCode() - Method in class org.springframework.http.client.AbstractClientHttpResponse
-
Deprecated.
- getStatusCode() - Method in interface org.springframework.http.client.ClientHttpResponse
-
Get the HTTP status code as an
HttpStatusCode
. - getStatusCode() - Method in class org.springframework.http.client.reactive.AbstractClientHttpResponse
- getStatusCode() - Method in interface org.springframework.http.client.reactive.ClientHttpResponse
-
Return the HTTP status code as an
HttpStatusCode
. - getStatusCode() - Method in class org.springframework.http.client.reactive.ClientHttpResponseDecorator
- getStatusCode() - Method in class org.springframework.http.ResponseEntity
-
Return the HTTP status code of the response.
- getStatusCode() - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
- getStatusCode() - Method in interface org.springframework.http.server.reactive.ServerHttpResponse
-
Return the status code that has been set, or otherwise fall back on the status of the response from the underlying server.
- getStatusCode() - Method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
- getStatusCode() - Method in exception org.springframework.web.bind.MethodArgumentNotValidException
- getStatusCode() - Method in exception org.springframework.web.bind.MissingPathVariableException
- getStatusCode() - Method in exception org.springframework.web.bind.ServletRequestBindingException
- getStatusCode() - Method in exception org.springframework.web.client.RestClientResponseException
-
Return the HTTP status code.
- getStatusCode() - Method in exception org.springframework.web.client.UnknownContentTypeException
-
Return the HTTP status code value.
- getStatusCode() - Method in exception org.springframework.web.context.request.async.AsyncRequestTimeoutException
- getStatusCode() - Method in class org.springframework.web.context.support.ServletRequestHandledEvent
-
Return the HTTP status code of the response or -1 if the status code is not available.
- getStatusCode() - Method in interface org.springframework.web.ErrorResponse
-
Return the HTTP status code to use for the response.
- getStatusCode() - Method in exception org.springframework.web.ErrorResponseException
- getStatusCode() - Method in exception org.springframework.web.HttpMediaTypeNotAcceptableException
- getStatusCode() - Method in exception org.springframework.web.HttpMediaTypeNotSupportedException
- getStatusCode() - Method in exception org.springframework.web.HttpRequestMethodNotSupportedException
- getStatusCode() - Method in exception org.springframework.web.multipart.MaxUploadSizeExceededException
- getStatusCode() - Method in exception org.springframework.web.multipart.support.MissingServletRequestPartException
-
Return the HTTP status code to use for the response.
- getStatusCodeValue() - Method in class org.springframework.http.ResponseEntity
-
Deprecated.as of 6.0, in favor of
ResponseEntity.getStatusCode()
; scheduled for removal in 7.0 - getStatusText() - Method in interface org.springframework.http.client.ClientHttpResponse
-
Get the HTTP status text of the response.
- getStatusText() - Method in exception org.springframework.web.client.RestClientResponseException
-
Return the HTTP status text.
- getStatusText() - Method in exception org.springframework.web.client.UnknownContentTypeException
-
Return the HTTP status text.
- getStrategies() - Method in class org.springframework.web.accept.ContentNegotiationManager
-
Return the configured content negotiation strategies.
- getStrategy(Class<T>) - Method in class org.springframework.web.accept.ContentNegotiationManager
-
Find a
ContentNegotiationStrategy
of the given type. - getStreamingMediaTypes() - Method in interface org.springframework.http.codec.HttpMessageEncoder
-
Return "streaming" media types for which flushing should be performed automatically vs at the end of the input stream.
- getStreamingMediaTypes() - Method in class org.springframework.http.codec.json.AbstractJackson2Encoder
- getStreamingMediaTypes() - Method in class org.springframework.http.codec.protobuf.ProtobufEncoder
- getStreamingMediaTypeSeparator(MimeType) - Method in class org.springframework.http.codec.json.AbstractJackson2Encoder
-
Return the separator to use for the given mime type.
- getStreamingMediaTypeSeparator(MimeType) - Method in class org.springframework.http.codec.json.Jackson2SmileEncoder
-
Return the separator to use for the given mime type.
- getStringParameter(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get a String parameter, or
null
if not present. - getStringParameter(ServletRequest, String, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get a String parameter, with a fallback value.
- getStringParameters(ServletRequest, String) - Static method in class org.springframework.web.bind.ServletRequestUtils
-
Get an array of String parameters, return an empty array if not found.
- getSupportedHttpMethods() - Method in exception org.springframework.web.HttpRequestMethodNotSupportedException
-
Return the actually supported HTTP methods as
HttpMethod
instances, ornull
if not known. - getSupportedLocales() - Method in class org.springframework.web.server.i18n.AcceptHeaderLocaleContextResolver
-
Return the configured list of supported locales.
- getSupportedMediaTypes() - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
- getSupportedMediaTypes() - Method in class org.springframework.http.converter.BufferedImageHttpMessageConverter
- getSupportedMediaTypes() - Method in class org.springframework.http.converter.FormHttpMessageConverter
-
Return the list of media types supported by this converter.
- getSupportedMediaTypes() - Method in interface org.springframework.http.converter.HttpMessageConverter
-
Return the list of media types supported by this converter.
- getSupportedMediaTypes() - Method in exception org.springframework.web.HttpMediaTypeException
-
Return the list of supported media types.
- getSupportedMediaTypes() - Method in exception org.springframework.web.server.NotAcceptableStatusException
-
Return the list of supported content types in cases when the Accept header is parsed but not supported, or an empty list otherwise.
- getSupportedMediaTypes() - Method in exception org.springframework.web.server.UnsupportedMediaTypeStatusException
-
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(Class<?>) - Method in interface org.springframework.http.converter.HttpMessageConverter
-
Return the list of media types supported by this converter for the given class.
- getSupportedMediaTypes(Class<?>) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
- getSupportedMethods() - Method in exception org.springframework.web.HttpRequestMethodNotSupportedException
-
Return the actually supported HTTP methods, or
null
if not known. - getSupportedMethods() - Method in exception org.springframework.web.server.MethodNotAllowedException
-
Return the list of supported HTTP methods.
- getSuppressedFields() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getTarget() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- getTarget() - Method in exception org.springframework.web.method.annotation.HandlerMethodValidationException
- getTargetBeanName() - Method in class org.springframework.web.filter.DelegatingFilterProxy
-
Return the name of the target bean in the Spring application context.
- getTargetBeanName(FacesContext) - Method in class org.springframework.web.jsf.DelegatingNavigationHandlerProxy
-
Return the name of the target NavigationHandler bean in the BeanFactory.
- getTargetType() - Method in exception org.springframework.web.client.UnknownContentTypeException
-
Return the target type expected for the response.
- getTempDir() - Method in class org.springframework.web.context.support.WebApplicationObjectSupport
-
Return the temporary directory for the current web application, as provided by the servlet container.
- getTempDir(ServletContext) - Static method in class org.springframework.web.util.WebUtils
-
Return the temporary directory for the current web application, as provided by the servlet container.
- getTheme(String) - Method in class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
-
Deprecated.
- getTheme(String) - Method in class org.springframework.web.context.support.GenericWebApplicationContext
-
Deprecated.
- getTheme(String) - Method in class org.springframework.web.context.support.StaticWebApplicationContext
-
Deprecated.
- getTimeout() - Method in class org.springframework.web.context.request.async.WebAsyncTask
-
Return the timeout value in milliseconds, or
null
if no timeout is set. - getTitle() - Method in interface org.springframework.http.converter.json.ProblemDetailJacksonXmlMixin
- getTitle() - Method in class org.springframework.http.ProblemDetail
-
Return the configured
problem title
. - getTitleMessageCode() - Method in interface org.springframework.web.ErrorResponse
-
Return a code to use to resolve the problem "title" for this exception through a
MessageSource
. - getType() - Method in class org.springframework.http.ContentDisposition
-
Return the disposition type.
- getType() - Method in interface org.springframework.http.converter.json.ProblemDetailJacksonXmlMixin
- getType() - Method in class org.springframework.http.ProblemDetail
-
Return the configured
problem type
. - getType() - Method in class org.springframework.http.RequestEntity
-
Return the type of the request's body.
- getType() - Method in exception org.springframework.web.server.MissingRequestValueException
-
Return the target type the value is converted when present.
- getType(ELContext, Object, Object) - Method in class org.springframework.web.jsf.el.SpringBeanFacesELResolver
- getType(ELContext, Object, Object) - Method in class org.springframework.web.jsf.el.WebApplicationContextFacesELResolver
- getTypeMessageCode() - Method in interface org.springframework.web.ErrorResponse
-
Return a code to use to resolve the problem "type" for this exception through a
MessageSource
. - getUnmarshallerProcessor() - Method in class org.springframework.http.codec.xml.Jaxb2XmlDecoder
-
Return the configured processor for customizing Unmarshaller instances.
- getUpgrade() - Method in class org.springframework.http.HttpHeaders
-
Return the value of the
Upgrade
header. - getUri() - Method in class org.springframework.web.service.invoker.HttpRequestValues
-
Return the URL to use.
- getURI() - Method in interface org.springframework.http.client.reactive.ClientHttpRequest
-
Return the URI of the request.
- getURI() - Method in class org.springframework.http.client.reactive.ClientHttpRequestDecorator
- getURI() - Method in class org.springframework.http.client.support.HttpRequestWrapper
-
Return the URI of the wrapped request.
- getURI() - Method in interface org.springframework.http.HttpRequest
-
Return the URI of the request (including a query string if any, but only if it is well-formed for a URI representation).
- getURI() - Method in class org.springframework.http.server.reactive.AbstractServerHttpRequest
- getURI() - Method in class org.springframework.http.server.reactive.ServerHttpRequestDecorator
- getURI() - Method in class org.springframework.http.server.ServletServerHttpRequest
- getUriBuilderFactory() - Method in class org.springframework.web.service.invoker.HttpRequestValues
-
Return the
UriBuilderFactory
to expand theHttpRequestValues.uriTemplate
andHttpRequestValues.getUriVariables()
with. - getUriTemplate() - Method in class org.springframework.http.client.observation.ClientRequestObservationContext
-
Return the URI template used for the current client exchange,
null
if none was used. - getUriTemplate() - Method in class org.springframework.http.RequestEntity.UriTemplateRequestEntity
- getUriTemplate() - Method in class org.springframework.web.service.invoker.HttpRequestValues
-
Return the URL template for the request.
- getUriTemplateHandler() - Method in class org.springframework.web.client.RestTemplate
-
Return the configured URI template handler.
- getUriVariables() - Method in class org.springframework.web.service.invoker.HttpRequestValues
-
Return the URL template variables, or an empty map.
- getUriVariables() - Method in class org.springframework.web.util.pattern.PathPattern.PathMatchInfo
-
Return the extracted URI variables.
- getUriVariables() - Method in class org.springframework.web.util.pattern.PathPattern.PathRemainingMatchInfo
-
Return variables that were bound in the part of the path that was successfully matched or an empty map.
- getUrl() - Method in class org.springframework.http.RequestEntity
-
Return the
URI
for the target HTTP endpoint. - getURL() - Method in class org.springframework.web.context.support.ServletContextResource
-
This implementation delegates to
ServletContext.getResource
, but throws a FileNotFoundException if no resource found. - getUserInfo() - Method in class org.springframework.web.util.UriComponents
-
Return the user info.
- getUserName() - Method in class org.springframework.web.context.support.RequestHandledEvent
-
Return the name of the user that was associated with the request (usually the UserPrincipal).
- getUserPrincipal() - Method in class org.springframework.web.context.request.FacesWebRequest
- getUserPrincipal() - Method in class org.springframework.web.context.request.ServletWebRequest
- getUserPrincipal() - Method in interface org.springframework.web.context.request.WebRequest
-
Return the user principal for this request, if any.
- getValidator() - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Return the Validator to apply after each binding step, if any.
- getValue() - Method in class org.springframework.http.converter.json.MappingJacksonValue
-
Return the POJO that needs to be serialized.
- getValue() - Method in class org.springframework.http.HttpCookie
-
Return the cookie value or an empty string (never
null
). - getValue(ELContext, Object, Object) - Method in class org.springframework.web.jsf.el.SpringBeanFacesELResolver
- getValue(ELContext, Object, Object) - Method in class org.springframework.web.jsf.el.WebApplicationContextFacesELResolver
- getValue(String) - Method in interface org.springframework.web.util.UriComponents.UriTemplateVariables
-
Get the value for the given URI variable name.
- getValuesAsList(String) - Method in class org.springframework.http.HttpHeaders
-
Return all values of a given header name, even if this header is set multiple times.
- getValuesToBind(ServerWebExchange) - Method in class org.springframework.web.bind.support.WebExchangeDataBinder
-
Obtain the values for data binding.
- getVariableName() - Method in exception org.springframework.web.bind.MissingMatrixVariableException
-
Return the expected name of the matrix variable.
- getVariableName() - Method in exception org.springframework.web.bind.MissingPathVariableException
-
Return the expected name of the path variable.
- getVariableNames() - Method in class org.springframework.web.util.UriTemplate
-
Return the names of the variables in the template, in order.
- getVars() - Method in class org.springframework.http.RequestEntity.UriTemplateRequestEntity
- getVarsMap() - Method in class org.springframework.http.RequestEntity.UriTemplateRequestEntity
- getVary() - Method in class org.springframework.http.HttpHeaders
-
Return the request header names subject to content negotiation.
- getView() - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Return the View object, or
null
if we are using a view name to be resolved by the DispatcherServlet via a ViewResolver. - getViewName() - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Return the view name to be resolved by the DispatcherServlet via a ViewResolver, or
null
if a View object is set. - getWebApplicationContext() - Method in class org.springframework.web.bind.support.SpringWebConstraintValidatorFactory
-
Retrieve the Spring
WebApplicationContext
to use. - getWebApplicationContext() - Method in class org.springframework.web.context.support.ContextExposingHttpServletRequest
-
Return the WebApplicationContext that this request runs in.
- getWebApplicationContext() - Method in class org.springframework.web.context.support.WebApplicationObjectSupport
-
Return the current application context as WebApplicationContext.
- getWebApplicationContext(ELContext) - Method in class org.springframework.web.jsf.el.SpringBeanFacesELResolver
-
Retrieve the web application context to delegate bean name resolution to.
- getWebApplicationContext(ELContext) - Method in class org.springframework.web.jsf.el.WebApplicationContextFacesELResolver
-
Retrieve the
WebApplicationContext
reference to expose. - getWebApplicationContext(FacesContext) - Method in class org.springframework.web.jsf.DelegatingNavigationHandlerProxy
-
Retrieve the web application context to delegate bean name resolution to.
- getWebApplicationContext(FacesContext) - Method in class org.springframework.web.jsf.DelegatingPhaseListenerMulticaster
-
Retrieve the web application context to delegate bean name resolution to.
- getWebApplicationContext(FacesContext) - Static method in class org.springframework.web.jsf.FacesContextUtils
-
Find the root
WebApplicationContext
for this web app, typically loaded viaContextLoaderListener
. - getWebApplicationContext(ServletContext) - Static method in class org.springframework.web.context.support.WebApplicationContextUtils
-
Find the root
WebApplicationContext
for this web app, typically loaded viaContextLoaderListener
. - getWebApplicationContext(ServletContext, String) - Static method in class org.springframework.web.context.support.WebApplicationContextUtils
-
Find a custom
WebApplicationContext
for this web app. - getWebRequest() - Method in class org.springframework.web.method.annotation.AbstractWebArgumentResolverAdapter
-
Required for access to NativeWebRequest in
AbstractWebArgumentResolverAdapter.supportsParameter(org.springframework.core.MethodParameter)
. - getWritableMediaTypes() - Method in class org.springframework.http.codec.EncoderHttpMessageWriter
- getWritableMediaTypes() - Method in class org.springframework.http.codec.FormHttpMessageWriter
- getWritableMediaTypes() - Method in interface org.springframework.http.codec.HttpMessageWriter
-
Return the list of media types supported by this Writer.
- getWritableMediaTypes() - Method in class org.springframework.http.codec.multipart.MultipartWriterSupport
- getWritableMediaTypes() - Method in class org.springframework.http.codec.ResourceHttpMessageWriter
- getWritableMediaTypes() - Method in class org.springframework.http.codec.ServerSentEventHttpMessageWriter
- getWritableMediaTypes(ResolvableType) - Method in class org.springframework.http.codec.EncoderHttpMessageWriter
- getWritableMediaTypes(ResolvableType) - Method in interface org.springframework.http.codec.HttpMessageWriter
-
Return the list of media types supported by this Writer for the given type of element.
- getWriteHints(ResolvableType, ResolvableType, MediaType, ServerHttpRequest, ServerHttpResponse) - Method in class org.springframework.http.codec.EncoderHttpMessageWriter
-
Get additional hints for encoding for example based on the server request or annotations from controller method parameters.
- getWriter() - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- getWriters() - Method in interface org.springframework.http.codec.CodecConfigurer
-
Obtain the configured HTTP message writers.
- getWriters() - Method in class org.springframework.http.codec.support.DefaultClientCodecConfigurer
- GLOBAL_INITIALIZER_CLASSES_PARAM - Static variable in class org.springframework.web.context.ContextLoader
-
Config param for global
ApplicationContextInitializer
classes to use for initializing all web application contexts in the current application: "globalInitializerClasses". - GONE - Enum constant in enum class org.springframework.http.HttpStatus
-
410 Gone
. - GroovyWebApplicationContext - Class in org.springframework.web.context.support
-
WebApplicationContext
implementation which takes its configuration from Groovy bean definition scripts and/or XML files, as understood by aGroovyBeanDefinitionReader
. - GroovyWebApplicationContext() - Constructor for class org.springframework.web.context.support.GroovyWebApplicationContext
- GsonBuilderUtils - Class in org.springframework.http.converter.json
-
A simple utility class for obtaining a Google Gson 2.x
GsonBuilder
which Base64-encodesbyte[]
properties when reading and writing JSON. - GsonBuilderUtils() - Constructor for class org.springframework.http.converter.json.GsonBuilderUtils
- gsonBuilderWithBase64EncodedByteArrays() - Static method in class org.springframework.http.converter.json.GsonBuilderUtils
-
Obtain a
GsonBuilder
which Base64-encodesbyte[]
properties when reading and writing JSON. - GsonFactoryBean - Class in org.springframework.http.converter.json
-
A
FactoryBean
for creating a Google Gson 2.xGson
instance. - GsonFactoryBean() - Constructor for class org.springframework.http.converter.json.GsonFactoryBean
- GsonHttpMessageConverter - Class in org.springframework.http.converter.json
-
Implementation of
HttpMessageConverter
that can read and write JSON using the Google Gson library. - GsonHttpMessageConverter() - Constructor for class org.springframework.http.converter.json.GsonHttpMessageConverter
-
Construct a new
GsonHttpMessageConverter
with default configuration. - GsonHttpMessageConverter(Gson) - Constructor for class org.springframework.http.converter.json.GsonHttpMessageConverter
-
Construct a new
GsonHttpMessageConverter
with the given delegate.
H
- handle(HttpRequest, ClientHttpResponse) - Method in interface org.springframework.web.client.RestClient.ResponseSpec.ErrorHandler
-
Handle the error in the given response.
- handle(ServerHttpRequest, ServerHttpResponse) - Method in class org.springframework.http.server.reactive.ContextPathCompositeHandler
- handle(ServerHttpRequest, ServerHttpResponse) - Method in interface org.springframework.http.server.reactive.HttpHandler
-
Handle the given request and write to the response.
- handle(ServerHttpRequest, ServerHttpResponse) - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
- handle(ServerWebExchange) - Method in class org.springframework.web.server.handler.ExceptionHandlingWebHandler
- handle(ServerWebExchange) - Method in class org.springframework.web.server.handler.FilteringWebHandler
- handle(ServerWebExchange) - Method in class org.springframework.web.server.handler.WebHandlerDecorator
- handle(ServerWebExchange) - Method in interface org.springframework.web.server.WebHandler
-
Handle the web server exchange.
- handle(ServerWebExchange, Throwable) - Method in class org.springframework.web.server.handler.ResponseStatusExceptionHandler
- handle(ServerWebExchange, Throwable) - Method in interface org.springframework.web.server.WebExceptionHandler
-
Handle the given exception.
- handleContentOverflow(int) - Method in class org.springframework.web.util.ContentCachingRequestWrapper
-
Template method for handling a content overflow: specifically, a request body being read that exceeds the specified content cache limit.
- HANDLED_WEB_EXCEPTION - Static variable in class org.springframework.web.server.handler.ExceptionHandlingWebHandler
-
Name of the
attribute
that contains the exception handled byWebExceptionHandlers
. - handleError(URI, HttpMethod, ClientHttpResponse) - Method in interface org.springframework.web.client.ResponseErrorHandler
-
Alternative to
ResponseErrorHandler.handleError(ClientHttpResponse)
with extra information providing access to the request URL and HTTP method. - handleError(ClientHttpResponse) - Method in class org.springframework.web.client.DefaultResponseErrorHandler
-
Handle the error in the given response with the given resolved status code.
- handleError(ClientHttpResponse) - Method in interface org.springframework.web.client.ResponseErrorHandler
-
Handle the error in the given response.
- handleError(ClientHttpResponse, HttpStatusCode) - Method in class org.springframework.web.client.DefaultResponseErrorHandler
-
Handle the error based on the resolved status code.
- handleError(ClientHttpResponse, HttpStatusCode) - Method in class org.springframework.web.client.ExtractingResponseErrorHandler
- handleError(NativeWebRequest, Callable<T>, Throwable) - Method in interface org.springframework.web.context.request.async.CallableProcessingInterceptor
-
Invoked from a container thread when an error occurred while processing the async request before the
Callable
task completes. - handleError(NativeWebRequest, DeferredResult<T>, Throwable) - Method in interface org.springframework.web.context.request.async.DeferredResultProcessingInterceptor
-
Invoked from a container thread when an error occurred while processing an async request before the
DeferredResult
has been set. - handleInternal(ServerHttpRequest, ServerHttpResponse, CorsConfiguration, boolean) - Method in class org.springframework.web.cors.DefaultCorsProcessor
-
Handle the given request.
- handleInternal(ServerWebExchange, CorsConfiguration, boolean) - Method in class org.springframework.web.cors.reactive.DefaultCorsProcessor
-
Handle the given request.
- handleMatch(String, MediaType) - Method in class org.springframework.web.accept.AbstractMappingContentNegotiationStrategy
-
Override to provide handling when a key is successfully resolved via
MappingMediaTypeFileExtensionResolver.lookupMediaType(java.lang.String)
. - handleMissingValue(String, MethodParameter) - Method in class org.springframework.web.method.annotation.AbstractCookieValueMethodArgumentResolver
- handleMissingValue(String, MethodParameter) - Method in class org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver
-
Invoked when a named value is required, but
AbstractNamedValueMethodArgumentResolver.resolveName(String, MethodParameter, NativeWebRequest)
returnednull
and there is no default value. - handleMissingValue(String, MethodParameter) - Method in class org.springframework.web.method.annotation.ExpressionValueMethodArgumentResolver
- handleMissingValue(String, MethodParameter) - Method in class org.springframework.web.method.annotation.RequestHeaderMethodArgumentResolver
- handleMissingValue(String, MethodParameter, NativeWebRequest) - Method in class org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver
-
Invoked when a named value is required, but
AbstractNamedValueMethodArgumentResolver.resolveName(String, MethodParameter, NativeWebRequest)
returnednull
and there is no default value. - handleMissingValue(String, MethodParameter, NativeWebRequest) - Method in class org.springframework.web.method.annotation.RequestParamMethodArgumentResolver
- handleMissingValueAfterConversion(String, MethodParameter, NativeWebRequest) - Method in class org.springframework.web.method.annotation.AbstractCookieValueMethodArgumentResolver
- handleMissingValueAfterConversion(String, MethodParameter, NativeWebRequest) - Method in class org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver
-
Invoked when a named value is present but becomes
null
after conversion. - handleMissingValueAfterConversion(String, MethodParameter, NativeWebRequest) - Method in class org.springframework.web.method.annotation.RequestHeaderMethodArgumentResolver
- handleMissingValueAfterConversion(String, MethodParameter, NativeWebRequest) - Method in class org.springframework.web.method.annotation.RequestParamMethodArgumentResolver
- handleMissingValueInternal(String, MethodParameter, NativeWebRequest, boolean) - Method in class org.springframework.web.method.annotation.RequestParamMethodArgumentResolver
- handleNavigation(FacesContext, String, String) - Method in class org.springframework.web.jsf.DecoratingNavigationHandler
-
This implementation of the standard JSF
handleNavigation
method delegates to the overloaded variant, passing in constructor-injected NavigationHandler as argument. - handleNavigation(FacesContext, String, String) - Method in class org.springframework.web.jsf.DelegatingNavigationHandlerProxy
-
Handle the navigation request implied by the specified parameters, through delegating to the target bean in the Spring application context.
- handleNavigation(FacesContext, String, String, NavigationHandler) - Method in class org.springframework.web.jsf.DecoratingNavigationHandler
-
Special
handleNavigation
variant with explicit NavigationHandler argument. - handleNoMatch(NativeWebRequest, String) - Method in class org.springframework.web.accept.AbstractMappingContentNegotiationStrategy
-
Override to provide handling when a key is not resolved via.
- handleNoMatch(NativeWebRequest, String) - Method in class org.springframework.web.accept.ServletPathExtensionContentNegotiationStrategy
-
Deprecated.Resolve file extension via
ServletContext.getMimeType(String)
and also delegate to base class for a potentialMediaTypeFactory
lookup. - handleParseFailure(Throwable) - Method in class org.springframework.web.multipart.support.StandardMultipartHttpServletRequest
- handlePreFlight(ServerWebExchange) - Method in interface org.springframework.web.cors.reactive.PreFlightRequestHandler
-
Handle a pre-flight request by finding and applying the CORS configuration that matches the expected actual request.
- handleRequest(HttpServerExchange) - Method in class org.springframework.http.server.reactive.UndertowHttpHandlerAdapter
- handleRequest(HttpServletRequest, HttpServletResponse) - Method in interface org.springframework.web.HttpRequestHandler
-
Process the given request, generating a response.
- handleResolvedValue(Object, String, MethodParameter, ModelAndViewContainer, NativeWebRequest) - Method in class org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver
-
Invoked after a value is resolved.
- handleResponse(URI, HttpMethod, ClientHttpResponse) - Method in class org.springframework.web.client.RestTemplate
-
Handle the given response, performing appropriate logging and invoking the
ResponseErrorHandler
if necessary. - handleResult(Object) - Method in interface org.springframework.web.context.request.async.DeferredResult.DeferredResultHandler
- handleReturnValue(Object, MethodParameter, ModelAndViewContainer, NativeWebRequest) - Method in class org.springframework.web.method.annotation.MapMethodProcessor
- handleReturnValue(Object, MethodParameter, ModelAndViewContainer, NativeWebRequest) - Method in class org.springframework.web.method.annotation.ModelAttributeMethodProcessor
-
Add non-null return values to the
ModelAndViewContainer
. - handleReturnValue(Object, MethodParameter, ModelAndViewContainer, NativeWebRequest) - Method in class org.springframework.web.method.annotation.ModelMethodProcessor
- handleReturnValue(Object, MethodParameter, ModelAndViewContainer, NativeWebRequest) - Method in interface org.springframework.web.method.support.HandlerMethodReturnValueHandler
-
Handle the given return value by adding attributes to the model and setting a view or setting the
ModelAndViewContainer.setRequestHandled(boolean)
flag totrue
to indicate the response has been handled directly. - handleReturnValue(Object, MethodParameter, ModelAndViewContainer, NativeWebRequest) - Method in class org.springframework.web.method.support.HandlerMethodReturnValueHandlerComposite
-
Iterate over registered
HandlerMethodReturnValueHandlers
and invoke the one that supports it. - handlerInstantiator(HandlerInstantiator) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Customize the construction of Jackson handlers (
JsonSerializer
,JsonDeserializer
,KeyDeserializer
,TypeResolverBuilder
andTypeIdResolver
). - HandlerMethod - Class in org.springframework.web.method
-
Encapsulates information about a handler method consisting of a method and a bean.
- HandlerMethod(Object, Method) - Constructor for class org.springframework.web.method.HandlerMethod
-
Create an instance from a bean instance and a method.
- HandlerMethod(Object, Method, MessageSource) - Constructor for class org.springframework.web.method.HandlerMethod
-
Variant of
HandlerMethod(Object, Method)
that also accepts aMessageSource
for use from subclasses. - HandlerMethod(Object, String, Class<?>...) - Constructor for class org.springframework.web.method.HandlerMethod
-
Create an instance from a bean instance, method name, and parameter types.
- HandlerMethod(String, BeanFactory, Method) - Constructor for class org.springframework.web.method.HandlerMethod
-
Create an instance from a bean name, a method, and a
BeanFactory
. - HandlerMethod(String, BeanFactory, MessageSource, Method) - Constructor for class org.springframework.web.method.HandlerMethod
-
Variant of
HandlerMethod(String, BeanFactory, Method)
that also accepts aMessageSource
. - HandlerMethod(HandlerMethod) - Constructor for class org.springframework.web.method.HandlerMethod
-
Copy constructor for use in subclasses.
- HandlerMethodArgumentResolver - Interface in org.springframework.web.method.support
-
Strategy interface for resolving method parameters into argument values in the context of a given request.
- HandlerMethodArgumentResolverComposite - Class in org.springframework.web.method.support
-
Resolves method parameters by delegating to a list of registered
HandlerMethodArgumentResolvers
. - HandlerMethodArgumentResolverComposite() - Constructor for class org.springframework.web.method.support.HandlerMethodArgumentResolverComposite
- HandlerMethodReturnValueHandler - Interface in org.springframework.web.method.support
-
Strategy interface to handle the value returned from the invocation of a handler method.
- HandlerMethodReturnValueHandlerComposite - Class in org.springframework.web.method.support
-
Handles method return values by delegating to a list of registered
HandlerMethodReturnValueHandlers
. - HandlerMethodReturnValueHandlerComposite() - Constructor for class org.springframework.web.method.support.HandlerMethodReturnValueHandlerComposite
- HandlerMethodValidationException - Exception in org.springframework.web.method.annotation
-
ResponseStatusException
that is alsoMethodValidationResult
. - HandlerMethodValidationException(MethodValidationResult) - Constructor for exception org.springframework.web.method.annotation.HandlerMethodValidationException
- HandlerMethodValidationException(MethodValidationResult, Predicate<MethodParameter>, Predicate<MethodParameter>) - Constructor for exception org.springframework.web.method.annotation.HandlerMethodValidationException
- HandlerMethodValidationException.Visitor - Interface in org.springframework.web.method.annotation
-
Contract to handle validation results with callbacks by controller method parameter type, with
HandlerMethodValidationException.Visitor.other(org.springframework.validation.method.ParameterValidationResult)
serving as the fallthrough. - HandlerMethodValidator - Class in org.springframework.web.method.annotation
-
MethodValidator
that uses Bean Validation to validate@RequestMapping
method arguments. - HandlerTypePredicate - Class in org.springframework.web.method
-
A
Predicate
to match request handling component types if any of the following selectors match: Base packages -- for selecting handlers by their package. - HandlerTypePredicate.Builder - Class in org.springframework.web.method
-
A
HandlerTypePredicate
builder. - handleTimeout(NativeWebRequest, Callable<T>) - Method in interface org.springframework.web.context.request.async.CallableProcessingInterceptor
-
Invoked from a container thread when the async request times out before the
Callable
task completes. - handleTimeout(NativeWebRequest, Callable<T>) - Method in class org.springframework.web.context.request.async.TimeoutCallableProcessingInterceptor
- handleTimeout(NativeWebRequest, DeferredResult<T>) - Method in interface org.springframework.web.context.request.async.DeferredResultProcessingInterceptor
-
Invoked from a container thread when an async request times out before the
DeferredResult
has been set. - handleTimeout(NativeWebRequest, DeferredResult<T>) - Method in class org.springframework.web.context.request.async.TimeoutDeferredResultProcessingInterceptor
- hasAncestorOfType(Tag, Class<?>) - Static method in class org.springframework.web.util.TagUtils
-
Determine whether the supplied
Tag
has any ancestor tag of the supplied type. - hasBaseUri() - Method in class org.springframework.web.util.DefaultUriBuilderFactory
-
Determine whether this factory has been configured with a base URI.
- hasBody() - Method in class org.springframework.http.HttpEntity
-
Indicates whether this entity has a body.
- hasBody() - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
- hasBody() - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- hasCachedPath(ServletRequest) - Static method in class org.springframework.web.util.ServletRequestPathUtils
- hasCodecConfigurer() - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Whether a
ServerCodecConfigurer
is configured or not, either detected from anApplicationContext
or explicitly configured viaWebHttpHandlerBuilder.codecConfigurer
. - hasConcurrentResult() - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Return whether a result value exists as a result of concurrent handling.
- hasContributors() - Method in class org.springframework.web.method.support.CompositeUriComponentsContributor
-
Determine if this
CompositeUriComponentsContributor
has any contributors. - hasError(int) - Method in class org.springframework.web.client.DefaultResponseErrorHandler
-
Deprecated.
- hasError(ClientHttpResponse) - Method in class org.springframework.web.client.DefaultResponseErrorHandler
-
Delegates to
DefaultResponseErrorHandler.hasError(HttpStatusCode)
with the response status code. - hasError(ClientHttpResponse) - Method in interface org.springframework.web.client.ResponseErrorHandler
-
Indicate whether the given response has any errors.
- hasError(HttpStatusCode) - Method in class org.springframework.web.client.DefaultResponseErrorHandler
-
Template method called from
DefaultResponseErrorHandler.hasError(ClientHttpResponse)
. - hasError(HttpStatusCode) - Method in class org.springframework.web.client.ExtractingResponseErrorHandler
- hasErrors() - Method in class org.springframework.web.bind.EscapedErrors
- hasErrors() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- hasExceptionMappings() - Method in class org.springframework.web.method.annotation.ExceptionHandlerMethodResolver
-
Whether the contained type has any exception mappings.
- hasFieldErrors() - Method in class org.springframework.web.bind.EscapedErrors
- hasFieldErrors() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- hasFieldErrors(String) - Method in class org.springframework.web.bind.EscapedErrors
- hasFieldErrors(String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- hasForwardedHeaders(ServerHttpRequest) - Method in class org.springframework.web.server.adapter.ForwardedHeaderTransformer
-
Whether the request has any Forwarded headers.
- hasForwardedHeaderTransformer() - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Whether a
ForwardedHeaderTransformer
is configured or not, either detected from anApplicationContext
or explicitly configured viaWebHttpHandlerBuilder.forwardedHeaderTransformer(ForwardedHeaderTransformer)
. - hasGlobalErrors() - Method in class org.springframework.web.bind.EscapedErrors
- hasGlobalErrors() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- hashCode() - Method in class org.springframework.http.ContentDisposition
- hashCode() - Method in class org.springframework.http.HttpCookie
- hashCode() - Method in class org.springframework.http.HttpEntity
- hashCode() - Method in class org.springframework.http.HttpHeaders
- hashCode() - Method in class org.springframework.http.HttpMethod
- hashCode() - Method in class org.springframework.http.ProblemDetail
- hashCode() - Method in class org.springframework.http.RequestEntity
- hashCode() - Method in class org.springframework.http.RequestEntity.UriTemplateRequestEntity
- hashCode() - Method in class org.springframework.http.ResponseCookie
- hashCode() - Method in class org.springframework.http.ResponseEntity
- hashCode() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- hashCode() - Method in class org.springframework.web.context.support.ServletContextResource
-
This implementation returns the hash code of the underlying ServletContext resource location.
- hashCode() - Method in class org.springframework.web.method.ControllerAdviceBean
- hashCode() - Method in class org.springframework.web.method.HandlerMethod
- hashCode() - Method in class org.springframework.web.util.pattern.PathPattern
- hasHttpHandlerDecorator() - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Whether a decorator for
HttpHandler
is configured or not viaWebHttpHandlerBuilder.httpHandlerDecorator(Function)
. - hasLocaleContextResolver() - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Whether a
LocaleContextResolver
is configured or not, either detected from anApplicationContext
or explicitly configured viaWebHttpHandlerBuilder.localeContextResolver
. - hasParsedRequestPath(ServletRequest) - Static method in class org.springframework.web.util.ServletRequestPathUtils
-
Check for a
previously
parsed and cachedRequestPath
. - hasParts() - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
- hasParts() - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- hasPatternSyntax() - Method in class org.springframework.web.util.pattern.PathPattern
-
Whether the pattern string contains pattern syntax that would require use of
PathPattern.matches(PathContainer)
, or if it is a regular String that could be compared directly to others. - hasResult() - Method in class org.springframework.web.context.request.async.DeferredResult
-
Return
true
if the DeferredResult has been set. - hasSessionAttributes() - Method in class org.springframework.web.method.annotation.SessionAttributesHandler
-
Whether the controller represented by this instance has declared any session attributes through an
SessionAttributes
annotation. - hasSessionManager() - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Whether a
WebSessionManager
is configured or not, either detected from anApplicationContext
or explicitly configured viaWebHttpHandlerBuilder.sessionManager
. - hasSubmitParameter(ServletRequest, String) - Static method in class org.springframework.web.util.WebUtils
-
Check if a specific input type="submit" parameter was sent in the request, either via a button (directly with name) or via an image (name + ".x" or name + ".y").
- head() - Method in interface org.springframework.web.client.RestClient
-
Start building an HTTP HEAD request.
- head(String, Object...) - Static method in class org.springframework.http.RequestEntity
-
Create an HTTP HEAD builder with the given string base uri template.
- head(URI) - Static method in class org.springframework.http.RequestEntity
-
Create an HTTP HEAD builder with the given url.
- HEAD - Enum constant in enum class org.springframework.web.bind.annotation.RequestMethod
- HEAD - Static variable in class org.springframework.http.HttpMethod
-
The HTTP method
HEAD
. - header(String, String...) - Method in interface org.springframework.http.client.MultipartBodyBuilder.PartBuilder
-
Add part header values.
- header(String, String...) - Method in interface org.springframework.http.RequestEntity.HeadersBuilder
-
Add the given, single header value under the given name.
- header(String, String...) - Method in interface org.springframework.http.ResponseEntity.HeadersBuilder
-
Add the given, single header value under the given name.
- header(String, String...) - Method in interface org.springframework.http.server.reactive.ServerHttpRequest.Builder
-
Set or override the specified header values under the given name.
- header(String, String...) - Method in interface org.springframework.web.client.RestClient.RequestHeadersSpec
-
Add the given, single header value under the given name.
- header(String, String...) - Method in interface org.springframework.web.ErrorResponse.Builder
-
Add the given header value(s) under the given name.
- HeaderContentNegotiationStrategy - Class in org.springframework.web.accept
-
A
ContentNegotiationStrategy
that checks the 'Accept' request header. - HeaderContentNegotiationStrategy() - Constructor for class org.springframework.web.accept.HeaderContentNegotiationStrategy
- headers() - Method in interface org.springframework.http.codec.multipart.Part
-
Return the headers associated with the part.
- headers() - Method in interface org.springframework.http.codec.multipart.PartEvent
-
Return the headers of the part that this event belongs to.
- headers() - Element in annotation interface org.springframework.web.bind.annotation.DeleteMapping
-
Alias for
RequestMapping.headers()
. - headers() - Element in annotation interface org.springframework.web.bind.annotation.GetMapping
-
Alias for
RequestMapping.headers()
. - headers() - Element in annotation interface org.springframework.web.bind.annotation.PatchMapping
-
Alias for
RequestMapping.headers()
. - headers() - Element in annotation interface org.springframework.web.bind.annotation.PostMapping
-
Alias for
RequestMapping.headers()
. - headers() - Element in annotation interface org.springframework.web.bind.annotation.PutMapping
-
Alias for
RequestMapping.headers()
. - headers() - Element in annotation interface org.springframework.web.bind.annotation.RequestMapping
-
The headers of the mapped request, narrowing the primary mapping.
- headers(Consumer<HttpHeaders>) - Method in interface org.springframework.http.client.MultipartBodyBuilder.PartBuilder
-
Manipulate the part headers through the given consumer.
- headers(Consumer<HttpHeaders>) - Method in interface org.springframework.http.RequestEntity.HeadersBuilder
-
Manipulate this entity's headers with the given consumer.
- headers(Consumer<HttpHeaders>) - Method in interface org.springframework.http.ResponseEntity.HeadersBuilder
-
Manipulate this entity's headers with the given consumer.
- headers(Consumer<HttpHeaders>) - Method in interface org.springframework.http.server.reactive.ServerHttpRequest.Builder
-
Manipulate request headers.
- headers(Consumer<HttpHeaders>) - Method in interface org.springframework.web.client.RestClient.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.ErrorResponse.Builder
-
Manipulate this response's headers with the given consumer.
- headers(HttpHeaders) - Method in interface org.springframework.http.RequestEntity.HeadersBuilder
-
Copy the given headers into the entity's headers map.
- headers(HttpHeaders) - Method in interface org.springframework.http.ResponseEntity.HeadersBuilder
-
Copy the given headers into the entity's headers map.
- headersExtractor() - Method in class org.springframework.web.client.RestTemplate
-
Return a response extractor for
HttpHeaders
. - HeaderWebSessionIdResolver - Class in org.springframework.web.server.session
-
Request and response header-based
WebSessionIdResolver
. - HeaderWebSessionIdResolver() - Constructor for class org.springframework.web.server.session.HeaderWebSessionIdResolver
- headForHeaders(String, Object...) - Method in interface org.springframework.web.client.RestOperations
-
Retrieve all headers of the resource specified by the URI template.
- headForHeaders(String, Object...) - Method in class org.springframework.web.client.RestTemplate
- headForHeaders(String, Map<String, ?>) - Method in interface org.springframework.web.client.RestOperations
-
Retrieve all headers of the resource specified by the URI template.
- headForHeaders(String, Map<String, ?>) - Method in class org.springframework.web.client.RestTemplate
- headForHeaders(URI) - Method in interface org.springframework.web.client.RestOperations
-
Retrieve all headers of the resource specified by the URL.
- headForHeaders(URI) - Method in class org.springframework.web.client.RestTemplate
- HiddenHttpMethodFilter - Class in org.springframework.web.filter
-
Filter
that converts posted method parameters into HTTP methods, retrievable viaHttpServletRequest.getMethod()
. - HiddenHttpMethodFilter - Class in org.springframework.web.filter.reactive
-
Reactive
WebFilter
that converts posted method parameters into HTTP methods, retrievable viaHttpRequest.getMethod()
. - HiddenHttpMethodFilter() - Constructor for class org.springframework.web.filter.HiddenHttpMethodFilter
- HiddenHttpMethodFilter() - Constructor for class org.springframework.web.filter.reactive.HiddenHttpMethodFilter
- host(String) - Method in interface org.springframework.web.util.UriBuilder
-
Set the URI host which may contain URI template variables, and may also be
null
to clear the host of this builder. - host(String) - Method in class org.springframework.web.util.UriComponentsBuilder
- HOST - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Host
header field name. - HTML_ESCAPE_CONTEXT_PARAM - Static variable in class org.springframework.web.util.WebUtils
-
HTML escape parameter at the servlet context level (i.e.
- htmlEscape(String) - Static method in class org.springframework.web.util.HtmlUtils
-
Turn special characters into HTML character references.
- htmlEscape(String, String) - Static method in class org.springframework.web.util.HtmlUtils
-
Turn special characters into HTML character references.
- htmlEscapeDecimal(String) - Static method in class org.springframework.web.util.HtmlUtils
-
Turn special characters into HTML character references.
- htmlEscapeDecimal(String, String) - Static method in class org.springframework.web.util.HtmlUtils
-
Turn special characters into HTML character references.
- htmlEscapeHex(String) - Static method in class org.springframework.web.util.HtmlUtils
-
Turn special characters into HTML character references.
- htmlEscapeHex(String, String) - Static method in class org.springframework.web.util.HtmlUtils
-
Turn special characters into HTML character references.
- htmlUnescape(String) - Static method in class org.springframework.web.util.HtmlUtils
-
Turn HTML character references into their plain text UNICODE equivalent.
- HtmlUtils - Class in org.springframework.web.util
-
Utility class for HTML escaping.
- HtmlUtils() - Constructor for class org.springframework.web.util.HtmlUtils
- HTTP_CLIENT_EXCHANGES - Enum constant in enum class org.springframework.http.client.observation.ClientHttpObservationDocumentation
-
HTTP exchanges observations for clients.
- HTTP_PATH - Static variable in class org.springframework.http.server.PathContainer.Options
-
Options for HTTP URL paths.
- HTTP_REACTIVE_SERVER_REQUESTS - Enum constant in enum class org.springframework.http.server.reactive.observation.ServerHttpObservationDocumentation
-
HTTP request observations for reactive servers.
- HTTP_SERVLET_SERVER_REQUESTS - Enum constant in enum class org.springframework.http.server.observation.ServerHttpObservationDocumentation
-
HTTP request observations for Servlet-based servers.
- HTTP_URL - Enum constant in enum class org.springframework.http.client.observation.ClientHttpObservationDocumentation.HighCardinalityKeyNames
-
HTTP request URI.
- HTTP_URL - Enum constant in enum class org.springframework.http.server.observation.ServerHttpObservationDocumentation.HighCardinalityKeyNames
-
HTTP request URI.
- HTTP_URL - Enum constant in enum class org.springframework.http.server.reactive.observation.ServerHttpObservationDocumentation.HighCardinalityKeyNames
-
HTTP request URI.
- HTTP_VERSION_NOT_SUPPORTED - Enum constant in enum class org.springframework.http.HttpStatus
-
505 HTTP Version Not Supported
. - HttpAccessor - Class in org.springframework.http.client.support
-
Base class for
RestTemplate
and other HTTP accessing gateway helpers, defining common properties such as theClientHttpRequestFactory
to operate on. - HttpAccessor() - Constructor for class org.springframework.http.client.support.HttpAccessor
- HttpClientAdapter - Interface in org.springframework.web.service.invoker
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of
ReactorHttpExchangeAdapter
- HttpClientErrorException - Exception in org.springframework.web.client
-
Exception thrown when an HTTP 4xx is received.
- HttpClientErrorException(String, HttpStatusCode, String, HttpHeaders, byte[], Charset) - Constructor for exception org.springframework.web.client.HttpClientErrorException
-
Constructor with a status code and status text, headers, and content, and a prepared message.
- HttpClientErrorException(HttpStatusCode) - Constructor for exception org.springframework.web.client.HttpClientErrorException
-
Constructor with a status code only.
- HttpClientErrorException(HttpStatusCode, String) - Constructor for exception org.springframework.web.client.HttpClientErrorException
-
Constructor with a status code and status text.
- HttpClientErrorException(HttpStatusCode, String, byte[], Charset) - Constructor for exception org.springframework.web.client.HttpClientErrorException
-
Constructor with a status code and status text, and content.
- HttpClientErrorException(HttpStatusCode, String, HttpHeaders, byte[], Charset) - Constructor for exception org.springframework.web.client.HttpClientErrorException
-
Constructor with a status code and status text, headers, and content.
- HttpClientErrorException.BadRequest - Exception in org.springframework.web.client
-
HttpClientErrorException
for status HTTP 400 Bad Request. - HttpClientErrorException.Conflict - Exception in org.springframework.web.client
-
HttpClientErrorException
for status HTTP 409 Conflict. - HttpClientErrorException.Forbidden - Exception in org.springframework.web.client
-
HttpClientErrorException
for status HTTP 403 Forbidden. - HttpClientErrorException.Gone - Exception in org.springframework.web.client
-
HttpClientErrorException
for status HTTP 410 Gone. - HttpClientErrorException.MethodNotAllowed - Exception in org.springframework.web.client
-
HttpClientErrorException
for status HTTP 405 Method Not Allowed. - HttpClientErrorException.NotAcceptable - Exception in org.springframework.web.client
-
HttpClientErrorException
for status HTTP 406 Not Acceptable. - HttpClientErrorException.NotFound - Exception in org.springframework.web.client
-
HttpClientErrorException
for status HTTP 404 Not Found. - HttpClientErrorException.TooManyRequests - Exception in org.springframework.web.client
-
HttpClientErrorException
for status HTTP 429 Too Many Requests. - HttpClientErrorException.Unauthorized - Exception in org.springframework.web.client
-
HttpClientErrorException
for status HTTP 401 Unauthorized. - HttpClientErrorException.UnprocessableEntity - Exception in org.springframework.web.client
-
HttpClientErrorException
for status HTTP 422 Unprocessable Entity. - HttpClientErrorException.UnsupportedMediaType - Exception in org.springframework.web.client
-
HttpClientErrorException
for status HTTP 415 Unsupported Media Type. - HttpComponentsClientHttpConnector - Class in org.springframework.http.client.reactive
-
ClientHttpConnector
implementation for the Apache HttpComponents HttpClient 5.x. - HttpComponentsClientHttpConnector() - Constructor for class org.springframework.http.client.reactive.HttpComponentsClientHttpConnector
-
Default constructor that creates and starts a new instance of
CloseableHttpAsyncClient
. - HttpComponentsClientHttpConnector(CloseableHttpAsyncClient) - Constructor for class org.springframework.http.client.reactive.HttpComponentsClientHttpConnector
-
Constructor with a pre-configured
CloseableHttpAsyncClient
instance. - HttpComponentsClientHttpConnector(CloseableHttpAsyncClient, BiFunction<HttpMethod, URI, ? extends HttpClientContext>) - Constructor for class org.springframework.http.client.reactive.HttpComponentsClientHttpConnector
-
Constructor with a pre-configured
CloseableHttpAsyncClient
instance and aHttpClientContext
supplier lambda which is called before each request and passed to the client. - HttpComponentsClientHttpRequestFactory - Class in org.springframework.http.client
-
ClientHttpRequestFactory
implementation that uses Apache HttpComponents HttpClient to create requests. - HttpComponentsClientHttpRequestFactory() - Constructor for class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Create a new instance of the
HttpComponentsClientHttpRequestFactory
with a defaultHttpClient
based on system properties. - HttpComponentsClientHttpRequestFactory(HttpClient) - Constructor for class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Create a new instance of the
HttpComponentsClientHttpRequestFactory
with the givenHttpClient
instance. - HttpComponentsHeadersAdapter - Class in org.springframework.http.support
-
MultiValueMap
implementation for wrapping Apache HttpComponents HttpClient headers. - HttpComponentsHeadersAdapter(HttpMessage) - Constructor for class org.springframework.http.support.HttpComponentsHeadersAdapter
-
Create a new
HttpComponentsHeadersAdapter
based on the givenHttpMessage
. - HttpCookie - Class in org.springframework.http
-
Represents an HTTP cookie as a name-value pair consistent with the content of the "Cookie" request header.
- HttpCookie(String, String) - Constructor for class org.springframework.http.HttpCookie
- HttpEntity<T> - Class in org.springframework.http
-
Represents an HTTP request or response entity, consisting of headers and body.
- HttpEntity() - Constructor for class org.springframework.http.HttpEntity
-
Create a new, empty
HttpEntity
. - HttpEntity(MultiValueMap<String, String>) - Constructor for class org.springframework.http.HttpEntity
-
Create a new
HttpEntity
with the given headers and no body. - HttpEntity(T) - Constructor for class org.springframework.http.HttpEntity
-
Create a new
HttpEntity
with the given body and no headers. - HttpEntity(T, MultiValueMap<String, String>) - Constructor for class org.springframework.http.HttpEntity
-
Create a new
HttpEntity
with the given body and headers. - httpEntityCallback(Object) - Method in class org.springframework.web.client.RestTemplate
-
Return a
RequestCallback
implementation that writes the given object to the request stream. - httpEntityCallback(Object, Type) - Method in class org.springframework.web.client.RestTemplate
-
Return a
RequestCallback
implementation that: Sets the requestAccept
header based on the given response type, cross-checked against the configured message converters. - HttpExchange - Annotation Interface in org.springframework.web.service.annotation
-
Annotation to declare a method on an HTTP service interface as an HTTP endpoint.
- HttpExchangeAdapter - Interface in org.springframework.web.service.invoker
-
Contract to abstract an HTTP client from HttpServiceProxyFactory and make it pluggable.
- HttpHandler - Interface in org.springframework.http.server.reactive
-
Lowest level contract for reactive HTTP request handling that serves as a common denominator across different runtimes.
- httpHandlerDecorator(Function<HttpHandler, HttpHandler>) - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Configure a
Function
to decorate theHttpHandler
returned by this builder which effectively wraps the entireWebExceptionHandler
-WebFilter
-WebHandler
processing chain. - HttpHandlerDecoratorFactory - Interface in org.springframework.http.server.reactive
-
Contract for applying a decorator to an
HttpHandler
. - HttpHeaders - Class in org.springframework.http
-
A data structure representing HTTP request or response headers, mapping String header names to a list of String values, also offering accessors for common application-level data types.
- HttpHeaders() - Constructor for class org.springframework.http.HttpHeaders
-
Construct a new, empty instance of the
HttpHeaders
object. - HttpHeaders(MultiValueMap<String, String>) - Constructor for class org.springframework.http.HttpHeaders
-
Construct a new
HttpHeaders
instance backed by an existing map. - HttpHeadResponseDecorator - Class in org.springframework.http.server.reactive
-
ServerHttpResponse
decorator for HTTP HEAD requests. - HttpHeadResponseDecorator(ServerHttpResponse) - Constructor for class org.springframework.http.server.reactive.HttpHeadResponseDecorator
- HttpInputMessage - Interface in org.springframework.http
- HttpLogging - Class in org.springframework.http
-
Holds the shared logger named "org.springframework.web.HttpLogging" for HTTP related logging when "org.springframework.http" is not enabled but "org.springframework.web" is.
- HttpLogging() - Constructor for class org.springframework.http.HttpLogging
- HttpMediaTypeException - Exception in org.springframework.web
-
Abstract base for exceptions related to media types.
- HttpMediaTypeException(String) - Constructor for exception org.springframework.web.HttpMediaTypeException
-
Deprecated.as of 6.0
- HttpMediaTypeException(String, List<MediaType>) - Constructor for exception org.springframework.web.HttpMediaTypeException
-
Deprecated.as of 6.0
- HttpMediaTypeException(String, List<MediaType>, String, Object[]) - Constructor for exception org.springframework.web.HttpMediaTypeException
-
Create a new HttpMediaTypeException with a list of supported media types.
- HttpMediaTypeNotAcceptableException - Exception in org.springframework.web
-
Exception thrown when the request handler cannot generate a response that is acceptable by the client.
- HttpMediaTypeNotAcceptableException(String) - Constructor for exception org.springframework.web.HttpMediaTypeNotAcceptableException
-
Constructor for when the
Accept
header cannot be parsed. - HttpMediaTypeNotAcceptableException(List<MediaType>) - Constructor for exception org.springframework.web.HttpMediaTypeNotAcceptableException
-
Create a new HttpMediaTypeNotSupportedException.
- HttpMediaTypeNotSupportedException - Exception in org.springframework.web
-
Exception thrown when a client POSTs, PUTs, or PATCHes content of a type not supported by request handler.
- HttpMediaTypeNotSupportedException(String) - Constructor for exception org.springframework.web.HttpMediaTypeNotSupportedException
-
Create a new HttpMediaTypeNotSupportedException.
- HttpMediaTypeNotSupportedException(String, List<MediaType>) - Constructor for exception org.springframework.web.HttpMediaTypeNotSupportedException
-
Create a new HttpMediaTypeNotSupportedException for a parse error.
- HttpMediaTypeNotSupportedException(MediaType, List<MediaType>) - Constructor for exception org.springframework.web.HttpMediaTypeNotSupportedException
-
Create a new HttpMediaTypeNotSupportedException.
- HttpMediaTypeNotSupportedException(MediaType, List<MediaType>, HttpMethod) - Constructor for exception org.springframework.web.HttpMediaTypeNotSupportedException
-
Create a new HttpMediaTypeNotSupportedException.
- HttpMediaTypeNotSupportedException(MediaType, List<MediaType>, HttpMethod, String) - Constructor for exception org.springframework.web.HttpMediaTypeNotSupportedException
-
Create a new HttpMediaTypeNotSupportedException.
- HttpMessage - Interface in org.springframework.http
-
Represents the base interface for HTTP request and response messages.
- HttpMessageConversionException - Exception in org.springframework.http.converter
-
Thrown by
HttpMessageConverter
implementations when a conversion attempt fails. - HttpMessageConversionException(String) - Constructor for exception org.springframework.http.converter.HttpMessageConversionException
-
Create a new HttpMessageConversionException.
- HttpMessageConversionException(String, Throwable) - Constructor for exception org.springframework.http.converter.HttpMessageConversionException
-
Create a new HttpMessageConversionException.
- HttpMessageConverter<T> - Interface in org.springframework.http.converter
-
Strategy interface for converting from and to HTTP requests and responses.
- HttpMessageConverterExtractor<T> - Class in org.springframework.web.client
-
Response extractor that uses the given entity converters to convert the response into a type
T
. - HttpMessageConverterExtractor(Class<T>, List<HttpMessageConverter<?>>) - Constructor for class org.springframework.web.client.HttpMessageConverterExtractor
-
Create a new instance of the
HttpMessageConverterExtractor
with the given response type and message converters. - HttpMessageConverterExtractor(Type, List<HttpMessageConverter<?>>) - Constructor for class org.springframework.web.client.HttpMessageConverterExtractor
-
Creates a new instance of the
HttpMessageConverterExtractor
with the given response type and message converters. - HttpMessageDecoder<T> - Interface in org.springframework.http.codec
-
Extension of
Decoder
exposing extra methods relevant in the context of HTTP request or response body decoding. - HttpMessageEncoder<T> - Interface in org.springframework.http.codec
-
Extension of
Encoder
exposing extra methods relevant in the context of HTTP request or response body encoding. - HttpMessageNotReadableException - Exception in org.springframework.http.converter
-
Thrown by
HttpMessageConverter
implementations when theHttpMessageConverter.read(java.lang.Class<? extends T>, org.springframework.http.HttpInputMessage)
method fails. - HttpMessageNotReadableException(String) - Constructor for exception org.springframework.http.converter.HttpMessageNotReadableException
-
Deprecated.as of 5.1, in favor of
HttpMessageNotReadableException(String, HttpInputMessage)
- HttpMessageNotReadableException(String, Throwable) - Constructor for exception org.springframework.http.converter.HttpMessageNotReadableException
-
Deprecated.as of 5.1, in favor of
HttpMessageNotReadableException(String, Throwable, HttpInputMessage)
- HttpMessageNotReadableException(String, Throwable, HttpInputMessage) - Constructor for exception org.springframework.http.converter.HttpMessageNotReadableException
-
Create a new HttpMessageNotReadableException.
- HttpMessageNotReadableException(String, HttpInputMessage) - Constructor for exception org.springframework.http.converter.HttpMessageNotReadableException
-
Create a new HttpMessageNotReadableException.
- HttpMessageNotWritableException - Exception in org.springframework.http.converter
-
Thrown by
HttpMessageConverter
implementations when theHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage)
method fails. - HttpMessageNotWritableException(String) - Constructor for exception org.springframework.http.converter.HttpMessageNotWritableException
-
Create a new HttpMessageNotWritableException.
- HttpMessageNotWritableException(String, Throwable) - Constructor for exception org.springframework.http.converter.HttpMessageNotWritableException
-
Create a new HttpMessageNotWritableException.
- HttpMessageReader<T> - Interface in org.springframework.http.codec
-
Strategy for reading from a
ReactiveHttpInputMessage
and decoding the stream of bytes to Objects of type<T>
. - HttpMessageWriter<T> - Interface in org.springframework.http.codec
-
Strategy for encoding a stream of objects of type
<T>
and writing the encoded stream of bytes to anReactiveHttpOutputMessage
. - HttpMethod - Class in org.springframework.http
-
Represents an HTTP request method.
- HttpMethodArgumentResolver - Class in org.springframework.web.service.invoker
-
HttpServiceArgumentResolver
that resolves the target request's HTTP method from anHttpMethod
argument. - HttpMethodArgumentResolver() - Constructor for class org.springframework.web.service.invoker.HttpMethodArgumentResolver
- httpOnly(boolean) - Method in interface org.springframework.http.ResponseCookie.ResponseCookieBuilder
-
Add the "HttpOnly" attribute to the cookie.
- HttpOutputMessage - Interface in org.springframework.http
- HttpRange - Class in org.springframework.http
-
Represents an HTTP (byte) range for use with the HTTP
"Range"
header. - HttpRange() - Constructor for class org.springframework.http.HttpRange
- httpRequest(Consumer<ClientHttpRequest>) - Method in interface org.springframework.web.client.RestClient.RequestHeadersSpec
-
Callback for access to the
ClientHttpRequest
that in turn provides access to the native request of the underlying HTTP library. - HttpRequest - Interface in org.springframework.http
- HttpRequestHandler - Interface in org.springframework.web
-
Plain handler interface for components that process HTTP requests, analogous to a Servlet.
- HttpRequestHandlerServlet - Class in org.springframework.web.context.support
-
Simple HttpServlet that delegates to an
HttpRequestHandler
bean defined in Spring's root web application context. - HttpRequestHandlerServlet() - Constructor for class org.springframework.web.context.support.HttpRequestHandlerServlet
- HttpRequestMethodNotSupportedException - Exception in org.springframework.web
-
Exception thrown when a request handler does not support a specific request method.
- HttpRequestMethodNotSupportedException(String) - Constructor for exception org.springframework.web.HttpRequestMethodNotSupportedException
-
Create a new
HttpRequestMethodNotSupportedException
. - HttpRequestMethodNotSupportedException(String, Collection<String>) - Constructor for exception org.springframework.web.HttpRequestMethodNotSupportedException
-
Create a new
HttpRequestMethodNotSupportedException
. - HttpRequestValues - Class in org.springframework.web.service.invoker
-
Container for HTTP request values extracted from an
@HttpExchange
-annotated method and argument values passed to it. - HttpRequestValues(HttpMethod, URI, String, Map<String, String>, HttpHeaders, MultiValueMap<String, String>, Map<String, Object>, Object) - Constructor for class org.springframework.web.service.invoker.HttpRequestValues
-
Deprecated, for removal: This API element is subject to removal in a future version.in favour of
HttpRequestValues(HttpMethod, URI, UriBuilderFactory, String, Map, HttpHeaders, MultiValueMap, Map, Object)
to be removed in 6.2. - HttpRequestValues(HttpMethod, URI, UriBuilderFactory, String, Map<String, String>, HttpHeaders, MultiValueMap<String, String>, Map<String, Object>, Object) - Constructor for class org.springframework.web.service.invoker.HttpRequestValues
-
Construct
HttpRequestValues
. - HttpRequestValues.Builder - Class in org.springframework.web.service.invoker
-
Builder for
HttpRequestValues
. - HttpRequestWrapper - Class in org.springframework.http.client.support
-
Provides a convenient implementation of the
HttpRequest
interface that can be overridden to adapt the request. - HttpRequestWrapper(HttpRequest) - Constructor for class org.springframework.http.client.support.HttpRequestWrapper
-
Create a new
HttpRequest
wrapping the given request object. - HttpServerErrorException - Exception in org.springframework.web.client
-
Exception thrown when an HTTP 5xx is received.
- HttpServerErrorException(String, HttpStatusCode, String, HttpHeaders, byte[], Charset) - Constructor for exception org.springframework.web.client.HttpServerErrorException
-
Constructor with a status code and status text, headers, content, and a prepared message.
- HttpServerErrorException(HttpStatusCode) - Constructor for exception org.springframework.web.client.HttpServerErrorException
-
Constructor with a status code only.
- HttpServerErrorException(HttpStatusCode, String) - Constructor for exception org.springframework.web.client.HttpServerErrorException
-
Constructor with a status code and status text.
- HttpServerErrorException(HttpStatusCode, String, byte[], Charset) - Constructor for exception org.springframework.web.client.HttpServerErrorException
-
Constructor with a status code and status text, and content.
- HttpServerErrorException(HttpStatusCode, String, HttpHeaders, byte[], Charset) - Constructor for exception org.springframework.web.client.HttpServerErrorException
-
Constructor with a status code and status text, headers, and content.
- HttpServerErrorException.BadGateway - Exception in org.springframework.web.client
-
HttpServerErrorException
for HTTP status 502 Bad Gateway. - HttpServerErrorException.GatewayTimeout - Exception in org.springframework.web.client
-
HttpServerErrorException
for status HTTP 504 Gateway Timeout. - HttpServerErrorException.InternalServerError - Exception in org.springframework.web.client
-
HttpServerErrorException
for status HTTP 500 Internal Server Error. - HttpServerErrorException.NotImplemented - Exception in org.springframework.web.client
-
HttpServerErrorException
for status HTTP 501 Not Implemented. - HttpServerErrorException.ServiceUnavailable - Exception in org.springframework.web.client
-
HttpServerErrorException
for status HTTP 503 Service Unavailable. - HttpServiceArgumentResolver - Interface in org.springframework.web.service.invoker
-
Resolve an argument from an
@HttpExchange
-annotated method to one or more HTTP request values. - HttpServiceProxyFactory - Class in org.springframework.web.service.invoker
-
Factory to create a client proxy from an HTTP service interface with
@HttpExchange
methods. - HttpServiceProxyFactory.Builder - Class in org.springframework.web.service.invoker
-
Builder to create an
HttpServiceProxyFactory
. - HttpSessionMutexListener - Class in org.springframework.web.util
-
Servlet HttpSessionListener that automatically exposes the session mutex when an HttpSession gets created.
- HttpSessionMutexListener() - Constructor for class org.springframework.web.util.HttpSessionMutexListener
- HttpSessionRequiredException - Exception in org.springframework.web
-
Exception thrown when an HTTP request handler requires a pre-existing session.
- HttpSessionRequiredException(String) - Constructor for exception org.springframework.web.HttpSessionRequiredException
-
Create a new HttpSessionRequiredException.
- HttpSessionRequiredException(String, String) - Constructor for exception org.springframework.web.HttpSessionRequiredException
-
Create a new HttpSessionRequiredException.
- HttpStatus - Enum Class in org.springframework.http
-
Enumeration of HTTP status codes.
- HttpStatus.Series - Enum Class in org.springframework.http
-
Enumeration of HTTP status series.
- HttpStatusCode - Interface in org.springframework.http
-
Represents an HTTP response status code.
- HttpStatusCodeException - Exception in org.springframework.web.client
-
Abstract base class for exceptions based on an
HttpStatusCode
. - HttpStatusCodeException(String, HttpStatusCode, String, HttpHeaders, byte[], Charset) - Constructor for exception org.springframework.web.client.HttpStatusCodeException
-
Construct instance with an
HttpStatusCode
, status text, content, and a response charset. - HttpStatusCodeException(HttpStatusCode) - Constructor for exception org.springframework.web.client.HttpStatusCodeException
-
Construct a new instance with an
HttpStatusCode
. - HttpStatusCodeException(HttpStatusCode, String) - Constructor for exception org.springframework.web.client.HttpStatusCodeException
-
Construct a new instance with an
HttpStatusCode
and status text. - HttpStatusCodeException(HttpStatusCode, String, byte[], Charset) - Constructor for exception org.springframework.web.client.HttpStatusCodeException
-
Construct instance with an
HttpStatusCode
, status text, and content. - HttpStatusCodeException(HttpStatusCode, String, HttpHeaders, byte[], Charset) - Constructor for exception org.springframework.web.client.HttpStatusCodeException
-
Construct instance with an
HttpStatusCode
, status text, content, and a response charset. - httpUrl(ServerRequestObservationContext) - Method in class org.springframework.http.server.observation.DefaultServerRequestObservationConvention
- httpUrl(ServerRequestObservationContext) - Method in class org.springframework.http.server.reactive.observation.DefaultServerRequestObservationConvention
- HttpWebHandlerAdapter - Class in org.springframework.web.server.adapter
-
Default adapter of
WebHandler
to theHttpHandler
contract. - HttpWebHandlerAdapter(WebHandler) - Constructor for class org.springframework.web.server.adapter.HttpWebHandlerAdapter
I
- I_AM_A_TEAPOT - Enum constant in enum class org.springframework.http.HttpStatus
-
418 I'm a teapot
. - id() - Method in class org.springframework.http.codec.ServerSentEvent
-
Return the
id
field of this event, if available. - id(String) - Method in interface org.springframework.http.codec.ServerSentEvent.Builder
-
Set the value of the
id
field. - IF_MATCH - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
If-Match
header field name. - IF_MODIFIED_SINCE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
If-Modified-Since
header field name. - IF_NONE_MATCH - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
If-None-Match
header field name. - IF_RANGE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
If-Range
header field name. - IF_UNMODIFIED_SINCE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
If-Unmodified-Since
header field name. - ifModifiedSince(long) - Method in interface org.springframework.http.RequestEntity.HeadersBuilder
-
Set the value of the
If-Modified-Since
header. - ifModifiedSince(Instant) - Method in interface org.springframework.http.RequestEntity.HeadersBuilder
-
Set the value of the
If-Modified-Since
header. - ifModifiedSince(ZonedDateTime) - Method in interface org.springframework.http.RequestEntity.HeadersBuilder
-
Set the value of the
If-Modified-Since
header. - ifModifiedSince(ZonedDateTime) - Method in interface org.springframework.web.client.RestClient.RequestHeadersSpec
-
Set the value of the
If-Modified-Since
header. - ifNoneMatch(String...) - Method in interface org.springframework.http.RequestEntity.HeadersBuilder
-
Set the values of the
If-None-Match
header. - ifNoneMatch(String...) - Method in interface org.springframework.web.client.RestClient.RequestHeadersSpec
-
Set the values of the
If-None-Match
header. - ILLEGAL_CHARACTER_AT_START_OF_CAPTURE_DESCRIPTOR - Enum constant in enum class org.springframework.web.util.pattern.PatternParseException.PatternMessage
- ILLEGAL_CHARACTER_IN_CAPTURE_DESCRIPTOR - Enum constant in enum class org.springframework.web.util.pattern.PatternParseException.PatternMessage
- ILLEGAL_DOUBLE_CAPTURE - Enum constant in enum class org.springframework.web.util.pattern.PatternParseException.PatternMessage
- ILLEGAL_NESTED_CAPTURE - Enum constant in enum class org.springframework.web.util.pattern.PatternParseException.PatternMessage
- IM_USED - Enum constant in enum class org.springframework.http.HttpStatus
-
226 IM Used
. - IMAGE_GIF - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
image/gif
. - IMAGE_GIF_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.IMAGE_GIF
. - IMAGE_JPEG - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
image/jpeg
. - IMAGE_JPEG_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.IMAGE_JPEG
. - IMAGE_PNG - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
image/png
. - IMAGE_PNG_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.IMAGE_PNG
. - immutable() - Method in class org.springframework.http.CacheControl
-
Add an "immutable" directive.
- immutableValueTypes - Static variable in class org.springframework.web.context.request.ServletRequestAttributes
- INCLUDE_CONTEXT_PATH_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.3+ spec request attribute for include context path.
- INCLUDE_PATH_INFO_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.3+ spec request attribute for include path info.
- INCLUDE_QUERY_STRING_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.3+ spec request attribute for include query string.
- INCLUDE_REQUEST_URI_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.3+ spec request attribute for include request URI.
- INCLUDE_SERVLET_PATH_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet 2.3+ spec request attribute for include servlet path.
- includes(MediaType) - Method in class org.springframework.http.MediaType
-
Indicate whether this
MediaType
includes the given media type. - indentOutput(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Shortcut for
SerializationFeature.INDENT_OUTPUT
option. - INFORMATIONAL - Enum constant in enum class org.springframework.http.HttpStatus.Series
- init() - Method in class org.springframework.web.context.support.HttpRequestHandlerServlet
- init(FilterConfig) - Method in class org.springframework.web.filter.CompositeFilter
-
Initialize all the filters, calling each one's init method in turn in the order supplied.
- init(FilterConfig) - Method in class org.springframework.web.filter.GenericFilterBean
-
Standard way of initializing this filter.
- init(ServletConfig) - Method in class org.springframework.http.server.reactive.ServletHttpHandlerAdapter
- initApplicationContext(ApplicationContext) - Method in class org.springframework.web.context.support.WebApplicationObjectSupport
-
Calls
WebApplicationObjectSupport.initServletContext(jakarta.servlet.ServletContext)
if the given ApplicationContext is aWebApplicationContext
. - initBeanDefinitionReader(GroovyBeanDefinitionReader) - Method in class org.springframework.web.context.support.GroovyWebApplicationContext
-
Initialize the bean definition reader used for loading the bean definitions of this context.
- initBeanDefinitionReader(XmlBeanDefinitionReader) - Method in class org.springframework.web.context.support.XmlWebApplicationContext
-
Initialize the bean definition reader used for loading the bean definitions of this context.
- initBeanWrapper(BeanWrapper) - Method in class org.springframework.web.filter.GenericFilterBean
-
Initialize the BeanWrapper for this GenericFilterBean, possibly with custom editors.
- initBinder(WebDataBinder) - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
- initBinder(WebDataBinder) - Method in interface org.springframework.web.bind.support.WebBindingInitializer
-
Initialize the given DataBinder.
- initBinder(WebDataBinder, NativeWebRequest) - Method in class org.springframework.web.bind.support.DefaultDataBinderFactory
-
Extension point to further initialize the created data binder instance (e.g.
- initBinder(WebDataBinder, NativeWebRequest) - Method in class org.springframework.web.method.annotation.InitBinderDataBinderFactory
-
Initialize a WebDataBinder with
@InitBinder
methods. - InitBinder - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation that identifies methods that initialize the
WebDataBinder
which will be used for populating command and form object arguments of annotated handler methods. - InitBinderDataBinderFactory - Class in org.springframework.web.method.annotation
-
Adds initialization to a WebDataBinder via
@InitBinder
methods. - InitBinderDataBinderFactory(List<InvocableHandlerMethod>, WebBindingInitializer) - Constructor for class org.springframework.web.method.annotation.InitBinderDataBinderFactory
-
Create a new InitBinderDataBinderFactory instance.
- initBodyConvertFunction(ClientHttpResponse, byte[]) - Method in class org.springframework.web.client.DefaultResponseErrorHandler
-
Return a function for decoding the error content.
- initCookies() - Method in class org.springframework.http.server.reactive.AbstractServerHttpRequest
-
Obtain the cookies from the underlying "native" request and adapt those to an
HttpCookie
map. - initDelegate(WebApplicationContext) - Method in class org.springframework.web.filter.DelegatingFilterProxy
-
Initialize the Filter delegate, defined as bean the given Spring application context.
- initFilterBean() - Method in class org.springframework.web.filter.DelegatingFilterProxy
- initFilterBean() - Method in class org.springframework.web.filter.GenericFilterBean
-
Subclasses may override this to perform custom initialization.
- initFullPathPattern(String) - Method in class org.springframework.web.util.pattern.PathPatternParser
-
Prepare the given pattern for use in matching to full URL paths.
- initialize(ClientHttpRequest) - Method in interface org.springframework.http.client.ClientHttpRequestInitializer
-
Initialize the given client HTTP request.
- initializeMultipart() - Method in class org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest
-
Lazily initialize the multipart request, if possible.
- initializeMultipart() - Method in class org.springframework.web.multipart.support.StandardMultipartHttpServletRequest
- initId() - Method in class org.springframework.http.server.reactive.AbstractServerHttpRequest
-
Obtain the request id to use, or
null
in which case the Object identity of this request instance is used. - initLogPrefix() - Method in class org.springframework.http.server.reactive.AbstractServerHttpRequest
-
Subclasses can override this to provide the prefix to use for log messages.
- initModel(NativeWebRequest, ModelAndViewContainer, HandlerMethod) - Method in class org.springframework.web.method.annotation.ModelFactory
-
Populate the model in the following order: Retrieve "known" session attributes listed as
@SessionAttributes
. - initParameterNames(ServletRequest) - Method in class org.springframework.web.bind.ServletRequestDataBinder.ServletRequestValueResolver
- initPropertySources() - Method in class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
- initPropertySources() - Method in class org.springframework.web.context.support.GenericWebApplicationContext
- initPropertySources() - Method in class org.springframework.web.context.support.StaticWebApplicationContext
- initPropertySources(ServletContext, ServletConfig) - Method in interface org.springframework.web.context.ConfigurableWebEnvironment
-
Replace any stub property source instances acting as placeholders with real servlet context/config property sources using the given parameters.
- initPropertySources(ServletContext, ServletConfig) - Method in class org.springframework.web.context.support.StandardServletEnvironment
- initQueryParams() - Method in class org.springframework.http.server.reactive.AbstractServerHttpRequest
-
A method for parsing of the query into name-value pairs.
- initReadOnlyHeaders() - Method in class org.springframework.http.client.reactive.AbstractClientHttpRequest
-
Initialize the read-only headers after the request is committed.
- initServletContext(ServletContext) - Method in class org.springframework.web.context.support.WebApplicationObjectSupport
-
Subclasses may override this for custom initialization based on the ServletContext that this application object runs in.
- initServletPropertySources(MutablePropertySources, ServletContext) - Static method in class org.springframework.web.context.support.WebApplicationContextUtils
-
Convenient variant of
WebApplicationContextUtils.initServletPropertySources(MutablePropertySources, ServletContext, ServletConfig)
that always providesnull
for theServletConfig
parameter. - initServletPropertySources(MutablePropertySources, ServletContext, ServletConfig) - Static method in class org.springframework.web.context.support.WebApplicationContextUtils
-
Replace
Servlet
-basedstub property sources
with actual instances populated with the givenservletContext
andservletConfig
objects. - initSslInfo() - Method in class org.springframework.http.server.reactive.AbstractServerHttpRequest
-
Obtain SSL session information from the underlying "native" request.
- initToStringContent() - Method in class org.springframework.http.ProblemDetail
-
Return a String representation of the
ProblemDetail
fields. - initURI(HttpServletRequest) - Static method in class org.springframework.http.server.ServletServerHttpRequest
-
Initialize a URI from the given Servlet request.
- initWebApplicationContext(ServletContext) - Method in class org.springframework.web.context.ContextLoader
-
Initialize Spring's web application context for the given servlet context, using the application context provided at construction time, or creating a new one according to the "
contextClass
" and "contextConfigLocation
" context-params. - inline() - Static method in class org.springframework.http.ContentDisposition
-
Return a builder for a
ContentDisposition
of type "inline". - InMemoryWebSessionStore - Class in org.springframework.web.server.session
-
Simple Map-based storage for
WebSession
instances. - InMemoryWebSessionStore() - Constructor for class org.springframework.web.server.session.InMemoryWebSessionStore
- instance(URI) - Method in interface org.springframework.web.ErrorResponse.Builder
-
Set the underlying
instance
field. - INSUFFICIENT_SPACE_ON_RESOURCE - Enum constant in enum class org.springframework.http.HttpStatus
-
Deprecated.
- INSUFFICIENT_STORAGE - Enum constant in enum class org.springframework.http.HttpStatus
-
507 Insufficient Storage
- intercept(HttpRequest, byte[], ClientHttpRequestExecution) - Method in interface org.springframework.http.client.ClientHttpRequestInterceptor
-
Intercept the given request, and return a response.
- intercept(HttpRequest, byte[], ClientHttpRequestExecution) - Method in class org.springframework.http.client.support.BasicAuthenticationInterceptor
- InterceptingClientHttpRequestFactory - Class in org.springframework.http.client
-
ClientHttpRequestFactory
wrapper with support forClientHttpRequestInterceptors
. - InterceptingClientHttpRequestFactory(ClientHttpRequestFactory, List<ClientHttpRequestInterceptor>) - Constructor for class org.springframework.http.client.InterceptingClientHttpRequestFactory
-
Create a new instance of the
InterceptingClientHttpRequestFactory
with the given parameters. - InterceptingHttpAccessor - Class in org.springframework.http.client.support
-
Base class for
RestTemplate
and other HTTP accessing gateway helpers, adding interceptor-related properties toHttpAccessor
's common properties. - InterceptingHttpAccessor() - Constructor for class org.springframework.http.client.support.InterceptingHttpAccessor
- INTERNAL_SERVER_ERROR - Enum constant in enum class org.springframework.http.HttpStatus
-
500 Internal Server Error
. - internalServerError() - Static method in class org.springframework.http.ResponseEntity
-
Create a builder with an INTERNAL_SERVER_ERROR status.
- IntrospectorCleanupListener - Class in org.springframework.web.util
-
Listener that flushes the JDK's
JavaBeans Introspector
cache on web app shutdown. - IntrospectorCleanupListener() - Constructor for class org.springframework.web.util.IntrospectorCleanupListener
- invalidate() - Method in interface org.springframework.web.server.WebSession
-
Invalidate the current session and clear session storage.
- InvalidMediaTypeException - Exception in org.springframework.http
-
Exception thrown from
MediaType.parseMediaType(String)
in case of encountering an invalid media type specification String. - InvalidMediaTypeException(String, String) - Constructor for exception org.springframework.http.InvalidMediaTypeException
-
Create a new InvalidMediaTypeException for the given media type.
- InvocableHandlerMethod - Class in org.springframework.web.method.support
-
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.method.support.InvocableHandlerMethod
-
Create an instance from a bean instance and a method.
- InvocableHandlerMethod(Object, Method, MessageSource) - Constructor for class org.springframework.web.method.support.InvocableHandlerMethod
-
Variant of
InvocableHandlerMethod(Object, Method)
that also accepts aMessageSource
, for use in subclasses. - InvocableHandlerMethod(Object, String, Class<?>...) - Constructor for class org.springframework.web.method.support.InvocableHandlerMethod
-
Construct a new handler method with the given bean instance, method name and parameters.
- InvocableHandlerMethod(HandlerMethod) - Constructor for class org.springframework.web.method.support.InvocableHandlerMethod
-
Create an instance from a
HandlerMethod
. - invokeDelegate(Filter, ServletRequest, ServletResponse, FilterChain) - Method in class org.springframework.web.filter.DelegatingFilterProxy
-
Actually invoke the delegate Filter with the given request and response.
- invokeForRequest(NativeWebRequest, ModelAndViewContainer, Object...) - Method in class org.springframework.web.method.support.InvocableHandlerMethod
-
Invoke the method after resolving its argument values in the context of the given request.
- invokeMethod(String, Object) - Method in class org.springframework.web.context.support.GroovyWebApplicationContext
- invokeSuspendingFunction(Method, Object, Object[]) - Method in class org.springframework.web.method.support.InvocableHandlerMethod
-
Invoke the given Kotlin coroutine suspended function.
- is1xxInformational() - Method in enum class org.springframework.http.HttpStatus
- is1xxInformational() - Method in interface org.springframework.http.HttpStatusCode
-
Whether this status code is in the Informational class (
1xx
). - is2xxSuccessful() - Method in enum class org.springframework.http.HttpStatus
- is2xxSuccessful() - Method in interface org.springframework.http.HttpStatusCode
-
Whether this status code is in the Successful class (
2xx
). - is3xxRedirection() - Method in enum class org.springframework.http.HttpStatus
- is3xxRedirection() - Method in interface org.springframework.http.HttpStatusCode
-
Whether this status code is in the Redirection class (
3xx
). - is4xxClientError() - Method in enum class org.springframework.http.HttpStatus
- is4xxClientError() - Method in interface org.springframework.http.HttpStatusCode
-
Whether this status code is in the Client Error class (
4xx
). - is5xxServerError() - Method in enum class org.springframework.http.HttpStatus
- is5xxServerError() - Method in interface org.springframework.http.HttpStatusCode
-
Whether this status code is in the Server Error class (
5xx
). - isApplicableToBeanType(Class<?>) - Method in class org.springframework.web.method.ControllerAdviceBean
-
Check whether the given bean type should be advised by this
ControllerAdviceBean
. - isAsyncComplete() - Method in interface org.springframework.web.context.request.async.AsyncWebRequest
-
Whether asynchronous processing has completed.
- isAsyncComplete() - Method in class org.springframework.web.context.request.async.StandardServletAsyncWebRequest
-
Whether async request processing has completed.
- isAsyncDispatch(HttpServletRequest) - Method in class org.springframework.web.filter.OncePerRequestFilter
-
The dispatcher type
jakarta.servlet.DispatcherType.ASYNC
means a filter can be invoked in more than one thread over the course of a single request. - isAsyncReturnValue(Object, MethodParameter) - Method in interface org.springframework.web.method.support.AsyncHandlerMethodReturnValueHandler
-
Whether the given return value represents asynchronous computation.
- isAsyncStarted() - Method in interface org.springframework.web.context.request.async.AsyncWebRequest
-
Whether the request is in async mode following a call to
AsyncWebRequest.startAsync()
. - isAsyncStarted() - Method in class org.springframework.web.context.request.async.StandardServletAsyncWebRequest
- isAsyncStarted(HttpServletRequest) - Method in class org.springframework.web.filter.OncePerRequestFilter
-
Whether request processing is in asynchronous mode meaning that the response will not be committed after the current thread is exited.
- isAttachment() - Method in class org.springframework.http.ContentDisposition
-
Return whether the
type
is "attachment". - isAutoGrowNestedPaths() - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Return whether a binder should attempt to "auto-grow" a nested path that contains a null value.
- isAutoStartup() - Method in class org.springframework.http.client.reactive.ReactorClientHttpConnector
- isAutoStartup() - Method in class org.springframework.http.client.ReactorNettyClientRequestFactory
- isBindEmptyMultipartFiles() - Method in class org.springframework.web.bind.WebDataBinder
-
Return whether to bind empty MultipartFile parameters.
- isBinderMethodApplicable(HandlerMethod, WebDataBinder) - Method in class org.springframework.web.method.annotation.InitBinderDataBinderFactory
-
Determine whether the given
@InitBinder
method should be used to initialize the givenWebDataBinder
instance. - isBindExceptionRequired(MethodParameter) - Method in class org.springframework.web.method.annotation.ModelAttributeMethodProcessor
-
Whether to raise a fatal bind exception on validation errors.
- isBindExceptionRequired(WebDataBinder, MethodParameter) - Method in class org.springframework.web.method.annotation.ModelAttributeMethodProcessor
-
Whether to raise a fatal bind exception on validation errors.
- isBindingDisabled(String) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Whether binding is disabled for the given model attribute.
- isCaseSensitive() - Method in class org.springframework.web.util.pattern.PathPatternParser
-
Whether case-sensitive pattern matching is enabled.
- isClientDisconnectedException(Throwable) - Static method in class org.springframework.web.util.DisconnectedClientHelper
-
Whether the given exception indicates the client has gone away.
- isCommitted() - Method in class org.springframework.http.client.reactive.AbstractClientHttpRequest
- isCommitted() - Method in class org.springframework.http.client.reactive.ClientHttpRequestDecorator
- isCommitted() - Method in interface org.springframework.http.ReactiveHttpOutputMessage
-
Whether the HttpOutputMessage is committed.
- isCommitted() - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
- isCommitted() - Method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
- isCompatibleWith(MediaType) - Method in class org.springframework.http.MediaType
-
Indicate whether this
MediaType
is compatible with the given media type. - isComplete() - Method in interface org.springframework.web.bind.support.SessionStatus
-
Return whether the current handler's session processing has been marked as complete.
- isComplete() - Method in class org.springframework.web.bind.support.SimpleSessionStatus
- isCompleted() - Method in interface org.springframework.http.server.ServerHttpAsyncRequestControl
-
Return whether asynchronous request processing has been completed.
- isCompleted() - Method in class org.springframework.http.server.ServletServerHttpAsyncRequestControl
- isConcurrentHandlingStarted() - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Return whether the selected handler for the current request chose to handle the request asynchronously.
- isConnectionAborted() - Method in class org.springframework.http.server.reactive.observation.ServerRequestObservationContext
-
Whether the current connection was aborted by the client, resulting in a
cancel signal
on the reactive chain, or anAbortedException
when reading the request. - isContextRequired() - Method in class org.springframework.web.context.support.WebApplicationObjectSupport
-
Overrides the base class behavior to enforce running in an ApplicationContext.
- isCookieHttpOnly() - Method in class org.springframework.web.util.CookieGenerator
-
Deprecated.Return whether the cookie is supposed to be marked with the "HttpOnly" attribute.
- isCookieSecure() - Method in class org.springframework.web.util.CookieGenerator
-
Deprecated.Return whether the cookie should only be sent using a secure protocol, such as HTTPS (SSL).
- isCorsRequest(HttpServletRequest) - Static method in class org.springframework.web.cors.CorsUtils
-
Returns
true
if the request is a valid CORS one by checkingOrigin
header presence and ensuring that origins are different. - isCorsRequest(ServerHttpRequest) - Static method in class org.springframework.web.cors.reactive.CorsUtils
-
Returns
true
if the request is a valid CORS one by checkingOrigin
header presence and ensuring that origins are different viaCorsUtils.isSameOrigin(org.springframework.http.server.reactive.ServerHttpRequest)
. - isDataEmpty(T) - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
-
Whether the given data item has any content to write.
- isDeclarativeBinding() - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Return whether to bind only fields intended for binding.
- isDirectFieldAccess() - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Return whether to use direct field access instead of bean property access.
- isEligibleForEtag(HttpServletRequest, HttpServletResponse, int, InputStream) - Method in class org.springframework.web.filter.ShallowEtagHeaderFilter
-
Whether an ETag should be calculated for the given request and response exchange.
- isEmpty() - Method in class org.springframework.http.HttpHeaders
- isEmpty() - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- isEmpty() - Method in class org.springframework.http.support.JettyHeadersAdapter
- isEmpty() - Method in class org.springframework.http.support.Netty4HeadersAdapter
- isEmpty() - Method in class org.springframework.http.support.Netty5HeadersAdapter
- isEmpty() - Method in interface org.springframework.web.multipart.MultipartFile
-
Return whether the uploaded file is empty, that is, either no file has been chosen in the multipart form or the chosen file has no content.
- isEnableLoggingRequestDetails() - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecConfig
-
Whether to log form data at DEBUG level, and headers at TRACE level.
- isEnableLoggingRequestDetails() - Method in class org.springframework.http.codec.LoggingCodecSupport
-
Whether any logging of values being encoded or decoded is explicitly disabled regardless of log level.
- isError() - Method in enum class org.springframework.http.HttpStatus
- isError() - Method in interface org.springframework.http.HttpStatusCode
-
Whether this status code is in the Client or Server Error class
- isExpired() - Method in interface org.springframework.web.server.WebSession
-
Return
true
if the session expired aftermaxIdleTime
elapsed. - isFile() - Method in class org.springframework.web.context.support.ServletContextResource
- isFlushPending() - Method in class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
-
Whether flushing is pending.
- isForceRequestEncoding() - Method in class org.springframework.web.filter.CharacterEncodingFilter
-
Return whether the encoding should be forced on requests.
- isForceResponseEncoding() - Method in class org.springframework.web.filter.CharacterEncodingFilter
-
Return whether the encoding should be forced on responses.
- isFormData() - Method in class org.springframework.http.ContentDisposition
-
Return whether the
type
is "form-data". - isForReturnValue() - Method in exception org.springframework.web.method.annotation.HandlerMethodValidationException
- isHandlerSessionAttribute(String, Class<?>) - Method in class org.springframework.web.method.annotation.SessionAttributesHandler
-
Whether the attribute name or type match the names and types specified via
@SessionAttributes
on the underlying controller. - isHttpOnly() - Method in class org.springframework.http.ResponseCookie
-
Return
true
if the cookie has the "HttpOnly" attribute. - isIgnoreUnknownExtensions() - Method in class org.springframework.web.accept.AbstractMappingContentNegotiationStrategy
- isImmutableSessionAttribute(String, Object) - Method in class org.springframework.web.context.request.ServletRequestAttributes
-
Determine whether the given value is to be considered as an immutable session attribute, that is, doesn't have to be re-set via
session.setAttribute
since its value cannot meaningfully change internally. - isIncludeClientInfo() - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Return whether the client address and session id should be included in the log message.
- isIncludeHeaders() - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Return whether the request headers should be included in the log message.
- isIncludePayload() - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Return whether the request payload (body) should be included in the log message.
- isIncludeQueryString() - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Return whether the query string should be included in the log message.
- isIncludeRequest(ServletRequest) - Static method in class org.springframework.web.util.WebUtils
-
Determine whether the given request is an include request, that is, not a top-level HTTP request coming in from the outside.
- isInline() - Method in class org.springframework.http.ContentDisposition
-
Return whether the
type
is "inline". - isLast() - Method in interface org.springframework.http.codec.multipart.PartEvent
-
Indicates whether this is the last event of a particular part.
- isLessSpecific(MimeType) - Method in class org.springframework.http.MediaType
-
Indicates whether this
MediaType
more specific than the given type. - isMatchOptionalTrailingSeparator() - Method in class org.springframework.web.util.pattern.PathPatternParser
-
Deprecated.as of 6.0 together with
PathPatternParser.setMatchOptionalTrailingSeparator(boolean)
. - isMissingAfterConversion() - Method in exception org.springframework.web.bind.MissingRequestValueException
-
Whether the request value was present but converted to
null
, e.g. - isMoreSpecific(MimeType) - Method in class org.springframework.http.MediaType
-
Indicates whether this
MediaType
more specific than the given type. - isMultipart(HttpServletRequest) - Method in interface org.springframework.web.multipart.MultipartResolver
-
Determine if the given request contains multipart content.
- isMultipart(HttpServletRequest) - Method in class org.springframework.web.multipart.support.StandardServletMultipartResolver
- isMultipartArgument(MethodParameter) - Static method in class org.springframework.web.multipart.support.MultipartResolutionDelegate
- isMultipartRequest(HttpServletRequest) - Static method in class org.springframework.web.multipart.support.MultipartResolutionDelegate
- isNotModified() - Method in class org.springframework.web.context.request.ServletWebRequest
- isNotModified() - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- isNotModified() - Method in interface org.springframework.web.server.ServerWebExchange
-
Returns
true
if the one of thecheckNotModified
methods in this contract were used and they returned true. - isNotModified() - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- isPattern(String) - Method in class org.springframework.web.util.pattern.PathPatternRouteMatcher
- isPreFlightRequest(HttpServletRequest) - Static method in class org.springframework.web.cors.CorsUtils
-
Returns
true
if the request is a valid CORS pre-flight one by checkingOPTIONS
method withOrigin
andAccess-Control-Request-Method
headers presence. - isPreFlightRequest(ServerHttpRequest) - Static method in class org.springframework.web.cors.reactive.CorsUtils
-
Returns
true
if the request is a valid CORS pre-flight one by checkingOPTIONS
method withOrigin
andAccess-Control-Request-Method
headers presence. - isProcessExternalEntities() - Method in class org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter
-
Return whether XML external entities are allowed.
- isProcessExternalEntities() - Method in class org.springframework.http.converter.xml.SourceHttpMessageConverter
-
Return whether XML external entities are allowed.
- isReadable() - Method in class org.springframework.web.context.support.ServletContextResource
-
This implementation delegates to
ServletContext.getResourceAsStream
, which returnsnull
in case of a non-readable resource (e.g. - isReadOnly(ELContext, Object, Object) - Method in class org.springframework.web.jsf.el.SpringBeanFacesELResolver
- isReadOnly(ELContext, Object, Object) - Method in class org.springframework.web.jsf.el.WebApplicationContextFacesELResolver
- isRemoveOnly() - Method in class org.springframework.web.server.adapter.ForwardedHeaderTransformer
-
Whether the "remove only" mode is on.
- isRequestActive() - Method in class org.springframework.web.context.request.AbstractRequestAttributes
-
Determine whether the original request is still active.
- isRequestHandled() - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Whether the request has been handled fully within the handler.
- isResolved() - Method in class org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest
-
Determine whether the underlying multipart request has been resolved.
- isRunning() - Method in class org.springframework.http.client.reactive.ReactorClientHttpConnector
- isRunning() - Method in class org.springframework.http.client.ReactorNettyClientRequestFactory
- isRunning() - Method in class org.springframework.http.client.ReactorResourceFactory
- isSameCodeAs(HttpStatusCode) - Method in interface org.springframework.http.HttpStatusCode
-
Whether this
HttpStatusCode
shares the same integervalue
as the other status code. - isSameOrigin(HttpRequest) - Static method in class org.springframework.web.util.WebUtils
-
Check if the request is a same-origin one, based on
Origin
,Host
,Forwarded
,X-Forwarded-Proto
,X-Forwarded-Host
andX-Forwarded-Port
headers. - isSameOrigin(ServerHttpRequest) - Static method in class org.springframework.web.cors.reactive.CorsUtils
-
Deprecated.as of 5.2, same-origin checks are performed directly by
CorsUtils.isCorsRequest(org.springframework.http.server.reactive.ServerHttpRequest)
- isSecure() - Method in class org.springframework.http.ResponseCookie
-
Return
true
if the cookie has the "Secure" attribute. - isSecure() - Method in class org.springframework.web.context.request.FacesWebRequest
- isSecure() - Method in class org.springframework.web.context.request.ServletWebRequest
- isSecure() - Method in interface org.springframework.web.context.request.WebRequest
-
Return whether this request has been sent over a secure transport mechanism (such as SSL).
- isSetOrExpired() - Method in class org.springframework.web.context.request.async.DeferredResult
-
Return
true
if this DeferredResult is no longer usable either because it was previously set or because the underlying request expired. - isSingleton() - Method in class org.springframework.http.client.support.ProxyFactoryBean
- isSingleton() - Method in class org.springframework.http.converter.json.GsonFactoryBean
- isSingleton() - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
- isSingleton() - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
- isSingleton() - Method in class org.springframework.web.context.support.ServletContextAttributeFactoryBean
- isSingleton() - Method in class org.springframework.web.context.support.ServletContextParameterFactoryBean
- isStarted() - Method in interface org.springframework.http.server.ServerHttpAsyncRequestControl
-
Return whether asynchronous request processing has been started.
- isStarted() - Method in class org.springframework.http.server.ServletServerHttpAsyncRequestControl
- isStarted() - Method in interface org.springframework.web.server.WebSession
-
Whether a session with the client has been started explicitly via
WebSession.start()
or implicitly by adding session attributes. - isSupportDtd() - Method in class org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter
-
Return whether DTD parsing is supported.
- isSupportDtd() - Method in class org.springframework.http.converter.xml.SourceHttpMessageConverter
-
Return whether DTD parsing is supported.
- isTargetFilterLifecycle() - Method in class org.springframework.web.filter.DelegatingFilterProxy
-
Return whether to invoke the
Filter.init
andFilter.destroy
lifecycle methods on the target bean. - isUrlDecode() - Method in class org.springframework.web.util.UrlPathHelper
-
Whether to decode the request URI when determining the lookup path.
- isUseGlobalResources() - Method in class org.springframework.http.client.reactive.ReactorNetty2ResourceFactory
-
Whether this factory exposes the global
HttpResources
holder. - isUseGlobalResources() - Method in class org.springframework.http.client.ReactorResourceFactory
-
Whether this factory exposes the global
HttpResources
holder. - isUseRegisteredExtensionsOnly() - Method in class org.springframework.web.accept.AbstractMappingContentNegotiationStrategy
- isUserInRole(String) - Method in class org.springframework.web.context.request.FacesWebRequest
- isUserInRole(String) - Method in class org.springframework.web.context.request.ServletWebRequest
- isUserInRole(String) - Method in interface org.springframework.web.context.request.WebRequest
-
Determine whether the user is in the given role for this request.
- isValidOrigin(HttpRequest, Collection<String>) - Static method in class org.springframework.web.util.WebUtils
-
Check the given request origin against a list of allowed origins.
- isViewReference() - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Whether the view is a view reference specified via a name to be resolved by the DispatcherServlet via a ViewResolver.
- isWritePossible() - Method in class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
-
Whether writing/flushing is possible.
- isWritePossible() - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
-
Whether writing is possible.
- isWriteWeakETag() - Method in class org.springframework.web.filter.ShallowEtagHeaderFilter
-
Return whether the ETag value written to the response should be weak, as per RFC 7232.
J
- Jackson2CborDecoder - Class in org.springframework.http.codec.cbor
-
Decode bytes into CBOR and convert to Object's with Jackson.
- Jackson2CborDecoder() - Constructor for class org.springframework.http.codec.cbor.Jackson2CborDecoder
- Jackson2CborDecoder(ObjectMapper, MimeType...) - Constructor for class org.springframework.http.codec.cbor.Jackson2CborDecoder
- Jackson2CborEncoder - Class in org.springframework.http.codec.cbor
-
Encode from an
Object
to bytes of CBOR objects using Jackson. - Jackson2CborEncoder() - Constructor for class org.springframework.http.codec.cbor.Jackson2CborEncoder
- Jackson2CborEncoder(ObjectMapper, MimeType...) - Constructor for class org.springframework.http.codec.cbor.Jackson2CborEncoder
- Jackson2CodecSupport - Class in org.springframework.http.codec.json
-
Base class providing support methods for Jackson 2.x encoding and decoding.
- Jackson2CodecSupport(ObjectMapper, MimeType...) - Constructor for class org.springframework.http.codec.json.Jackson2CodecSupport
-
Constructor with a Jackson
ObjectMapper
to use. - jackson2JsonDecoder(Decoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Override the default Jackson JSON
Decoder
. - Jackson2JsonDecoder - Class in org.springframework.http.codec.json
-
Decode a byte stream into JSON and convert to Object's with Jackson 2.x, leveraging non-blocking parsing.
- Jackson2JsonDecoder() - Constructor for class org.springframework.http.codec.json.Jackson2JsonDecoder
- Jackson2JsonDecoder(ObjectMapper, MimeType...) - Constructor for class org.springframework.http.codec.json.Jackson2JsonDecoder
- jackson2JsonEncoder(Encoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Override the default Jackson JSON
Encoder
. - Jackson2JsonEncoder - Class in org.springframework.http.codec.json
-
Encode from an
Object
stream to a byte stream of JSON objects using Jackson 2.x. - Jackson2JsonEncoder() - Constructor for class org.springframework.http.codec.json.Jackson2JsonEncoder
- Jackson2JsonEncoder(ObjectMapper, MimeType...) - Constructor for class org.springframework.http.codec.json.Jackson2JsonEncoder
- Jackson2ObjectMapperBuilder - Class in org.springframework.http.converter.json
-
A builder used to create
ObjectMapper
instances with a fluent API. - Jackson2ObjectMapperBuilder() - Constructor for class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
- Jackson2ObjectMapperFactoryBean - Class in org.springframework.http.converter.json
-
A
FactoryBean
for creating a Jackson 2.xObjectMapper
(default) orXmlMapper
(createXmlMapper
property set to true) with setters to enable or disable Jackson features from within XML configuration. - Jackson2ObjectMapperFactoryBean() - Constructor for class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
- jackson2SmileDecoder(Decoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Override the default Jackson Smile
Decoder
. - Jackson2SmileDecoder - Class in org.springframework.http.codec.json
-
Decode a byte stream into Smile and convert to Object's with Jackson 2.x, leveraging non-blocking parsing.
- Jackson2SmileDecoder() - Constructor for class org.springframework.http.codec.json.Jackson2SmileDecoder
- Jackson2SmileDecoder(ObjectMapper, MimeType...) - Constructor for class org.springframework.http.codec.json.Jackson2SmileDecoder
- jackson2SmileEncoder(Encoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Override the default Jackson Smile
Encoder
. - Jackson2SmileEncoder - Class in org.springframework.http.codec.json
-
Encode from an
Object
stream to a byte stream of Smile objects using Jackson 2.x. - Jackson2SmileEncoder() - Constructor for class org.springframework.http.codec.json.Jackson2SmileEncoder
- Jackson2SmileEncoder(ObjectMapper, MimeType...) - Constructor for class org.springframework.http.codec.json.Jackson2SmileEncoder
- javaScriptEscape(String) - Static method in class org.springframework.web.util.JavaScriptUtils
-
Turn JavaScript special characters into escaped characters.
- JavaScriptUtils - Class in org.springframework.web.util
-
Utility class for JavaScript escaping.
- JavaScriptUtils() - Constructor for class org.springframework.web.util.JavaScriptUtils
- Jaxb2CollectionHttpMessageConverter<T extends Collection> - Class in org.springframework.http.converter.xml
-
An
HttpMessageConverter
that can read XML collections using JAXB2. - Jaxb2CollectionHttpMessageConverter() - Constructor for class org.springframework.http.converter.xml.Jaxb2CollectionHttpMessageConverter
- jaxb2Decoder(Decoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Override the default JAXB2
Decoder
. - jaxb2Encoder(Encoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Override the default JABX2
Encoder
. - Jaxb2RootElementHttpMessageConverter - Class in org.springframework.http.converter.xml
-
Implementation of
HttpMessageConverter
that can read and write XML using JAXB2. - Jaxb2RootElementHttpMessageConverter() - Constructor for class org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter
- Jaxb2XmlDecoder - Class in org.springframework.http.codec.xml
-
Decode from a bytes stream containing XML elements to a stream of
Object
s (POJOs). - Jaxb2XmlDecoder() - Constructor for class org.springframework.http.codec.xml.Jaxb2XmlDecoder
- Jaxb2XmlDecoder(MimeType...) - Constructor for class org.springframework.http.codec.xml.Jaxb2XmlDecoder
-
Create a
Jaxb2XmlDecoder
with the specified MIME types. - Jaxb2XmlEncoder - Class in org.springframework.http.codec.xml
-
Encode from single value to a byte stream containing XML elements.
- Jaxb2XmlEncoder() - Constructor for class org.springframework.http.codec.xml.Jaxb2XmlEncoder
- JdkClientHttpConnector - Class in org.springframework.http.client.reactive
-
ClientHttpConnector
for the JavaHttpClient
. - JdkClientHttpConnector() - Constructor for class org.springframework.http.client.reactive.JdkClientHttpConnector
-
Default constructor that uses
HttpClient.newHttpClient()
. - JdkClientHttpConnector(HttpClient) - Constructor for class org.springframework.http.client.reactive.JdkClientHttpConnector
-
Constructor with an initialized
HttpClient
and aDataBufferFactory
. - JdkClientHttpConnector(HttpClient.Builder, JdkHttpClientResourceFactory) - Constructor for class org.springframework.http.client.reactive.JdkClientHttpConnector
-
Constructor with a
JdkHttpClientResourceFactory
that provides shared resources. - JdkClientHttpRequestFactory - Class in org.springframework.http.client
-
ClientHttpRequestFactory
implementation based on the JavaHttpClient
. - JdkClientHttpRequestFactory() - Constructor for class org.springframework.http.client.JdkClientHttpRequestFactory
-
Create a new instance of the
JdkClientHttpRequestFactory
with a defaultHttpClient
. - JdkClientHttpRequestFactory(HttpClient) - Constructor for class org.springframework.http.client.JdkClientHttpRequestFactory
-
Create a new instance of the
JdkClientHttpRequestFactory
based on the givenHttpClient
. - JdkClientHttpRequestFactory(HttpClient, Executor) - Constructor for class org.springframework.http.client.JdkClientHttpRequestFactory
-
Create a new instance of the
JdkClientHttpRequestFactory
based on the givenHttpClient
andExecutor
. - JdkHttpClientResourceFactory - Class in org.springframework.http.client.reactive
-
Factory to manage JDK HttpClient resources such as a shared
Executor
within the lifecycle of a SpringApplicationContext
. - JdkHttpClientResourceFactory() - Constructor for class org.springframework.http.client.reactive.JdkHttpClientResourceFactory
- JettyClientHttpConnector - Class in org.springframework.http.client.reactive
-
ClientHttpConnector
for the Jetty Reactive Streams HttpClient. - JettyClientHttpConnector() - Constructor for class org.springframework.http.client.reactive.JettyClientHttpConnector
-
Default constructor that creates a new instance of
HttpClient
. - JettyClientHttpConnector(HttpClient) - Constructor for class org.springframework.http.client.reactive.JettyClientHttpConnector
-
Constructor with an initialized
HttpClient
. - JettyClientHttpConnector(HttpClient, JettyResourceFactory) - Constructor for class org.springframework.http.client.reactive.JettyClientHttpConnector
-
Constructor with an initialized
HttpClient
and configures it with the givenJettyResourceFactory
. - JettyClientHttpConnector(JettyResourceFactory, Consumer<HttpClient>) - Constructor for class org.springframework.http.client.reactive.JettyClientHttpConnector
-
Deprecated.as of 5.2, in favor of
JettyClientHttpConnector(HttpClient, JettyResourceFactory)
- JettyClientHttpRequestFactory - Class in org.springframework.http.client
-
ClientHttpRequestFactory
implementation based on Jetty'sHttpClient
. - JettyClientHttpRequestFactory() - Constructor for class org.springframework.http.client.JettyClientHttpRequestFactory
-
Default constructor that creates a new instance of
HttpClient
. - JettyClientHttpRequestFactory(HttpClient) - Constructor for class org.springframework.http.client.JettyClientHttpRequestFactory
-
Constructor that takes a customized
HttpClient
instance. - JettyHeadersAdapter - Class in org.springframework.http.support
-
MultiValueMap
implementation for wrapping Jetty HTTP headers. - JettyHeadersAdapter(HttpFields) - Constructor for class org.springframework.http.support.JettyHeadersAdapter
-
Creates a new
JettyHeadersAdapter
based on the givenHttpFields
instance. - JettyHttpHandlerAdapter - Class in org.springframework.http.server.reactive
-
ServletHttpHandlerAdapter
extension that uses Jetty APIs for writing to the response withByteBuffer
. - JettyHttpHandlerAdapter(HttpHandler) - Constructor for class org.springframework.http.server.reactive.JettyHttpHandlerAdapter
- JettyResourceFactory - Class in org.springframework.http.client.reactive
-
Factory to manage Jetty resources, i.e.
- JettyResourceFactory() - Constructor for class org.springframework.http.client.reactive.JettyResourceFactory
- JNDI_PROPERTY_SOURCE_NAME - Static variable in class org.springframework.web.context.support.StandardServletEnvironment
-
JNDI property source name: "jndiProperties".
- json() - Static method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Obtain a
Jackson2ObjectMapperBuilder
instance in order to build a regular JSONObjectMapper
instance. - JSON_VIEW_HINT - Static variable in class org.springframework.http.codec.json.Jackson2CodecSupport
-
The key for the hint to specify a "JSON View" for encoding or decoding with the value expected to be a
Class
. - JsonbHttpMessageConverter - Class in org.springframework.http.converter.json
-
Implementation of
HttpMessageConverter
that can read and write JSON using the JSON Binding API. - JsonbHttpMessageConverter() - Constructor for class org.springframework.http.converter.json.JsonbHttpMessageConverter
-
Construct a new
JsonbHttpMessageConverter
with default configuration. - JsonbHttpMessageConverter(Jsonb) - Constructor for class org.springframework.http.converter.json.JsonbHttpMessageConverter
-
Construct a new
JsonbHttpMessageConverter
with the given delegate. - JsonbHttpMessageConverter(JsonbConfig) - Constructor for class org.springframework.http.converter.json.JsonbHttpMessageConverter
-
Construct a new
JsonbHttpMessageConverter
with the given configuration.
K
- keyDeserializerInstance(DeserializationConfig, Annotated, Class<?>) - Method in class org.springframework.http.converter.json.SpringHandlerInstantiator
- keySet() - Method in class org.springframework.http.HttpHeaders
- keySet() - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- keySet() - Method in class org.springframework.http.support.JettyHeadersAdapter
- keySet() - Method in class org.springframework.http.support.Netty4HeadersAdapter
- keySet() - Method in class org.springframework.http.support.Netty5HeadersAdapter
- KotlinSerializationBinaryDecoder<T extends kotlinx.serialization.BinaryFormat> - Class in org.springframework.http.codec
-
Abstract base class for
Decoder
implementations that defer to Kotlin binary serializers. - KotlinSerializationBinaryDecoder(T, MimeType...) - Constructor for class org.springframework.http.codec.KotlinSerializationBinaryDecoder
- KotlinSerializationBinaryEncoder<T extends kotlinx.serialization.BinaryFormat> - Class in org.springframework.http.codec
-
Abstract base class for
Encoder
implementations that defer to Kotlin binary serializers. - KotlinSerializationBinaryEncoder(T, MimeType...) - Constructor for class org.springframework.http.codec.KotlinSerializationBinaryEncoder
- KotlinSerializationBinaryHttpMessageConverter<T extends kotlinx.serialization.BinaryFormat> - Class in org.springframework.http.converter
-
Abstract base class for
HttpMessageConverter
implementations that defer to Kotlin binary serializers. - KotlinSerializationBinaryHttpMessageConverter(T, MediaType...) - Constructor for class org.springframework.http.converter.KotlinSerializationBinaryHttpMessageConverter
-
Construct an
KotlinSerializationBinaryHttpMessageConverter
with format and supported media types. - kotlinSerializationCborDecoder(Decoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Override the default Kotlin Serialization CBOR
Decoder
. - KotlinSerializationCborDecoder - Class in org.springframework.http.codec.cbor
-
Decode a byte stream into CBOR and convert to Objects with kotlinx.serialization.
- KotlinSerializationCborDecoder() - Constructor for class org.springframework.http.codec.cbor.KotlinSerializationCborDecoder
- KotlinSerializationCborDecoder(Cbor) - Constructor for class org.springframework.http.codec.cbor.KotlinSerializationCborDecoder
- kotlinSerializationCborEncoder(Encoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Override the default Kotlin Serialization CBOR
Encoder
. - KotlinSerializationCborEncoder - Class in org.springframework.http.codec.cbor
-
Encode from an
Object
stream to a byte stream of CBOR objects using kotlinx.serialization. - KotlinSerializationCborEncoder() - Constructor for class org.springframework.http.codec.cbor.KotlinSerializationCborEncoder
- KotlinSerializationCborEncoder(Cbor) - Constructor for class org.springframework.http.codec.cbor.KotlinSerializationCborEncoder
- KotlinSerializationCborHttpMessageConverter - Class in org.springframework.http.converter.cbor
-
Implementation of
HttpMessageConverter
that can read and write CBOR using kotlinx.serialization. - KotlinSerializationCborHttpMessageConverter() - Constructor for class org.springframework.http.converter.cbor.KotlinSerializationCborHttpMessageConverter
- KotlinSerializationCborHttpMessageConverter(Cbor) - Constructor for class org.springframework.http.converter.cbor.KotlinSerializationCborHttpMessageConverter
- kotlinSerializationJsonDecoder(Decoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Override the default Kotlin Serialization JSON
Decoder
. - KotlinSerializationJsonDecoder - Class in org.springframework.http.codec.json
-
Decode a byte stream into JSON and convert to Object's with kotlinx.serialization.
- KotlinSerializationJsonDecoder() - Constructor for class org.springframework.http.codec.json.KotlinSerializationJsonDecoder
- KotlinSerializationJsonDecoder(Json) - Constructor for class org.springframework.http.codec.json.KotlinSerializationJsonDecoder
- kotlinSerializationJsonEncoder(Encoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Override the default Kotlin Serialization JSON
Encoder
. - KotlinSerializationJsonEncoder - Class in org.springframework.http.codec.json
-
Encode from an
Object
stream to a byte stream of JSON objects using kotlinx.serialization. - KotlinSerializationJsonEncoder() - Constructor for class org.springframework.http.codec.json.KotlinSerializationJsonEncoder
- KotlinSerializationJsonEncoder(Json) - Constructor for class org.springframework.http.codec.json.KotlinSerializationJsonEncoder
- KotlinSerializationJsonHttpMessageConverter - Class in org.springframework.http.converter.json
-
Implementation of
HttpMessageConverter
that can read and write JSON using kotlinx.serialization. - KotlinSerializationJsonHttpMessageConverter() - Constructor for class org.springframework.http.converter.json.KotlinSerializationJsonHttpMessageConverter
-
Construct a new
KotlinSerializationJsonHttpMessageConverter
with the default configuration. - KotlinSerializationJsonHttpMessageConverter(Json) - Constructor for class org.springframework.http.converter.json.KotlinSerializationJsonHttpMessageConverter
-
Construct a new
KotlinSerializationJsonHttpMessageConverter
with a custom configuration. - kotlinSerializationProtobufDecoder(Decoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Override the default Kotlin Serialization Protobuf
Decoder
. - KotlinSerializationProtobufDecoder - Class in org.springframework.http.codec.protobuf
-
Decode a byte stream into a protocol Buffer and convert to Objects with kotlinx.serialization.
- KotlinSerializationProtobufDecoder() - Constructor for class org.springframework.http.codec.protobuf.KotlinSerializationProtobufDecoder
- KotlinSerializationProtobufDecoder(ProtoBuf) - Constructor for class org.springframework.http.codec.protobuf.KotlinSerializationProtobufDecoder
- kotlinSerializationProtobufEncoder(Encoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Override the default Kotlin Serialization Protobuf
Encoder
. - KotlinSerializationProtobufEncoder - Class in org.springframework.http.codec.protobuf
-
Decode a byte stream into a Protocol Buffer and convert to Objects with kotlinx.serialization.
- KotlinSerializationProtobufEncoder() - Constructor for class org.springframework.http.codec.protobuf.KotlinSerializationProtobufEncoder
- KotlinSerializationProtobufEncoder(ProtoBuf) - Constructor for class org.springframework.http.codec.protobuf.KotlinSerializationProtobufEncoder
- KotlinSerializationProtobufHttpMessageConverter - Class in org.springframework.http.converter.protobuf
-
Implementation of
HttpMessageConverter
that can read and write Protocol Buffers using kotlinx.serialization. - KotlinSerializationProtobufHttpMessageConverter() - Constructor for class org.springframework.http.converter.protobuf.KotlinSerializationProtobufHttpMessageConverter
- KotlinSerializationProtobufHttpMessageConverter(ProtoBuf) - Constructor for class org.springframework.http.converter.protobuf.KotlinSerializationProtobufHttpMessageConverter
- KotlinSerializationStringDecoder<T extends kotlinx.serialization.StringFormat> - Class in org.springframework.http.codec
-
Abstract base class for
Decoder
implementations that defer to Kotlin string serializers. - KotlinSerializationStringDecoder(T, MimeType...) - Constructor for class org.springframework.http.codec.KotlinSerializationStringDecoder
- KotlinSerializationStringEncoder<T extends kotlinx.serialization.StringFormat> - Class in org.springframework.http.codec
-
Abstract base class for
Encoder
implementations that defer to Kotlin string serializers. - KotlinSerializationStringEncoder(T, MimeType...) - Constructor for class org.springframework.http.codec.KotlinSerializationStringEncoder
- KotlinSerializationStringHttpMessageConverter<T extends kotlinx.serialization.StringFormat> - Class in org.springframework.http.converter
-
Abstract base class for
HttpMessageConverter
implementations that defer to Kotlin string serializers. - KotlinSerializationStringHttpMessageConverter(T, MediaType...) - Constructor for class org.springframework.http.converter.KotlinSerializationStringHttpMessageConverter
-
Construct an
KotlinSerializationStringHttpMessageConverter
with format and supported media types. - KotlinSerializationSupport<T extends kotlinx.serialization.SerialFormat> - Class in org.springframework.http.codec
-
Base class providing support methods for encoding and decoding with Kotlin serialization.
- KotlinSerializationSupport(T, MimeType...) - Constructor for class org.springframework.http.codec.KotlinSerializationSupport
-
Creates a new instance of this support class with the given format and supported mime types.
L
- LAST_MODIFIED - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Last-Modified
header field name. - lastModified(long) - Method in interface org.springframework.http.ResponseEntity.HeadersBuilder
-
Set the time the resource was last changed, as specified by the
Last-Modified
header. - lastModified(Instant) - Method in interface org.springframework.http.ResponseEntity.HeadersBuilder
-
Set the time the resource was last changed, as specified by the
Last-Modified
header. - lastModified(ZonedDateTime) - Method in interface org.springframework.http.ResponseEntity.HeadersBuilder
-
Set the time the resource was last changed, as specified by the
Last-Modified
header. - LENGTH_REQUIRED - Enum constant in enum class org.springframework.http.HttpStatus
-
411 Length Required
. - LINK - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Link
header field name. - loadBeanDefinitions(GroovyBeanDefinitionReader) - Method in class org.springframework.web.context.support.GroovyWebApplicationContext
-
Load the bean definitions with the given GroovyBeanDefinitionReader.
- loadBeanDefinitions(DefaultListableBeanFactory) - Method in class org.springframework.web.context.support.AnnotationConfigWebApplicationContext
-
Register a
BeanDefinition
for any classes specified byAnnotationConfigWebApplicationContext.register(Class...)
and scan any packages specified byAnnotationConfigWebApplicationContext.scan(String...)
. - loadBeanDefinitions(DefaultListableBeanFactory) - Method in class org.springframework.web.context.support.GroovyWebApplicationContext
-
Loads the bean definitions via an GroovyBeanDefinitionReader.
- loadBeanDefinitions(DefaultListableBeanFactory) - Method in class org.springframework.web.context.support.XmlWebApplicationContext
-
Loads the bean definitions via an XmlBeanDefinitionReader.
- loadBeanDefinitions(XmlBeanDefinitionReader) - Method in class org.springframework.web.context.support.XmlWebApplicationContext
-
Load the bean definitions with the given XmlBeanDefinitionReader.
- loadParentContext(ServletContext) - Method in class org.springframework.web.context.ContextLoader
-
Template method with default implementation (which may be overridden by a subclass), to load or obtain an ApplicationContext instance which will be used as the parent context of the root WebApplicationContext.
- locale(String) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Override the default
Locale
to use for formatting. - locale(Locale) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Override the default
Locale
to use for formatting. - LOCALE_CONTEXT_RESOLVER_BEAN_NAME - Static variable in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Well-known name for the LocaleContextResolver in the bean factory.
- localeContextResolver(LocaleContextResolver) - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Configure the
LocaleContextResolver
to set on theWebServerExchange
. - LocaleContextResolver - Interface in org.springframework.web.server.i18n
-
Interface for web-based locale context resolution strategies that allows for both locale context resolution via the request and locale context modification via the HTTP exchange.
- location(URI) - Method in interface org.springframework.http.ResponseEntity.HeadersBuilder
-
Set the location of a resource, as specified by the
Location
header. - LOCATION - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Location
header field name. - LOCKED - Enum constant in enum class org.springframework.http.HttpStatus
-
423 Locked
. - LOG_ID_ATTRIBUTE - Static variable in interface org.springframework.web.server.ServerWebExchange
-
Name of
attribute
whose value can be used to correlate log messages for this exchange. - logger - Variable in class org.springframework.http.client.support.HttpAccessor
-
Logger available to subclasses.
- logger - Variable in class org.springframework.http.codec.json.Jackson2CodecSupport
- logger - Variable in class org.springframework.http.codec.LoggingCodecSupport
- logger - Variable in class org.springframework.http.converter.AbstractHttpMessageConverter
-
Logger available to subclasses.
- logger - Variable in class org.springframework.web.accept.AbstractMappingContentNegotiationStrategy
- logger - Variable in class org.springframework.web.client.support.RestGatewaySupport
-
Logger available to subclasses.
- logger - Variable in class org.springframework.web.context.AbstractContextLoaderInitializer
-
Logger available to subclasses.
- logger - Variable in class org.springframework.web.context.support.ServletContextAttributeExporter
- logger - Variable in class org.springframework.web.filter.GenericFilterBean
-
Logger available to subclasses.
- logger - Variable in class org.springframework.web.jsf.el.WebApplicationContextFacesELResolver
-
Logger available to subclasses.
- logger - Variable in class org.springframework.web.method.annotation.ModelAttributeMethodProcessor
- logger - Static variable in class org.springframework.web.method.HandlerMethod
-
Logger that is available to subclasses.
- logger - Variable in class org.springframework.web.service.invoker.AbstractNamedValueArgumentResolver
- logger - Variable in class org.springframework.web.util.CookieGenerator
-
Deprecated.
- LoggingCodecSupport - Class in org.springframework.http.codec
-
Base class for
Encoder
,Decoder
,HttpMessageReader
, orHttpMessageWriter
that uses a logger and shows potentially sensitive request data. - LoggingCodecSupport() - Constructor for class org.springframework.http.codec.LoggingCodecSupport
- logWarningIfNecessary(Type, Throwable) - Method in class org.springframework.http.codec.json.Jackson2CodecSupport
-
Determine whether to log the given exception coming from a
ObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType)
/ObjectMapper.canSerialize(java.lang.Class<?>)
check. - logWarningIfNecessary(Type, Throwable) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
-
Determine whether to log the given exception coming from a
ObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType)
/ObjectMapper.canSerialize(java.lang.Class<?>)
check. - lookupMediaType(String) - Method in class org.springframework.web.accept.MappingMediaTypeFileExtensionResolver
-
Use this method for a reverse lookup from extension to MediaType.
- lookupMultipartResolver() - Method in class org.springframework.web.multipart.support.MultipartFilter
-
Look for a MultipartResolver bean in the root web application context.
- lookupMultipartResolver(HttpServletRequest) - Method in class org.springframework.web.multipart.support.MultipartFilter
-
Look up the MultipartResolver that this filter should use, taking the current HTTP request as argument.
- LOOP_DETECTED - Enum constant in enum class org.springframework.http.HttpStatus
-
508 Loop Detected
M
- MapMethodProcessor - Class in org.springframework.web.method.annotation
- MapMethodProcessor() - Constructor for class org.springframework.web.method.annotation.MapMethodProcessor
- Mapping - Annotation Interface in org.springframework.web.bind.annotation
-
Meta annotation that indicates a web mapping annotation.
- MappingJackson2CborHttpMessageConverter - Class in org.springframework.http.converter.cbor
-
Implementation of
HttpMessageConverter
that can read and write the CBOR data format using the dedicated Jackson 2.x extension. - MappingJackson2CborHttpMessageConverter() - Constructor for class org.springframework.http.converter.cbor.MappingJackson2CborHttpMessageConverter
-
Construct a new
MappingJackson2CborHttpMessageConverter
using the default configuration provided byJackson2ObjectMapperBuilder
. - MappingJackson2CborHttpMessageConverter(ObjectMapper) - Constructor for class org.springframework.http.converter.cbor.MappingJackson2CborHttpMessageConverter
-
Construct a new
MappingJackson2CborHttpMessageConverter
with a customObjectMapper
(must be configured with aCBORFactory
instance). - MappingJackson2HttpMessageConverter - Class in org.springframework.http.converter.json
-
Implementation of
HttpMessageConverter
that can read and write JSON using Jackson 2.x'sObjectMapper
. - MappingJackson2HttpMessageConverter() - Constructor for class org.springframework.http.converter.json.MappingJackson2HttpMessageConverter
-
Construct a new
MappingJackson2HttpMessageConverter
using default configuration provided byJackson2ObjectMapperBuilder
. - MappingJackson2HttpMessageConverter(ObjectMapper) - Constructor for class org.springframework.http.converter.json.MappingJackson2HttpMessageConverter
-
Construct a new
MappingJackson2HttpMessageConverter
with a customObjectMapper
. - MappingJackson2SmileHttpMessageConverter - Class in org.springframework.http.converter.smile
-
Implementation of
HttpMessageConverter
that can read and write Smile data format ("binary JSON") using the dedicated Jackson 2.x extension. - MappingJackson2SmileHttpMessageConverter() - Constructor for class org.springframework.http.converter.smile.MappingJackson2SmileHttpMessageConverter
-
Construct a new
MappingJackson2SmileHttpMessageConverter
using default configuration provided byJackson2ObjectMapperBuilder
. - MappingJackson2SmileHttpMessageConverter(ObjectMapper) - Constructor for class org.springframework.http.converter.smile.MappingJackson2SmileHttpMessageConverter
-
Construct a new
MappingJackson2SmileHttpMessageConverter
with a customObjectMapper
(must be configured with aSmileFactory
instance). - MappingJackson2XmlHttpMessageConverter - Class in org.springframework.http.converter.xml
-
Implementation of
HttpMessageConverter
that can read and write XML using Jackson 2.x extension component for reading and writing XML encoded data. - MappingJackson2XmlHttpMessageConverter() - Constructor for class org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter
-
Construct a new
MappingJackson2XmlHttpMessageConverter
using default configuration provided byJackson2ObjectMapperBuilder
. - MappingJackson2XmlHttpMessageConverter(ObjectMapper) - Constructor for class org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter
-
Construct a new
MappingJackson2XmlHttpMessageConverter
with a customObjectMapper
(must be aXmlMapper
instance). - MappingJacksonInputMessage - Class in org.springframework.http.converter.json
-
HttpInputMessage
that can eventually stores a Jackson view that will be used to deserialize the message. - MappingJacksonInputMessage(InputStream, HttpHeaders) - Constructor for class org.springframework.http.converter.json.MappingJacksonInputMessage
- MappingJacksonInputMessage(InputStream, HttpHeaders, Class<?>) - Constructor for class org.springframework.http.converter.json.MappingJacksonInputMessage
- MappingJacksonValue - Class in org.springframework.http.converter.json
-
A simple holder for the POJO to serialize via
MappingJackson2HttpMessageConverter
along with further serialization instructions to be passed in to the converter. - MappingJacksonValue(Object) - Constructor for class org.springframework.http.converter.json.MappingJacksonValue
-
Create a new instance wrapping the given POJO to be serialized.
- MappingMediaTypeFileExtensionResolver - Class in org.springframework.web.accept
-
An implementation of
MediaTypeFileExtensionResolver
that maintains lookups between file extensions and MediaTypes in both directions. - MappingMediaTypeFileExtensionResolver(Map<String, MediaType>) - Constructor for class org.springframework.web.accept.MappingMediaTypeFileExtensionResolver
-
Create an instance with the given map of file extensions and media types.
- MarshallingHttpMessageConverter - Class in org.springframework.http.converter.xml
-
Implementation of
HttpMessageConverter
that can read and write XML using Spring'sMarshaller
andUnmarshaller
abstractions. - MarshallingHttpMessageConverter() - Constructor for class org.springframework.http.converter.xml.MarshallingHttpMessageConverter
-
Construct a new
MarshallingHttpMessageConverter
with noMarshaller
orUnmarshaller
set. - MarshallingHttpMessageConverter(Marshaller) - Constructor for class org.springframework.http.converter.xml.MarshallingHttpMessageConverter
-
Construct a new
MarshallingMessageConverter
with the givenMarshaller
set. - MarshallingHttpMessageConverter(Marshaller, Unmarshaller) - Constructor for class org.springframework.http.converter.xml.MarshallingHttpMessageConverter
-
Construct a new
MarshallingMessageConverter
with the givenMarshaller
andUnmarshaller
. - match(String) - Method in class org.springframework.web.util.UriTemplate
-
Match the given URI to a map of variable values.
- match(String, RouteMatcher.Route) - Method in class org.springframework.web.util.pattern.PathPatternRouteMatcher
- matchAndExtract(String, RouteMatcher.Route) - Method in class org.springframework.web.util.pattern.PathPatternRouteMatcher
- matchAndExtract(PathContainer) - Method in class org.springframework.web.util.pattern.PathPattern
-
Match this pattern to the given URI path and return extracted URI template variables as well as path parameters (matrix variables).
- matches(String) - Method in class org.springframework.http.HttpMethod
-
Determine whether this
HttpMethod
matches the given method value. - matches(String) - Method in class org.springframework.web.util.UriTemplate
-
Indicate whether the given URI matches this template.
- matches(PathContainer) - Method in class org.springframework.web.util.pattern.PathPattern
-
Whether this pattern matches the given path.
- matchStartOfPath(PathContainer) - Method in class org.springframework.web.util.pattern.PathPattern
-
Match the beginning of the given path and return the remaining portion not covered by this pattern.
- matrixVariable(MatrixVariable, ParameterValidationResult) - Method in interface org.springframework.web.method.annotation.HandlerMethodValidationException.Visitor
-
Handle results for
@MatrixVariable
method parameters. - MatrixVariable - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation which indicates that a method parameter should be bound to a name-value pair within a path segment.
- MAX_FORWARDS - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Max-Forwards
header field name. - maxAge() - Element in annotation interface org.springframework.web.bind.annotation.CrossOrigin
-
The maximum age (in seconds) of the cache duration for preflight responses.
- maxAge(long) - Method in interface org.springframework.http.ResponseCookie.ResponseCookieBuilder
-
Variant of
ResponseCookie.ResponseCookieBuilder.maxAge(Duration)
accepting a value in seconds. - maxAge(long, TimeUnit) - Static method in class org.springframework.http.CacheControl
-
Add a "max-age=" directive.
- maxAge(Duration) - Static method in class org.springframework.http.CacheControl
-
Add a "max-age=" directive.
- maxAge(Duration) - Method in interface org.springframework.http.ResponseCookie.ResponseCookieBuilder
-
Set the cookie "Max-Age" attribute.
- maxInMemorySize() - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecConfig
-
Get the configured limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated.
- maxInMemorySize(int) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Configure a limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated.
- MaxUploadSizeExceededException - Exception in org.springframework.web.multipart
-
MultipartException subclass thrown when an upload exceeds the maximum upload size allowed.
- MaxUploadSizeExceededException(long) - Constructor for exception org.springframework.web.multipart.MaxUploadSizeExceededException
-
Constructor for MaxUploadSizeExceededException.
- MaxUploadSizeExceededException(long, Throwable) - Constructor for exception org.springframework.web.multipart.MaxUploadSizeExceededException
-
Constructor for MaxUploadSizeExceededException.
- MEDIA_TYPE_ALL_LIST - Static variable in interface org.springframework.web.accept.ContentNegotiationStrategy
-
A singleton list with
MediaType.ALL
that is returned fromContentNegotiationStrategy.resolveMediaTypes(org.springframework.web.context.request.NativeWebRequest)
when no specific media types are requested. - MediaType - Class in org.springframework.http
-
A subclass of
MimeType
that adds support for quality parameters as defined in the HTTP specification. - MediaType(String) - Constructor for class org.springframework.http.MediaType
-
Create a new
MediaType
for the given primary type. - MediaType(String, String) - Constructor for class org.springframework.http.MediaType
-
Create a new
MediaType
for the given primary type and subtype. - MediaType(String, String, double) - Constructor for class org.springframework.http.MediaType
-
Create a new
MediaType
for the given type, subtype, and quality value. - MediaType(String, String, Charset) - Constructor for class org.springframework.http.MediaType
-
Create a new
MediaType
for the given type, subtype, and character set. - MediaType(String, String, Map<String, String>) - Constructor for class org.springframework.http.MediaType
-
Create a new
MediaType
for the given type, subtype, and parameters. - MediaType(MediaType, Charset) - Constructor for class org.springframework.http.MediaType
-
Copy-constructor that copies the type, subtype and parameters of the given
MediaType
, and allows to set the specified character set. - MediaType(MediaType, Map<String, String>) - Constructor for class org.springframework.http.MediaType
-
Copy-constructor that copies the type and subtype of the given
MediaType
, and allows for different parameters. - MediaType(MimeType) - Constructor for class org.springframework.http.MediaType
-
Create a new
MediaType
for the givenMimeType
. - MediaTypeEditor - Class in org.springframework.http
- MediaTypeEditor() - Constructor for class org.springframework.http.MediaTypeEditor
- MediaTypeFactory - Class in org.springframework.http
-
A factory delegate for resolving
MediaType
objects fromResource
handles or filenames. - MediaTypeFileExtensionResolver - Interface in org.springframework.web.accept
-
Strategy to resolve a
MediaType
to a list of file extensions — for example, to resolve "application/json" to "json". - mergeAttributes(Map<String, ?>) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Copy attributes in the supplied
Map
with existing objects of the same name taking precedence (i.e. - mergeRequestConfig(RequestConfig) - Method in class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Merge the given
HttpClient
-levelRequestConfig
with the factory-level configuration, if necessary. - MESSAGE_ROUTE - Static variable in class org.springframework.http.server.PathContainer.Options
-
Options for a message route.
- messageConverters(Consumer<List<HttpMessageConverter<?>>>) - Method in interface org.springframework.web.client.RestClient.Builder
-
Configure the message converters for the
RestClient
to use. - method() - Element in annotation interface org.springframework.web.bind.annotation.RequestMapping
-
The HTTP request methods to map to, narrowing the primary mapping: GET, POST, HEAD, OPTIONS, PUT, PATCH, DELETE, TRACE.
- method() - Element in annotation interface org.springframework.web.service.annotation.HttpExchange
-
The HTTP method to use.
- method(ClientRequestObservationContext) - Method in class org.springframework.http.client.observation.DefaultClientRequestObservationConvention
- method(HttpMethod) - Method in interface org.springframework.http.server.reactive.ServerHttpRequest.Builder
-
Set the HTTP method to return.
- method(HttpMethod) - Method in interface org.springframework.web.client.RestClient
-
Start building a request for the given
HttpMethod
. - method(HttpMethod, String, Object...) - Static method in class org.springframework.http.RequestEntity
-
Create a builder with the given HTTP method, URI template, and variables.
- method(HttpMethod, String, Map<String, ?>) - Static method in class org.springframework.http.RequestEntity
-
Create a builder with the given HTTP method, URI template, and variables.
- method(HttpMethod, URI) - Static method in class org.springframework.http.RequestEntity
-
Create a builder with the given method and url.
- method(ServerRequestObservationContext) - Method in class org.springframework.http.server.observation.DefaultServerRequestObservationConvention
- method(ServerRequestObservationContext) - Method in class org.springframework.http.server.reactive.observation.DefaultServerRequestObservationConvention
- METHOD - Enum constant in enum class org.springframework.http.client.observation.ClientHttpObservationDocumentation.LowCardinalityKeyNames
-
Name of HTTP request method or "none" if the request could not be created.
- METHOD - Enum constant in enum class org.springframework.http.server.observation.ServerHttpObservationDocumentation.LowCardinalityKeyNames
-
Name of HTTP request method or "none" if the request was not received properly.
- METHOD - Enum constant in enum class org.springframework.http.server.reactive.observation.ServerHttpObservationDocumentation.LowCardinalityKeyNames
-
Name of HTTP request method or "none" if the request was not received properly.
- METHOD_FAILURE - Enum constant in enum class org.springframework.http.HttpStatus
-
Deprecated.
- METHOD_NOT_ALLOWED - Enum constant in enum class org.springframework.http.HttpStatus
-
405 Method Not Allowed
. - MethodArgumentConversionNotSupportedException - Exception in org.springframework.web.method.annotation
-
A ConversionNotSupportedException raised while resolving a method argument.
- MethodArgumentConversionNotSupportedException(Object, Class<?>, String, MethodParameter, Throwable) - Constructor for exception org.springframework.web.method.annotation.MethodArgumentConversionNotSupportedException
- MethodArgumentNotValidException - Exception in org.springframework.web.bind
-
Exception to be thrown when validation on an argument annotated with
@Valid
fails. - MethodArgumentNotValidException(MethodParameter, BindingResult) - Constructor for exception org.springframework.web.bind.MethodArgumentNotValidException
-
Constructor for
MethodArgumentNotValidException
. - MethodArgumentTypeMismatchException - Exception in org.springframework.web.method.annotation
-
A TypeMismatchException raised while resolving a controller method argument.
- MethodArgumentTypeMismatchException(Object, Class<?>, String, MethodParameter, Throwable) - Constructor for exception org.springframework.web.method.annotation.MethodArgumentTypeMismatchException
- MethodNotAllowedException - Exception in org.springframework.web.server
-
Exception for errors that fit response status 405 (method not allowed).
- MethodNotAllowedException(String, Collection<HttpMethod>) - Constructor for exception org.springframework.web.server.MethodNotAllowedException
- MethodNotAllowedException(HttpMethod, Collection<HttpMethod>) - Constructor for exception org.springframework.web.server.MethodNotAllowedException
- methods() - Element in annotation interface org.springframework.web.bind.annotation.CrossOrigin
-
The list of supported HTTP request methods.
- MISSING_CLOSE_CAPTURE - Enum constant in enum class org.springframework.web.util.pattern.PatternParseException.PatternMessage
- MISSING_OPEN_CAPTURE - Enum constant in enum class org.springframework.web.util.pattern.PatternParseException.PatternMessage
- MISSING_REGEX_CONSTRAINT - Enum constant in enum class org.springframework.web.util.pattern.PatternParseException.PatternMessage
- MissingMatrixVariableException - Exception in org.springframework.web.bind
-
ServletRequestBindingException
subclass that indicates that a matrix variable expected in the method parameters of an@RequestMapping
method is not present among the matrix variables extracted from the URL. - MissingMatrixVariableException(String, MethodParameter) - Constructor for exception org.springframework.web.bind.MissingMatrixVariableException
-
Constructor for MissingMatrixVariableException.
- MissingMatrixVariableException(String, MethodParameter, boolean) - Constructor for exception org.springframework.web.bind.MissingMatrixVariableException
-
Constructor for use when a value was present but converted to
null
. - MissingPathVariableException - Exception in org.springframework.web.bind
-
ServletRequestBindingException
subclass that indicates that a path variable expected in the method parameters of an@RequestMapping
method is not present among the URI variables extracted from the URL. - MissingPathVariableException(String, MethodParameter) - Constructor for exception org.springframework.web.bind.MissingPathVariableException
-
Constructor for MissingPathVariableException.
- MissingPathVariableException(String, MethodParameter, boolean) - Constructor for exception org.springframework.web.bind.MissingPathVariableException
-
Constructor for use when a value was present but converted to
null
. - MissingRequestCookieException - Exception in org.springframework.web.bind
-
ServletRequestBindingException
subclass that indicates that a request cookie expected in the method parameters of an@RequestMapping
method is not present. - MissingRequestCookieException(String, MethodParameter) - Constructor for exception org.springframework.web.bind.MissingRequestCookieException
-
Constructor for MissingRequestCookieException.
- MissingRequestCookieException(String, MethodParameter, boolean) - Constructor for exception org.springframework.web.bind.MissingRequestCookieException
-
Constructor for use when a value was present but converted to
null
. - MissingRequestHeaderException - Exception in org.springframework.web.bind
-
ServletRequestBindingException
subclass that indicates that a request header expected in the method parameters of an@RequestMapping
method is not present. - MissingRequestHeaderException(String, MethodParameter) - Constructor for exception org.springframework.web.bind.MissingRequestHeaderException
-
Constructor for MissingRequestHeaderException.
- MissingRequestHeaderException(String, MethodParameter, boolean) - Constructor for exception org.springframework.web.bind.MissingRequestHeaderException
-
Constructor for use when a value was present but converted to
null
. - MissingRequestValueException - Exception in org.springframework.web.bind
-
Base class for
ServletRequestBindingException
exceptions that could not bind because the request value is required but is either missing or otherwise resolves tonull
after conversion. - MissingRequestValueException - Exception in org.springframework.web.server
-
ServerWebInputException
subclass that indicates a missing request value such as a request header, cookie value, query parameter, etc. - MissingRequestValueException(String) - Constructor for exception org.springframework.web.bind.MissingRequestValueException
-
Constructor with a message only.
- MissingRequestValueException(String, boolean) - Constructor for exception org.springframework.web.bind.MissingRequestValueException
-
Constructor with a message and a flag that indicates whether a value was present but became
null
after conversion. - MissingRequestValueException(String, boolean, String, Object[]) - Constructor for exception org.springframework.web.bind.MissingRequestValueException
-
Constructor with a given
ProblemDetail
, and aMessageSource
code and arguments to resolve the detail message with. - MissingRequestValueException(String, Class<?>, String, MethodParameter) - Constructor for exception org.springframework.web.server.MissingRequestValueException
- MissingServletRequestParameterException - Exception in org.springframework.web.bind
-
ServletRequestBindingException
subclass that indicates a missing parameter. - MissingServletRequestParameterException(String, String) - Constructor for exception org.springframework.web.bind.MissingServletRequestParameterException
-
Constructor for MissingServletRequestParameterException.
- MissingServletRequestParameterException(String, String, boolean) - Constructor for exception org.springframework.web.bind.MissingServletRequestParameterException
-
Deprecated, for removal: This API element is subject to removal in a future version.
- MissingServletRequestParameterException(String, MethodParameter, boolean) - Constructor for exception org.springframework.web.bind.MissingServletRequestParameterException
-
Constructor with a
MethodParameter
instead of a String parameterType. - MissingServletRequestPartException - Exception in org.springframework.web.multipart.support
-
Signals the part of a "multipart/form-data" request, identified by name could not be found.
- MissingServletRequestPartException(String) - Constructor for exception org.springframework.web.multipart.support.MissingServletRequestPartException
-
Constructor for MissingServletRequestPartException.
- mixIn(Class<?>, Class<?>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Add mix-in annotations to use for augmenting specified class or interface.
- mixIns(Map<Class<?>, Class<?>>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Add mix-in annotations to use for augmenting specified class or interface.
- ModelAndViewContainer - Class in org.springframework.web.method.support
-
Records model and view related decisions made by
HandlerMethodArgumentResolvers
andHandlerMethodReturnValueHandlers
during the course of invocation of a controller method. - ModelAndViewContainer() - Constructor for class org.springframework.web.method.support.ModelAndViewContainer
- modelAttribute(ModelAttribute, ParameterErrors) - Method in interface org.springframework.web.method.annotation.HandlerMethodValidationException.Visitor
-
Handle results for
@ModelAttribute
method parameters. - ModelAttribute - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation that binds a method parameter or method return value to a named model attribute, exposed to a web view.
- ModelAttributeMethodProcessor - Class in org.springframework.web.method.annotation
-
Resolve
@ModelAttribute
annotated method arguments and handle return values from@ModelAttribute
annotated methods. - ModelAttributeMethodProcessor(boolean) - Constructor for class org.springframework.web.method.annotation.ModelAttributeMethodProcessor
-
Class constructor.
- ModelFactory - Class in org.springframework.web.method.annotation
-
Assist with initialization of the
Model
before controller method invocation and with updates to it after the invocation. - ModelFactory(List<InvocableHandlerMethod>, WebDataBinderFactory, SessionAttributesHandler) - Constructor for class org.springframework.web.method.annotation.ModelFactory
-
Create a new instance with the given
@ModelAttribute
methods. - ModelMethodProcessor - Class in org.springframework.web.method.annotation
-
Resolves
Model
arguments and handlesModel
return values. - ModelMethodProcessor() - Constructor for class org.springframework.web.method.annotation.ModelMethodProcessor
- modificationDate(ZonedDateTime) - Method in interface org.springframework.http.ContentDisposition.Builder
-
Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.
- modifyContextPath(String) - Method in interface org.springframework.http.server.RequestPath
-
Return a new
RequestPath
instance with a modified context path. - moduleClassLoader(ClassLoader) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Set the ClassLoader to use for loading Jackson extension modules.
- modules(Module...) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Specify the modules to be registered with the
ObjectMapper
. - modules(Consumer<List<Module>>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Variant of
Jackson2ObjectMapperBuilder.modules(Module...)
with aConsumer
for full control over the underlying list of modules. - modules(List<Module>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Variant of
Jackson2ObjectMapperBuilder.modules(Module...)
with aList
. - modulesToInstall(Module...) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Specify one or more modules to be registered with the
ObjectMapper
. - modulesToInstall(Class<? extends Module>...) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Specify one or more modules by class to be registered with the
ObjectMapper
. - modulesToInstall(Consumer<List<Module>>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Variant of
Jackson2ObjectMapperBuilder.modulesToInstall(Module...)
with aConsumer
for full control over the underlying list of modules. - MOVED_PERMANENTLY - Enum constant in enum class org.springframework.http.HttpStatus
-
301 Moved Permanently
. - MOVED_TEMPORARILY - Enum constant in enum class org.springframework.http.HttpStatus
-
Deprecated.in favor of
HttpStatus.FOUND
which will be returned fromHttpStatus.valueOf(302)
- MULTI_STATUS - Enum constant in enum class org.springframework.http.HttpStatus
-
207 Multi-Status
. - MULTIPART_FORM_DATA - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
multipart/form-data
. - MULTIPART_FORM_DATA_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.MULTIPART_FORM_DATA
. - MULTIPART_MIXED - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
multipart/mixed
. - MULTIPART_MIXED_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.MULTIPART_MIXED
. - MULTIPART_RELATED - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
multipart/related
. - MULTIPART_RELATED_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.MULTIPART_RELATED
. - MultipartBodyBuilder - Class in org.springframework.http.client
-
Prepare the body of a multipart request, resulting in a
MultiValueMap<String, HttpEntity>
. - MultipartBodyBuilder() - Constructor for class org.springframework.http.client.MultipartBodyBuilder
-
Creates a new, empty instance of the
MultipartBodyBuilder
. - MultipartBodyBuilder.PartBuilder - Interface in org.springframework.http.client
-
Builder that allows for further customization of part headers.
- multipartCodecs() - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Configure encoders or writers for use with
MultipartHttpMessageWriter
. - MultipartException - Exception in org.springframework.web.multipart
-
Exception thrown when multipart resolution fails.
- MultipartException(String) - Constructor for exception org.springframework.web.multipart.MultipartException
-
Constructor for MultipartException.
- MultipartException(String, Throwable) - Constructor for exception org.springframework.web.multipart.MultipartException
-
Constructor for MultipartException.
- MultipartFile - Interface in org.springframework.web.multipart
-
A representation of an uploaded file received in a multipart request.
- MultipartFilter - Class in org.springframework.web.multipart.support
-
Servlet Filter that resolves multipart requests via a
MultipartResolver
. - MultipartFilter() - Constructor for class org.springframework.web.multipart.support.MultipartFilter
- MultipartHttpMessageReader - Class in org.springframework.http.codec.multipart
-
HttpMessageReader
for reading"multipart/form-data"
requests into aMultiValueMap<String, Part>
. - MultipartHttpMessageReader(HttpMessageReader<Part>) - Constructor for class org.springframework.http.codec.multipart.MultipartHttpMessageReader
- MultipartHttpMessageWriter - Class in org.springframework.http.codec.multipart
-
HttpMessageWriter
for writing aMultiValueMap<String, ?>
as multipart form data, i.e. - MultipartHttpMessageWriter() - Constructor for class org.springframework.http.codec.multipart.MultipartHttpMessageWriter
-
Constructor with a default list of part writers (String and Resource).
- MultipartHttpMessageWriter(Supplier<List<HttpMessageWriter<?>>>, HttpMessageWriter<MultiValueMap<String, String>>) - Constructor for class org.springframework.http.codec.multipart.MultipartHttpMessageWriter
-
Constructor with a supplier for an explicit list of writers for serializing parts and a writer for plain form data to fall back when no media type is specified and the actual map consists of String values only.
- MultipartHttpMessageWriter(List<HttpMessageWriter<?>>) - Constructor for class org.springframework.http.codec.multipart.MultipartHttpMessageWriter
-
Constructor with explicit list of writers for serializing parts.
- MultipartHttpMessageWriter(List<HttpMessageWriter<?>>, HttpMessageWriter<MultiValueMap<String, String>>) - Constructor for class org.springframework.http.codec.multipart.MultipartHttpMessageWriter
-
Constructor with explicit list of writers for serializing parts and a writer for plain form data to fall back when no media type is specified and the actual map consists of String values only.
- MultipartHttpServletRequest - Interface in org.springframework.web.multipart
-
Provides additional methods for dealing with multipart content within a servlet request, allowing to access uploaded files.
- multipartReader(HttpMessageReader<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Configure the
HttpMessageReader
to use for multipart requests. - MultipartRequest - Interface in org.springframework.web.multipart
-
This interface defines the multipart request access operations that are exposed for actual multipart requests.
- MultipartResolutionDelegate - Class in org.springframework.web.multipart.support
-
A common delegate for
HandlerMethodArgumentResolver
implementations which need to resolveMultipartFile
andPart
arguments. - MultipartResolver - Interface in org.springframework.web.multipart
-
A strategy interface for multipart file upload resolution in accordance with RFC 1867.
- MultipartWriterSupport - Class in org.springframework.http.codec.multipart
-
Support class for multipart HTTP message writers.
- MultipartWriterSupport(List<MediaType>) - Constructor for class org.springframework.http.codec.multipart.MultipartWriterSupport
-
Constructor with the list of supported media types.
- MULTIPLE_CHOICES - Enum constant in enum class org.springframework.http.HttpStatus
-
300 Multiple Choices
. - mustRevalidate() - Method in class org.springframework.http.CacheControl
-
Add a "must-revalidate" directive.
- mutate() - Method in class org.springframework.http.ResponseCookie
-
Return a builder pre-populated with values from
"this"
instance. - mutate() - Method in interface org.springframework.http.server.reactive.ServerHttpRequest
-
Return a builder to mutate properties of this request by wrapping it with
ServerHttpRequestDecorator
and returning either mutated values or delegating back to this instance. - mutate() - Method in interface org.springframework.web.client.RestClient
-
Return a builder to create a new
RestClient
whose settings are replicated from thisRestClient
. - mutate() - Method in interface org.springframework.web.server.ServerWebExchange
-
Return a builder to mutate properties of this exchange by wrapping it with
ServerWebExchangeDecorator
and returning either mutated values or delegating back to this instance.
N
- name() - Method in interface org.springframework.http.codec.multipart.Part
-
Return the name of the part in the multipart form.
- name() - Method in interface org.springframework.http.codec.multipart.PartEvent
-
Return the name of the event, as provided through the
Content-Disposition name
parameter. - name() - Method in class org.springframework.http.HttpMethod
-
Return the name of this method, e.g.
- name() - Element in annotation interface org.springframework.web.bind.annotation.ControllerAdvice
-
Alias for
Component.value()
. - name() - Element in annotation interface org.springframework.web.bind.annotation.CookieValue
-
The name of the cookie to bind to.
- name() - Element in annotation interface org.springframework.web.bind.annotation.DeleteMapping
-
Alias for
RequestMapping.name()
. - name() - Element in annotation interface org.springframework.web.bind.annotation.GetMapping
-
Alias for
RequestMapping.name()
. - name() - Element in annotation interface org.springframework.web.bind.annotation.MatrixVariable
-
The name of the matrix variable.
- name() - Element in annotation interface org.springframework.web.bind.annotation.ModelAttribute
-
The name of the model attribute to bind to.
- name() - Element in annotation interface org.springframework.web.bind.annotation.PatchMapping
-
Alias for
RequestMapping.name()
. - name() - Element in annotation interface org.springframework.web.bind.annotation.PathVariable
-
The name of the path variable to bind to.
- name() - Element in annotation interface org.springframework.web.bind.annotation.PostMapping
-
Alias for
RequestMapping.name()
. - name() - Element in annotation interface org.springframework.web.bind.annotation.PutMapping
-
Alias for
RequestMapping.name()
. - name() - Element in annotation interface org.springframework.web.bind.annotation.RequestAttribute
-
The name of the request attribute to bind to.
- name() - Element in annotation interface org.springframework.web.bind.annotation.RequestHeader
-
The name of the request header to bind to.
- name() - Element in annotation interface org.springframework.web.bind.annotation.RequestMapping
-
Assign a name to this mapping.
- name() - Element in annotation interface org.springframework.web.bind.annotation.RequestParam
-
The name of the request parameter to bind to.
- name() - Element in annotation interface org.springframework.web.bind.annotation.RequestPart
-
The name of the part in the
"multipart/form-data"
request to bind to. - name() - Element in annotation interface org.springframework.web.bind.annotation.RestControllerAdvice
-
Alias for
ControllerAdvice.name()
. - name() - Element in annotation interface org.springframework.web.bind.annotation.SessionAttribute
-
The name of the session attribute to bind to.
- name(String) - Method in interface org.springframework.http.ContentDisposition.Builder
-
Set the value of the name parameter.
- NamedValueInfo(String, boolean, String) - Constructor for class org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver.NamedValueInfo
- NamedValueInfo(String, boolean, String, String, boolean) - Constructor for class org.springframework.web.service.invoker.AbstractNamedValueArgumentResolver.NamedValueInfo
-
Create an instance.
- names() - Element in annotation interface org.springframework.web.bind.annotation.SessionAttributes
-
The names of session attributes in the model that should be stored in the session or some conversational storage.
- namingStrategyInstance(MapperConfig<?>, Annotated, Class<?>) - Method in class org.springframework.http.converter.json.SpringHandlerInstantiator
- NativeWebRequest - Interface in org.springframework.web.context.request
-
Extension of the
WebRequest
interface, exposing the native request and response objects in a generic fashion. - NestedServletException - Exception in org.springframework.web.util
-
Deprecated.as of 6.0, in favor of standard
ServletException
nesting - NestedServletException(String) - Constructor for exception org.springframework.web.util.NestedServletException
-
Deprecated.Construct a
NestedServletException
with the specified detail message. - NestedServletException(String, Throwable) - Constructor for exception org.springframework.web.util.NestedServletException
-
Deprecated.Construct a
NestedServletException
with the specified detail message and nested exception. - Netty4HeadersAdapter - Class in org.springframework.http.support
-
MultiValueMap
implementation for wrapping Netty 4 HTTP headers. - Netty4HeadersAdapter(HttpHeaders) - Constructor for class org.springframework.http.support.Netty4HeadersAdapter
-
Creates a new
Netty4HeadersAdapter
based on the givenHttpHeaders
. - Netty5HeadersAdapter - Class in org.springframework.http.support
-
MultiValueMap
implementation for wrapping Netty HTTP headers. - Netty5HeadersAdapter(HttpHeaders) - Constructor for class org.springframework.http.support.Netty5HeadersAdapter
-
Create a new
Netty5HeadersAdapter
based on the givenHttpHeaders
. - NETWORK_AUTHENTICATION_REQUIRED - Enum constant in enum class org.springframework.http.HttpStatus
-
511 Network Authentication Required
. - newInstance() - Static method in class org.springframework.web.util.UriComponentsBuilder
-
Create a new, empty builder.
- NO_CONTENT - Enum constant in enum class org.springframework.http.HttpStatus
-
204 No Content
. - NO_MORE_DATA_EXPECTED_AFTER_CAPTURE_THE_REST - Enum constant in enum class org.springframework.web.util.pattern.PatternParseException.PatternMessage
- noCache() - Static method in class org.springframework.http.CacheControl
-
Add a "no-cache" directive.
- noContent() - Static method in class org.springframework.http.ResponseEntity
-
Create a builder with a NO_CONTENT status.
- NON_AUTHORITATIVE_INFORMATION - Enum constant in enum class org.springframework.http.HttpStatus
-
203 Non-Authoritative Information
. - NONE - Enum constant in enum class org.springframework.web.util.DefaultUriBuilderFactory.EncodingMode
-
No encoding should be applied.
- normalize() - Method in class org.springframework.web.util.UriComponents
-
Normalize the path removing sequences like "path/..".
- noStore() - Static method in class org.springframework.http.CacheControl
-
Add a "no-store" directive.
- NOT_ACCEPTABLE - Enum constant in enum class org.springframework.http.HttpStatus
-
406 Not Acceptable
. - NOT_EXTENDED - Enum constant in enum class org.springframework.http.HttpStatus
-
510 Not Extended
- NOT_FOUND - Enum constant in enum class org.springframework.http.HttpStatus
-
404 Not Found
. - NOT_IMPLEMENTED - Enum constant in enum class org.springframework.http.HttpStatus
-
501 Not Implemented
. - NOT_MODIFIED - Enum constant in enum class org.springframework.http.HttpStatus
-
304 Not Modified
. - NotAcceptableStatusException - Exception in org.springframework.web.server
-
Exception for errors that fit response status 406 (not acceptable).
- NotAcceptableStatusException(String) - Constructor for exception org.springframework.web.server.NotAcceptableStatusException
-
Constructor for when the requested Content-Type is invalid.
- NotAcceptableStatusException(List<MediaType>) - Constructor for exception org.springframework.web.server.NotAcceptableStatusException
-
Constructor for when the requested Content-Type is not supported.
- notFound() - Static method in class org.springframework.http.ResponseEntity
-
Create a builder with a NOT_FOUND status.
- noTransform() - Method in class org.springframework.http.CacheControl
-
Add a "no-transform" directive.
O
- objectIdGeneratorInstance(MapperConfig<?>, Annotated, Class<?>) - Method in class org.springframework.http.converter.json.SpringHandlerInstantiator
- ObjectToStringHttpMessageConverter - Class in org.springframework.http.converter
-
An
HttpMessageConverter
that usesStringHttpMessageConverter
for reading and writing content and aConversionService
for converting the String content to and from the target object type. - ObjectToStringHttpMessageConverter(ConversionService) - Constructor for class org.springframework.http.converter.ObjectToStringHttpMessageConverter
-
A constructor accepting a
ConversionService
to use to convert the (String) message body to/from the target class type. - ObjectToStringHttpMessageConverter(ConversionService, Charset) - Constructor for class org.springframework.http.converter.ObjectToStringHttpMessageConverter
-
A constructor accepting a
ConversionService
as well as a default charset. - observationConvention(ClientRequestObservationConvention) - Method in interface org.springframework.web.client.RestClient.Builder
-
Configure the
ObservationConvention
to use for collecting metadata for the request observation. - observationConvention(ServerRequestObservationConvention) - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Configure a
ServerRequestObservationConvention
to use for server observations. - observationRegistry(ObservationRegistry) - Method in interface org.springframework.web.client.RestClient.Builder
-
Configure the
ObservationRegistry
to use for recording HTTP client observations. - observationRegistry(ObservationRegistry) - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Configure an
ObservationRegistry
for recording server exchange observations. - of(Optional<T>) - Static method in class org.springframework.http.ResponseEntity
-
A shortcut for creating a
ResponseEntity
with the given body and the OK status, or an empty body and a NOT FOUND status in case of an Optional.empty() parameter. - of(ProblemDetail) - Static method in class org.springframework.http.ResponseEntity
-
Create a new
ResponseEntity.HeadersBuilder
with its status set toProblemDetail.getStatus()
and its body is set toProblemDetail
. - ofNullable(T) - Static method in class org.springframework.http.ResponseEntity
- ok() - Static method in class org.springframework.http.ResponseEntity
-
Create a builder with the status set to OK.
- ok(T) - Static method in class org.springframework.http.ResponseEntity
-
A shortcut for creating a
ResponseEntity
with the given body and the status set to OK. - OK - Enum constant in enum class org.springframework.http.HttpStatus
-
200 OK
. - OkHttp3ClientHttpRequestFactory - Class in org.springframework.http.client
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.1, in favor of other
ClientHttpRequestFactory
implementations; scheduled for removal in 6.2 - OkHttp3ClientHttpRequestFactory() - Constructor for class org.springframework.http.client.OkHttp3ClientHttpRequestFactory
-
Deprecated.Create a factory with a default
OkHttpClient
instance. - OkHttp3ClientHttpRequestFactory(OkHttpClient) - Constructor for class org.springframework.http.client.OkHttp3ClientHttpRequestFactory
-
Deprecated.Create a factory with the given
OkHttpClient
instance. - onAllDataRead() - Method in class org.springframework.http.server.reactive.AbstractListenerReadPublisher
-
Subclasses can call this method to signal onComplete, delegating a notification from the container when all data has been read.
- OncePerRequestFilter - Class in org.springframework.web.filter
-
Filter base class that aims to guarantee a single execution per request dispatch, on any servlet container.
- OncePerRequestFilter() - Constructor for class org.springframework.web.filter.OncePerRequestFilter
- onComplete() - Method in class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
-
Completion signal from the upstream, write Publisher.
- onComplete() - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
-
Completion signal from the upstream, write Publisher.
- onComplete(AsyncEvent) - Method in class org.springframework.http.server.ServletServerHttpAsyncRequestControl
- onComplete(AsyncEvent) - Method in class org.springframework.web.context.request.async.StandardServletAsyncWebRequest
- onCompletion(Runnable) - Method in class org.springframework.web.context.request.async.DeferredResult
-
Register code to invoke when the async request completes.
- onCompletion(Runnable) - Method in class org.springframework.web.context.request.async.WebAsyncTask
-
Register code to invoke when the async request completes.
- onDataAvailable() - Method in class org.springframework.http.server.reactive.AbstractListenerReadPublisher
-
Invoked when reading is possible, either in the same thread after a check via
AbstractListenerReadPublisher.checkOnDataAvailable()
, or as a callback from the underlying container. - onError(AsyncEvent) - Method in class org.springframework.http.server.ServletServerHttpAsyncRequestControl
- onError(AsyncEvent) - Method in class org.springframework.web.context.request.async.StandardServletAsyncWebRequest
- onError(Throwable) - Method in class org.springframework.http.server.reactive.AbstractListenerReadPublisher
-
Subclasses can call this to signal onError, delegating a notification from the container for an error.
- onError(Throwable) - Method in class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
-
Error signal from the upstream, write Publisher.
- onError(Throwable) - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
-
Error signal from the upstream, write Publisher.
- onError(Callable<V>) - Method in class org.springframework.web.context.request.async.WebAsyncTask
-
Register code to invoke for an error during async request processing.
- onError(Consumer<Throwable>) - Method in class org.springframework.web.context.request.async.DeferredResult
-
Register code to invoke when an error occurred during the async request.
- onFlushPossible() - Method in class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
-
Invoked when flushing is possible, either in the same thread after a check via
AbstractListenerWriteFlushProcessor.isWritePossible()
, or as a callback from the underlying container. - onNext(Publisher<? extends T>) - Method in class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
- onNext(T) - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
- onRefresh() - Method in class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
-
Initialize the theme capability.
- onRefresh() - Method in class org.springframework.web.context.support.GenericWebApplicationContext
-
Initialize the theme capability.
- onRefresh() - Method in class org.springframework.web.context.support.StaticWebApplicationContext
-
Initialize the theme capability.
- onStartAsync(AsyncEvent) - Method in class org.springframework.http.server.ServletServerHttpAsyncRequestControl
- onStartAsync(AsyncEvent) - Method in class org.springframework.web.context.request.async.StandardServletAsyncWebRequest
- onStartup(ServletContext) - Method in class org.springframework.web.context.AbstractContextLoaderInitializer
- onStartup(ServletContext) - Method in class org.springframework.web.server.adapter.AbstractReactiveWebInitializer
- onStartup(ServletContext) - Method in interface org.springframework.web.WebApplicationInitializer
-
Configure the given
ServletContext
with any servlets, filters, listeners context-params and attributes necessary for initializing this web application. - onStartup(Set<Class<?>>, ServletContext) - Method in class org.springframework.web.SpringServletContainerInitializer
-
Delegate the
ServletContext
to anyWebApplicationInitializer
implementations present on the application classpath. - onStatus(Predicate<HttpStatusCode>, RestClient.ResponseSpec.ErrorHandler) - Method in interface org.springframework.web.client.RestClient.ResponseSpec
-
Provide a function to map specific error status codes to an error handler.
- onStatus(ResponseErrorHandler) - Method in interface org.springframework.web.client.RestClient.ResponseSpec
-
Provide a function to map specific error status codes to an error handler.
- onSubscribe(Subscription) - Method in class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
- onSubscribe(Subscription) - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
- onTimeout(AsyncEvent) - Method in class org.springframework.http.server.ServletServerHttpAsyncRequestControl
- onTimeout(AsyncEvent) - Method in class org.springframework.web.context.request.async.StandardServletAsyncWebRequest
- onTimeout(Runnable) - Method in class org.springframework.web.context.request.async.DeferredResult
-
Register code to invoke when the async request times out.
- onTimeout(Callable<V>) - Method in class org.springframework.web.context.request.async.WebAsyncTask
-
Register code to invoke when the async request times out.
- onWritePossible() - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
-
Invoked when writing is possible, either in the same thread after a check via
AbstractListenerWriteProcessor.isWritePossible()
, or as a callback from the underlying container. - openConnection(URL, Proxy) - Method in class org.springframework.http.client.SimpleClientHttpRequestFactory
-
Opens and returns a connection to the given URL.
- options() - Method in interface org.springframework.web.client.RestClient
-
Start building an HTTP OPTIONS request.
- options(String, Object...) - Static method in class org.springframework.http.RequestEntity
-
Creates an HTTP OPTIONS builder with the given string base uri template.
- options(URI) - Static method in class org.springframework.http.RequestEntity
-
Creates an HTTP OPTIONS builder with the given url.
- OPTIONS - Enum constant in enum class org.springframework.web.bind.annotation.RequestMethod
- OPTIONS - Static variable in class org.springframework.http.HttpMethod
-
The HTTP method
OPTIONS
. - optionsForAllow(String, Object...) - Method in interface org.springframework.web.client.RestOperations
-
Return the value of the
Allow
header for the given URI. - optionsForAllow(String, Object...) - Method in class org.springframework.web.client.RestTemplate
- optionsForAllow(String, Map<String, ?>) - Method in interface org.springframework.web.client.RestOperations
-
Return the value of the
Allow
header for the given URI. - optionsForAllow(String, Map<String, ?>) - Method in class org.springframework.web.client.RestTemplate
- optionsForAllow(URI) - Method in interface org.springframework.web.client.RestOperations
-
Return the value of the
Allow
header for the given URL. - optionsForAllow(URI) - Method in class org.springframework.web.client.RestTemplate
- org.springframework.http - package org.springframework.http
-
Contains a basic abstraction over client/server-side HTTP.
- org.springframework.http.client - package org.springframework.http.client
-
Contains an abstraction over client-side HTTP.
- org.springframework.http.client.observation - package org.springframework.http.client.observation
-
This package provides support for client HTTP
Observation
. - org.springframework.http.client.reactive - package org.springframework.http.client.reactive
-
Abstractions for reactive HTTP client support including
ClientHttpRequest
andClientHttpResponse
as well as aClientHttpConnector
. - org.springframework.http.client.support - package org.springframework.http.client.support
-
This package provides generic HTTP support classes, to be used by higher-level classes like RestTemplate.
- org.springframework.http.codec - package org.springframework.http.codec
-
Provides implementations of
Encoder
andDecoder
for web use. - org.springframework.http.codec.cbor - package org.springframework.http.codec.cbor
-
CBOR encoder and decoder support.
- org.springframework.http.codec.json - package org.springframework.http.codec.json
-
JSON encoder and decoder support.
- org.springframework.http.codec.multipart - package org.springframework.http.codec.multipart
-
Multipart support.
- org.springframework.http.codec.protobuf - package org.springframework.http.codec.protobuf
-
Provides an encoder and a decoder for Google Protocol Buffers.
- org.springframework.http.codec.support - package org.springframework.http.codec.support
-
Provides implementations of
ClientCodecConfigurer
andServerCodecConfigurer
based on the converter implementations fromorg.springframework.http.codec.json
and co. - org.springframework.http.codec.xml - package org.springframework.http.codec.xml
-
XML encoder and decoder support.
- org.springframework.http.converter - package org.springframework.http.converter
-
Provides an HttpMessageConverter abstraction to convert between Java objects and HTTP input/output messages.
- org.springframework.http.converter.cbor - package org.springframework.http.converter.cbor
-
Provides an HttpMessageConverter for the CBOR data format.
- org.springframework.http.converter.feed - package org.springframework.http.converter.feed
-
Provides HttpMessageConverter implementations for handling Atom and RSS feeds.
- org.springframework.http.converter.json - package org.springframework.http.converter.json
-
Provides HttpMessageConverter implementations for handling JSON.
- org.springframework.http.converter.protobuf - package org.springframework.http.converter.protobuf
-
Provides an HttpMessageConverter implementation for handling Google Protocol Buffers.
- org.springframework.http.converter.smile - package org.springframework.http.converter.smile
-
Provides an HttpMessageConverter for the Smile data format ("binary JSON").
- org.springframework.http.converter.support - package org.springframework.http.converter.support
-
Provides a comprehensive HttpMessageConverter variant for form handling.
- org.springframework.http.converter.xml - package org.springframework.http.converter.xml
-
Provides HttpMessageConverter implementations for handling XML.
- org.springframework.http.server - package org.springframework.http.server
-
Contains an abstraction over server-side HTTP.
- org.springframework.http.server.observation - package org.springframework.http.server.observation
-
Instrumentation for
observing
HTTP server applications. - org.springframework.http.server.reactive - package org.springframework.http.server.reactive
-
Abstractions for reactive HTTP server support including a
ServerHttpRequest
andServerHttpResponse
along with anHttpHandler
for processing. - org.springframework.http.server.reactive.observation - package org.springframework.http.server.reactive.observation
-
Instrumentation for
observing
reactive HTTP server applications. - org.springframework.http.support - package org.springframework.http.support
-
This package provides internal HTTP support classes, to be used by higher-level client and server classes.
- org.springframework.web - package org.springframework.web
-
Common, generic interfaces that define minimal boundary points between Spring's web infrastructure and other framework modules.
- org.springframework.web.accept - package org.springframework.web.accept
-
This package contains classes used to determine the requested the media types in a request.
- org.springframework.web.bind - package org.springframework.web.bind
-
Provides web-specific data binding functionality.
- org.springframework.web.bind.annotation - package org.springframework.web.bind.annotation
-
Annotations for binding requests to controllers and handler methods as well as for binding request parameters to method arguments.
- org.springframework.web.bind.support - package org.springframework.web.bind.support
-
Support classes for web data binding.
- org.springframework.web.client - package org.springframework.web.client
-
Core package of the client-side web support.
- org.springframework.web.client.support - package org.springframework.web.client.support
-
Classes supporting the
org.springframework.web.client
package. - org.springframework.web.context - package org.springframework.web.context
-
Contains a variant of the application context interface for web applications, and the ContextLoaderListener that bootstraps a root web application context.
- org.springframework.web.context.annotation - package org.springframework.web.context.annotation
-
Provides convenience annotations for web scopes.
- org.springframework.web.context.request - package org.springframework.web.context.request
-
Support for generic request context holding, in particular for scoping of application objects per HTTP request or HTTP session.
- org.springframework.web.context.request.async - package org.springframework.web.context.request.async
-
Support for asynchronous request processing.
- org.springframework.web.context.support - package org.springframework.web.context.support
-
Classes supporting the
org.springframework.web.context
package, such as WebApplicationContext implementations and various utility classes. - org.springframework.web.cors - package org.springframework.web.cors
-
Support for CORS (Cross-Origin Resource Sharing), based on a common
CorsProcessor
strategy. - org.springframework.web.cors.reactive - package org.springframework.web.cors.reactive
-
Reactive support for CORS (Cross-Origin Resource Sharing), based on a common
CorsProcessor
strategy. - org.springframework.web.filter - package org.springframework.web.filter
-
Provides generic filter base classes allowing for bean-style configuration.
- org.springframework.web.filter.reactive - package org.springframework.web.filter.reactive
-
WebFilter
implementations for use in reactive web applications. - org.springframework.web.jsf - package org.springframework.web.jsf
-
Support classes for integrating a JSF web layer with a Spring service layer which is hosted in a Spring root WebApplicationContext.
- org.springframework.web.jsf.el - package org.springframework.web.jsf.el
-
ELResolvers for integrating a JSF web layer with a Spring service layer which is hosted in a Spring root WebApplicationContext.
- org.springframework.web.method - package org.springframework.web.method
-
Common infrastructure for handler method processing, as used by Spring MVC's
org.springframework.web.servlet.mvc.method
package. - org.springframework.web.method.annotation - package org.springframework.web.method.annotation
-
Support classes for annotation-based handler method processing.
- org.springframework.web.method.support - package org.springframework.web.method.support
-
Generic support classes for handler method processing.
- org.springframework.web.multipart - package org.springframework.web.multipart
-
Multipart resolution framework for handling file uploads.
- org.springframework.web.multipart.support - package org.springframework.web.multipart.support
-
Support classes for the multipart resolution framework.
- org.springframework.web.server - package org.springframework.web.server
-
Core interfaces and classes for Spring's generic, reactive web support.
- org.springframework.web.server.adapter - package org.springframework.web.server.adapter
-
Implementations to adapt to the underlying
org.springframework.http.client.reactive
reactive HTTP adapter andHttpHandler
. - org.springframework.web.server.handler - package org.springframework.web.server.handler
-
Provides common WebHandler implementations and a
WebHandlerDecorator
. - org.springframework.web.server.i18n - package org.springframework.web.server.i18n
-
Locale related support classes.
- org.springframework.web.server.session - package org.springframework.web.server.session
-
Auxiliary interfaces and implementation classes for
WebSession
support. - org.springframework.web.service.annotation - package org.springframework.web.service.annotation
-
Annotations for declaring HTTP service request methods.
- org.springframework.web.service.invoker - package org.springframework.web.service.invoker
-
Support for creating a client proxy for an HTTP service annotated with
HttpExchange
methods. - org.springframework.web.util - package org.springframework.web.util
-
Miscellaneous web utility classes, such as HTML escaping and cookie handling.
- org.springframework.web.util.pattern - package org.springframework.web.util.pattern
-
Dedicated support for matching HTTP request paths.
- ORIGIN - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Origin
header field name. - originPatterns() - Element in annotation interface org.springframework.web.bind.annotation.CrossOrigin
-
Alternative to
CrossOrigin.origins()
that supports more flexible origin patterns. - origins() - Element in annotation interface org.springframework.web.bind.annotation.CrossOrigin
-
A list of origins for which cross-origin requests are allowed.
- other(ParameterValidationResult) - Method in interface org.springframework.web.method.annotation.HandlerMethodValidationException.Visitor
-
Handle other results that aren't any of the above.
- outcome(ClientRequestObservationContext) - Method in class org.springframework.http.client.observation.DefaultClientRequestObservationConvention
- outcome(ServerRequestObservationContext) - Method in class org.springframework.http.server.observation.DefaultServerRequestObservationConvention
- outcome(ServerRequestObservationContext) - Method in class org.springframework.http.server.reactive.observation.DefaultServerRequestObservationConvention
- OUTCOME - Enum constant in enum class org.springframework.http.client.observation.ClientHttpObservationDocumentation.LowCardinalityKeyNames
-
Outcome of the HTTP client exchange.
- OUTCOME - Enum constant in enum class org.springframework.http.server.observation.ServerHttpObservationDocumentation.LowCardinalityKeyNames
-
Outcome of the HTTP server exchange.
- OUTCOME - Enum constant in enum class org.springframework.http.server.reactive.observation.ServerHttpObservationDocumentation.LowCardinalityKeyNames
-
Outcome of the HTTP server exchange.
P
- ParameterContentNegotiationStrategy - Class in org.springframework.web.accept
-
Strategy that resolves the requested content type from a query parameter.
- ParameterContentNegotiationStrategy(Map<String, MediaType>) - Constructor for class org.springframework.web.accept.ParameterContentNegotiationStrategy
-
Create an instance with the given map of file extensions and media types.
- parameters() - Method in interface org.springframework.http.server.PathContainer.PathSegment
-
Path parameters associated with this path segment.
- params() - Element in annotation interface org.springframework.web.bind.annotation.DeleteMapping
-
Alias for
RequestMapping.params()
. - params() - Element in annotation interface org.springframework.web.bind.annotation.GetMapping
-
Alias for
RequestMapping.params()
. - params() - Element in annotation interface org.springframework.web.bind.annotation.PatchMapping
-
Alias for
RequestMapping.params()
. - params() - Element in annotation interface org.springframework.web.bind.annotation.PostMapping
-
Alias for
RequestMapping.params()
. - params() - Element in annotation interface org.springframework.web.bind.annotation.PutMapping
-
Alias for
RequestMapping.params()
. - params() - Element in annotation interface org.springframework.web.bind.annotation.RequestMapping
-
The parameters of the mapped request, narrowing the primary mapping.
- parse(String) - Static method in class org.springframework.http.ContentDisposition
-
Parse a Content-Disposition header value as defined in RFC 2183.
- parse(String) - Method in class org.springframework.web.util.pattern.PathPatternParser
-
Process the path pattern content, a character at a time, breaking it into path elements around separator boundaries and verifying the structure at each stage.
- parse(String, String) - Static method in interface org.springframework.http.server.RequestPath
-
Variant of
RequestPath.parse(URI, String)
with the encodedraw path
. - parse(URI, String) - Static method in interface org.springframework.http.server.RequestPath
-
Parse the URI for a request into a
RequestPath
. - parseAndCache(HttpServletRequest) - Static method in class org.springframework.web.util.ServletRequestPathUtils
-
Parse the
requestURI
to aRequestPath
and save it in the request attributeServletRequestPathUtils.PATH_ATTRIBUTE
for subsequent use withparsed patterns
. - parseForwardedFor(URI, HttpHeaders, InetSocketAddress) - Static method in class org.springframework.web.util.ForwardedHeaderUtils
-
Parse the first "Forwarded: for=..." or "X-Forwarded-For" header value to an
InetSocketAddress
representing the address of the client. - parseForwardedFor(HttpRequest, InetSocketAddress) - Static method in class org.springframework.web.util.UriComponentsBuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of
ForwardedHeaderUtils.parseForwardedFor(java.net.URI, org.springframework.http.HttpHeaders, java.net.InetSocketAddress)
; to be removed in 6.2 - parseMatrixVariables(String) - Static method in class org.springframework.web.util.WebUtils
-
Parse the given string with matrix variables.
- parseMediaType(String) - Static method in class org.springframework.http.MediaType
-
Parse the given String into a single
MediaType
. - parseMediaTypes(String) - Static method in class org.springframework.http.MediaType
-
Parse the comma-separated string into a list of
MediaType
objects. - parseMediaTypes(List<String>) - Static method in class org.springframework.http.MediaType
-
Parse the given list of (potentially) comma-separated strings into a list of
MediaType
objects. - parsePath(String) - Static method in interface org.springframework.http.server.PathContainer
- parsePath(String, PathContainer.Options) - Static method in interface org.springframework.http.server.PathContainer
-
Parse the path value into a sequence of
Separator
andPathSegment
elements. - parseRanges(String) - Static method in class org.springframework.http.HttpRange
-
Parse the given, comma-separated string into a list of
HttpRange
objects. - parseRoute(String) - Method in class org.springframework.web.util.pattern.PathPatternRouteMatcher
- part(String, Object) - Method in class org.springframework.http.client.MultipartBodyBuilder
-
Add a part where the Object may be: String -- form field
Resource
-- file part Object -- content to be encoded (e.g. - part(String, Object, MediaType) - Method in class org.springframework.http.client.MultipartBodyBuilder
-
Variant of
MultipartBodyBuilder.part(String, Object)
that also accepts a MediaType. - Part - Interface in org.springframework.http.codec.multipart
-
Representation for a part in a "multipart/form-data" request.
- PartEvent - Interface in org.springframework.http.codec.multipart
-
Represents an event for a "multipart/form-data" request.
- PartEventHttpMessageReader - Class in org.springframework.http.codec.multipart
- PartEventHttpMessageReader() - Constructor for class org.springframework.http.codec.multipart.PartEventHttpMessageReader
- PartEventHttpMessageWriter - Class in org.springframework.http.codec.multipart
-
HttpMessageWriter
for writingPartEvent
objects. - PartEventHttpMessageWriter() - Constructor for class org.springframework.http.codec.multipart.PartEventHttpMessageWriter
- PartHttpMessageWriter - Class in org.springframework.http.codec.multipart
-
HttpMessageWriter
for writing withPart
. - PartHttpMessageWriter() - Constructor for class org.springframework.http.codec.multipart.PartHttpMessageWriter
- PARTIAL_CONTENT - Enum constant in enum class org.springframework.http.HttpStatus
-
206 Partial Content
. - patch() - Method in interface org.springframework.web.client.RestClient
-
Start building an HTTP PATCH request.
- patch(String, Object...) - Static method in class org.springframework.http.RequestEntity
-
Create an HTTP PATCH builder with the given string base uri template.
- patch(URI) - Static method in class org.springframework.http.RequestEntity
-
Create an HTTP PATCH builder with the given url.
- PATCH - Enum constant in enum class org.springframework.web.bind.annotation.RequestMethod
- PATCH - Static variable in class org.springframework.http.HttpMethod
-
The HTTP method
PATCH
. - PatchExchange - Annotation Interface in org.springframework.web.service.annotation
-
Shortcut for
@HttpExchange
for HTTP PATCH requests. - patchForObject(String, Object, Class<T>, Object...) - Method in interface org.springframework.web.client.RestOperations
-
Update a resource by PATCHing the given object to the URI template, and return the representation found in the response.
- patchForObject(String, Object, Class<T>, Object...) - Method in class org.springframework.web.client.RestTemplate
- patchForObject(String, Object, Class<T>, Map<String, ?>) - Method in interface org.springframework.web.client.RestOperations
-
Update a resource by PATCHing the given object to the URI template, and return the representation found in the response.
- patchForObject(String, Object, Class<T>, Map<String, ?>) - Method in class org.springframework.web.client.RestTemplate
- patchForObject(URI, Object, Class<T>) - Method in interface org.springframework.web.client.RestOperations
-
Update a resource by PATCHing the given object to the URL, and return the representation found in the response.
- patchForObject(URI, Object, Class<T>) - Method in class org.springframework.web.client.RestTemplate
- PatchMapping - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation for mapping HTTP
PATCH
requests onto specific handler methods. - path() - Element in annotation interface org.springframework.web.bind.annotation.DeleteMapping
-
Alias for
RequestMapping.path()
. - path() - Element in annotation interface org.springframework.web.bind.annotation.GetMapping
-
Alias for
RequestMapping.path()
. - path() - Element in annotation interface org.springframework.web.bind.annotation.PatchMapping
-
Alias for
RequestMapping.path()
. - path() - Element in annotation interface org.springframework.web.bind.annotation.PostMapping
-
Alias for
RequestMapping.path()
. - path() - Element in annotation interface org.springframework.web.bind.annotation.PutMapping
-
Alias for
RequestMapping.path()
. - path() - Element in annotation interface org.springframework.web.bind.annotation.RequestMapping
-
The path mapping URIs — for example,
"/profile"
. - path(String) - Method in interface org.springframework.http.ResponseCookie.ResponseCookieBuilder
-
Set the cookie "Path" attribute.
- path(String) - Method in interface org.springframework.http.server.reactive.ServerHttpRequest.Builder
-
Set the path to use instead of the
"rawPath"
of the URI of the request with the following conditions: Ifuri
is also set, the path given here overrides the path of the given URI. - path(String) - Method in interface org.springframework.web.util.UriBuilder
-
Append to the path of this builder.
- path(String) - Method in class org.springframework.web.util.UriComponentsBuilder
- PATH_ATTRIBUTE - Static variable in class org.springframework.web.util.ServletRequestPathUtils
-
Name of Servlet request attribute that holds the parsed
RequestPath
. - PATH_ATTRIBUTE - Static variable in class org.springframework.web.util.UrlPathHelper
-
Name of Servlet request attribute that holds a
resolved
lookupPath. - PathContainer - Interface in org.springframework.http.server
-
Structured representation of a URI path parsed via
PathContainer.parsePath(String)
into a sequence ofPathContainer.Separator
andPathContainer.PathSegment
elements. - PathContainer.Element - Interface in org.springframework.http.server
-
A path element, either separator or path segment.
- PathContainer.Options - Class in org.springframework.http.server
-
Options to customize parsing based on the type of input path.
- PathContainer.PathSegment - Interface in org.springframework.http.server
-
Path segment element.
- PathContainer.Separator - Interface in org.springframework.http.server
-
Path separator element.
- PathExtensionContentNegotiationStrategy - Class in org.springframework.web.accept
-
Deprecated.as of 5.2.4. See class-level note in
ContentNegotiationManagerFactoryBean
on the deprecation of path extension config options. - PathExtensionContentNegotiationStrategy() - Constructor for class org.springframework.web.accept.PathExtensionContentNegotiationStrategy
-
Deprecated.Create an instance without any mappings to start with.
- PathExtensionContentNegotiationStrategy(Map<String, MediaType>) - Constructor for class org.springframework.web.accept.PathExtensionContentNegotiationStrategy
-
Deprecated.Create an instance with the given map of file extensions and media types.
- PathPattern - Class in org.springframework.web.util.pattern
-
Representation of a parsed path pattern.
- PathPattern.PathMatchInfo - Class in org.springframework.web.util.pattern
-
Holder for URI variables and path parameters (matrix variables) extracted based on the pattern for a given matched path.
- PathPattern.PathRemainingMatchInfo - Class in org.springframework.web.util.pattern
-
Holder for the result of a match on the start of a pattern.
- PathPatternParser - Class in org.springframework.web.util.pattern
-
Parser for URI path patterns producing
PathPattern
instances that can then be matched to requests. - PathPatternParser() - Constructor for class org.springframework.web.util.pattern.PathPatternParser
- PathPatternRouteMatcher - Class in org.springframework.web.util.pattern
-
RouteMatcher
built onPathPatternParser
that usesPathContainer
andPathPattern
as parsed representations of routes and patterns. - PathPatternRouteMatcher() - Constructor for class org.springframework.web.util.pattern.PathPatternRouteMatcher
-
Default constructor with
PathPatternParser
customized forMESSAGE_ROUTE
and without matching of trailing separator. - PathPatternRouteMatcher(PathPatternParser) - Constructor for class org.springframework.web.util.pattern.PathPatternRouteMatcher
-
Constructor with given
PathPatternParser
. - pathSegment(String...) - Method in interface org.springframework.web.util.UriBuilder
-
Append to the path using path segments.
- pathSegment(String...) - Method in class org.springframework.web.util.UriComponentsBuilder
- pathVar() - Element in annotation interface org.springframework.web.bind.annotation.MatrixVariable
-
The name of the URI path variable where the matrix variable is located, if necessary for disambiguation (e.g.
- pathVariable(PathVariable, ParameterValidationResult) - Method in interface org.springframework.web.method.annotation.HandlerMethodValidationException.Visitor
-
Handle results for
@PathVariable
method parameters. - PathVariable - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation which indicates that a method parameter should be bound to a URI template variable.
- PathVariableArgumentResolver - Class in org.springframework.web.service.invoker
-
HttpServiceArgumentResolver
for@PathVariable
annotated arguments. - PathVariableArgumentResolver(ConversionService) - Constructor for class org.springframework.web.service.invoker.PathVariableArgumentResolver
- pathWithinApplication() - Method in interface org.springframework.http.server.RequestPath
-
The portion of the request path after the context path which is typically used for request mapping within the application.
- PatternParseException - Exception in org.springframework.web.util.pattern
-
Exception that is thrown when there is a problem with the pattern being parsed.
- PatternParseException.PatternMessage - Enum Class in org.springframework.web.util.pattern
-
The messages that can be included in a
PatternParseException
when there is a parse failure. - PAYLOAD_TOO_LARGE - Enum constant in enum class org.springframework.http.HttpStatus
-
413 Payload Too Large
. - PAYMENT_REQUIRED - Enum constant in enum class org.springframework.http.HttpStatus
-
402 Payment Required
. - PERMANENT_REDIRECT - Enum constant in enum class org.springframework.http.HttpStatus
-
308 Permanent Redirect
. - popNestedPath() - Method in class org.springframework.web.bind.EscapedErrors
- popNestedPath() - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- port(int) - Method in interface org.springframework.web.util.UriBuilder
-
Set the URI port.
- port(int) - Method in class org.springframework.web.util.UriComponentsBuilder
- port(String) - Method in interface org.springframework.web.util.UriBuilder
-
Set the URI port.
- port(String) - Method in class org.springframework.web.util.UriComponentsBuilder
- post() - Method in interface org.springframework.web.client.RestClient
-
Start building an HTTP POST request.
- post(String, Object...) - Static method in class org.springframework.http.RequestEntity
-
Create an HTTP POST builder with the given string base uri template.
- post(URI) - Static method in class org.springframework.http.RequestEntity
-
Create an HTTP POST builder with the given url.
- POST - Enum constant in enum class org.springframework.web.bind.annotation.RequestMethod
- POST - Static variable in class org.springframework.http.HttpMethod
-
The HTTP method
POST
. - postConfigurer(Consumer<ObjectMapper>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
An option to apply additional customizations directly to the
ObjectMapper
instances at the end, after all other config properties of the builder have been applied. - PostExchange - Annotation Interface in org.springframework.web.service.annotation
-
Shortcut for
@HttpExchange
for HTTP POST requests. - postForEntity(String, Object, Class<T>, Object...) - Method in interface org.springframework.web.client.RestOperations
-
Create a new resource by POSTing the given object to the URI template, and return the response as
ResponseEntity
. - postForEntity(String, Object, Class<T>, Object...) - Method in class org.springframework.web.client.RestTemplate
- postForEntity(String, Object, Class<T>, Map<String, ?>) - Method in interface org.springframework.web.client.RestOperations
-
Create a new resource by POSTing the given object to the URI template, and return the response as
HttpEntity
. - postForEntity(String, Object, Class<T>, Map<String, ?>) - Method in class org.springframework.web.client.RestTemplate
- postForEntity(URI, Object, Class<T>) - Method in interface org.springframework.web.client.RestOperations
-
Create a new resource by POSTing the given object to the URL, and return the response as
ResponseEntity
. - postForEntity(URI, Object, Class<T>) - Method in class org.springframework.web.client.RestTemplate
- postForLocation(String, Object, Object...) - Method in interface org.springframework.web.client.RestOperations
-
Create a new resource by POSTing the given object to the URI template, and return the value of the
Location
header. - postForLocation(String, Object, Object...) - Method in class org.springframework.web.client.RestTemplate
- postForLocation(String, Object, Map<String, ?>) - Method in interface org.springframework.web.client.RestOperations
-
Create a new resource by POSTing the given object to the URI template, and return the value of the
Location
header. - postForLocation(String, Object, Map<String, ?>) - Method in class org.springframework.web.client.RestTemplate
- postForLocation(URI, Object) - Method in interface org.springframework.web.client.RestOperations
-
Create a new resource by POSTing the given object to the URL, and return the value of the
Location
header. - postForLocation(URI, Object) - Method in class org.springframework.web.client.RestTemplate
- postForObject(String, Object, Class<T>, Object...) - Method in interface org.springframework.web.client.RestOperations
-
Create a new resource by POSTing the given object to the URI template, and return the representation found in the response.
- postForObject(String, Object, Class<T>, Object...) - Method in class org.springframework.web.client.RestTemplate
- postForObject(String, Object, Class<T>, Map<String, ?>) - Method in interface org.springframework.web.client.RestOperations
-
Create a new resource by POSTing the given object to the URI template, and return the representation found in the response.
- postForObject(String, Object, Class<T>, Map<String, ?>) - Method in class org.springframework.web.client.RestTemplate
- postForObject(URI, Object, Class<T>) - Method in interface org.springframework.web.client.RestOperations
-
Create a new resource by POSTing the given object to the URL, and return the representation found in the response.
- postForObject(URI, Object, Class<T>) - Method in class org.springframework.web.client.RestTemplate
- postHandle(WebRequest, ModelMap) - Method in interface org.springframework.web.context.request.WebRequestInterceptor
-
Intercept the execution of a request handler after its successful invocation, right before view rendering (if any).
- PostMapping - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation for mapping HTTP
POST
requests onto specific handler methods. - postProcess(NativeWebRequest, Callable<T>, Object) - Method in interface org.springframework.web.context.request.async.CallableProcessingInterceptor
-
Invoked after the
Callable
has produced a result in the async thread in which theCallable
is executed. - postProcess(NativeWebRequest, DeferredResult<T>, Object) - Method in interface org.springframework.web.context.request.async.DeferredResultProcessingInterceptor
-
Invoked after a
DeferredResult
has been set, viaDeferredResult.setResult(Object)
orDeferredResult.setErrorResult(Object)
, and is also ready to handle the concurrent result. - postProcessAfterInitialization(Object, String) - Method in class org.springframework.web.context.support.ServletContextAwareProcessor
- postProcessBeanFactory(ConfigurableListableBeanFactory) - Method in class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
-
Register request/session scopes, a
ServletContextAwareProcessor
, etc. - postProcessBeanFactory(ConfigurableListableBeanFactory) - Method in class org.springframework.web.context.support.GenericWebApplicationContext
-
Register request/session scopes, environment beans, a
ServletContextAwareProcessor
, etc. - postProcessBeanFactory(ConfigurableListableBeanFactory) - Method in class org.springframework.web.context.support.StaticWebApplicationContext
-
Register request/session scopes, a
ServletContextAwareProcessor
, etc. - postProcessBeforeInitialization(Object, String) - Method in class org.springframework.web.context.support.ServletContextAwareProcessor
- postProcessHttpRequest(ClassicHttpRequest) - Method in class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Template method that allows for manipulating the
ClassicHttpRequest
before it is returned as part of aHttpComponentsClientHttpRequest
. - PRAGMA - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Pragma
header field name. - PRECONDITION_FAILED - Enum constant in enum class org.springframework.http.HttpStatus
-
412 Precondition failed
. - PRECONDITION_REQUIRED - Enum constant in enum class org.springframework.http.HttpStatus
-
428 Precondition Required
. - PreFlightRequestHandler - Interface in org.springframework.web.cors.reactive
-
Handler for CORS pre-flight requests.
- PreFlightRequestWebFilter - Class in org.springframework.web.cors.reactive
-
WebFilter that handles pre-flight requests through a
PreFlightRequestHandler
and bypasses the rest of the chain. - PreFlightRequestWebFilter(PreFlightRequestHandler) - Constructor for class org.springframework.web.cors.reactive.PreFlightRequestWebFilter
-
Create an instance that will delegate to the given handler.
- preHandle(WebRequest) - Method in interface org.springframework.web.context.request.WebRequestInterceptor
-
Intercept the execution of a request handler before its invocation.
- prepareConnection(HttpURLConnection, String) - Method in class org.springframework.http.client.SimpleClientHttpRequestFactory
-
Template method for preparing the given
HttpURLConnection
. - preProcess(NativeWebRequest, Callable<T>) - Method in interface org.springframework.web.context.request.async.CallableProcessingInterceptor
-
Invoked after the start of concurrent handling in the async thread in which the
Callable
is executed and before the actual invocation of theCallable
. - preProcess(NativeWebRequest, DeferredResult<T>) - Method in interface org.springframework.web.context.request.async.DeferredResultProcessingInterceptor
-
Invoked immediately after the start of concurrent handling, in the same thread that started it.
- principal(Mono<Principal>) - Method in interface org.springframework.web.server.ServerWebExchange.Builder
-
Set the
Mono<Principal>
to return for this exchange. - ProblemDetail - Class in org.springframework.http
-
Representation for an RFC 7807 problem detail.
- ProblemDetail() - Constructor for class org.springframework.http.ProblemDetail
-
No-arg constructor, for deserialization.
- ProblemDetail(int) - Constructor for class org.springframework.http.ProblemDetail
-
Protected constructor for subclasses.
- ProblemDetail(ProblemDetail) - Constructor for class org.springframework.http.ProblemDetail
-
Copy constructor that a subclass can use to re-create and extend a
ProblemDetail
with additional properties. - ProblemDetailJacksonMixin - Interface in org.springframework.http.converter.json
-
An interface to associate Jackson annotations with
ProblemDetail
to avoid a hard dependency on the Jackson library. - ProblemDetailJacksonXmlMixin - Interface in org.springframework.http.converter.json
-
Provides the same declarations as
ProblemDetailJacksonMixin
and some additional ones to support XML serialization whenjackson-dataformat-xml
is on the classpath. - process(ImageReadParam) - Method in class org.springframework.http.converter.BufferedImageHttpMessageConverter
-
Template method that allows for manipulating the
ImageReadParam
before it is used to read an image. - process(ImageWriteParam) - Method in class org.springframework.http.converter.BufferedImageHttpMessageConverter
-
Template method that allows for manipulating the
ImageWriteParam
before it is used to write an image. - process(CorsConfiguration, ServerWebExchange) - Method in interface org.springframework.web.cors.reactive.CorsProcessor
-
Process a request using the given
CorsConfiguration
. - process(CorsConfiguration, ServerWebExchange) - Method in class org.springframework.web.cors.reactive.DefaultCorsProcessor
- PROCESSING - Enum constant in enum class org.springframework.http.HttpStatus
-
102 Processing
. - processInjectionBasedOnCurrentContext(Object) - Static method in class org.springframework.web.context.support.SpringBeanAutowiringSupport
-
Process
@Autowired
injection for the given target object, based on the current web application context. - processInjectionBasedOnServletContext(Object, ServletContext) - Static method in class org.springframework.web.context.support.SpringBeanAutowiringSupport
-
Process
@Autowired
injection for the given target object, based on the current root web application context as stored in the ServletContext. - processInput(Publisher<DataBuffer>, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.json.AbstractJackson2Decoder
-
Process the input publisher into a flux.
- processInput(Publisher<DataBuffer>, ResolvableType, MimeType, Map<String, Object>) - Method in class org.springframework.http.codec.json.Jackson2JsonDecoder
- processRequest(CorsConfiguration, HttpServletRequest, HttpServletResponse) - Method in interface org.springframework.web.cors.CorsProcessor
-
Process a request given a
CorsConfiguration
. - processRequest(CorsConfiguration, HttpServletRequest, HttpServletResponse) - Method in class org.springframework.web.cors.DefaultCorsProcessor
- processSource(Source) - Method in class org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter
- produces() - Element in annotation interface org.springframework.web.bind.annotation.DeleteMapping
-
Alias for
RequestMapping.produces()
. - produces() - Element in annotation interface org.springframework.web.bind.annotation.GetMapping
-
Alias for
RequestMapping.produces()
. - produces() - Element in annotation interface org.springframework.web.bind.annotation.PatchMapping
-
Alias for
RequestMapping.produces()
. - produces() - Element in annotation interface org.springframework.web.bind.annotation.PostMapping
-
Alias for
RequestMapping.produces()
. - produces() - Element in annotation interface org.springframework.web.bind.annotation.PutMapping
-
Alias for
RequestMapping.produces()
. - produces() - Element in annotation interface org.springframework.web.bind.annotation.RequestMapping
-
Narrows the primary mapping by media types that can be produced by the mapped handler.
- property(String, Object) - Method in interface org.springframework.web.ErrorResponse.Builder
-
Set a "dynamic"
property
on the underlyingProblemDetail
. - propertyNamingStrategy(PropertyNamingStrategy) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Specify a
PropertyNamingStrategy
to configure theObjectMapper
with. - PROTOBUF - Static variable in class org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter
-
The media-type for protobuf
application/x-protobuf
. - ProtobufCodecSupport - Class in org.springframework.http.codec.protobuf
-
Base class providing support methods for Protobuf encoding and decoding.
- ProtobufCodecSupport() - Constructor for class org.springframework.http.codec.protobuf.ProtobufCodecSupport
- protobufDecoder(Decoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Override the default Protobuf
Decoder
. - ProtobufDecoder - Class in org.springframework.http.codec.protobuf
- ProtobufDecoder() - Constructor for class org.springframework.http.codec.protobuf.ProtobufDecoder
-
Construct a new
ProtobufDecoder
. - ProtobufDecoder(ExtensionRegistry) - Constructor for class org.springframework.http.codec.protobuf.ProtobufDecoder
-
Construct a new
ProtobufDecoder
with an initializer that allows the registration of message extensions. - protobufEncoder(Encoder<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.DefaultCodecs
-
Override the default Protobuf
Encoder
. - ProtobufEncoder - Class in org.springframework.http.codec.protobuf
- ProtobufEncoder() - Constructor for class org.springframework.http.codec.protobuf.ProtobufEncoder
- ProtobufHttpMessageConverter - Class in org.springframework.http.converter.protobuf
-
An
HttpMessageConverter
that reads and writescom.google.protobuf.Messages
using Google Protocol Buffers. - ProtobufHttpMessageConverter() - Constructor for class org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter
-
Construct a new
ProtobufHttpMessageConverter
. - ProtobufHttpMessageConverter(ExtensionRegistry) - Constructor for class org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter
-
Construct a new
ProtobufHttpMessageConverter
with a registry that specifies protocol message extensions. - ProtobufHttpMessageWriter - Class in org.springframework.http.codec.protobuf
-
HttpMessageWriter
that can write a protobufMessage
and addsX-Protobuf-Schema
,X-Protobuf-Message
headers and adelimited=true
parameter is added to the content type if a flux is serialized. - ProtobufHttpMessageWriter() - Constructor for class org.springframework.http.codec.protobuf.ProtobufHttpMessageWriter
-
Create a new
ProtobufHttpMessageWriter
with a defaultProtobufEncoder
. - ProtobufHttpMessageWriter(Encoder<Message>) - Constructor for class org.springframework.http.codec.protobuf.ProtobufHttpMessageWriter
-
Create a new
ProtobufHttpMessageWriter
with the given encoder. - ProtobufJsonFormatHttpMessageConverter - Class in org.springframework.http.converter.protobuf
-
Subclass of
ProtobufHttpMessageConverter
which enforces the use of Protobuf 3 and its official library"com.google.protobuf:protobuf-java-util"
for JSON processing. - ProtobufJsonFormatHttpMessageConverter() - Constructor for class org.springframework.http.converter.protobuf.ProtobufJsonFormatHttpMessageConverter
-
Constructor with default instances of
JsonFormat.Parser
,JsonFormat.Printer
, andExtensionRegistry
. - ProtobufJsonFormatHttpMessageConverter(JsonFormat.Parser, JsonFormat.Printer) - Constructor for class org.springframework.http.converter.protobuf.ProtobufJsonFormatHttpMessageConverter
-
Constructor with given instances of
JsonFormat.Parser
,JsonFormat.Printer
, and a default instance ofExtensionRegistry
. - ProtobufJsonFormatHttpMessageConverter(JsonFormat.Parser, JsonFormat.Printer, ExtensionRegistry) - Constructor for class org.springframework.http.converter.protobuf.ProtobufJsonFormatHttpMessageConverter
-
Constructor with given instances of
JsonFormat.Parser
,JsonFormat.Printer
, andExtensionRegistry
. - PROXY_AUTHENTICATE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Proxy-Authenticate
header field name. - PROXY_AUTHENTICATION_REQUIRED - Enum constant in enum class org.springframework.http.HttpStatus
-
407 Proxy Authentication Required
. - PROXY_AUTHORIZATION - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Proxy-Authorization
header field name. - ProxyFactoryBean - Class in org.springframework.http.client.support
-
FactoryBean
that creates ajava.net.Proxy
. - ProxyFactoryBean() - Constructor for class org.springframework.http.client.support.ProxyFactoryBean
- proxyMode() - Element in annotation interface org.springframework.web.context.annotation.ApplicationScope
-
Alias for
Scope.proxyMode()
. - proxyMode() - Element in annotation interface org.springframework.web.context.annotation.RequestScope
-
Alias for
Scope.proxyMode()
. - proxyMode() - Element in annotation interface org.springframework.web.context.annotation.SessionScope
-
Alias for
Scope.proxyMode()
. - proxyRevalidate() - Method in class org.springframework.http.CacheControl
-
Add a "proxy-revalidate" directive.
- pushNestedPath(String) - Method in class org.springframework.web.bind.EscapedErrors
- pushNestedPath(String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- put() - Method in interface org.springframework.web.client.RestClient
-
Start building an HTTP PUT request.
- put(String, Object...) - Static method in class org.springframework.http.RequestEntity
-
Create an HTTP PUT builder with the given string base uri template.
- put(String, Object, Object...) - Method in interface org.springframework.web.client.RestOperations
-
Create or update a resource by PUTting the given object to the URI.
- put(String, Object, Object...) - Method in class org.springframework.web.client.RestTemplate
- put(String, Object, Map<String, ?>) - Method in interface org.springframework.web.client.RestOperations
-
Creates a new resource by PUTting the given object to URI template.
- put(String, Object, Map<String, ?>) - Method in class org.springframework.web.client.RestTemplate
- put(String, List<String>) - Method in class org.springframework.http.HttpHeaders
- put(String, List<String>) - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- put(String, List<String>) - Method in class org.springframework.http.support.JettyHeadersAdapter
- put(String, List<String>) - Method in class org.springframework.http.support.Netty4HeadersAdapter
- put(String, List<String>) - Method in class org.springframework.http.support.Netty5HeadersAdapter
- put(URI) - Static method in class org.springframework.http.RequestEntity
-
Create an HTTP PUT builder with the given url.
- put(URI, Object) - Method in interface org.springframework.web.client.RestOperations
-
Creates a new resource by PUTting the given object to URL.
- put(URI, Object) - Method in class org.springframework.web.client.RestTemplate
- PUT - Enum constant in enum class org.springframework.web.bind.annotation.RequestMethod
- PUT - Static variable in class org.springframework.http.HttpMethod
-
The HTTP method
PUT
. - putAll(Map<? extends String, ? extends List<String>>) - Method in class org.springframework.http.HttpHeaders
- putAll(Map<? extends String, ? extends List<String>>) - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- putAll(Map<? extends String, ? extends List<String>>) - Method in class org.springframework.http.support.JettyHeadersAdapter
- putAll(Map<? extends String, ? extends List<String>>) - Method in class org.springframework.http.support.Netty4HeadersAdapter
- putAll(Map<? extends String, ? extends List<String>>) - Method in class org.springframework.http.support.Netty5HeadersAdapter
- PutExchange - Annotation Interface in org.springframework.web.service.annotation
-
Shortcut for
@HttpExchange
for HTTP PUT requests. - putIfAbsent(String, List<String>) - Method in class org.springframework.http.HttpHeaders
- PutMapping - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation for mapping HTTP
PUT
requests onto specific handler methods.
Q
- QUALITY_VALUE_COMPARATOR - Static variable in class org.springframework.http.MediaType
-
Deprecated, for removal: This API element is subject to removal in a future version.As of 6.0, with no direct replacement
- query(String) - Method in interface org.springframework.web.util.UriBuilder
-
Parse the given query string into query parameters where parameters are separated with
'&'
and their values, if any, with'='
. - query(String) - Method in class org.springframework.web.util.UriComponentsBuilder
- queryParam(String, Object...) - Method in interface org.springframework.web.util.UriBuilder
-
Append the given query parameter.
- queryParam(String, Object...) - Method in class org.springframework.web.util.UriComponentsBuilder
- queryParam(String, Collection<?>) - Method in interface org.springframework.web.util.UriBuilder
-
Variant of
UriBuilder.queryParam(String, Object...)
with a Collection. - queryParam(String, Collection<?>) - Method in class org.springframework.web.util.UriComponentsBuilder
- queryParamIfPresent(String, Optional<?>) - Method in interface org.springframework.web.util.UriBuilder
-
Delegates to either
UriBuilder.queryParam(String, Object...)
orUriBuilder.queryParam(String, Collection)
if the givenOptional
has a value, or else if it is empty, no query parameter is added at all. - queryParamIfPresent(String, Optional<?>) - Method in class org.springframework.web.util.UriComponentsBuilder
- queryParams(MultiValueMap<String, String>) - Method in interface org.springframework.web.util.UriBuilder
-
Add multiple query parameters and values.
- queryParams(MultiValueMap<String, String>) - Method in class org.springframework.web.util.UriComponentsBuilder
-
Add multiple query parameters and values.
R
- RANGE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Range
header field name. - rawPathInstance - Static variable in class org.springframework.web.util.UrlPathHelper
-
Shared, read-only instance for the full, encoded path.
- reactiveAdapterRegistry(ReactiveAdapterRegistry) - Method in class org.springframework.web.service.invoker.HttpServiceProxyFactory.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of setting the same directly on the
HttpExchangeAdapter
- ReactiveHttpInputMessage - Interface in org.springframework.http
-
A "reactive" HTTP input message that exposes the input as
Publisher
. - ReactiveHttpOutputMessage - Interface in org.springframework.http
-
A "reactive" HTTP output message that accepts output as a
Publisher
. - ReactiveHttpRequestValues - Class in org.springframework.web.service.invoker
-
HttpRequestValues
extension for use withReactorHttpExchangeAdapter
. - ReactiveHttpRequestValues.Builder - Class in org.springframework.web.service.invoker
-
Builder for
ReactiveHttpRequestValues
. - ReactorClientHttpConnector - Class in org.springframework.http.client.reactive
-
Reactor-Netty implementation of
ClientHttpConnector
. - ReactorClientHttpConnector() - Constructor for class org.springframework.http.client.reactive.ReactorClientHttpConnector
-
Default constructor.
- ReactorClientHttpConnector(ReactorResourceFactory, Function<HttpClient, HttpClient>) - Constructor for class org.springframework.http.client.reactive.ReactorClientHttpConnector
-
Constructor with externally managed Reactor Netty resources, including
LoopResources
for event loop threads, andConnectionProvider
for the connection pool. - ReactorClientHttpConnector(HttpClient) - Constructor for class org.springframework.http.client.reactive.ReactorClientHttpConnector
-
Constructor with a pre-configured
HttpClient
instance. - ReactorHttpExchangeAdapter - Interface in org.springframework.web.service.invoker
-
Contract to abstract a reactive, HTTP client from HttpServiceProxyFactory and make it pluggable.
- ReactorHttpHandlerAdapter - Class in org.springframework.http.server.reactive
-
Adapt
HttpHandler
to the Reactor Netty channel handling function. - ReactorHttpHandlerAdapter(HttpHandler) - Constructor for class org.springframework.http.server.reactive.ReactorHttpHandlerAdapter
- ReactorNetty2ClientHttpConnector - Class in org.springframework.http.client.reactive
-
Reactor Netty 2 (Netty 5) implementation of
ClientHttpConnector
. - ReactorNetty2ClientHttpConnector() - Constructor for class org.springframework.http.client.reactive.ReactorNetty2ClientHttpConnector
-
Default constructor.
- ReactorNetty2ClientHttpConnector(ReactorNetty2ResourceFactory, Function<HttpClient, HttpClient>) - Constructor for class org.springframework.http.client.reactive.ReactorNetty2ClientHttpConnector
-
Constructor with externally managed Reactor Netty resources, including
LoopResources
for event loop threads, andConnectionProvider
for the connection pool. - ReactorNetty2ClientHttpConnector(HttpClient) - Constructor for class org.springframework.http.client.reactive.ReactorNetty2ClientHttpConnector
-
Constructor with a pre-configured
HttpClient
instance. - ReactorNetty2HttpHandlerAdapter - Class in org.springframework.http.server.reactive
-
Adapt
HttpHandler
to the Reactor Netty 5 channel handling function. - ReactorNetty2HttpHandlerAdapter(HttpHandler) - Constructor for class org.springframework.http.server.reactive.ReactorNetty2HttpHandlerAdapter
- ReactorNetty2ResourceFactory - Class in org.springframework.http.client.reactive
-
Factory to manage Reactor Netty resources, i.e.
- ReactorNetty2ResourceFactory() - Constructor for class org.springframework.http.client.reactive.ReactorNetty2ResourceFactory
- ReactorNettyClientRequestFactory - Class in org.springframework.http.client
-
Reactor-Netty implementation of
ClientHttpRequestFactory
. - ReactorNettyClientRequestFactory() - Constructor for class org.springframework.http.client.ReactorNettyClientRequestFactory
-
Create a new instance of the
ReactorNettyClientRequestFactory
with a defaultHttpClient
that has compression enabled. - ReactorNettyClientRequestFactory(ReactorResourceFactory, Function<HttpClient, HttpClient>) - Constructor for class org.springframework.http.client.ReactorNettyClientRequestFactory
-
Constructor with externally managed Reactor Netty resources, including
LoopResources
for event loop threads, andConnectionProvider
for the connection pool. - ReactorNettyClientRequestFactory(HttpClient) - Constructor for class org.springframework.http.client.ReactorNettyClientRequestFactory
-
Create a new instance of the
ReactorNettyClientRequestFactory
based on the givenHttpClient
. - ReactorResourceFactory - Class in org.springframework.http.client.reactive
-
Deprecated.since 6.1 due to a package change; use
ReactorResourceFactory
instead. - ReactorResourceFactory - Class in org.springframework.http.client
-
Factory to manage Reactor Netty resources, i.e.
- ReactorResourceFactory() - Constructor for class org.springframework.http.client.reactive.ReactorResourceFactory
-
Deprecated.
- ReactorResourceFactory() - Constructor for class org.springframework.http.client.ReactorResourceFactory
- read() - Method in class org.springframework.http.server.reactive.AbstractListenerReadPublisher
-
Read once from the input, if possible.
- read(Class<? extends BufferedImage>, HttpInputMessage) - Method in class org.springframework.http.converter.BufferedImageHttpMessageConverter
- read(Class<? extends MultiValueMap<String, ?>>, HttpInputMessage) - Method in class org.springframework.http.converter.FormHttpMessageConverter
- read(Class<? extends T>, HttpInputMessage) - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
-
This implementation simple delegates to
AbstractHttpMessageConverter.readInternal(Class, HttpInputMessage)
. - read(Class<? extends T>, HttpInputMessage) - Method in interface org.springframework.http.converter.HttpMessageConverter
-
Read an object of the given type from the given input message, and returns it.
- read(Type, Class<?>, HttpInputMessage) - Method in class org.springframework.http.converter.AbstractKotlinSerializationHttpMessageConverter
- read(Type, Class<?>, HttpInputMessage) - Method in interface org.springframework.http.converter.GenericHttpMessageConverter
-
Read an object of the given type form the given input message, and returns it.
- read(Type, Class<?>, HttpInputMessage) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
- read(Type, Class<?>, HttpInputMessage) - Method in class org.springframework.http.converter.json.AbstractJsonHttpMessageConverter
- read(Type, Class<?>, HttpInputMessage) - Method in class org.springframework.http.converter.ResourceRegionHttpMessageConverter
- read(Type, Class<?>, HttpInputMessage) - Method in class org.springframework.http.converter.xml.Jaxb2CollectionHttpMessageConverter
- read(ResolvableType, ResolvableType, ServerHttpRequest, ServerHttpResponse, Map<String, Object>) - Method in class org.springframework.http.codec.DecoderHttpMessageReader
- read(ResolvableType, ResolvableType, ServerHttpRequest, ServerHttpResponse, Map<String, Object>) - Method in interface org.springframework.http.codec.HttpMessageReader
-
Server-side only alternative to
HttpMessageReader.read(ResolvableType, ReactiveHttpInputMessage, Map)
with additional context available. - read(ResolvableType, ReactiveHttpInputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.DecoderHttpMessageReader
- read(ResolvableType, ReactiveHttpInputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.FormHttpMessageReader
- read(ResolvableType, ReactiveHttpInputMessage, Map<String, Object>) - Method in interface org.springframework.http.codec.HttpMessageReader
-
Read from the input message and decode to a stream of objects.
- read(ResolvableType, ReactiveHttpInputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.multipart.DefaultPartHttpMessageReader
- read(ResolvableType, ReactiveHttpInputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.multipart.MultipartHttpMessageReader
- read(ResolvableType, ReactiveHttpInputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.multipart.PartEventHttpMessageReader
- read(ResolvableType, ReactiveHttpInputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.ServerSentEventHttpMessageReader
- readDate(ZonedDateTime) - Method in interface org.springframework.http.ContentDisposition.Builder
-
Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.
- reader(HttpMessageReader<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.CustomCodecs
-
Deprecated.as of 5.1.13, use
CodecConfigurer.CustomCodecs.register(Object)
orCodecConfigurer.CustomCodecs.registerWithDefaultConfig(Object)
instead. - readFromSource(Class<?>, HttpHeaders, Source) - Method in class org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter
- readFromSource(Class<?>, HttpHeaders, Source) - Method in class org.springframework.http.converter.xml.MarshallingHttpMessageConverter
- readFromSource(Class<? extends T>, HttpHeaders, Source) - Method in class org.springframework.http.converter.xml.AbstractXmlHttpMessageConverter
-
Abstract template method called from
AbstractHttpMessageConverter.read(Class, HttpInputMessage)
. - readFromSource(Class<? extends T>, HttpHeaders, Source) - Method in class org.springframework.http.converter.xml.Jaxb2CollectionHttpMessageConverter
- readingPaused() - Method in class org.springframework.http.server.reactive.AbstractListenerReadPublisher
-
Invoked when reading is paused due to a lack of demand.
- readInternal(Class<?>, HttpInputMessage) - Method in class org.springframework.http.converter.AbstractKotlinSerializationHttpMessageConverter
- readInternal(Class<?>, HttpInputMessage) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
- readInternal(Class<?>, HttpInputMessage) - Method in class org.springframework.http.converter.json.AbstractJsonHttpMessageConverter
- readInternal(Class<?>, HttpInputMessage) - Method in class org.springframework.http.converter.ObjectToStringHttpMessageConverter
- readInternal(Class<?>, HttpInputMessage) - Method in class org.springframework.http.converter.ResourceRegionHttpMessageConverter
- readInternal(Class<? extends byte[]>, HttpInputMessage) - Method in class org.springframework.http.converter.ByteArrayHttpMessageConverter
- readInternal(Class<? extends Message>, HttpInputMessage) - Method in class org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter
- readInternal(Class<? extends String>, HttpInputMessage) - Method in class org.springframework.http.converter.StringHttpMessageConverter
- readInternal(Class<? extends Resource>, HttpInputMessage) - Method in class org.springframework.http.converter.ResourceHttpMessageConverter
- readInternal(Class<? extends T>, HttpInputMessage) - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
-
Abstract template method that reads the actual object.
- readInternal(Class<? extends T>, HttpInputMessage) - Method in class org.springframework.http.converter.feed.AbstractWireFeedHttpMessageConverter
- readInternal(Class<? extends T>, HttpInputMessage) - Method in class org.springframework.http.converter.xml.AbstractXmlHttpMessageConverter
- readInternal(Class<? extends T>, HttpInputMessage) - Method in class org.springframework.http.converter.xml.SourceHttpMessageConverter
- readInternal(Type, Reader) - Method in class org.springframework.http.converter.json.AbstractJsonHttpMessageConverter
-
Template method that reads the JSON-bound object from the given
Reader
. - readInternal(Type, Reader) - Method in class org.springframework.http.converter.json.GsonHttpMessageConverter
- readInternal(Type, Reader) - Method in class org.springframework.http.converter.json.JsonbHttpMessageConverter
- readInternal(KSerializer<Object>, T, HttpInputMessage) - Method in class org.springframework.http.converter.AbstractKotlinSerializationHttpMessageConverter
-
Reads the given input message with the given serializer and format.
- readInternal(KSerializer<Object>, T, HttpInputMessage) - Method in class org.springframework.http.converter.KotlinSerializationBinaryHttpMessageConverter
- readInternal(KSerializer<Object>, T, HttpInputMessage) - Method in class org.springframework.http.converter.KotlinSerializationStringHttpMessageConverter
- readMono(ResolvableType, ResolvableType, ServerHttpRequest, ServerHttpResponse, Map<String, Object>) - Method in class org.springframework.http.codec.DecoderHttpMessageReader
- readMono(ResolvableType, ResolvableType, ServerHttpRequest, ServerHttpResponse, Map<String, Object>) - Method in interface org.springframework.http.codec.HttpMessageReader
-
Server-side only alternative to
HttpMessageReader.readMono(ResolvableType, ReactiveHttpInputMessage, Map)
with additional, context available. - readMono(ResolvableType, ReactiveHttpInputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.DecoderHttpMessageReader
- readMono(ResolvableType, ReactiveHttpInputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.FormHttpMessageReader
- readMono(ResolvableType, ReactiveHttpInputMessage, Map<String, Object>) - Method in interface org.springframework.http.codec.HttpMessageReader
-
Read from the input message and decode to a single object.
- readMono(ResolvableType, ReactiveHttpInputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.multipart.DefaultPartHttpMessageReader
- readMono(ResolvableType, ReactiveHttpInputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.multipart.MultipartHttpMessageReader
- readMono(ResolvableType, ReactiveHttpInputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.multipart.PartEventHttpMessageReader
- readMono(ResolvableType, ReactiveHttpInputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.ServerSentEventHttpMessageReader
- readOnlyHttpHeaders(HttpHeaders) - Static method in class org.springframework.http.HttpHeaders
-
Apply a read-only
HttpHeaders
wrapper around the given headers, if necessary. - readOnlyHttpHeaders(MultiValueMap<String, String>) - Static method in class org.springframework.http.HttpHeaders
-
Apply a read-only
HttpHeaders
wrapper around the given headers, if necessary. - reason() - Element in annotation interface org.springframework.web.bind.annotation.ResponseStatus
-
The reason to be used for the response.
- recordFieldValue(String, Class<?>, Object) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- recordSuppressedField(String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- REDIRECTION - Enum constant in enum class org.springframework.http.HttpStatus.Series
- REFERENCE_REQUEST - Static variable in interface org.springframework.web.context.request.RequestAttributes
-
Name of the standard reference to the request object: "request".
- REFERENCE_SESSION - Static variable in interface org.springframework.web.context.request.RequestAttributes
-
Name of the standard reference to the session object: "session".
- REFERER - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Referer
header field name. - refreshApplicationContext(ApplicationContext) - Method in class org.springframework.web.server.adapter.AbstractReactiveWebInitializer
-
Refresh the given application context, if necessary.
- REGEX_PATTERN_SYNTAX_EXCEPTION - Enum constant in enum class org.springframework.web.util.pattern.PatternParseException.PatternMessage
- register(Class<?>...) - Method in class org.springframework.web.context.support.AnnotationConfigWebApplicationContext
-
Register one or more component classes to be processed.
- register(Object) - Method in interface org.springframework.http.codec.CodecConfigurer.CustomCodecs
-
Register a custom codec.
- registerCallableInterceptor(Object, CallableProcessingInterceptor) - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Register a
CallableProcessingInterceptor
under the given key. - registerCallableInterceptors(CallableProcessingInterceptor...) - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Register a
CallableProcessingInterceptor
without a key. - registerCloseListener(ServletContext, ApplicationContext) - Method in class org.springframework.web.server.adapter.AbstractReactiveWebInitializer
-
Register a
ServletContextListener
that closes the given application context when the servlet context is destroyed. - registerContextLoaderListener(ServletContext) - Method in class org.springframework.web.context.AbstractContextLoaderInitializer
-
Register a
ContextLoaderListener
against the given servlet context. - registerCorsConfiguration(String, CorsConfiguration) - Method in class org.springframework.web.cors.reactive.UrlBasedCorsConfigurationSource
-
Register a
CorsConfiguration
for the specified path pattern. - registerCorsConfiguration(String, CorsConfiguration) - Method in class org.springframework.web.cors.UrlBasedCorsConfigurationSource
-
Variant of
UrlBasedCorsConfigurationSource.setCorsConfigurations(Map)
to register one mapping at a time. - registerDefaults(boolean) - Method in interface org.springframework.http.codec.CodecConfigurer
-
Provides a way to completely turn off registration of default HTTP message readers and writers, and instead rely only on the ones provided via
CodecConfigurer.customCodecs()
. - registerDefaults(boolean) - Method in class org.springframework.http.codec.support.DefaultClientCodecConfigurer
- registerDeferredResultInterceptor(Object, DeferredResultProcessingInterceptor) - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Register a
DeferredResultProcessingInterceptor
under the given key. - registerDeferredResultInterceptors(DeferredResultProcessingInterceptor...) - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Register one or more
DeferredResultProcessingInterceptors
without a specified key. - registerDestructionCallback(String, Runnable) - Method in class org.springframework.web.context.request.AbstractRequestAttributesScope
- registerDestructionCallback(String, Runnable) - Method in class org.springframework.web.context.support.ServletContextScope
- registerDestructionCallback(String, Runnable, int) - Method in class org.springframework.web.context.request.FacesRequestAttributes
- registerDestructionCallback(String, Runnable, int) - Method in interface org.springframework.web.context.request.RequestAttributes
-
Register a callback to be executed on destruction of the specified attribute in the given scope.
- registerDestructionCallback(String, Runnable, int) - Method in class org.springframework.web.context.request.ServletRequestAttributes
- registerEnvironmentBeans(ConfigurableListableBeanFactory, ServletContext) - Static method in class org.springframework.web.context.support.WebApplicationContextUtils
-
Register web-specific environment beans ("contextParameters", "contextAttributes") with the given BeanFactory, as used by the WebApplicationContext.
- registerEnvironmentBeans(ConfigurableListableBeanFactory, ServletContext, ServletConfig) - Static method in class org.springframework.web.context.support.WebApplicationContextUtils
-
Register web-specific environment beans ("contextParameters", "contextAttributes") with the given BeanFactory, as used by the WebApplicationContext.
- registerObjectMappersForType(Class<?>, Consumer<Map<MediaType, ObjectMapper>>) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
-
Configure the
ObjectMapper
instances to use for the givenClass
. - registerObjectMappersForType(Class<?>, Consumer<Map<MimeType, ObjectMapper>>) - Method in class org.springframework.http.codec.json.Jackson2CodecSupport
-
Configure the
ObjectMapper
instances to use for the givenClass
. - registerRequestDestructionCallback(String, Runnable) - Method in class org.springframework.web.context.request.AbstractRequestAttributes
-
Register the given callback as to be executed after request completion.
- registerSessionDestructionCallback(String, Runnable) - Method in class org.springframework.web.context.request.ServletRequestAttributes
-
Register the given callback as to be executed after session termination.
- registerWebApplicationScopes(ConfigurableListableBeanFactory) - Static method in class org.springframework.web.context.support.WebApplicationContextUtils
-
Register web-specific scopes ("request", "session", "globalSession") with the given BeanFactory, as used by the WebApplicationContext.
- registerWebApplicationScopes(ConfigurableListableBeanFactory, ServletContext) - Static method in class org.springframework.web.context.support.WebApplicationContextUtils
-
Register web-specific scopes ("request", "session", "globalSession", "application") with the given BeanFactory, as used by the WebApplicationContext.
- registerWithDefaultConfig(Object) - Method in interface org.springframework.http.codec.CodecConfigurer.CustomCodecs
-
Variant of
CodecConfigurer.CustomCodecs.register(Object)
that also applies the below properties, if configured, viaCodecConfigurer.defaultCodecs()
:maxInMemorySize
enableLoggingRequestDetails
- registerWithDefaultConfig(Object, Consumer<CodecConfigurer.DefaultCodecConfig>) - Method in interface org.springframework.http.codec.CodecConfigurer.CustomCodecs
-
Variant of
CodecConfigurer.CustomCodecs.register(Object)
that also allows the caller to apply the properties fromCodecConfigurer.DefaultCodecConfig
to the given codec. - reject(String) - Method in class org.springframework.web.bind.EscapedErrors
- reject(String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- reject(String, Object[], String) - Method in class org.springframework.web.bind.EscapedErrors
- reject(String, Object[], String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- reject(String, String) - Method in class org.springframework.web.bind.EscapedErrors
- reject(String, String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- rejectRequest(ServerHttpResponse) - Method in class org.springframework.web.cors.reactive.DefaultCorsProcessor
-
Invoked when one of the CORS checks failed.
- rejectRequest(ServerHttpResponse) - Method in class org.springframework.web.cors.DefaultCorsProcessor
-
Invoked when one of the CORS checks failed.
- rejectValue(String, String) - Method in class org.springframework.web.bind.EscapedErrors
- rejectValue(String, String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- rejectValue(String, String, Object[], String) - Method in class org.springframework.web.bind.EscapedErrors
- rejectValue(String, String, Object[], String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- rejectValue(String, String, String) - Method in class org.springframework.web.bind.EscapedErrors
- rejectValue(String, String, String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- RelativeRedirectFilter - Class in org.springframework.web.filter
-
Overrides
HttpServletResponse.sendRedirect(String)
and handles it by setting the HTTP status and "Location" headers, which keeps the Servlet container from re-writing relative redirect URLs into absolute ones. - RelativeRedirectFilter() - Constructor for class org.springframework.web.filter.RelativeRedirectFilter
- releaseInstance(ConstraintValidator<?, ?>) - Method in class org.springframework.web.bind.support.SpringWebConstraintValidatorFactory
- remoteAddress(InetSocketAddress) - Method in interface org.springframework.http.server.reactive.ServerHttpRequest.Builder
-
Set the address of the remote client.
- remove(Object) - Method in class org.springframework.http.HttpHeaders
- remove(Object) - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- remove(Object) - Method in class org.springframework.http.support.JettyHeadersAdapter
- remove(Object) - Method in class org.springframework.http.support.Netty4HeadersAdapter
- remove(Object) - Method in class org.springframework.http.support.Netty5HeadersAdapter
- remove(String) - Method in class org.springframework.web.context.request.AbstractRequestAttributesScope
- remove(String) - Method in class org.springframework.web.context.request.SessionScope
- remove(String) - Method in class org.springframework.web.context.support.ServletContextScope
- removeAttribute(String, int) - Method in class org.springframework.web.context.request.FacesRequestAttributes
- removeAttribute(String, int) - Method in interface org.springframework.web.context.request.RequestAttributes
-
Remove the scoped attribute of the given name, if it exists.
- removeAttribute(String, int) - Method in class org.springframework.web.context.request.ServletRequestAttributes
- removeAttributes(Map<String, ?>) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Remove the given attributes from the model.
- removeCookie(HttpServletResponse) - Method in class org.springframework.web.util.CookieGenerator
-
Deprecated.Remove the cookie that this generator describes from the response.
- removeExpiredSessions() - Method in class org.springframework.web.server.session.InMemoryWebSessionStore
-
Check for expired sessions and remove them.
- removeQualityValue() - Method in class org.springframework.http.MediaType
-
Return a replica of this instance with its quality value removed.
- removeRequestDestructionCallback(String) - Method in class org.springframework.web.context.request.AbstractRequestAttributes
-
Remove the request destruction callback for the specified attribute, if any.
- removeSemicolonContent(String) - Method in class org.springframework.web.util.UrlPathHelper
-
Remove ";" (semicolon) content from the given request URI if the removeSemicolonContent property is set to "true".
- removeSession(String) - Method in class org.springframework.web.server.session.InMemoryWebSessionStore
- removeSession(String) - Method in interface org.springframework.web.server.session.WebSessionStore
-
Remove the WebSession for the specified id.
- removeWebAppRootSystemProperty(ServletContext) - Static method in class org.springframework.web.util.WebUtils
-
Remove the system property that points to the web app root directory.
- repeatable() - Method in interface org.springframework.http.StreamingHttpOutputMessage.Body
-
Indicates whether this body is capable of writing its data more than once.
- replacePath(String) - Method in interface org.springframework.web.util.UriBuilder
-
Override the current path.
- replacePath(String) - Method in class org.springframework.web.util.UriComponentsBuilder
- replaceQuery(String) - Method in interface org.springframework.web.util.UriBuilder
-
Clear existing query parameters and then delegate to
UriBuilder.query(String)
. - replaceQuery(String) - Method in class org.springframework.web.util.UriComponentsBuilder
- replaceQueryParam(String, Object...) - Method in interface org.springframework.web.util.UriBuilder
-
Set the query parameter values replacing existing values, or if no values are given, the query parameter is removed.
- replaceQueryParam(String, Object...) - Method in class org.springframework.web.util.UriComponentsBuilder
- replaceQueryParam(String, Collection<?>) - Method in interface org.springframework.web.util.UriBuilder
-
Variant of
UriBuilder.replaceQueryParam(String, Object...)
with a Collection. - replaceQueryParam(String, Collection<?>) - Method in class org.springframework.web.util.UriComponentsBuilder
- replaceQueryParams(MultiValueMap<String, String>) - Method in interface org.springframework.web.util.UriBuilder
-
Set the query parameter values after removing all existing ones.
- replaceQueryParams(MultiValueMap<String, String>) - Method in class org.springframework.web.util.UriComponentsBuilder
-
Set the query parameter values after removing all existing ones.
- request(Consumer<ServerHttpRequest.Builder>) - Method in interface org.springframework.web.server.ServerWebExchange.Builder
-
Configure a consumer to modify the current request using a builder.
- request(ServerHttpRequest) - Method in interface org.springframework.web.server.ServerWebExchange.Builder
-
Set the request to use especially when there is a need to override
ServerHttpRequest
methods. - REQUEST_ENTITY_TOO_LARGE - Enum constant in enum class org.springframework.http.HttpStatus
-
Deprecated.in favor of
HttpStatus.PAYLOAD_TOO_LARGE
which will be returned fromHttpStatus.valueOf(413)
- REQUEST_HEADER_FIELDS_TOO_LARGE - Enum constant in enum class org.springframework.http.HttpStatus
-
431 Request Header Fields Too Large
. - REQUEST_TIMEOUT - Enum constant in enum class org.springframework.http.HttpStatus
-
408 Request Timeout
. - REQUEST_URI_TOO_LONG - Enum constant in enum class org.springframework.http.HttpStatus
-
Deprecated.in favor of
HttpStatus.URI_TOO_LONG
which will be returned fromHttpStatus.valueOf(414)
- RequestAttribute - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation to bind a method parameter to a request attribute.
- RequestAttributeArgumentResolver - Class in org.springframework.web.service.invoker
-
HttpServiceArgumentResolver
for@RequestAttribute
annotated arguments. - RequestAttributeArgumentResolver() - Constructor for class org.springframework.web.service.invoker.RequestAttributeArgumentResolver
- RequestAttributes - Interface in org.springframework.web.context.request
-
Abstraction for accessing attribute objects associated with a request.
- requestBody(RequestBody, ParameterErrors) - Method in interface org.springframework.web.method.annotation.HandlerMethodValidationException.Visitor
-
Handle results for
@RequestBody
method parameters. - RequestBody - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation indicating a method parameter should be bound to the body of the web request.
- RequestBodyArgumentResolver - Class in org.springframework.web.service.invoker
-
HttpServiceArgumentResolver
for@RequestBody
annotated arguments. - RequestBodyArgumentResolver(HttpExchangeAdapter) - Constructor for class org.springframework.web.service.invoker.RequestBodyArgumentResolver
-
Constructor with a
HttpExchangeAdapter
, for access to config settings. - RequestCallback - Interface in org.springframework.web.client
-
Callback interface for code that operates on a
ClientHttpRequest
. - requestCompleted() - Method in class org.springframework.web.context.request.AbstractRequestAttributes
-
Signal that the request has been completed.
- RequestContextFilter - Class in org.springframework.web.filter
-
Servlet Filter that exposes the request to the current thread, through both
LocaleContextHolder
andRequestContextHolder
. - RequestContextFilter() - Constructor for class org.springframework.web.filter.RequestContextFilter
- RequestContextHolder - Class in org.springframework.web.context.request
-
Holder class to expose the web request in the form of a thread-bound
RequestAttributes
object. - RequestContextHolder() - Constructor for class org.springframework.web.context.request.RequestContextHolder
- RequestContextListener - Class in org.springframework.web.context.request
-
Servlet listener that exposes the request to the current thread, through both
LocaleContextHolder
andRequestContextHolder
. - RequestContextListener() - Constructor for class org.springframework.web.context.request.RequestContextListener
- requestDestroyed(ServletRequestEvent) - Method in class org.springframework.web.context.request.RequestContextListener
- requestDestructionCallbacks - Variable in class org.springframework.web.context.request.AbstractRequestAttributes
-
Map from attribute name String to destruction callback Runnable.
- REQUESTED_RANGE_NOT_SATISFIABLE - Enum constant in enum class org.springframework.http.HttpStatus
-
416 Requested Range Not Satisfiable
. - RequestEntity<T> - Class in org.springframework.http
-
Extension of
HttpEntity
that also exposes the HTTP method and the target URL. - RequestEntity(HttpMethod, URI) - Constructor for class org.springframework.http.RequestEntity
-
Constructor with method and URL but without body nor headers.
- RequestEntity(MultiValueMap<String, String>, HttpMethod, URI) - Constructor for class org.springframework.http.RequestEntity
-
Constructor with method, URL and headers but without body.
- RequestEntity(T, HttpMethod, URI) - Constructor for class org.springframework.http.RequestEntity
-
Constructor with method, URL and body but without headers.
- RequestEntity(T, HttpMethod, URI, Type) - Constructor for class org.springframework.http.RequestEntity
-
Constructor with method, URL, body and type but without headers.
- RequestEntity(T, MultiValueMap<String, String>, HttpMethod, URI) - Constructor for class org.springframework.http.RequestEntity
-
Constructor with method, URL, headers and body.
- RequestEntity(T, MultiValueMap<String, String>, HttpMethod, URI, Type) - Constructor for class org.springframework.http.RequestEntity
-
Constructor with method, URL, headers, body and type.
- RequestEntity.BodyBuilder - Interface in org.springframework.http
-
Defines a builder that adds a body to the response entity.
- RequestEntity.HeadersBuilder<B extends RequestEntity.HeadersBuilder<B>> - Interface in org.springframework.http
-
Defines a builder that adds headers to the request entity.
- RequestEntity.UriTemplateRequestEntity<T> - Class in org.springframework.http
-
RequestEntity initialized with a URI template and variables instead of a
URI
. - requestFactory(ClientHttpRequestFactory) - Method in interface org.springframework.web.client.RestClient.Builder
-
Configure the
ClientHttpRequestFactory
to use. - RequestHandledEvent - Class in org.springframework.web.context.support
-
Event raised when a request is handled within an ApplicationContext.
- RequestHandledEvent(Object, String, String, long) - Constructor for class org.springframework.web.context.support.RequestHandledEvent
-
Create a new RequestHandledEvent with session information.
- RequestHandledEvent(Object, String, String, long, Throwable) - Constructor for class org.springframework.web.context.support.RequestHandledEvent
-
Create a new RequestHandledEvent with session information.
- requestHeader(RequestHeader, ParameterValidationResult) - Method in interface org.springframework.web.method.annotation.HandlerMethodValidationException.Visitor
-
Handle results for
@RequestHeader
method parameters. - RequestHeader - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation which indicates that a method parameter should be bound to a web request header.
- RequestHeaderArgumentResolver - Class in org.springframework.web.service.invoker
-
HttpServiceArgumentResolver
for@RequestHeader
annotated arguments. - RequestHeaderArgumentResolver(ConversionService) - Constructor for class org.springframework.web.service.invoker.RequestHeaderArgumentResolver
- RequestHeaderMapMethodArgumentResolver - Class in org.springframework.web.method.annotation
-
Resolves
Map
method arguments annotated with@RequestHeader
. - RequestHeaderMapMethodArgumentResolver() - Constructor for class org.springframework.web.method.annotation.RequestHeaderMapMethodArgumentResolver
- RequestHeaderMethodArgumentResolver - Class in org.springframework.web.method.annotation
-
Resolves method arguments annotated with
@RequestHeader
except forMap
arguments. - RequestHeaderMethodArgumentResolver(ConfigurableBeanFactory) - Constructor for class org.springframework.web.method.annotation.RequestHeaderMethodArgumentResolver
-
Create a new
RequestHeaderMethodArgumentResolver
instance. - requestInitialized(ServletRequestEvent) - Method in class org.springframework.web.context.request.RequestContextListener
- requestInitializer(ClientHttpRequestInitializer) - Method in interface org.springframework.web.client.RestClient.Builder
-
Add the given request initializer to the end of the initializer chain.
- requestInitializers(Consumer<List<ClientHttpRequestInitializer>>) - Method in interface org.springframework.web.client.RestClient.Builder
-
Manipulate the initializers with the given consumer.
- requestInterceptor(ClientHttpRequestInterceptor) - Method in interface org.springframework.web.client.RestClient.Builder
-
Add the given request interceptor to the end of the interceptor chain.
- requestInterceptors(Consumer<List<ClientHttpRequestInterceptor>>) - Method in interface org.springframework.web.client.RestClient.Builder
-
Manipulate the interceptors with the given consumer.
- RequestMapping - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation for mapping web requests onto methods in request-handling classes with flexible method signatures.
- RequestMethod - Enum Class in org.springframework.web.bind.annotation
-
Enumeration of HTTP request methods.
- requestParam(RequestParam, ParameterValidationResult) - Method in interface org.springframework.web.method.annotation.HandlerMethodValidationException.Visitor
-
Handle results for
@RequestParam
method parameters. - RequestParam - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation which indicates that a method parameter should be bound to a web request parameter.
- RequestParamArgumentResolver - Class in org.springframework.web.service.invoker
-
HttpServiceArgumentResolver
for@RequestParam
annotated arguments. - RequestParamArgumentResolver(ConversionService) - Constructor for class org.springframework.web.service.invoker.RequestParamArgumentResolver
- RequestParamMapMethodArgumentResolver - Class in org.springframework.web.method.annotation
-
Resolves
Map
method arguments annotated with an @RequestParam
where the annotation does not specify a request parameter name. - RequestParamMapMethodArgumentResolver() - Constructor for class org.springframework.web.method.annotation.RequestParamMapMethodArgumentResolver
- RequestParamMethodArgumentResolver - Class in org.springframework.web.method.annotation
-
Resolves method arguments annotated with @
RequestParam
, arguments of typeMultipartFile
in conjunction with Spring'sMultipartResolver
abstraction, and arguments of typejakarta.servlet.http.Part
in conjunction with Servlet multipart requests. - RequestParamMethodArgumentResolver(boolean) - Constructor for class org.springframework.web.method.annotation.RequestParamMethodArgumentResolver
-
Create a new
RequestParamMethodArgumentResolver
instance. - RequestParamMethodArgumentResolver(ConfigurableBeanFactory, boolean) - Constructor for class org.springframework.web.method.annotation.RequestParamMethodArgumentResolver
-
Create a new
RequestParamMethodArgumentResolver
instance. - requestPart(RequestPart, ParameterErrors) - Method in interface org.springframework.web.method.annotation.HandlerMethodValidationException.Visitor
-
Handle results for
@RequestPart
method parameters. - RequestPart - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation that can be used to associate the part of a "multipart/form-data" request with a method argument.
- RequestPartArgumentResolver - Class in org.springframework.web.service.invoker
-
HttpServiceArgumentResolver
for@RequestPart
annotated arguments. - RequestPartArgumentResolver(HttpExchangeAdapter) - Constructor for class org.springframework.web.service.invoker.RequestPartArgumentResolver
-
Constructor with a
HttpExchangeAdapter
, for access to config settings. - RequestPartServletServerHttpRequest - Class in org.springframework.web.multipart.support
-
ServerHttpRequest
implementation that accesses one part of a multipart request. - RequestPartServletServerHttpRequest(HttpServletRequest, String) - Constructor for class org.springframework.web.multipart.support.RequestPartServletServerHttpRequest
-
Create a new
RequestPartServletServerHttpRequest
instance. - RequestPath - Interface in org.springframework.http.server
-
Specialization of
PathContainer
that subdivides the path into aRequestPath.contextPath()
and the remainingRequestPath.pathWithinApplication()
. - RequestScope - Class in org.springframework.web.context.request
-
Request-backed
Scope
implementation. - RequestScope - Annotation Interface in org.springframework.web.context.annotation
-
@RequestScope
is a specialization of@Scope
for a component whose lifecycle is bound to the current web request. - RequestScope() - Constructor for class org.springframework.web.context.request.RequestScope
- requestToBodilessEntity(HttpRequestValues) - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
- requestToBodilessEntity(HttpRequestValues) - Method in interface org.springframework.web.service.invoker.HttpClientAdapter
-
Deprecated.Variant of
HttpClientAdapter.requestToVoid(HttpRequestValues)
with additional access to the response status and headers. - requestToBody(HttpRequestValues, ParameterizedTypeReference<T>) - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
- requestToBody(HttpRequestValues, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.service.invoker.HttpClientAdapter
-
Deprecated.Perform the given request and decode the response content to the given type.
- requestToBodyFlux(HttpRequestValues, ParameterizedTypeReference<T>) - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
- requestToBodyFlux(HttpRequestValues, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.service.invoker.HttpClientAdapter
-
Deprecated.Perform the given request and decode the response content to a stream with elements of the given type.
- requestToEntity(HttpRequestValues, ParameterizedTypeReference<T>) - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
- requestToEntity(HttpRequestValues, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.service.invoker.HttpClientAdapter
-
Deprecated.Variant of
HttpClientAdapter.requestToBody(HttpRequestValues, ParameterizedTypeReference)
with additional access to the response status and headers. - requestToEntityFlux(HttpRequestValues, ParameterizedTypeReference<T>) - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
- requestToEntityFlux(HttpRequestValues, ParameterizedTypeReference<T>) - Method in interface org.springframework.web.service.invoker.HttpClientAdapter
-
Deprecated.Variant of
HttpClientAdapter.requestToBodyFlux(HttpRequestValues, ParameterizedTypeReference)
with additional access to the response status and headers. - requestToHeaders(HttpRequestValues) - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
- requestToHeaders(HttpRequestValues) - Method in interface org.springframework.web.service.invoker.HttpClientAdapter
-
Deprecated.Perform the given request, release the response content, and return the response headers.
- requestToVoid(HttpRequestValues) - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
- requestToVoid(HttpRequestValues) - Method in interface org.springframework.web.service.invoker.HttpClientAdapter
-
Deprecated.Perform the given request, and release the response content, if any.
- requestUri(ClientRequestObservationContext) - Method in class org.springframework.http.client.observation.DefaultClientRequestObservationConvention
- required() - Element in annotation interface org.springframework.web.bind.annotation.CookieValue
-
Whether the cookie is required.
- required() - Element in annotation interface org.springframework.web.bind.annotation.MatrixVariable
-
Whether the matrix variable is required.
- required() - Element in annotation interface org.springframework.web.bind.annotation.PathVariable
-
Whether the path variable is required.
- required() - Element in annotation interface org.springframework.web.bind.annotation.RequestAttribute
-
Whether the request attribute is required.
- required() - Element in annotation interface org.springframework.web.bind.annotation.RequestBody
-
Whether body content is required.
- required() - Element in annotation interface org.springframework.web.bind.annotation.RequestHeader
-
Whether the header is required.
- required() - Element in annotation interface org.springframework.web.bind.annotation.RequestParam
-
Whether the parameter is required.
- required() - Element in annotation interface org.springframework.web.bind.annotation.RequestPart
-
Whether the part is required.
- required() - Element in annotation interface org.springframework.web.bind.annotation.SessionAttribute
-
Whether the session attribute is required.
- reset() - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- RESET_CONTENT - Enum constant in enum class org.springframework.http.HttpStatus
-
205 Reset Content
. - resetBuffer() - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- resetRequestAttributes() - Static method in class org.springframework.web.context.request.RequestContextHolder
-
Reset the RequestAttributes for the current thread.
- resolve(int) - Static method in enum class org.springframework.http.HttpStatus
-
Resolve the given status code to an
HttpStatus
, if possible. - resolve(int) - Static method in enum class org.springframework.http.HttpStatus.Series
-
Resolve the given status code to an
HttpStatus.Series
, if possible. - resolve(Object, MethodParameter, HttpRequestValues.Builder) - Method in class org.springframework.web.service.invoker.AbstractNamedValueArgumentResolver
- resolve(Object, MethodParameter, HttpRequestValues.Builder) - Method in class org.springframework.web.service.invoker.HttpMethodArgumentResolver
- resolve(Object, MethodParameter, HttpRequestValues.Builder) - Method in interface org.springframework.web.service.invoker.HttpServiceArgumentResolver
-
Resolve the argument value.
- resolve(Object, MethodParameter, HttpRequestValues.Builder) - Method in class org.springframework.web.service.invoker.RequestBodyArgumentResolver
- resolve(Object, MethodParameter, HttpRequestValues.Builder) - Method in class org.springframework.web.service.invoker.UriBuilderFactoryArgumentResolver
- resolve(Object, MethodParameter, HttpRequestValues.Builder) - Method in class org.springframework.web.service.invoker.UrlArgumentResolver
- resolve(String) - Static method in enum class org.springframework.web.bind.annotation.RequestMethod
-
Resolve the given method value to an
RequestMethod
enum value. - resolve(List<E>) - Static method in class org.springframework.web.util.BindErrorUtils
-
Shortcut for
BindErrorUtils.resolve(List, MessageSource, Locale)
with an emptyMessageSource
that simply formats the default message, or first error code, also prepending the field name for field errors. - resolve(List<E>, MessageSource, Locale) - Static method in class org.springframework.web.util.BindErrorUtils
-
Resolve all errors through the given
MessageSource
. - resolve(HttpMethod) - Static method in enum class org.springframework.web.bind.annotation.RequestMethod
-
Resolve the given
HttpMethod
to aRequestMethod
enum value. - resolveAndCacheLookupPath(HttpServletRequest) - Method in class org.springframework.web.util.UrlPathHelper
-
Resolve
the lookupPath and cache it in a request attribute with the keyUrlPathHelper.PATH_ATTRIBUTE
for subsequent access viaUrlPathHelper.getResolvedLookupPath(ServletRequest)
. - resolveAndJoin(CharSequence, CharSequence, CharSequence, List<? extends MessageSourceResolvable>, MessageSource, Locale) - Static method in class org.springframework.web.util.BindErrorUtils
-
Resolve all errors through the given
MessageSource
and join them. - resolveAndJoin(List<? extends MessageSourceResolvable>) - Static method in class org.springframework.web.util.BindErrorUtils
-
Shortcut for
BindErrorUtils.resolveAndJoin(List, MessageSource, Locale)
with an emptyMessageSource
that simply formats the default message, or first error code, also prepending the field name for field errors. - resolveAndJoin(List<? extends MessageSourceResolvable>, MessageSource, Locale) - Static method in class org.springframework.web.util.BindErrorUtils
-
Shortcut for
BindErrorUtils.resolveAndJoin(CharSequence, CharSequence, CharSequence, List, MessageSource, Locale)
with", and "
as delimiter, and an empty prefix and suffix. - resolveArgument(MethodParameter, NativeWebRequest) - Method in interface org.springframework.web.bind.support.WebArgumentResolver
-
Resolve an argument for the given handler method parameter within the given web request.
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.web.method.annotation.AbstractWebArgumentResolverAdapter
-
Delegate to the
WebArgumentResolver
instance. - resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.web.method.annotation.ErrorsMethodArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.web.method.annotation.MapMethodProcessor
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.web.method.annotation.ModelAttributeMethodProcessor
-
Resolve the argument from the model or if not found instantiate it with its default if it is available.
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.web.method.annotation.ModelMethodProcessor
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.web.method.annotation.RequestHeaderMapMethodArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.web.method.annotation.RequestParamMapMethodArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.web.method.annotation.SessionStatusMethodArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in interface org.springframework.web.method.support.HandlerMethodArgumentResolver
-
Resolves a method parameter into an argument value from a given request.
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.web.method.support.HandlerMethodArgumentResolverComposite
-
Iterate over registered
HandlerMethodArgumentResolvers
and invoke the one that supports it. - resolveBean() - Method in class org.springframework.web.method.ControllerAdviceBean
-
Get the bean instance for this
ControllerAdviceBean
, if necessary resolving the bean name through theBeanFactory
. - resolveContextualObject(String) - Method in class org.springframework.web.context.request.AbstractRequestAttributesScope
- resolveContextualObject(String) - Method in class org.springframework.web.context.support.ServletContextScope
- resolveErrorMessages(MessageSource, Locale) - Method in exception org.springframework.web.bind.MethodArgumentNotValidException
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of using
BindErrorUtils
andBindException.getAllErrors()
, to be removed in 6.2 - resolveErrorMessages(MessageSource, Locale) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of using
BindErrorUtils
andWebExchangeBindException.getAllErrors()
, to be removed in 6.2 - resolveFileExtensions(MediaType) - Method in class org.springframework.web.accept.ContentNegotiationManager
- resolveFileExtensions(MediaType) - Method in class org.springframework.web.accept.MappingMediaTypeFileExtensionResolver
- resolveFileExtensions(MediaType) - Method in interface org.springframework.web.accept.MediaTypeFileExtensionResolver
-
Resolve the given media type to a list of file extensions.
- resolveLocaleContext(ServerWebExchange) - Method in class org.springframework.web.server.i18n.AcceptHeaderLocaleContextResolver
- resolveLocaleContext(ServerWebExchange) - Method in class org.springframework.web.server.i18n.FixedLocaleContextResolver
- resolveLocaleContext(ServerWebExchange) - Method in interface org.springframework.web.server.i18n.LocaleContextResolver
-
Resolve the current locale context via the given exchange.
- resolveMediaTypeKey(NativeWebRequest, String) - Method in class org.springframework.web.accept.AbstractMappingContentNegotiationStrategy
-
An alternative to
AbstractMappingContentNegotiationStrategy.resolveMediaTypes(NativeWebRequest)
that accepts an already extracted key. - resolveMediaTypes(NativeWebRequest) - Method in class org.springframework.web.accept.AbstractMappingContentNegotiationStrategy
- resolveMediaTypes(NativeWebRequest) - Method in class org.springframework.web.accept.ContentNegotiationManager
- resolveMediaTypes(NativeWebRequest) - Method in interface org.springframework.web.accept.ContentNegotiationStrategy
-
Resolve the given request to a list of media types.
- resolveMediaTypes(NativeWebRequest) - Method in class org.springframework.web.accept.FixedContentNegotiationStrategy
- resolveMediaTypes(NativeWebRequest) - Method in class org.springframework.web.accept.HeaderContentNegotiationStrategy
-
Resolve the given request to a list of media types.
- resolveMessageCodes(String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- resolveMessageCodes(String, String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- resolveMethod(Exception) - Method in class org.springframework.web.method.annotation.ExceptionHandlerMethodResolver
-
Find a
Method
to handle the given exception. - resolveMethodByExceptionType(Class<? extends Throwable>) - Method in class org.springframework.web.method.annotation.ExceptionHandlerMethodResolver
-
Find a
Method
to handle the given exception type. - resolveMethodByThrowable(Throwable) - Method in class org.springframework.web.method.annotation.ExceptionHandlerMethodResolver
-
Find a
Method
to handle the given Throwable. - resolveMultipart(HttpServletRequest) - Method in interface org.springframework.web.multipart.MultipartResolver
-
Parse the given HTTP request into multipart files and parameters, and wrap the request inside a
MultipartHttpServletRequest
object that provides access to file descriptors and makes contained parameters accessible via the standard ServletRequest methods. - resolveMultipart(HttpServletRequest) - Method in class org.springframework.web.multipart.support.StandardServletMultipartResolver
- resolveMultipartArgument(String, MethodParameter, HttpServletRequest) - Static method in class org.springframework.web.multipart.support.MultipartResolutionDelegate
- resolveMultipartRequest(NativeWebRequest) - Static method in class org.springframework.web.multipart.support.MultipartResolutionDelegate
- resolveName(String, MethodParameter, NativeWebRequest) - Method in class org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver
-
Resolve the given parameter type and value name into an argument value.
- resolveName(String, MethodParameter, NativeWebRequest) - Method in class org.springframework.web.method.annotation.ExpressionValueMethodArgumentResolver
- resolveName(String, MethodParameter, NativeWebRequest) - Method in class org.springframework.web.method.annotation.RequestHeaderMethodArgumentResolver
- resolveName(String, MethodParameter, NativeWebRequest) - Method in class org.springframework.web.method.annotation.RequestParamMethodArgumentResolver
- resolveName(MethodParameter) - Method in class org.springframework.web.bind.support.BindParamNameResolver
- resolvePlaceholders(String, ServletContext) - Static method in class org.springframework.web.util.ServletContextPropertyUtils
-
Resolve ${...} placeholders in the given text, replacing them with corresponding servlet context init parameter or system property values.
- resolvePlaceholders(String, ServletContext, boolean) - Static method in class org.springframework.web.util.ServletContextPropertyUtils
-
Resolve ${...} placeholders in the given text, replacing them with corresponding servlet context init parameter or system property values.
- resolvePrefixValue(String, Class<?>, BiFunction<String, Class<?>, Object>) - Method in class org.springframework.web.bind.WebDataBinder
-
Check if a value can be resolved if
WebDataBinder.getFieldDefaultPrefix()
orWebDataBinder.getFieldMarkerPrefix()
is prepended. - resolveReference(String) - Method in class org.springframework.web.context.request.FacesRequestAttributes
- resolveReference(String) - Method in interface org.springframework.web.context.request.RequestAttributes
-
Resolve the contextual reference for the given key, if any.
- resolveReference(String) - Method in class org.springframework.web.context.request.ServletRequestAttributes
- resolverIdGeneratorInstance(MapperConfig<?>, Annotated, Class<?>) - Method in class org.springframework.http.converter.json.SpringHandlerInstantiator
- resolveSessionIds(ServerWebExchange) - Method in class org.springframework.web.server.session.CookieWebSessionIdResolver
- resolveSessionIds(ServerWebExchange) - Method in class org.springframework.web.server.session.HeaderWebSessionIdResolver
- resolveSessionIds(ServerWebExchange) - Method in interface org.springframework.web.server.session.WebSessionIdResolver
-
Resolve the session IDs associated with the request.
- resolveValue(String, Class<?>) - Method in class org.springframework.web.bind.ServletRequestDataBinder.ServletRequestValueResolver
- ResourceAccessException - Exception in org.springframework.web.client
-
Exception thrown when an I/O error occurs.
- ResourceAccessException(String) - Constructor for exception org.springframework.web.client.ResourceAccessException
-
Construct a new
ResourceAccessException
with the given message. - ResourceAccessException(String, IOException) - Constructor for exception org.springframework.web.client.ResourceAccessException
-
Construct a new
ResourceAccessException
with the given message andIOException
. - ResourceHttpMessageConverter - Class in org.springframework.http.converter
-
Implementation of
HttpMessageConverter
that can read/writeResources
and supports byte range requests. - ResourceHttpMessageConverter() - Constructor for class org.springframework.http.converter.ResourceHttpMessageConverter
-
Create a new instance of the
ResourceHttpMessageConverter
that supports read streaming, i.e. - ResourceHttpMessageConverter(boolean) - Constructor for class org.springframework.http.converter.ResourceHttpMessageConverter
-
Create a new instance of the
ResourceHttpMessageConverter
. - ResourceHttpMessageReader - Class in org.springframework.http.codec
-
HttpMessageReader
that wraps and delegates to aResourceDecoder
that extracts the filename from the"Content-Disposition"
header, if available, and passes it as theResourceDecoder.FILENAME_HINT
. - ResourceHttpMessageReader() - Constructor for class org.springframework.http.codec.ResourceHttpMessageReader
- ResourceHttpMessageReader(ResourceDecoder) - Constructor for class org.springframework.http.codec.ResourceHttpMessageReader
- ResourceHttpMessageWriter - Class in org.springframework.http.codec
-
HttpMessageWriter
that can write aResource
. - ResourceHttpMessageWriter() - Constructor for class org.springframework.http.codec.ResourceHttpMessageWriter
- ResourceHttpMessageWriter(int) - Constructor for class org.springframework.http.codec.ResourceHttpMessageWriter
- ResourceRegionHttpMessageConverter - Class in org.springframework.http.converter
-
Implementation of
HttpMessageConverter
that can write a singleResourceRegion
or Collections ofResourceRegions
. - ResourceRegionHttpMessageConverter() - Constructor for class org.springframework.http.converter.ResourceRegionHttpMessageConverter
- response(ServerHttpResponse) - Method in interface org.springframework.web.server.ServerWebExchange.Builder
-
Set the response to use.
- RESPONSE_ENCODED_HTML_ESCAPE_CONTEXT_PARAM - Static variable in class org.springframework.web.util.WebUtils
-
Use of response encoding for HTML escaping parameter at the servlet context level (i.e.
- RESPONSE_HANDLED - Static variable in interface org.springframework.web.context.request.async.CallableProcessingInterceptor
-
Constant indicating that the response has been handled by this interceptor without a result and that no further interceptors are to be invoked.
- ResponseBody - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation that indicates a method return value should be bound to the web response body.
- ResponseCookie - Class in org.springframework.http
-
An
HttpCookie
subclass with the additional attributes allowed in the "Set-Cookie" response header. - ResponseCookie.ResponseCookieBuilder - Interface in org.springframework.http
-
A builder for a server-defined HttpCookie with attributes.
- ResponseEntity<T> - Class in org.springframework.http
-
Extension of
HttpEntity
that adds anHttpStatusCode
status code. - ResponseEntity(HttpStatusCode) - Constructor for class org.springframework.http.ResponseEntity
-
Create a
ResponseEntity
with a status code only. - ResponseEntity(MultiValueMap<String, String>, HttpStatusCode) - Constructor for class org.springframework.http.ResponseEntity
-
Create a
ResponseEntity
with headers and a status code. - ResponseEntity(T, HttpStatusCode) - Constructor for class org.springframework.http.ResponseEntity
-
Create a
ResponseEntity
with a body and status code. - ResponseEntity(T, MultiValueMap<String, String>, int) - Constructor for class org.springframework.http.ResponseEntity
-
Create a
ResponseEntity
with a body, headers, and a raw status code. - ResponseEntity(T, MultiValueMap<String, String>, HttpStatusCode) - Constructor for class org.springframework.http.ResponseEntity
-
Create a
ResponseEntity
with a body, headers, and a status code. - ResponseEntity.BodyBuilder - Interface in org.springframework.http
-
Defines a builder that adds a body to the response entity.
- ResponseEntity.HeadersBuilder<B extends ResponseEntity.HeadersBuilder<B>> - Interface in org.springframework.http
-
Defines a builder that adds headers to the response entity.
- responseEntityExtractor(Type) - Method in class org.springframework.web.client.RestTemplate
-
Return a
ResponseExtractor
that prepares aResponseEntity
. - ResponseErrorHandler - Interface in org.springframework.web.client
-
Strategy interface used by the
RestTemplate
to determine whether a particular response has an error or not. - ResponseExtractor<T> - Interface in org.springframework.web.client
-
Generic callback interface used by
RestTemplate
's retrieval methods. - ResponseStatus - Annotation Interface in org.springframework.web.bind.annotation
-
Marks a method or exception class with the status
ResponseStatus.code()
andResponseStatus.reason()
that should be returned. - ResponseStatusException - Exception in org.springframework.web.server
-
Subclass of
ErrorResponseException
that accepts a "reason", and by default maps that to the"detail"
of theProblemDetail
. - ResponseStatusException(int, String, Throwable) - Constructor for exception org.springframework.web.server.ResponseStatusException
-
Constructor with a response status and a reason to add to the exception message as explanation, as well as a nested exception.
- ResponseStatusException(HttpStatusCode) - Constructor for exception org.springframework.web.server.ResponseStatusException
-
Constructor with a response status.
- ResponseStatusException(HttpStatusCode, String) - Constructor for exception org.springframework.web.server.ResponseStatusException
-
Constructor with a response status and a reason to add to the exception message as explanation.
- ResponseStatusException(HttpStatusCode, String, Throwable) - Constructor for exception org.springframework.web.server.ResponseStatusException
-
Constructor with a response status and a reason to add to the exception message as explanation, as well as a nested exception.
- ResponseStatusException(HttpStatusCode, String, Throwable, String, Object[]) - Constructor for exception org.springframework.web.server.ResponseStatusException
-
Constructor with a message code and arguments for resolving the error "detail" via
MessageSource
. - ResponseStatusExceptionHandler - Class in org.springframework.web.server.handler
-
Handle
ResponseStatusException
by setting the response status. - ResponseStatusExceptionHandler() - Constructor for class org.springframework.web.server.handler.ResponseStatusExceptionHandler
- RestClient - Interface in org.springframework.web.client
-
Client to perform HTTP requests, exposing a fluent, synchronous API over underlying HTTP client libraries such as the JDK
HttpClient
, Apache HttpComponents, and others. - RestClient.Builder - Interface in org.springframework.web.client
-
A mutable builder for creating a
RestClient
. - RestClient.RequestBodySpec - Interface in org.springframework.web.client
-
Contract for specifying request headers and body leading up to the exchange.
- RestClient.RequestBodyUriSpec - Interface in org.springframework.web.client
-
Contract for specifying request headers, body and URI for a request.
- RestClient.RequestHeadersSpec<S extends RestClient.RequestHeadersSpec<S>> - Interface in org.springframework.web.client
-
Contract for specifying request headers leading up to the exchange.
- RestClient.RequestHeadersSpec.ConvertibleClientHttpResponse - Interface in org.springframework.web.client
-
Extension of
ClientHttpResponse
that can convert the body. - RestClient.RequestHeadersSpec.ExchangeFunction<T> - Interface in org.springframework.web.client
-
Defines the contract for
RestClient.RequestHeadersSpec.exchange(ExchangeFunction)
. - RestClient.RequestHeadersUriSpec<S extends RestClient.RequestHeadersSpec<S>> - Interface in org.springframework.web.client
-
Contract for specifying request headers and URI for a request.
- RestClient.ResponseSpec - Interface in org.springframework.web.client
-
Contract for specifying response operations following the exchange.
- RestClient.ResponseSpec.ErrorHandler - Interface in org.springframework.web.client
- RestClient.UriSpec<S extends RestClient.RequestHeadersSpec<?>> - Interface in org.springframework.web.client
-
Contract for specifying the URI for a request.
- RestClientAdapter - Class in org.springframework.web.client.support
-
HttpExchangeAdapter
that enables anHttpServiceProxyFactory
to useRestClient
for request execution. - RestClientException - Exception in org.springframework.web.client
-
Base class for exceptions thrown by
RestTemplate
in case a request fails because of a server error response, as determined viaResponseErrorHandler.hasError(ClientHttpResponse)
, failure to decode the response, or a low level I/O error. - RestClientException(String) - Constructor for exception org.springframework.web.client.RestClientException
-
Construct a new instance of
RestClientException
with the given message. - RestClientException(String, Throwable) - Constructor for exception org.springframework.web.client.RestClientException
-
Construct a new instance of
RestClientException
with the given message and exception. - RestClientResponseException - Exception in org.springframework.web.client
-
Common base class for exceptions that contain actual HTTP response data.
- RestClientResponseException(String, int, String, HttpHeaders, byte[], Charset) - Constructor for exception org.springframework.web.client.RestClientResponseException
-
Construct a new instance of with the given response data.
- RestClientResponseException(String, HttpStatusCode, String, HttpHeaders, byte[], Charset) - Constructor for exception org.springframework.web.client.RestClientResponseException
-
Construct a new instance of with the given response data.
- RestController - Annotation Interface in org.springframework.web.bind.annotation
-
A convenience annotation that is itself annotated with
@Controller
and@ResponseBody
. - RestControllerAdvice - Annotation Interface in org.springframework.web.bind.annotation
-
A convenience annotation that is itself annotated with
@ControllerAdvice
and@ResponseBody
. - RestGatewaySupport - Class in org.springframework.web.client.support
-
Convenient superclass for application classes that need REST access.
- RestGatewaySupport() - Constructor for class org.springframework.web.client.support.RestGatewaySupport
-
Construct a new instance of the
RestGatewaySupport
, with default parameters. - RestGatewaySupport(ClientHttpRequestFactory) - Constructor for class org.springframework.web.client.support.RestGatewaySupport
-
Construct a new instance of the
RestGatewaySupport
, with the givenClientHttpRequestFactory
. - RestOperations - Interface in org.springframework.web.client
-
Interface specifying a basic set of RESTful operations.
- RestTemplate - Class in org.springframework.web.client
-
Synchronous client to perform HTTP requests, exposing a simple, template method API over underlying HTTP client libraries such as the JDK
HttpURLConnection
, Apache HttpComponents, and others. - RestTemplate() - Constructor for class org.springframework.web.client.RestTemplate
-
Create a new instance of the
RestTemplate
using default settings. - RestTemplate(List<HttpMessageConverter<?>>) - Constructor for class org.springframework.web.client.RestTemplate
-
Create a new instance of the
RestTemplate
using the given list ofHttpMessageConverter
to use. - RestTemplate(ClientHttpRequestFactory) - Constructor for class org.springframework.web.client.RestTemplate
-
Create a new instance of the
RestTemplate
based on the givenClientHttpRequestFactory
. - RestTemplateAdapter - Class in org.springframework.web.client.support
-
HttpExchangeAdapter
that enables anHttpServiceProxyFactory
to useRestTemplate
for request execution. - RESULT_NONE - Static variable in interface org.springframework.web.context.request.async.CallableProcessingInterceptor
-
Constant indicating that no result has been determined by this interceptor, giving subsequent interceptors a chance.
- retrieve() - Method in interface org.springframework.web.client.RestClient.RequestHeadersSpec
-
Proceed to declare how to extract the response.
- retrieveAttribute(WebRequest, String) - Method in class org.springframework.web.bind.support.DefaultSessionAttributeStore
- retrieveAttribute(WebRequest, String) - Method in interface org.springframework.web.bind.support.SessionAttributeStore
-
Retrieve the specified attribute from the backend session.
- retrieveAttributes(WebRequest) - Method in class org.springframework.web.method.annotation.SessionAttributesHandler
-
Retrieve "known" attributes from the session, i.e.
- retrieveSession(String) - Method in class org.springframework.web.server.session.InMemoryWebSessionStore
- retrieveSession(String) - Method in interface org.springframework.web.server.session.WebSessionStore
-
Return the WebSession for the given id.
- retry() - Method in class org.springframework.http.codec.ServerSentEvent
-
Return the
retry
field of this event, if available. - retry(Duration) - Method in interface org.springframework.http.codec.ServerSentEvent.Builder
-
Set the value of the
retry
field. - RETRY_AFTER - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Retry-After
header field name. - RFC_7807_NAMESPACE - Static variable in interface org.springframework.http.converter.json.ProblemDetailJacksonXmlMixin
-
RFC 7807 namespace.
- ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE - Static variable in interface org.springframework.web.context.WebApplicationContext
-
Context attribute to bind root WebApplicationContext to on successful startup.
- rsReadLogger - Static variable in class org.springframework.http.server.reactive.AbstractListenerReadPublisher
-
Special logger for debugging Reactive Streams signals.
- RssChannelHttpMessageConverter - Class in org.springframework.http.converter.feed
-
Implementation of
HttpMessageConverter
that can read and write RSS feeds. - RssChannelHttpMessageConverter() - Constructor for class org.springframework.http.converter.feed.RssChannelHttpMessageConverter
- rsWriteFlushLogger - Static variable in class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
-
Special logger for debugging Reactive Streams signals.
- rsWriteLogger - Static variable in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
-
Special logger for debugging Reactive Streams signals.
S
- sameSite(String) - Method in interface org.springframework.http.ResponseCookie.ResponseCookieBuilder
-
Add the "SameSite" attribute to the cookie.
- save() - Method in interface org.springframework.web.server.WebSession
-
Save the session through the
WebSessionStore
as follows: If the session is new (i.e. - scan(String...) - Method in class org.springframework.web.context.support.AnnotationConfigWebApplicationContext
-
Perform a scan within the specified base packages.
- scanUnsafe(Scannable.Attr) - Method in class org.springframework.http.server.reactive.ChannelSendOperator
- scheme(String) - Method in interface org.springframework.web.util.UriBuilder
-
Set the URI scheme which may contain URI template variables, and may also be
null
to clear the scheme of this builder. - scheme(String) - Method in class org.springframework.web.util.UriComponentsBuilder
- schemeSpecificPart(String) - Method in class org.springframework.web.util.UriComponentsBuilder
-
Set the URI scheme-specific-part.
- SCOPE_APPLICATION - Static variable in interface org.springframework.web.context.WebApplicationContext
-
Scope identifier for the global web application scope: "application".
- SCOPE_APPLICATION - Static variable in class org.springframework.web.util.TagUtils
-
Constant identifying the application scope.
- SCOPE_PAGE - Static variable in class org.springframework.web.util.TagUtils
-
Constant identifying the page scope.
- SCOPE_REQUEST - Static variable in interface org.springframework.web.context.request.RequestAttributes
-
Constant that indicates request scope.
- SCOPE_REQUEST - Static variable in interface org.springframework.web.context.WebApplicationContext
-
Scope identifier for request scope: "request".
- SCOPE_REQUEST - Static variable in class org.springframework.web.util.TagUtils
-
Constant identifying the request scope.
- SCOPE_SESSION - Static variable in interface org.springframework.web.context.request.RequestAttributes
-
Constant that indicates session scope.
- SCOPE_SESSION - Static variable in interface org.springframework.web.context.WebApplicationContext
-
Scope identifier for session scope: "session".
- SCOPE_SESSION - Static variable in class org.springframework.web.util.TagUtils
-
Constant identifying the session scope.
- secure(boolean) - Method in interface org.springframework.http.ResponseCookie.ResponseCookieBuilder
-
Add the "Secure" attribute to the cookie.
- SEE_OTHER - Enum constant in enum class org.springframework.http.HttpStatus
-
303 See Other
. - selectObjectMapper(ResolvableType, MimeType) - Method in class org.springframework.http.codec.json.Jackson2CodecSupport
-
Select an ObjectMapper to use, either the main ObjectMapper or another if the handling for the given Class has been customized through
Jackson2CodecSupport.registerObjectMappersForType(Class, Consumer)
. - sendError(int) - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- sendError(int, String) - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- sendRedirect(String) - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- separator() - Method in class org.springframework.http.server.PathContainer.Options
- serializationInclusion(JsonInclude.Include) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Set a custom inclusion strategy for serialization.
- serializationInclusion(JsonInclude.Value) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Set a custom inclusion strategy for serialization.
- serializeForm(MultiValueMap<String, Object>, Charset) - Method in class org.springframework.http.converter.FormHttpMessageConverter
- serializeForm(MultiValueMap<String, String>, Charset) - Method in class org.springframework.http.codec.FormHttpMessageWriter
- serializer(ResolvableType) - Method in class org.springframework.http.codec.KotlinSerializationSupport
-
Returns the serializer that can (de)serialize instances of the given type.
- serializerByType(Class<?>, JsonSerializer<?>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Configure a custom serializer for the given type.
- serializerInstance(SerializationConfig, Annotated, Class<?>) - Method in class org.springframework.http.converter.json.SpringHandlerInstantiator
- serializers(JsonSerializer<?>...) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Configure custom serializers.
- serializersByType(Map<Class<?>, JsonSerializer<?>>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Configure custom serializers for the given types.
- series() - Method in enum class org.springframework.http.HttpStatus
-
Return the HTTP status series of this status code.
- SERVER - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Server
header field name. - SERVER_CODEC_CONFIGURER_BEAN_NAME - Static variable in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Well-known name for the ServerCodecConfigurer in the bean factory.
- SERVER_ERROR - Enum constant in enum class org.springframework.http.HttpStatus.Series
- ServerCodecConfigurer - Interface in org.springframework.http.codec
-
Extension of
CodecConfigurer
for HTTP message reader and writer options relevant on the server side. - ServerCodecConfigurer.ServerDefaultCodecs - Interface in org.springframework.http.codec
-
CodecConfigurer.DefaultCodecs
extension with extra server-side options. - ServerErrorException - Exception in org.springframework.web.server
-
Exception for an
HttpStatus.INTERNAL_SERVER_ERROR
that exposes extra information about a controller method that failed, or a controller method argument that could not be resolved. - ServerErrorException(String, Method, Throwable) - Constructor for exception org.springframework.web.server.ServerErrorException
-
Constructor for a 500 error with a handler
Method
and an optional cause. - ServerErrorException(String, Throwable) - Constructor for exception org.springframework.web.server.ServerErrorException
-
Constructor for a 500 error with a reason and an optional cause.
- ServerErrorException(String, MethodParameter, Throwable) - Constructor for exception org.springframework.web.server.ServerErrorException
-
Constructor for a 500 error with a
MethodParameter
and an optional cause. - ServerHttpAsyncRequestControl - Interface in org.springframework.http.server
-
A control that can put the processing of an HTTP request in asynchronous mode during which the response remains open until explicitly closed.
- ServerHttpObservationDocumentation - Enum Class in org.springframework.http.server.observation
-
Documented
KeyValues
for the HTTP server observations for Servlet-based web applications. - ServerHttpObservationDocumentation - Enum Class in org.springframework.http.server.reactive.observation
-
Documented
KeyValues
for the HTTP server observations for reactive web applications. - ServerHttpObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.http.server.observation
- ServerHttpObservationDocumentation.HighCardinalityKeyNames - Enum Class in org.springframework.http.server.reactive.observation
- ServerHttpObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.http.server.observation
- ServerHttpObservationDocumentation.LowCardinalityKeyNames - Enum Class in org.springframework.http.server.reactive.observation
- ServerHttpObservationFilter - Class in org.springframework.web.filter.reactive
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.1 in favor of
WebHttpHandlerBuilder
. - ServerHttpObservationFilter - Class in org.springframework.web.filter
-
Filter
that createsobservations
for HTTP exchanges. - ServerHttpObservationFilter(ObservationRegistry) - Constructor for class org.springframework.web.filter.reactive.ServerHttpObservationFilter
-
Deprecated.Create an
HttpRequestsObservationWebFilter
that records observations against the givenObservationRegistry
. - ServerHttpObservationFilter(ObservationRegistry) - Constructor for class org.springframework.web.filter.ServerHttpObservationFilter
-
Create an
HttpRequestsObservationFilter
that records observations against the givenObservationRegistry
. - ServerHttpObservationFilter(ObservationRegistry, ServerRequestObservationConvention) - Constructor for class org.springframework.web.filter.ServerHttpObservationFilter
-
Create an
HttpRequestsObservationFilter
that records observations against the givenObservationRegistry
with a custom convention. - ServerHttpObservationFilter(ObservationRegistry, ServerRequestObservationConvention) - Constructor for class org.springframework.web.filter.reactive.ServerHttpObservationFilter
-
Deprecated.Create an
HttpRequestsObservationWebFilter
that records observations against the givenObservationRegistry
with a custom convention. - ServerHttpRequest - Interface in org.springframework.http.server.reactive
-
Represents a reactive server-side HTTP request.
- ServerHttpRequest - Interface in org.springframework.http.server
-
Represents a server-side HTTP request.
- ServerHttpRequest.Builder - Interface in org.springframework.http.server.reactive
-
Builder for mutating an existing
ServerHttpRequest
. - ServerHttpRequestDecorator - Class in org.springframework.http.server.reactive
-
Wraps another
ServerHttpRequest
and delegates all methods to it. - ServerHttpRequestDecorator(ServerHttpRequest) - Constructor for class org.springframework.http.server.reactive.ServerHttpRequestDecorator
- ServerHttpResponse - Interface in org.springframework.http.server.reactive
-
Represents a reactive server-side HTTP response.
- ServerHttpResponse - Interface in org.springframework.http.server
-
Represents a server-side HTTP response.
- ServerHttpResponseDecorator - Class in org.springframework.http.server.reactive
-
Wraps another
ServerHttpResponse
and delegates all methods to it. - ServerHttpResponseDecorator(ServerHttpResponse) - Constructor for class org.springframework.http.server.reactive.ServerHttpResponseDecorator
- ServerRequestObservationContext - Class in org.springframework.http.server.observation
-
Context that holds information for metadata collection regarding
Servlet HTTP requests
observations. - ServerRequestObservationContext - Class in org.springframework.http.server.reactive.observation
-
Context that holds information for metadata collection regarding
reactive HTTP requests
observations. - ServerRequestObservationContext(HttpServletRequest, HttpServletResponse) - Constructor for class org.springframework.http.server.observation.ServerRequestObservationContext
- ServerRequestObservationContext(ServerHttpRequest, ServerHttpResponse, Map<String, Object>) - Constructor for class org.springframework.http.server.reactive.observation.ServerRequestObservationContext
-
Create a new
ServerRequestObservationContext
instance. - ServerRequestObservationConvention - Interface in org.springframework.http.server.observation
-
Interface for an
ObservationConvention
forServlet HTTP requests
. - ServerRequestObservationConvention - Interface in org.springframework.http.server.reactive.observation
-
Interface for an
ObservationConvention
forreactive HTTP requests
. - ServerSentEvent<T> - Class in org.springframework.http.codec
-
Representation for a Server-Sent Event for use with Spring's reactive Web support.
- ServerSentEvent.Builder<T> - Interface in org.springframework.http.codec
-
A mutable builder for a
SseEvent
. - serverSentEventDecoder(Decoder<?>) - Method in interface org.springframework.http.codec.ClientCodecConfigurer.ClientDefaultCodecs
-
Configure the
Decoder
to use for Server-Sent Events. - serverSentEventEncoder(Encoder<?>) - Method in interface org.springframework.http.codec.ServerCodecConfigurer.ServerDefaultCodecs
-
Configure the
Encoder
to use for Server-Sent Events. - ServerSentEventHttpMessageReader - Class in org.springframework.http.codec
-
Reader that supports a stream of
ServerSentEvents
and also plainObjects
which is the same as anServerSentEvent
with data only. - ServerSentEventHttpMessageReader() - Constructor for class org.springframework.http.codec.ServerSentEventHttpMessageReader
-
Constructor without a
Decoder
. - ServerSentEventHttpMessageReader(Decoder<?>) - Constructor for class org.springframework.http.codec.ServerSentEventHttpMessageReader
-
Constructor with JSON
Decoder
for decoding to Objects. - ServerSentEventHttpMessageWriter - Class in org.springframework.http.codec
-
HttpMessageWriter
for"text/event-stream"
responses. - ServerSentEventHttpMessageWriter() - Constructor for class org.springframework.http.codec.ServerSentEventHttpMessageWriter
-
Constructor without an
Encoder
. - ServerSentEventHttpMessageWriter(Encoder<?>) - Constructor for class org.springframework.http.codec.ServerSentEventHttpMessageWriter
-
Constructor with JSON
Encoder
for encoding objects. - ServerWebExchange - Interface in org.springframework.web.server
-
Contract for an HTTP request-response interaction.
- ServerWebExchange.Builder - Interface in org.springframework.web.server
-
Builder for mutating an existing
ServerWebExchange
. - ServerWebExchangeContextFilter - Class in org.springframework.web.filter.reactive
-
Inserts an attribute in the Reactor
Context
that makes the currentServerWebExchange
available under the attribute nameServerWebExchangeContextFilter.EXCHANGE_CONTEXT_ATTRIBUTE
. - ServerWebExchangeContextFilter() - Constructor for class org.springframework.web.filter.reactive.ServerWebExchangeContextFilter
- ServerWebExchangeDecorator - Class in org.springframework.web.server
-
A convenient base class for classes that need to wrap another
ServerWebExchange
. - ServerWebExchangeDecorator(ServerWebExchange) - Constructor for class org.springframework.web.server.ServerWebExchangeDecorator
- ServerWebInputException - Exception in org.springframework.web.server
-
Exception for errors that fit response status 400 (bad request) for use in Spring Web applications.
- ServerWebInputException(String) - Constructor for exception org.springframework.web.server.ServerWebInputException
-
Constructor with an explanation only.
- ServerWebInputException(String, MethodParameter) - Constructor for exception org.springframework.web.server.ServerWebInputException
-
Constructor for a 400 error linked to a specific
MethodParameter
. - ServerWebInputException(String, MethodParameter, Throwable) - Constructor for exception org.springframework.web.server.ServerWebInputException
-
Constructor for a 400 error with a root cause.
- ServerWebInputException(String, MethodParameter, Throwable, String, Object[]) - Constructor for exception org.springframework.web.server.ServerWebInputException
-
Constructor with a message code and arguments for resolving the error "detail" via
MessageSource
. - service(HttpServletRequest, HttpServletResponse) - Method in class org.springframework.web.context.support.HttpRequestHandlerServlet
- service(ServletRequest, ServletResponse) - Method in class org.springframework.http.server.reactive.ServletHttpHandlerAdapter
- SERVICE_UNAVAILABLE - Enum constant in enum class org.springframework.http.HttpStatus
-
503 Service Unavailable
. - SERVLET_CONFIG_BEAN_NAME - Static variable in interface org.springframework.web.context.ConfigurableWebApplicationContext
-
Name of the ServletConfig environment bean in the factory.
- SERVLET_CONFIG_PROPERTY_SOURCE_NAME - Static variable in class org.springframework.web.context.support.StandardServletEnvironment
-
Servlet config init parameters property source name: "servletConfigInitParams".
- SERVLET_CONTEXT_BEAN_NAME - Static variable in interface org.springframework.web.context.WebApplicationContext
-
Name of the ServletContext environment bean in the factory.
- SERVLET_CONTEXT_PROPERTY_SOURCE_NAME - Static variable in class org.springframework.web.context.support.StandardServletEnvironment
-
Servlet context init parameters property source name: "servletContextInitParams".
- ServletConfigAware - Interface in org.springframework.web.context
-
Interface to be implemented by any object that wishes to be notified of the
ServletConfig
(typically determined by theWebApplicationContext
) that it runs in. - ServletConfigPropertySource - Class in org.springframework.web.context.support
-
PropertySource
that reads init parameters from aServletConfig
object. - ServletConfigPropertySource(String, ServletConfig) - Constructor for class org.springframework.web.context.support.ServletConfigPropertySource
- ServletContextAttributeExporter - Class in org.springframework.web.context.support
-
Exporter that takes Spring-defined objects and exposes them as ServletContext attributes.
- ServletContextAttributeExporter() - Constructor for class org.springframework.web.context.support.ServletContextAttributeExporter
- ServletContextAttributeFactoryBean - Class in org.springframework.web.context.support
-
FactoryBean
that fetches a specific, existing ServletContext attribute. - ServletContextAttributeFactoryBean() - Constructor for class org.springframework.web.context.support.ServletContextAttributeFactoryBean
- ServletContextAware - Interface in org.springframework.web.context
-
Interface to be implemented by any object that wishes to be notified of the
ServletContext
(typically determined by theWebApplicationContext
) that it runs in. - ServletContextAwareProcessor - Class in org.springframework.web.context.support
-
BeanPostProcessor
implementation that passes the ServletContext to beans that implement theServletContextAware
interface. - ServletContextAwareProcessor() - Constructor for class org.springframework.web.context.support.ServletContextAwareProcessor
-
Create a new ServletContextAwareProcessor without an initial context or config.
- ServletContextAwareProcessor(ServletConfig) - Constructor for class org.springframework.web.context.support.ServletContextAwareProcessor
-
Create a new ServletContextAwareProcessor for the given config.
- ServletContextAwareProcessor(ServletContext) - Constructor for class org.springframework.web.context.support.ServletContextAwareProcessor
-
Create a new ServletContextAwareProcessor for the given context.
- ServletContextAwareProcessor(ServletContext, ServletConfig) - Constructor for class org.springframework.web.context.support.ServletContextAwareProcessor
-
Create a new ServletContextAwareProcessor for the given context and config.
- ServletContextParameterFactoryBean - Class in org.springframework.web.context.support
-
FactoryBean
that retrieves a specific ServletContext init parameter (that is, a "context-param" defined inweb.xml
). - ServletContextParameterFactoryBean() - Constructor for class org.springframework.web.context.support.ServletContextParameterFactoryBean
- ServletContextPropertySource - Class in org.springframework.web.context.support
-
PropertySource
that reads init parameters from aServletContext
object. - ServletContextPropertySource(String, ServletContext) - Constructor for class org.springframework.web.context.support.ServletContextPropertySource
- ServletContextPropertyUtils - Class in org.springframework.web.util
-
Helper class for resolving placeholders in texts.
- ServletContextPropertyUtils() - Constructor for class org.springframework.web.util.ServletContextPropertyUtils
- ServletContextRequestLoggingFilter - Class in org.springframework.web.filter
-
Simple request logging filter that writes the request URI (and optionally the query string) to the ServletContext log.
- ServletContextRequestLoggingFilter() - Constructor for class org.springframework.web.filter.ServletContextRequestLoggingFilter
- ServletContextResource - Class in org.springframework.web.context.support
-
Resource
implementation forServletContext
resources, interpreting relative paths within the web application root directory. - ServletContextResource(ServletContext, String) - Constructor for class org.springframework.web.context.support.ServletContextResource
-
Create a new
ServletContextResource
for the given path. - ServletContextResourceLoader - Class in org.springframework.web.context.support
-
ResourceLoader implementation that resolves paths as ServletContext resources, for use outside a WebApplicationContext (for example, in an HttpServletBean or GenericFilterBean subclass).
- ServletContextResourceLoader(ServletContext) - Constructor for class org.springframework.web.context.support.ServletContextResourceLoader
-
Create a new ServletContextResourceLoader.
- ServletContextResourcePatternResolver - Class in org.springframework.web.context.support
-
ServletContext-aware subclass of
PathMatchingResourcePatternResolver
, able to find matching resources below the web application root directory viaServletContext.getResourcePaths(java.lang.String)
. - ServletContextResourcePatternResolver(ServletContext) - Constructor for class org.springframework.web.context.support.ServletContextResourcePatternResolver
-
Create a new ServletContextResourcePatternResolver.
- ServletContextResourcePatternResolver(ResourceLoader) - Constructor for class org.springframework.web.context.support.ServletContextResourcePatternResolver
-
Create a new ServletContextResourcePatternResolver.
- ServletContextScope - Class in org.springframework.web.context.support
-
Scope
wrapper for a ServletContext, i.e. - ServletContextScope(ServletContext) - Constructor for class org.springframework.web.context.support.ServletContextScope
-
Create a new Scope wrapper for the given ServletContext.
- ServletHttpHandlerAdapter - Class in org.springframework.http.server.reactive
-
Adapt
HttpHandler
to anHttpServlet
using Servlet Async support and Servlet non-blocking I/O. - ServletHttpHandlerAdapter(HttpHandler) - Constructor for class org.springframework.http.server.reactive.ServletHttpHandlerAdapter
- ServletPathExtensionContentNegotiationStrategy - Class in org.springframework.web.accept
-
Deprecated.as of 5.2.4. See class-level note in
ContentNegotiationManagerFactoryBean
on the deprecation of path extension config options. - ServletPathExtensionContentNegotiationStrategy(ServletContext) - Constructor for class org.springframework.web.accept.ServletPathExtensionContentNegotiationStrategy
-
Deprecated.Create an instance without any mappings to start with.
- ServletPathExtensionContentNegotiationStrategy(ServletContext, Map<String, MediaType>) - Constructor for class org.springframework.web.accept.ServletPathExtensionContentNegotiationStrategy
-
Deprecated.Create an instance with the given extension-to-MediaType lookup.
- ServletRequestAttributes - Class in org.springframework.web.context.request
-
Servlet-based implementation of the
RequestAttributes
interface. - ServletRequestAttributes(HttpServletRequest) - Constructor for class org.springframework.web.context.request.ServletRequestAttributes
-
Create a new ServletRequestAttributes instance for the given request.
- ServletRequestAttributes(HttpServletRequest, HttpServletResponse) - Constructor for class org.springframework.web.context.request.ServletRequestAttributes
-
Create a new ServletRequestAttributes instance for the given request.
- ServletRequestBindingException - Exception in org.springframework.web.bind
-
Fatal binding exception, thrown when we want to treat binding exceptions as unrecoverable.
- ServletRequestBindingException(String) - Constructor for exception org.springframework.web.bind.ServletRequestBindingException
-
Constructor with a message only.
- ServletRequestBindingException(String, String, Object[]) - Constructor for exception org.springframework.web.bind.ServletRequestBindingException
-
Constructor for ServletRequestBindingException.
- ServletRequestBindingException(String, Throwable) - Constructor for exception org.springframework.web.bind.ServletRequestBindingException
-
Constructor with a message and a cause.
- ServletRequestBindingException(String, Throwable, String, Object[]) - Constructor for exception org.springframework.web.bind.ServletRequestBindingException
-
Constructor for ServletRequestBindingException.
- ServletRequestDataBinder - Class in org.springframework.web.bind
-
Special
DataBinder
to perform data binding from servlet request parameters to JavaBeans, including support for multipart files. - ServletRequestDataBinder(Object) - Constructor for class org.springframework.web.bind.ServletRequestDataBinder
-
Create a new ServletRequestDataBinder instance, with default object name.
- ServletRequestDataBinder(Object, String) - Constructor for class org.springframework.web.bind.ServletRequestDataBinder
-
Create a new ServletRequestDataBinder instance.
- ServletRequestDataBinder.ServletRequestValueResolver - Class in org.springframework.web.bind
-
Resolver that looks up values to bind in a
ServletRequest
. - ServletRequestHandledEvent - Class in org.springframework.web.context.support
-
Servlet-specific subclass of RequestHandledEvent, adding servlet-specific context information.
- ServletRequestHandledEvent(Object, String, String, String, String, String, String, long) - Constructor for class org.springframework.web.context.support.ServletRequestHandledEvent
-
Create a new ServletRequestHandledEvent.
- ServletRequestHandledEvent(Object, String, String, String, String, String, String, long, Throwable) - Constructor for class org.springframework.web.context.support.ServletRequestHandledEvent
-
Create a new ServletRequestHandledEvent.
- ServletRequestHandledEvent(Object, String, String, String, String, String, String, long, Throwable, int) - Constructor for class org.springframework.web.context.support.ServletRequestHandledEvent
-
Create a new ServletRequestHandledEvent.
- ServletRequestParameterPropertyValues - Class in org.springframework.web.bind
-
PropertyValues implementation created from parameters in a ServletRequest.
- ServletRequestParameterPropertyValues(ServletRequest) - Constructor for class org.springframework.web.bind.ServletRequestParameterPropertyValues
-
Create new ServletRequestPropertyValues using no prefix (and hence, no prefix separator).
- ServletRequestParameterPropertyValues(ServletRequest, String) - Constructor for class org.springframework.web.bind.ServletRequestParameterPropertyValues
-
Create new ServletRequestPropertyValues using the given prefix and the default prefix separator (the underscore character "_").
- ServletRequestParameterPropertyValues(ServletRequest, String, String) - Constructor for class org.springframework.web.bind.ServletRequestParameterPropertyValues
-
Create new ServletRequestPropertyValues supplying both prefix and prefix separator.
- ServletRequestPathFilter - Class in org.springframework.web.filter
-
Filter
thatparses and caches
aRequestPath
that can then be accessed viaServletRequestPathUtils.getParsedRequestPath(jakarta.servlet.ServletRequest)
. - ServletRequestPathFilter() - Constructor for class org.springframework.web.filter.ServletRequestPathFilter
- ServletRequestPathUtils - Class in org.springframework.web.util
-
Utility class to assist with preparation and access to the lookup path for request mapping purposes.
- ServletRequestPathUtils() - Constructor for class org.springframework.web.util.ServletRequestPathUtils
- ServletRequestUtils - Class in org.springframework.web.bind
-
Parameter extraction methods, for an approach distinct from data binding, in which parameters of specific types are required.
- ServletRequestUtils() - Constructor for class org.springframework.web.bind.ServletRequestUtils
- ServletRequestValueResolver(ServletRequest, WebDataBinder) - Constructor for class org.springframework.web.bind.ServletRequestDataBinder.ServletRequestValueResolver
- ServletServerHttpAsyncRequestControl - Class in org.springframework.http.server
-
A
ServerHttpAsyncRequestControl
to use on Servlet containers. - ServletServerHttpAsyncRequestControl(ServletServerHttpRequest, ServletServerHttpResponse) - Constructor for class org.springframework.http.server.ServletServerHttpAsyncRequestControl
-
Constructor accepting a request and response pair that are expected to be of type
ServletServerHttpRequest
andServletServerHttpResponse
respectively. - ServletServerHttpRequest - Class in org.springframework.http.server
-
ServerHttpRequest
implementation that is based on aHttpServletRequest
. - ServletServerHttpRequest(HttpServletRequest) - Constructor for class org.springframework.http.server.ServletServerHttpRequest
-
Construct a new instance of the ServletServerHttpRequest based on the given
HttpServletRequest
. - ServletServerHttpResponse - Class in org.springframework.http.server
-
ServerHttpResponse
implementation that is based on aHttpServletResponse
. - ServletServerHttpResponse(HttpServletResponse) - Constructor for class org.springframework.http.server.ServletServerHttpResponse
-
Construct a new instance of the ServletServerHttpResponse based on the given
HttpServletResponse
. - ServletWebRequest - Class in org.springframework.web.context.request
-
WebRequest
adapter for anHttpServletRequest
. - ServletWebRequest(HttpServletRequest) - Constructor for class org.springframework.web.context.request.ServletWebRequest
-
Create a new ServletWebRequest instance for the given request.
- ServletWebRequest(HttpServletRequest, HttpServletResponse) - Constructor for class org.springframework.web.context.request.ServletWebRequest
-
Create a new ServletWebRequest instance for the given request/response pair.
- SESSION_KNOWN_ATTRIBUTE - Static variable in class org.springframework.web.method.annotation.SessionAttributesHandler
-
Key for known-attribute-names storage (a String array) as a session attribute.
- SESSION_MUTEX_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Key for the mutex session attribute.
- SessionAttribute - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation to bind a method parameter to a session attribute.
- SessionAttributes - Annotation Interface in org.springframework.web.bind.annotation
-
Annotation that indicates the session attributes that a specific handler uses.
- SessionAttributesHandler - Class in org.springframework.web.method.annotation
-
Manages controller-specific session attributes declared via
@SessionAttributes
. - SessionAttributesHandler(Class<?>, SessionAttributeStore) - Constructor for class org.springframework.web.method.annotation.SessionAttributesHandler
-
Create a new session attributes handler.
- SessionAttributeStore - Interface in org.springframework.web.bind.support
-
Strategy interface for storing model attributes in a backend session.
- sessionCreated(HttpSessionEvent) - Method in class org.springframework.web.util.HttpSessionMutexListener
- sessionDestroyed(HttpSessionEvent) - Method in class org.springframework.web.util.HttpSessionMutexListener
- sessionManager(WebSessionManager) - Method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Configure the
WebSessionManager
to set on theWebServerExchange
. - SessionScope - Class in org.springframework.web.context.request
-
Session-backed
Scope
implementation. - SessionScope - Annotation Interface in org.springframework.web.context.annotation
-
@SessionScope
is a specialization of@Scope
for a component whose lifecycle is bound to the current web session. - SessionScope() - Constructor for class org.springframework.web.context.request.SessionScope
- SessionStatus - Interface in org.springframework.web.bind.support
-
Simple interface that can be injected into handler methods, allowing them to signal that their session processing is complete.
- SessionStatusMethodArgumentResolver - Class in org.springframework.web.method.annotation
-
Resolves a
SessionStatus
argument by obtaining it from theModelAndViewContainer
. - SessionStatusMethodArgumentResolver() - Constructor for class org.springframework.web.method.annotation.SessionStatusMethodArgumentResolver
- set(String, String) - Method in class org.springframework.http.HttpHeaders
-
Set the given, single header value under the given name.
- set(String, String) - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- set(String, String) - Method in class org.springframework.http.support.JettyHeadersAdapter
- set(String, String) - Method in class org.springframework.http.support.Netty4HeadersAdapter
- set(String, String) - Method in class org.springframework.http.support.Netty5HeadersAdapter
- SET_COOKIE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Set-Cookie
header field name. - SET_COOKIE2 - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Set-Cookie2
header field name. - setAccept(List<MediaType>) - Method in class org.springframework.http.HttpHeaders
-
Set the list of acceptable media types, as specified by the
Accept
header. - setAccept(List<MediaType>) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Set the media types for the request
Accept
header. - setAccept(List<MediaType>) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- setAcceptCharset(List<Charset>) - Method in class org.springframework.http.HttpHeaders
-
Set the list of acceptable charsets, as specified by the
Accept-Charset
header. - setAcceptLanguage(List<Locale.LanguageRange>) - Method in class org.springframework.http.HttpHeaders
-
Set the acceptable language ranges, as specified by the Accept-Language header.
- setAcceptLanguageAsLocales(List<Locale>) - Method in class org.springframework.http.HttpHeaders
-
Variant of
HttpHeaders.setAcceptLanguage(List)
usingLocale
's. - setAcceptPatch(List<MediaType>) - Method in class org.springframework.http.HttpHeaders
- setAccessControlAllowCredentials(boolean) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Access-Control-Allow-Credentials
response header. - setAccessControlAllowHeaders(List<String>) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Access-Control-Allow-Headers
response header. - setAccessControlAllowMethods(List<HttpMethod>) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Access-Control-Allow-Methods
response header. - setAccessControlAllowOrigin(String) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Access-Control-Allow-Origin
response header. - setAccessControlExposeHeaders(List<String>) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Access-Control-Expose-Headers
response header. - setAccessControlMaxAge(long) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Access-Control-Max-Age
response header. - setAccessControlMaxAge(Duration) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Access-Control-Max-Age
response header. - setAccessControlRequestHeaders(List<String>) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Access-Control-Request-Headers
request header. - setAccessControlRequestMethod(HttpMethod) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Access-Control-Request-Method
request header. - setAfterMessagePrefix(String) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Set the value that should be prepended to the log message written after a request is processed.
- setAfterMessageSuffix(String) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Set the value that should be appended to the log message written after a request is processed.
- setAll(Map<String, String>) - Method in class org.springframework.http.HttpHeaders
- setAll(Map<String, String>) - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- setAll(Map<String, String>) - Method in class org.springframework.http.support.JettyHeadersAdapter
- setAll(Map<String, String>) - Method in class org.springframework.http.support.Netty4HeadersAdapter
- setAll(Map<String, String>) - Method in class org.springframework.http.support.Netty5HeadersAdapter
- setAllow(Set<HttpMethod>) - Method in class org.springframework.http.HttpHeaders
-
Set the set of allowed
HTTP methods
, as specified by theAllow
header. - setAllowCredentials(Boolean) - Method in class org.springframework.web.cors.CorsConfiguration
-
Whether user credentials are supported.
- setAllowedHeaders(List<String>) - Method in class org.springframework.web.cors.CorsConfiguration
-
Set the list of headers that a pre-flight request can list as allowed for use during an actual request.
- setAllowedMethods(List<String>) - Method in class org.springframework.web.cors.CorsConfiguration
-
Set the HTTP methods to allow, e.g.
- setAllowedOriginPatterns(List<String>) - Method in class org.springframework.web.cors.CorsConfiguration
-
Alternative to
CorsConfiguration.setAllowedOrigins(java.util.List<java.lang.String>)
that supports more flexible origins patterns with "*" anywhere in the host name in addition to port lists. - setAllowedOrigins(List<String>) - Method in class org.springframework.web.cors.CorsConfiguration
-
A list of origins for which cross-origin requests are allowed where each value may be one of the following: a specific domain, e.g.
- setAllowInitLookupPath(boolean) - Method in class org.springframework.web.cors.UrlBasedCorsConfigurationSource
-
When enabled, if there is neither a
esolved
String lookupPath nor aparsed
RequestPath
then use theconfigured
UrlPathHelper
to resolve a String lookupPath. - setAllowPrivateNetwork(Boolean) - Method in class org.springframework.web.cors.CorsConfiguration
-
Whether private network access is supported for user-agents restricting such access by default.
- setAlwaysUseFullPath(boolean) - Method in class org.springframework.web.cors.UrlBasedCorsConfigurationSource
-
Deprecated.as of 5.3 in favor of using
UrlBasedCorsConfigurationSource.setUrlPathHelper(UrlPathHelper)
, if at all. For further details, please seeUrlBasedCorsConfigurationSource.setAllowInitLookupPath(boolean)
. - setAlwaysUseFullPath(boolean) - Method in class org.springframework.web.util.UrlPathHelper
-
Whether URL lookups should always use the full path within the current web application context, i.e.
- setAnnotationIntrospector(AnnotationIntrospector) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Set an
AnnotationIntrospector
for both serialization and deserialization. - setApplicationContext(ApplicationContext) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Set the builder
ApplicationContext
in order to autowire Jackson handlers (JsonSerializer
,JsonDeserializer
,KeyDeserializer
,TypeResolverBuilder
andTypeIdResolver
). - setApplicationContext(ApplicationContext) - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
Configure the
ApplicationContext
associated with the web application, if it was initialized with one viaWebHttpHandlerBuilder.applicationContext(ApplicationContext)
. - setAsText(String) - Method in class org.springframework.http.MediaTypeEditor
- setAsText(String) - Method in class org.springframework.web.multipart.support.StringMultipartFileEditor
- setAsyncWebRequest(AsyncWebRequest) - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Configure the
AsyncWebRequest
to use. - setAttribute(String, Object) - Method in class org.springframework.web.context.support.ContextExposingHttpServletRequest
- setAttribute(String, Object, int) - Method in class org.springframework.web.context.request.FacesRequestAttributes
- setAttribute(String, Object, int) - Method in interface org.springframework.web.context.request.RequestAttributes
-
Set the value for the scoped attribute of the given name, replacing an existing value (if any).
- setAttribute(String, Object, int) - Method in class org.springframework.web.context.request.ServletRequestAttributes
- setAttributeName(String) - Method in class org.springframework.web.context.support.ServletContextAttributeFactoryBean
-
Set the name of the ServletContext attribute to expose.
- setAttributeNamePrefix(String) - Method in class org.springframework.web.bind.support.DefaultSessionAttributeStore
-
Specify a prefix to use for the attribute names in the backend session.
- setAttributes(Map<String, Object>) - Method in class org.springframework.web.context.support.ServletContextAttributeExporter
-
Set the ServletContext attributes to expose as key-value pairs.
- setAutoDetectFields(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Shortcut for
MapperFeature.AUTO_DETECT_FIELDS
option. - setAutoDetectGettersSetters(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
- setAutoGrowNestedPaths(boolean) - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Set whether a binder should attempt to "auto-grow" a nested path that contains a null value.
- setBase64EncodeByteArrays(boolean) - Method in class org.springframework.http.converter.json.GsonFactoryBean
-
Whether to Base64-encode
byte[]
properties when reading and writing JSON. - setBasicAuth(String) - Method in class org.springframework.http.HttpHeaders
-
Set the value of the Authorization header to Basic Authentication based on the given encoded credentials.
- setBasicAuth(String, String) - Method in class org.springframework.http.HttpHeaders
-
Set the value of the Authorization header to Basic Authentication based on the given username and password.
- setBasicAuth(String, String, Charset) - Method in class org.springframework.http.HttpHeaders
-
Set the value of the Authorization header to Basic Authentication based on the given username and password.
- setBeanClassLoader(ClassLoader) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
- setBeanFactory(BeanFactory) - Method in class org.springframework.web.context.request.async.WebAsyncTask
-
A
BeanFactory
to use for resolving an executor name. - setBeanName(String) - Method in class org.springframework.web.filter.GenericFilterBean
-
Stores the bean name as defined in the Spring bean factory.
- setBeanNameGenerator(BeanNameGenerator) - Method in class org.springframework.web.context.support.AnnotationConfigWebApplicationContext
-
Set a custom
BeanNameGenerator
for use withAnnotatedBeanDefinitionReader
and/orClassPathBeanDefinitionScanner
. - setBearerAuth(String) - Method in class org.springframework.http.HttpHeaders
-
Set the value of the Authorization header to the given Bearer token.
- setBeforeMessagePrefix(String) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Set the value that should be prepended to the log message written before a request is processed.
- setBeforeMessageSuffix(String) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Set the value that should be appended to the log message written before a request is processed.
- setBindEmptyMultipartFiles(boolean) - Method in class org.springframework.web.bind.WebDataBinder
-
Set whether to bind empty MultipartFile parameters.
- setBinding(String, boolean) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Register whether data binding should occur for a corresponding model attribute, corresponding to an
@ModelAttribute(binding=true/false)
declaration. - setBindingDisabled(String) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Programmatically register an attribute for which data binding should not occur, not even for a subsequent
@ModelAttribute
declaration. - setBindingErrorProcessor(BindingErrorProcessor) - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Set the strategy to use for processing binding errors, that is, required field errors and
PropertyAccessException
s. - setBlockingOperationScheduler(Scheduler) - Method in class org.springframework.http.codec.multipart.DefaultPartHttpMessageReader
-
Set the Reactor
Scheduler
to be used for creating files and directories, and writing to files. - setBlockTimeout(Duration) - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
-
Configure how long to block for the response of an HTTP service method as described in
AbstractReactorHttpExchangeAdapter.getBlockTimeout()
. - setBody(StreamingHttpOutputMessage.Body) - Method in interface org.springframework.http.StreamingHttpOutputMessage
-
Set the streaming body callback for this message.
- setBody(P, ParameterizedTypeReference<T>) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.in favor of
ReactiveHttpRequestValues.Builder.setBodyPublisher(P, org.springframework.core.ParameterizedTypeReference<T>)
; to be removed in 6.2 - setBody(P, ParameterizedTypeReference<T>) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- setBodyConvertFunction(Function<ResolvableType, ?>) - Method in exception org.springframework.web.client.RestClientResponseException
-
Provide a function to use to decode the response error content via
RestClientResponseException.getResponseBodyAs(Class)
. - setBodyPublisher(P, ParameterizedTypeReference<T>) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
-
Set the request body as a Reactive Streams Publisher.
- setBodyValue(Object) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Set the request body as an Object to be serialized.
- setBodyValue(Object) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
-
Set the request body as an Object to be serialized.
- setBufferFactory(DataBufferFactory) - Method in class org.springframework.http.client.reactive.HttpComponentsClientHttpConnector
-
Set the buffer factory to use.
- setBufferFactory(DataBufferFactory) - Method in class org.springframework.http.client.reactive.JdkClientHttpConnector
-
Set the buffer factory to use.
- setBufferFactory(DataBufferFactory) - Method in class org.springframework.http.client.reactive.JettyClientHttpConnector
-
Set the buffer factory to use.
- setBufferRequestBody(boolean) - Method in class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.1 requests are never buffered, as if this property is
false
- setBufferRequestBody(boolean) - Method in class org.springframework.http.client.SimpleClientHttpRequestFactory
-
Deprecated, for removal: This API element is subject to removal in a future version.since 6.1 requests are never buffered, as if this property is
false
- setBufferSize(int) - Method in class org.springframework.http.server.reactive.ServletHttpHandlerAdapter
-
Set the size of the input buffer used for reading in bytes.
- setBufferSize(int) - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- setByteBufferPool(ByteBufferPool) - Method in class org.springframework.http.client.reactive.JettyResourceFactory
-
Configure the
ByteBufferPool
to use. - setCacheControl(String) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Cache-Control
header. - setCacheControl(CacheControl) - Method in class org.springframework.http.HttpHeaders
-
Set a configured
CacheControl
instance as the new value of theCache-Control
header. - setCacheDir(File) - Method in class org.springframework.http.converter.BufferedImageHttpMessageConverter
-
Sets the cache directory.
- setCaseSensitive(boolean) - Method in class org.springframework.web.util.pattern.PathPatternParser
-
Configure whether path pattern matching should be case-sensitive.
- setCharset(Charset) - Method in class org.springframework.http.codec.multipart.MultipartWriterSupport
-
Set the character set to use for part headers such as "Content-Disposition" (and its filename parameter).
- setCharset(Charset) - Method in class org.springframework.http.converter.FormHttpMessageConverter
-
Set the default character set to use for reading and writing form data when the request or response
Content-Type
header does not explicitly specify it. - setCharset(Charset) - Method in class org.springframework.web.filter.FormContentFilter
-
The default character set to use for reading form data.
- setChunkSize(int) - Method in class org.springframework.http.client.SimpleClientHttpRequestFactory
-
Set the number of bytes to write in each chunk when not buffering request bodies locally.
- setClientHttpRequestInitializers(List<ClientHttpRequestInitializer>) - Method in class org.springframework.http.client.support.HttpAccessor
-
Set the request initializers that this accessor should use.
- setClock(Clock) - Method in class org.springframework.web.server.session.InMemoryWebSessionStore
-
Configure the
Clock
to use to set lastAccessTime on every created session and to calculate if it is expired. - setCodecConfigurer(ServerCodecConfigurer) - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
Configure a custom
ServerCodecConfigurer
. - setComplete() - Method in class org.springframework.http.client.reactive.ClientHttpRequestDecorator
- setComplete() - Method in interface org.springframework.http.ReactiveHttpOutputMessage
-
Indicate that message handling is complete, allowing for any cleanup or end-of-processing tasks to be performed such as applying header changes made via
HttpMessage.getHeaders()
to the underlying HTTP message (if not applied already). - setComplete() - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
- setComplete() - Method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
- setComplete() - Method in interface org.springframework.web.bind.support.SessionStatus
-
Mark the current handler's session processing as complete, allowing for cleanup of session attributes.
- setComplete() - Method in class org.springframework.web.bind.support.SimpleSessionStatus
- setConfigLocation(String) - Method in interface org.springframework.web.context.ConfigurableWebApplicationContext
-
Set the config locations for this web application context in init-param style, i.e.
- setConfigLocation(String) - Method in class org.springframework.web.context.support.GenericWebApplicationContext
- setConfigLocation(String) - Method in class org.springframework.web.context.support.StaticWebApplicationContext
-
The
StaticWebApplicationContext
class does not support this method. - setConfigLocations(String...) - Method in interface org.springframework.web.context.ConfigurableWebApplicationContext
-
Set the config locations for this web application context.
- setConfigLocations(String...) - Method in class org.springframework.web.context.support.GenericWebApplicationContext
- setConfigLocations(String...) - Method in class org.springframework.web.context.support.StaticWebApplicationContext
-
The
StaticWebApplicationContext
class does not support this method. - setConnection(String) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Connection
header. - setConnection(List<String>) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Connection
header. - setConnectionAborted(boolean) - Method in class org.springframework.http.server.reactive.observation.ServerRequestObservationContext
-
Set whether the current connection was aborted by the client, resulting in a
cancel signal
on the reactive chain, or anAbortedException
when reading the request. - setConnectionProvider(ConnectionProvider) - Method in class org.springframework.http.client.ReactorResourceFactory
-
Use this when you want to provide an externally managed
ConnectionProvider
instance. - setConnectionProvider(ConnectionProvider) - Method in class org.springframework.http.client.reactive.ReactorNetty2ResourceFactory
-
Use this when you want to provide an externally managed
ConnectionProvider
instance. - setConnectionProviderSupplier(Supplier<ConnectionProvider>) - Method in class org.springframework.http.client.ReactorResourceFactory
-
Use this when you don't want to participate in global resources and you want to customize the creation of the managed
ConnectionProvider
. - setConnectionProviderSupplier(Supplier<ConnectionProvider>) - Method in class org.springframework.http.client.reactive.ReactorNetty2ResourceFactory
-
Use this when you don't want to participate in global resources and you want to customize the creation of the managed
ConnectionProvider
. - setConnectionRequestTimeout(int) - Method in class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Set the timeout in milliseconds used when requesting a connection from the connection manager using the underlying
RequestConfig
. - setConnectionRequestTimeout(Duration) - Method in class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Set the timeout in milliseconds used when requesting a connection from the connection manager using the underlying
RequestConfig
. - setConnectTimeout(int) - Method in class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Set the connection timeout for the underlying
RequestConfig
. - setConnectTimeout(int) - Method in class org.springframework.http.client.JettyClientHttpRequestFactory
-
Set the underlying connect timeout in milliseconds.
- setConnectTimeout(int) - Method in class org.springframework.http.client.OkHttp3ClientHttpRequestFactory
-
Deprecated.Set the underlying connect timeout in milliseconds.
- setConnectTimeout(int) - Method in class org.springframework.http.client.ReactorNettyClientRequestFactory
-
Set the underlying connect timeout in milliseconds.
- setConnectTimeout(int) - Method in class org.springframework.http.client.SimpleClientHttpRequestFactory
-
Set the underlying URLConnection's connect timeout (in milliseconds).
- setConnectTimeout(Duration) - Method in class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Set the connection timeout for the underlying
RequestConfig
. - setConnectTimeout(Duration) - Method in class org.springframework.http.client.JettyClientHttpRequestFactory
-
Set the underlying connect timeout in milliseconds.
- setConnectTimeout(Duration) - Method in class org.springframework.http.client.OkHttp3ClientHttpRequestFactory
-
Deprecated.Set the underlying connect timeout in milliseconds.
- setConnectTimeout(Duration) - Method in class org.springframework.http.client.ReactorNettyClientRequestFactory
-
Set the underlying connect timeout in milliseconds.
- setConnectTimeout(Duration) - Method in class org.springframework.http.client.SimpleClientHttpRequestFactory
-
Set the underlying URLConnection's connect timeout as
Duration
. - setContentDisposition(ContentDisposition) - Method in class org.springframework.http.HttpHeaders
-
Set the Content-Disposition header.
- setContentDispositionFormData(String, String) - Method in class org.springframework.http.HttpHeaders
-
Set the
Content-Disposition
header when creating a"multipart/form-data"
request. - setContentLanguage(Locale) - Method in class org.springframework.http.HttpHeaders
-
Set the
Locale
of the content language, as specified by the Content-Language header. - setContentLength(int) - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- setContentLength(long) - Method in class org.springframework.http.HttpHeaders
-
Set the length of the body in bytes, as specified by the
Content-Length
header. - setContentLengthLong(long) - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- setContentType(MediaType) - Method in class org.springframework.http.HttpHeaders
-
Set the media type of the body, as specified by the
Content-Type
header. - setContentType(MediaType) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Set the media type for the request
Content-Type
header. - setContentType(MediaType) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- setContextAttribute(String) - Method in class org.springframework.web.filter.DelegatingFilterProxy
-
Set the name of the ServletContext attribute which should be used to retrieve the
WebApplicationContext
from which to load the delegateFilter
bean. - setContextInitializers(ApplicationContextInitializer<?>...) - Method in class org.springframework.web.context.ContextLoader
-
Specify which
ApplicationContextInitializer
instances should be used to initialize the application context used by thisContextLoader
. - setConversionService(ConversionService) - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Specify a ConversionService which will apply to every DataBinder.
- setCookieDomain(String) - Method in class org.springframework.web.util.CookieGenerator
-
Deprecated.Use the given domain for cookies created by this generator.
- setCookieHttpOnly(boolean) - Method in class org.springframework.web.util.CookieGenerator
-
Deprecated.Set whether the cookie is supposed to be marked with the "HttpOnly" attribute.
- setCookieMaxAge(Integer) - Method in class org.springframework.web.util.CookieGenerator
-
Deprecated.Use the given maximum age (in seconds) for cookies created by this generator.
- setCookieMaxAge(Duration) - Method in class org.springframework.web.server.session.CookieWebSessionIdResolver
-
Set the "Max-Age" attribute for the session id cookie.
- setCookieName(String) - Method in class org.springframework.web.server.session.CookieWebSessionIdResolver
-
Set the name for the session id cookie.
- setCookieName(String) - Method in class org.springframework.web.util.CookieGenerator
-
Deprecated.Use the given name for cookies created by this generator.
- setCookiePath(String) - Method in class org.springframework.web.util.CookieGenerator
-
Deprecated.Use the given path for cookies created by this generator.
- setCookieSecure(boolean) - Method in class org.springframework.web.util.CookieGenerator
-
Deprecated.Set whether the cookie should only be sent using a secure protocol, such as HTTPS (SSL).
- setCorsConfigurations(Map<String, CorsConfiguration>) - Method in class org.springframework.web.cors.reactive.UrlBasedCorsConfigurationSource
-
Set CORS configuration based on URL patterns.
- setCorsConfigurations(Map<String, CorsConfiguration>) - Method in class org.springframework.web.cors.UrlBasedCorsConfigurationSource
-
Set the CORS configuration mappings.
- setCorsProcessor(CorsProcessor) - Method in class org.springframework.web.filter.CorsFilter
-
Configure a custom
CorsProcessor
to use to apply the matchedCorsConfiguration
for a request. - setCreateXmlMapper(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
If set to true and no custom
ObjectMapper
has been set, aXmlMapper
will be created using its default constructor. - setDataBinderFactory(WebDataBinderFactory) - Method in class org.springframework.web.method.support.InvocableHandlerMethod
-
Set the
WebDataBinderFactory
to be passed to argument resolvers allowing them to create aWebDataBinder
for data binding and type conversion purposes. - setDataBufferFactory(DataBufferFactory) - Method in class org.springframework.http.server.reactive.ServletHttpHandlerAdapter
- setDataBufferFactory(DataBufferFactory) - Method in class org.springframework.http.server.reactive.UndertowHttpHandlerAdapter
- setDate(long) - Method in class org.springframework.http.HttpHeaders
-
Set the date and time at which the message was created, as specified by the
Date
header. - setDate(String, long) - Method in class org.springframework.http.HttpHeaders
-
Set the given date under the given header name after formatting it as a string using the RFC-1123 date-time formatter.
- setDate(Instant) - Method in class org.springframework.http.HttpHeaders
-
Set the date and time at which the message was created, as specified by the
Date
header. - setDate(ZonedDateTime) - Method in class org.springframework.http.HttpHeaders
-
Set the date and time at which the message was created, as specified by the
Date
header. - setDateFormat(DateFormat) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Define the format for date/time with the given
DateFormat
. - setDateFormatPattern(String) - Method in class org.springframework.http.converter.json.GsonFactoryBean
-
Define the date/time format with a
SimpleDateFormat
-style pattern. - setDeclarativeBinding(boolean) - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Set whether to bind only fields intended for binding as described in
DataBinder.setDeclarativeBinding(boolean)
. - setDefaultCharset(Charset) - Method in class org.springframework.http.codec.FormHttpMessageReader
-
Set the default character set to use for reading form data when the request Content-Type header does not explicitly specify it.
- setDefaultCharset(Charset) - Method in class org.springframework.http.codec.FormHttpMessageWriter
-
Set the default character set to use for writing form data when the response Content-Type header does not explicitly specify it.
- setDefaultCharset(Charset) - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
-
Set the default character set, if any.
- setDefaultContentType(MediaType) - Method in class org.springframework.http.converter.BufferedImageHttpMessageConverter
-
Sets the default
Content-Type
to be used for writing. - setDefaultContentType(MediaType) - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
Set the default content type to use when no content type is requested.
- setDefaultContentTypes(List<MediaType>) - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
Set the default content types to use when no content type is requested.
- setDefaultContentTypeStrategy(ContentNegotiationStrategy) - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
Set a custom
ContentNegotiationStrategy
to use to determine the content type to use when no content type is requested. - setDefaultEncoding(String) - Method in class org.springframework.web.util.UrlPathHelper
-
Set the default character encoding to use for URL decoding.
- setDefaultLocale(Locale) - Method in class org.springframework.web.server.i18n.AcceptHeaderLocaleContextResolver
-
Configure a fixed default locale to fall back on if the request does not have an "Accept-Language" header (not set by default).
- setDefaultTyping(TypeResolverBuilder<?>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Specify a
TypeResolverBuilder
to use for Jackson's default typing. - setDefaultUriVariables(Map<String, ?>) - Method in class org.springframework.web.client.RestTemplate
-
Configure default URI variable values.
- setDefaultUriVariables(Map<String, ?>) - Method in class org.springframework.web.util.DefaultUriBuilderFactory
-
Provide default URI variable values to use when expanding URI templates with a Map of variables.
- setDefaultUseWrapper(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Define if a wrapper will be used for indexed (List, array) properties or not by default (only applies to
XmlMapper
). - setDefaultViewInclusion(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Shortcut for
MapperFeature.DEFAULT_VIEW_INCLUSION
option. - setDeserializationView(Class<?>) - Method in class org.springframework.http.converter.json.MappingJacksonInputMessage
- setDeserializers(JsonDeserializer<?>...) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Configure custom deserializers.
- setDeserializersByType(Map<Class<?>, JsonDeserializer<?>>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Configure custom deserializers for the given types.
- setDetail(String) - Method in class org.springframework.http.ProblemDetail
-
Setter for the
problem detail
. - setDetail(String) - Method in exception org.springframework.web.ErrorResponseException
-
Set the
detail
field of the response body. - setDirectFieldAccess(boolean) - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Set whether to use direct field access instead of bean property access.
- setDisableHtmlEscaping(boolean) - Method in class org.springframework.http.converter.json.GsonFactoryBean
-
Whether to use the
GsonBuilder.disableHtmlEscaping()
when writing JSON. - setEnableLoggingRequestDetails(boolean) - Method in class org.springframework.http.codec.LoggingCodecSupport
-
Whether to log form data at DEBUG level, and headers at TRACE level.
- setEncoding(String) - Method in class org.springframework.web.filter.CharacterEncodingFilter
-
Set the encoding to use for requests.
- setEncodingMode(DefaultUriBuilderFactory.EncodingMode) - Method in class org.springframework.web.util.DefaultUriBuilderFactory
-
Set the
encoding mode
to use. - setEnvironment(Environment) - Method in class org.springframework.web.filter.GenericFilterBean
-
Set the
Environment
that this filter runs in. - setErrorHandler(ResponseErrorHandler) - Method in class org.springframework.web.client.RestTemplate
-
Set the error handler.
- setErrorResult(Object) - Method in class org.springframework.web.context.request.async.DeferredResult
-
Set an error value for the
DeferredResult
and handle it. - setETag(String) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) entity tag of the body, as specified by the
ETag
header. - setExchangeTimeout(long) - Method in class org.springframework.http.client.ReactorNettyClientRequestFactory
-
Set the timeout for the HTTP exchange in milliseconds.
- setExchangeTimeout(Duration) - Method in class org.springframework.http.client.ReactorNettyClientRequestFactory
-
Set the timeout for the HTTP exchange.
- setExecutor(Executor) - Method in class org.springframework.http.client.reactive.JdkHttpClientResourceFactory
-
Configure the
Executor
to use forHttpClient
exchanges. - setExecutor(Executor) - Method in class org.springframework.http.client.reactive.JettyResourceFactory
-
Configure the
Executor
to use. - setExpires(long) - Method in class org.springframework.http.HttpHeaders
-
Set the date and time at which the message is no longer valid, as specified by the
Expires
header. - setExpires(Instant) - Method in class org.springframework.http.HttpHeaders
-
Set the date and time at which the message is no longer valid, as specified by the
Expires
header. - setExpires(ZonedDateTime) - Method in class org.springframework.http.HttpHeaders
-
Set the duration after which the message is no longer valid, as specified by the
Expires
header. - setExposedHeaders(List<String>) - Method in class org.springframework.web.cors.CorsConfiguration
-
Set the list of response headers that an actual response might have and can be exposed to the client.
- setFactory(JsonFactory) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Define the
JsonFactory
to be used to create theObjectMapper
instance. - setFailOnEmptyBeans(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Shortcut for
SerializationFeature.FAIL_ON_EMPTY_BEANS
option. - setFailOnUnknownProperties(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Shortcut for
DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES
option. - setFavorParameter(boolean) - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
Whether a request parameter ("format" by default) should be used to determine the requested media type.
- setFavorPathExtension(boolean) - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
Deprecated.as of 5.2.4. See class-level note on the deprecation of path extension config options. As there is no replacement for this method, in 5.2.x it is necessary to set it to
false
. In 5.3 the default changes tofalse
and use of this property becomes unnecessary. - setFeaturesToDisable(Object...) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Specify features to disable.
- setFeaturesToEnable(Object...) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Specify features to enable.
- setFieldDefaultPrefix(String) - Method in class org.springframework.web.bind.WebDataBinder
-
Specify a prefix that can be used for parameters that indicate default value fields, having "prefix + field" as name.
- setFieldMarkerPrefix(String) - Method in class org.springframework.web.bind.WebDataBinder
-
Specify a prefix that can be used for parameters that mark potentially empty fields, having "prefix + field" as name.
- setFileStorageDirectory(Path) - Method in class org.springframework.http.codec.multipart.DefaultPartHttpMessageReader
-
Set the directory used to store parts larger than
maxInMemorySize
. - setFilters(FilterProvider) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Set the global filters to use in order to support
@JsonFilter
annotated POJO. - setFilters(FilterProvider) - Method in class org.springframework.http.converter.json.MappingJacksonValue
-
Set the Jackson filter provider to serialize the POJO with.
- setFilters(List<? extends Filter>) - Method in class org.springframework.web.filter.CompositeFilter
- setFindModulesViaServiceLoader(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Set whether to let Jackson find available modules via the JDK ServiceLoader, based on META-INF metadata in the classpath.
- setForceEncoding(boolean) - Method in class org.springframework.web.filter.CharacterEncodingFilter
-
Set whether the configured
encoding
of this filter is supposed to override existing request and response encodings. - setForceRequestEncoding(boolean) - Method in class org.springframework.web.filter.CharacterEncodingFilter
-
Set whether the configured
encoding
of this filter is supposed to override existing request encodings. - setForceResponseEncoding(boolean) - Method in class org.springframework.web.filter.CharacterEncodingFilter
-
Set whether the configured
encoding
of this filter is supposed to override existing response encodings. - setFormConverter(FormHttpMessageConverter) - Method in class org.springframework.web.filter.FormContentFilter
-
Set the converter to use for parsing form content.
- setForwardedHeaderTransformer(ForwardedHeaderTransformer) - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
Enable processing of forwarded headers, either extracting and removing, or remove only.
- setGson(Gson) - Method in class org.springframework.http.converter.json.GsonHttpMessageConverter
-
Set the
Gson
instance to use. - setHandlerInstantiator(HandlerInstantiator) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Customize the construction of Jackson handlers (
JsonSerializer
,JsonDeserializer
,KeyDeserializer
,TypeResolverBuilder
andTypeIdResolver
). - setHandlerMethodArgumentResolvers(HandlerMethodArgumentResolverComposite) - Method in class org.springframework.web.method.support.InvocableHandlerMethod
-
Set
HandlerMethodArgumentResolvers
to use for resolving method argument values. - setHeader(String, String) - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- setHeaderName(String) - Method in class org.springframework.web.server.session.HeaderWebSessionIdResolver
-
Set the name of the session header to use for the session ID.
- setHeaderPredicate(Predicate<String>) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Configure a predicate for selecting which headers should be logged if
AbstractRequestLoggingFilter.setIncludeHeaders(boolean)
is set totrue
. - setHeadersCharset(Charset) - Method in class org.springframework.http.codec.multipart.DefaultPartHttpMessageReader
-
Set the character set used to decode headers.
- setHeadersCharset(Charset) - Method in class org.springframework.http.codec.multipart.PartEventHttpMessageReader
-
Set the character set used to decode headers.
- setHost(InetSocketAddress) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Host
header. - setHostname(String) - Method in class org.springframework.http.client.support.ProxyFactoryBean
-
Set the proxy host name.
- setHttpClient(HttpClient) - Method in class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Set the
HttpClient
used for synchronous execution. - setHttpContextFactory(BiFunction<HttpMethod, URI, HttpContext>) - Method in class org.springframework.http.client.HttpComponentsClientHttpRequestFactory
-
Configure a factory to pre-create the
HttpContext
for each request. - setHttpMethod(HttpMethod) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Set the HTTP method for the request.
- setHttpMethod(HttpMethod) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- setIfMatch(String) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
If-Match
header. - setIfMatch(List<String>) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
If-Match
header. - setIfModifiedSince(long) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
If-Modified-Since
header. - setIfModifiedSince(Instant) - Method in class org.springframework.http.HttpHeaders
-
Set the time the resource was last changed, as specified by the
Last-Modified
header. - setIfModifiedSince(ZonedDateTime) - Method in class org.springframework.http.HttpHeaders
-
Set the time the resource was last changed, as specified by the
Last-Modified
header. - setIfNoneMatch(String) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
If-None-Match
header. - setIfNoneMatch(List<String>) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) values of the
If-None-Match
header. - setIfUnmodifiedSince(long) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
If-Unmodified-Since
header. - setIfUnmodifiedSince(Instant) - Method in class org.springframework.http.HttpHeaders
-
Set the time the resource was last changed, as specified by the
Last-Modified
header. - setIfUnmodifiedSince(ZonedDateTime) - Method in class org.springframework.http.HttpHeaders
-
Set the time the resource was last changed, as specified by the
Last-Modified
header. - setIgnoreAcceptHeader(boolean) - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
Whether to disable checking the 'Accept' request header.
- setIgnoreDefaultModelOnRedirect(boolean) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Deprecated.as of 6.0 without a replacement; once removed, the default model will always be ignored on redirect
- setIgnoreUnknownExtensions(boolean) - Method in class org.springframework.web.accept.AbstractMappingContentNegotiationStrategy
-
Whether to ignore requests with unknown file extension.
- setIgnoreUnknownPathExtensions(boolean) - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
Deprecated.as of 5.2.4. See class-level note on the deprecation of path extension config options.
- setIncludeClientInfo(boolean) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Set whether the client address and session id should be included in the log message.
- setIncludeHeaders(boolean) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Set whether the request headers should be included in the log message.
- setIncludePayload(boolean) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Set whether the request payload (body) should be included in the log message.
- setIncludeQueryString(boolean) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Set whether the query string should be included in the log message.
- setIndentOutput(boolean) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Shortcut for
SerializationFeature.INDENT_OUTPUT
option. - setInitParamName(String) - Method in class org.springframework.web.context.support.ServletContextParameterFactoryBean
-
Set the name of the ServletContext init parameter to expose.
- setInstance(URI) - Method in class org.springframework.http.ProblemDetail
-
Setter for the
problem instance
. - setInstance(URI) - Method in exception org.springframework.web.ErrorResponseException
-
Set the
instance
field of the response body. - setInstant(String, Instant) - Method in class org.springframework.http.HttpHeaders
-
Set the given date under the given header name after formatting it as a string using the RFC-1123 date-time formatter.
- setInterceptors(List<ClientHttpRequestInterceptor>) - Method in class org.springframework.http.client.support.InterceptingHttpAccessor
-
Set the request interceptors that this accessor should use.
- setIntHeader(String, int) - Method in class org.springframework.web.util.ContentCachingResponseWrapper
- setJsonb(Jsonb) - Method in class org.springframework.http.converter.json.JsonbHttpMessageConverter
-
Set the
Jsonb
instance to use. - setJsonPrefix(String) - Method in class org.springframework.http.converter.json.AbstractJsonHttpMessageConverter
-
Specify a custom prefix to use for JSON output.
- setJsonPrefix(String) - Method in class org.springframework.http.converter.json.MappingJackson2HttpMessageConverter
-
Specify a custom prefix to use for this view's JSON output.
- setLastModified(long) - Method in class org.springframework.http.HttpHeaders
-
Set the time the resource was last changed, as specified by the
Last-Modified
header. - setLastModified(Instant) - Method in class org.springframework.http.HttpHeaders
-
Set the time the resource was last changed, as specified by the
Last-Modified
header. - setLastModified(ZonedDateTime) - Method in class org.springframework.http.HttpHeaders
-
Set the time the resource was last changed, as specified by the
Last-Modified
header. - setLocale(Locale) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Override the default
Locale
to use for formatting. - setLocaleContext(ServerWebExchange, LocaleContext) - Method in class org.springframework.web.server.i18n.AcceptHeaderLocaleContextResolver
- setLocaleContext(ServerWebExchange, LocaleContext) - Method in class org.springframework.web.server.i18n.FixedLocaleContextResolver
- setLocaleContext(ServerWebExchange, LocaleContext) - Method in interface org.springframework.web.server.i18n.LocaleContextResolver
-
Set the current locale context to the given one, potentially including a locale with associated time zone information.
- setLocaleContextResolver(LocaleContextResolver) - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
Configure a custom
LocaleContextResolver
. - setLocation(URI) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) location of a resource, as specified by the
Location
header. - setLookupPathAttributeName(String) - Method in class org.springframework.web.cors.UrlBasedCorsConfigurationSource
-
Deprecated.as of 5.3 in favor of
UrlPathHelper.PATH_ATTRIBUTE
. - setLoopResources(LoopResources) - Method in class org.springframework.http.client.ReactorResourceFactory
-
Use this option when you want to provide an externally managed
LoopResources
instance. - setLoopResources(LoopResources) - Method in class org.springframework.http.client.reactive.ReactorNetty2ResourceFactory
-
Use this option when you want to provide an externally managed
LoopResources
instance. - setLoopResourcesSupplier(Supplier<LoopResources>) - Method in class org.springframework.http.client.ReactorResourceFactory
-
Use this when you don't want to participate in global resources and you want to customize the creation of the managed
LoopResources
. - setLoopResourcesSupplier(Supplier<LoopResources>) - Method in class org.springframework.http.client.reactive.ReactorNetty2ResourceFactory
-
Use this when you don't want to participate in global resources and you want to customize the creation of the managed
LoopResources
. - setMarshaller(Marshaller) - Method in class org.springframework.http.converter.xml.MarshallingHttpMessageConverter
-
Set the
Marshaller
to be used by this message converter. - setMarshallerProcessor(Function<Marshaller, Marshaller>) - Method in class org.springframework.http.codec.xml.Jaxb2XmlEncoder
-
Configure a processor function to customize Marshaller instances.
- setMatchOptionalTrailingSeparator(boolean) - Method in class org.springframework.web.util.pattern.PathPatternParser
-
Deprecated.transparent support for trailing slashes is deprecated as of 6.0 in favor of configuring explicit redirects through a proxy, Servlet/web filter, or a controller.
- setMaxAge(Long) - Method in class org.springframework.web.cors.CorsConfiguration
-
Configure how long, in seconds, the response from a pre-flight request can be cached by clients.
- setMaxAge(Duration) - Method in class org.springframework.web.cors.CorsConfiguration
-
Configure how long, as a duration, the response from a pre-flight request can be cached by clients.
- setMaxDiskUsagePerPart(long) - Method in class org.springframework.http.codec.multipart.DefaultPartHttpMessageReader
-
Configure the maximum amount of disk space allowed for file parts.
- setMaxHeadersSize(int) - Method in class org.springframework.http.codec.multipart.DefaultPartHttpMessageReader
-
Configure the maximum amount of memory that is allowed per headers section of each part.
- setMaxHeadersSize(int) - Method in class org.springframework.http.codec.multipart.PartEventHttpMessageReader
-
Configure the maximum amount of memory that is allowed per headers section of each part.
- setMaxIdleTime(Duration) - Method in interface org.springframework.web.server.WebSession
-
Configure the max amount of time that may elapse after the
lastAccessTime
before a session is considered expired. - setMaxInMemorySize(int) - Method in class org.springframework.http.codec.FormHttpMessageReader
-
Set the max number of bytes for input form data.
- setMaxInMemorySize(int) - Method in class org.springframework.http.codec.json.AbstractJackson2Decoder
-
Set the max number of bytes that can be buffered by this decoder.
- setMaxInMemorySize(int) - Method in class org.springframework.http.codec.KotlinSerializationBinaryDecoder
-
Configure a limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated.
- setMaxInMemorySize(int) - Method in class org.springframework.http.codec.KotlinSerializationStringDecoder
-
Configure a limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated.
- setMaxInMemorySize(int) - Method in class org.springframework.http.codec.multipart.DefaultPartHttpMessageReader
-
Configure the maximum amount of memory allowed per part.
- setMaxInMemorySize(int) - Method in class org.springframework.http.codec.multipart.PartEventHttpMessageReader
-
Configure the maximum amount of memory allowed for form fields.
- setMaxInMemorySize(int) - Method in class org.springframework.http.codec.ServerSentEventHttpMessageReader
-
Configure a limit on the maximum number of bytes per SSE event which are buffered before the event is parsed.
- setMaxInMemorySize(int) - Method in class org.springframework.http.codec.xml.Jaxb2XmlDecoder
-
Set the max number of bytes that can be buffered by this decoder.
- setMaxInMemorySize(int) - Method in class org.springframework.http.codec.xml.XmlEventDecoder
-
Set the max number of bytes that can be buffered by this decoder.
- setMaxMessageSize(int) - Method in class org.springframework.http.codec.protobuf.ProtobufDecoder
-
The max size allowed per message.
- setMaxParts(int) - Method in class org.springframework.http.codec.multipart.DefaultPartHttpMessageReader
-
Specify the maximum number of parts allowed in a given multipart request.
- setMaxParts(int) - Method in class org.springframework.http.codec.multipart.PartEventHttpMessageReader
-
Specify the maximum number of parts allowed in a given multipart request.
- setMaxPartSize(long) - Method in class org.springframework.http.codec.multipart.PartEventHttpMessageReader
-
Configure the maximum size allowed for any part.
- setMaxPayloadLength(int) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Set the maximum length of the payload body to be included in the log message.
- setMaxSessions(int) - Method in class org.springframework.web.server.session.InMemoryWebSessionStore
-
Set the maximum number of sessions that can be stored.
- setMediaTypes(Properties) - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
Add a mapping from a key to a MediaType where the key are normalized to lowercase and may have been extracted from a path extension, a filename extension, or passed as a query parameter.
- setMessageCodesResolver(MessageCodesResolver) - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Set the strategy to use for resolving errors into message codes.
- setMessageConverters(List<HttpMessageConverter<?>>) - Method in class org.springframework.web.client.ExtractingResponseErrorHandler
-
Set the message converters to use by this extractor.
- setMessageConverters(List<HttpMessageConverter<?>>) - Method in class org.springframework.web.client.RestTemplate
-
Set the message body converters to use.
- setMetaClass(MetaClass) - Method in class org.springframework.web.context.support.GroovyWebApplicationContext
- setMethodParam(String) - Method in class org.springframework.web.filter.HiddenHttpMethodFilter
-
Set the parameter name to look for HTTP methods.
- setMethodParamName(String) - Method in class org.springframework.web.filter.reactive.HiddenHttpMethodFilter
-
Set the name of the form parameter with the HTTP method to use.
- setMethodValidationApplicable(boolean) - Method in class org.springframework.web.bind.support.DefaultDataBinderFactory
-
Configure flag to signal whether validation will be applied to handler method arguments, which is the case if Bean Validation is enabled in Spring MVC, and method parameters have
@Constraint
annotations. - setMethodValidator(MethodValidator) - Method in class org.springframework.web.method.support.InvocableHandlerMethod
-
Set the
MethodValidator
to perform method validation with if the controller methodHandlerMethod.shouldValidateArguments()
orHandlerMethod.shouldValidateReturnValue()
. - setMixIns(Map<Class<?>, Class<?>>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Add mix-in annotations to use for augmenting specified class or interface.
- setModules(List<Module>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Set a complete list of modules to be registered with the
ObjectMapper
. - setModulesToInstall(Class<? extends Module>...) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Specify one or more modules by class (or class name in XML) to be registered with the
ObjectMapper
. - setMultipartCharset(Charset) - Method in class org.springframework.http.converter.FormHttpMessageConverter
-
Set the character set to use when writing multipart data to encode file names.
- setMultipartFiles(MultiValueMap<String, MultipartFile>) - Method in class org.springframework.web.multipart.support.AbstractMultipartHttpServletRequest
-
Set a Map with parameter names as keys and list of MultipartFile objects as values.
- setMultipartParameterContentTypes(Map<String, String>) - Method in class org.springframework.web.multipart.support.DefaultMultipartHttpServletRequest
-
Set a Map with parameter names as keys and content type Strings as values.
- setMultipartParameters(Map<String, String[]>) - Method in class org.springframework.web.multipart.support.DefaultMultipartHttpServletRequest
-
Set a Map with parameter names as keys and String array objects as values.
- setMultipartResolverBeanName(String) - Method in class org.springframework.web.multipart.support.MultipartFilter
-
Set the bean name of the MultipartResolver to fetch from Spring's root application context.
- setNamespace(String) - Method in interface org.springframework.web.context.ConfigurableWebApplicationContext
-
Set the namespace for this web application context, to be used for building a default context config location.
- setNamespace(String) - Method in class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
- setNamespace(String) - Method in class org.springframework.web.context.support.GenericWebApplicationContext
- setNamespace(String) - Method in class org.springframework.web.context.support.StaticWebApplicationContext
- setNestedPath(String) - Method in class org.springframework.web.bind.EscapedErrors
- setNestedPath(String) - Method in exception org.springframework.web.bind.support.WebExchangeBindException
- setObjectMapper(ObjectMapper) - Method in class org.springframework.http.codec.json.Jackson2CodecSupport
-
Configure the default ObjectMapper instance to use.
- setObjectMapper(ObjectMapper) - Method in class org.springframework.http.converter.cbor.MappingJackson2CborHttpMessageConverter
-
Configure the main
ObjectMapper
to use for Object conversion. - setObjectMapper(ObjectMapper) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
-
Configure the main
ObjectMapper
to use for Object conversion. - setObjectMapper(ObjectMapper) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Set the
ObjectMapper
instance to use. - setObjectMapper(ObjectMapper) - Method in class org.springframework.http.converter.smile.MappingJackson2SmileHttpMessageConverter
-
Configure the main
ObjectMapper
to use for Object conversion. - setObjectMapper(ObjectMapper) - Method in class org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter
-
Configure the main
ObjectMapper
to use for Object conversion. - setObservationConvention(ClientRequestObservationConvention) - Method in class org.springframework.web.client.RestTemplate
-
Configure an
ObservationConvention
that sets the name of theobservation
as well as itsKeyValues
extracted from theClientRequestObservationContext
. - setObservationConvention(ServerRequestObservationConvention) - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
Configure a
ServerRequestObservationConvention
for server exchanges observations. - setObservationRegistry(ObservationRegistry) - Method in class org.springframework.web.client.RestTemplate
-
Configure an
ObservationRegistry
for collecting spans and metrics for request execution. - setObservationRegistry(ObservationRegistry) - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
Configure an
ObservationRegistry
for recording server exchange observations. - setOrigin(String) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Origin
header. - setOutputStreaming(boolean) - Method in class org.springframework.http.client.SimpleClientHttpRequestFactory
-
Deprecated, for removal: This API element is subject to removal in a future version.as of 6.1 requests are always streamed, as if this property is
true
- setParameterName(String) - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
Set the query parameter name to use when
ContentNegotiationManagerFactoryBean.setFavorParameter(boolean)
is on. - setParameterName(String) - Method in class org.springframework.web.accept.ParameterContentNegotiationStrategy
-
Set the name of the parameter to use to determine requested media types.
- setParameterNameDiscoverer(ParameterNameDiscoverer) - Method in class org.springframework.web.method.support.InvocableHandlerMethod
-
Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g.
- setParsedRequestPath(RequestPath, ServletRequest) - Static method in class org.springframework.web.util.ServletRequestPathUtils
-
Set the cached, parsed
RequestPath
to the given value. - setParsePath(boolean) - Method in class org.springframework.web.util.DefaultUriBuilderFactory
-
Whether to parse the input path into path segments if the encoding mode is set to
EncodingMode.URI_COMPONENT
, which ensures that URI variables in the path are encoded according to path segment rules and for example a '/' is encoded. - setPartConverters(List<HttpMessageConverter<?>>) - Method in class org.springframework.http.converter.FormHttpMessageConverter
-
Set the message body converters to use.
- setPathMatcher(PathMatcher) - Method in class org.springframework.web.cors.UrlBasedCorsConfigurationSource
-
Configure a
PathMatcher
to use for pattern matching. - setPathOptions(PathContainer.Options) - Method in class org.springframework.web.util.pattern.PathPatternParser
-
Set options for parsing patterns.
- setPathPattern(String) - Method in class org.springframework.http.server.observation.ServerRequestObservationContext
- setPathPattern(String) - Method in class org.springframework.http.server.reactive.observation.ServerRequestObservationContext
-
Set the path pattern for the handler that matches the current request.
- setPort(int) - Method in class org.springframework.http.client.support.ProxyFactoryBean
-
Set the proxy port.
- setPragma(String) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Pragma
header. - setPrefixJson(boolean) - Method in class org.springframework.http.converter.json.AbstractJsonHttpMessageConverter
-
Indicate whether the JSON output by this view should be prefixed with ")]}', ".
- setPrefixJson(boolean) - Method in class org.springframework.http.converter.json.MappingJackson2HttpMessageConverter
-
Indicate whether the JSON output by this view should be prefixed with ")]}', ".
- setPrettyPrint(boolean) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
-
Whether to use the
DefaultPrettyPrinter
when writing JSON. - setPrettyPrinting(boolean) - Method in class org.springframework.http.converter.json.GsonFactoryBean
-
Whether to use the
GsonBuilder.setPrettyPrinting()
when writing JSON. - setProcessExternalEntities(boolean) - Method in class org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter
-
Indicate whether external XML entities are processed when converting to a Source.
- setProcessExternalEntities(boolean) - Method in class org.springframework.http.converter.xml.SourceHttpMessageConverter
-
Indicate whether external XML entities are processed when converting to a Source.
- setProperties(Map<String, Object>) - Method in class org.springframework.http.ProblemDetail
-
Setter for the
properties map
. - setProperty(String, Object) - Method in interface org.springframework.http.converter.json.ProblemDetailJacksonMixin
- setProperty(String, Object) - Method in interface org.springframework.http.converter.json.ProblemDetailJacksonXmlMixin
- setProperty(String, Object) - Method in class org.springframework.http.ProblemDetail
-
Set a "dynamic" property to be added to a generic
properties map
. - setProperty(String, Object) - Method in class org.springframework.web.context.support.GroovyWebApplicationContext
- setPropertyEditorRegistrar(PropertyEditorRegistrar) - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Specify a single PropertyEditorRegistrar to be applied to every DataBinder.
- setPropertyEditorRegistrars(PropertyEditorRegistrar[]) - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Specify multiple PropertyEditorRegistrars to be applied to every DataBinder.
- setPropertyNamingStrategy(PropertyNamingStrategy) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Specify a
PropertyNamingStrategy
to configure theObjectMapper
with. - setProxy(Proxy) - Method in class org.springframework.http.client.SimpleClientHttpRequestFactory
-
Set the
Proxy
to use for this request factory. - setRange(List<HttpRange>) - Method in class org.springframework.http.HttpHeaders
-
Sets the (new) value of the
Range
header. - setRawStatusCode(Integer) - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
- setRawStatusCode(Integer) - Method in interface org.springframework.http.server.reactive.ServerHttpResponse
-
Set the HTTP status code to the given value as an integer.
- setRawStatusCode(Integer) - Method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
- setReactiveAdapterRegistry(ReactiveAdapterRegistry) - Method in class org.springframework.web.service.invoker.AbstractReactorHttpExchangeAdapter
-
Configure the
ReactiveAdapterRegistry
to use. - setReadTimeout(int) - Method in class org.springframework.http.client.JdkClientHttpRequestFactory
-
Set the underlying
HttpClient
's read timeout (in milliseconds). - setReadTimeout(int) - Method in class org.springframework.http.client.OkHttp3ClientHttpRequestFactory
-
Deprecated.Set the underlying read timeout in milliseconds.
- setReadTimeout(int) - Method in class org.springframework.http.client.SimpleClientHttpRequestFactory
-
Set the underlying URLConnection's read timeout (in milliseconds).
- setReadTimeout(long) - Method in class org.springframework.http.client.JettyClientHttpRequestFactory
-
Set the underlying read timeout in milliseconds.
- setReadTimeout(long) - Method in class org.springframework.http.client.ReactorNettyClientRequestFactory
-
Set the underlying read timeout in milliseconds.
- setReadTimeout(Duration) - Method in class org.springframework.http.client.JdkClientHttpRequestFactory
-
Set the underlying
HttpClient
's read timeout as aDuration
. - setReadTimeout(Duration) - Method in class org.springframework.http.client.JettyClientHttpRequestFactory
-
Set the underlying read timeout as
Duration
. - setReadTimeout(Duration) - Method in class org.springframework.http.client.OkHttp3ClientHttpRequestFactory
-
Deprecated.Set the underlying read timeout in milliseconds.
- setReadTimeout(Duration) - Method in class org.springframework.http.client.ReactorNettyClientRequestFactory
-
Set the underlying read timeout as
Duration
. - setReadTimeout(Duration) - Method in class org.springframework.http.client.SimpleClientHttpRequestFactory
-
Set the underlying URLConnection's read timeout (in milliseconds).
- setRedirectModel(ModelMap) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Provide a separate model instance to use in a redirect scenario.
- setRedirectModelScenario(boolean) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Whether the controller has returned a redirect instruction, e.g.
- setRedirectStatus(HttpStatusCode) - Method in class org.springframework.web.filter.RelativeRedirectFilter
-
Set the default HTTP Status to use for redirects.
- setRelativeRedirects(boolean) - Method in class org.springframework.web.filter.ForwardedHeaderFilter
-
Use this property to enable relative redirects as explained in
RelativeRedirectFilter
, and also using the same response wrapper as that filter does, or if both are configured, only one will wrap. - setRemoveOnly(boolean) - Method in class org.springframework.web.filter.ForwardedHeaderFilter
-
Enables mode in which any "Forwarded" or "X-Forwarded-*" headers are removed only and the information in them ignored.
- setRemoveOnly(boolean) - Method in class org.springframework.web.server.adapter.ForwardedHeaderTransformer
-
Enable mode in which any "Forwarded" or "X-Forwarded-*" headers are removed only and the information in them ignored.
- setRemoveSemicolonContent(boolean) - Method in class org.springframework.web.cors.UrlBasedCorsConfigurationSource
-
Deprecated.as of 5.3 in favor of using
UrlBasedCorsConfigurationSource.setUrlPathHelper(UrlPathHelper)
, if at all. For further details, please seeUrlBasedCorsConfigurationSource.setAllowInitLookupPath(boolean)
. - setRemoveSemicolonContent(boolean) - Method in class org.springframework.web.util.UrlPathHelper
-
Set if ";" (semicolon) content should be stripped from the request URI.
- setRequestAttributes(RequestAttributes) - Static method in class org.springframework.web.context.request.RequestContextHolder
-
Bind the given RequestAttributes to the current thread, not exposing it as inheritable for child threads.
- setRequestAttributes(RequestAttributes, boolean) - Static method in class org.springframework.web.context.request.RequestContextHolder
-
Bind the given RequestAttributes to the current thread.
- setRequestFactory(ClientHttpRequestFactory) - Method in class org.springframework.http.client.support.HttpAccessor
-
Set the request factory that this accessor uses for obtaining client request handles.
- setRequestFactory(ClientHttpRequestFactory) - Method in class org.springframework.http.client.support.InterceptingHttpAccessor
- setRequestHandled(boolean) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Whether the request has been handled fully within the handler, e.g.
- setResolveLazily(boolean) - Method in class org.springframework.web.multipart.support.StandardServletMultipartResolver
-
Set whether to resolve the multipart request lazily at the time of file or parameter access.
- setRestTemplate(RestTemplate) - Method in class org.springframework.web.client.support.RestGatewaySupport
-
Sets the
RestTemplate
for the gateway. - setResult(T) - Method in class org.springframework.web.context.request.async.DeferredResult
-
Set the value for the DeferredResult and handle it.
- setResultHandler(DeferredResult.DeferredResultHandler) - Method in class org.springframework.web.context.request.async.DeferredResult
-
Provide a handler to use to handle the result value.
- setScheduler(Scheduler) - Method in class org.springframework.http.client.reactive.JettyResourceFactory
-
Configure the
Scheduler
to use. - setScopeMetadataResolver(ScopeMetadataResolver) - Method in class org.springframework.web.context.support.AnnotationConfigWebApplicationContext
-
Set a custom
ScopeMetadataResolver
for use withAnnotatedBeanDefinitionReader
and/orClassPathBeanDefinitionScanner
. - setSerializationInclusion(JsonInclude.Include) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Set a custom inclusion strategy for serialization.
- setSerializationView(Class<?>) - Method in class org.springframework.http.converter.json.MappingJacksonValue
-
Set the serialization view to serialize the POJO with.
- setSerializeNulls(boolean) - Method in class org.springframework.http.converter.json.GsonFactoryBean
-
Whether to use the
GsonBuilder.serializeNulls()
option when writing JSON. - setSerializers(JsonSerializer<?>...) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Configure custom serializers.
- setSerializersByType(Map<Class<?>, JsonSerializer<?>>) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Configure custom serializers for the given types.
- setSeriesMapping(Map<HttpStatus.Series, Class<? extends RestClientException>>) - Method in class org.springframework.web.client.ExtractingResponseErrorHandler
-
Set the mapping from HTTP status series to
RestClientException
subclass. - setServletConfig(ServletConfig) - Method in interface org.springframework.web.context.ConfigurableWebApplicationContext
-
Set the ServletConfig for this web application context.
- setServletConfig(ServletConfig) - Method in interface org.springframework.web.context.ServletConfigAware
-
Set the
ServletConfig
that this object runs in. - setServletConfig(ServletConfig) - Method in class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
- setServletConfig(ServletConfig) - Method in class org.springframework.web.context.support.GenericWebApplicationContext
- setServletConfig(ServletConfig) - Method in class org.springframework.web.context.support.StaticWebApplicationContext
- setServletContext(ServletContext) - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
Invoked by Spring to inject the ServletContext.
- setServletContext(ServletContext) - Method in interface org.springframework.web.context.ConfigurableWebApplicationContext
-
Set the ServletContext for this web application context.
- setServletContext(ServletContext) - Method in interface org.springframework.web.context.ServletContextAware
-
Set the
ServletContext
that this object runs in. - setServletContext(ServletContext) - Method in class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
- setServletContext(ServletContext) - Method in class org.springframework.web.context.support.GenericWebApplicationContext
-
Set the
ServletContext
that thisWebApplicationContext
runs in. - setServletContext(ServletContext) - Method in class org.springframework.web.context.support.ServletContextAttributeExporter
- setServletContext(ServletContext) - Method in class org.springframework.web.context.support.ServletContextAttributeFactoryBean
- setServletContext(ServletContext) - Method in class org.springframework.web.context.support.ServletContextParameterFactoryBean
- setServletContext(ServletContext) - Method in class org.springframework.web.context.support.StaticWebApplicationContext
-
Set the ServletContext that this WebApplicationContext runs in.
- setServletContext(ServletContext) - Method in class org.springframework.web.context.support.WebApplicationObjectSupport
- setServletContext(ServletContext) - Method in class org.springframework.web.filter.GenericFilterBean
-
Stores the ServletContext that the bean factory runs in.
- setSessionAttribute(HttpServletRequest, String, Object) - Static method in class org.springframework.web.util.WebUtils
-
Set the session attribute with the given name to the given value.
- setSessionId(ServerWebExchange, String) - Method in class org.springframework.web.server.session.CookieWebSessionIdResolver
- setSessionId(ServerWebExchange, String) - Method in class org.springframework.web.server.session.HeaderWebSessionIdResolver
- setSessionId(ServerWebExchange, String) - Method in interface org.springframework.web.server.session.WebSessionIdResolver
-
Send the given session ID to the client.
- setSessionIdResolver(WebSessionIdResolver) - Method in class org.springframework.web.server.session.DefaultWebSessionManager
-
Configure the id resolution strategy.
- setSessionManager(WebSessionManager) - Method in class org.springframework.web.server.adapter.HttpWebHandlerAdapter
-
Configure a custom
WebSessionManager
to use for managing web sessions. - setSessionStore(WebSessionStore) - Method in class org.springframework.web.server.session.DefaultWebSessionManager
-
Configure the persistence strategy.
- setShutdownQuietPeriod(Duration) - Method in class org.springframework.http.client.reactive.ReactorNetty2ResourceFactory
-
Configure the amount of time we'll wait before shutting down resources.
- setShutdownQuietPeriod(Duration) - Method in class org.springframework.http.client.ReactorResourceFactory
-
Configure the amount of time we'll wait before shutting down resources.
- setShutdownTimeout(Duration) - Method in class org.springframework.http.client.reactive.ReactorNetty2ResourceFactory
-
Configure the maximum amount of time to wait until the disposal of the underlying resources regardless if a task was submitted during the
shutdownQuietPeriod
. - setShutdownTimeout(Duration) - Method in class org.springframework.http.client.ReactorResourceFactory
-
Configure the maximum amount of time to wait until the disposal of the underlying resources regardless if a task was submitted during the
shutdownQuietPeriod
. - setSimpleDateFormat(String) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Define the date/time format with a
SimpleDateFormat
. - setStatus(int) - Method in class org.springframework.http.ProblemDetail
-
Setter for the
problem status
. - setStatus(HttpStatus) - Method in class org.springframework.http.ProblemDetail
-
Setter for the
problem status
. - setStatus(HttpStatusCode) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Provide an HTTP status that will be passed on to with the
ModelAndView
used for view rendering purposes. - setStatusCode(HttpStatusCode) - Method in class org.springframework.http.server.DelegatingServerHttpResponse
- setStatusCode(HttpStatusCode) - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
- setStatusCode(HttpStatusCode) - Method in interface org.springframework.http.server.reactive.ServerHttpResponse
-
Set the HTTP status code of the response.
- setStatusCode(HttpStatusCode) - Method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
- setStatusCode(HttpStatusCode) - Method in interface org.springframework.http.server.ServerHttpResponse
-
Set the HTTP status code of the response.
- setStatusCode(HttpStatusCode) - Method in class org.springframework.http.server.ServletServerHttpResponse
- setStatusMapping(Map<HttpStatusCode, Class<? extends RestClientException>>) - Method in class org.springframework.web.client.ExtractingResponseErrorHandler
-
Set the mapping from HTTP status code to
RestClientException
subclass. - setStrategies(List<ContentNegotiationStrategy>) - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
Set the exact list of strategies to use.
- setStreamingMediaTypes(Collection<MediaType>) - Method in class org.springframework.http.codec.KotlinSerializationStringEncoder
- setStreamingMediaTypes(List<MediaType>) - Method in class org.springframework.http.codec.json.AbstractJackson2Encoder
-
Configure "streaming" media types for which flushing should be performed automatically vs at the end of the stream.
- setStrictServletCompliance(boolean) - Method in class org.springframework.web.multipart.support.StandardServletMultipartResolver
-
Specify whether this resolver should strictly comply with the Servlet specification, only kicking in for "multipart/form-data" requests.
- setSupportDtd(boolean) - Method in class org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter
-
Indicate whether DTD parsing should be supported.
- setSupportDtd(boolean) - Method in class org.springframework.http.converter.xml.SourceHttpMessageConverter
-
Indicate whether DTD parsing should be supported.
- setSupportedLocales(List<Locale>) - Method in class org.springframework.web.server.i18n.AcceptHeaderLocaleContextResolver
-
Configure the list of supported locales to compare and match against
requested locales
. - setSupportedMediaTypes(List<MediaType>) - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
-
Set the list of
MediaType
objects supported by this converter. - setSupportedMediaTypes(List<MediaType>) - Method in class org.springframework.http.converter.FormHttpMessageConverter
-
Set the list of
MediaType
objects supported by this converter. - setSupportedMediaTypes(List<MediaType>) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
- setTargetBeanName(String) - Method in class org.springframework.web.filter.DelegatingFilterProxy
-
Set the name of the target bean in the Spring application context.
- setTargetFilterLifecycle(boolean) - Method in class org.springframework.web.filter.DelegatingFilterProxy
-
Set whether to invoke the
Filter.init
andFilter.destroy
lifecycle methods on the target bean. - setTaskExecutor(AsyncTaskExecutor) - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Configure an AsyncTaskExecutor for use with concurrent processing via
WebAsyncManager.startCallableProcessing(Callable, Object...)
. - setThreadContextInheritable(boolean) - Method in class org.springframework.web.filter.RequestContextFilter
-
Set whether to expose the LocaleContext and RequestAttributes as inheritable for child threads (using an
InheritableThreadLocal
). - setThreadPrefix(String) - Method in class org.springframework.http.client.reactive.JdkHttpClientResourceFactory
-
Configure the thread prefix to initialize the executor with.
- setThreadPrefix(String) - Method in class org.springframework.http.client.reactive.JettyResourceFactory
-
Configure the thread prefix to initialize
QueuedThreadPool
executor with. - setTimeout(Long) - Method in interface org.springframework.web.context.request.async.AsyncWebRequest
-
Set the time required for concurrent handling to complete.
- setTimeout(Long) - Method in class org.springframework.web.context.request.async.StandardServletAsyncWebRequest
-
In Servlet 3 async processing, the timeout period begins after the container processing thread has exited.
- setTimeZone(TimeZone) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean
-
Override the default
TimeZone
to use for formatting. - setTitle(String) - Method in class org.springframework.http.ProblemDetail
-
Setter for the
problem title
. - setTitle(String) - Method in exception org.springframework.web.ErrorResponseException
-
Set the
title
field of the response body. - setType(Proxy.Type) - Method in class org.springframework.http.client.support.ProxyFactoryBean
-
Set the proxy type.
- setType(URI) - Method in class org.springframework.http.ProblemDetail
-
Setter for the
problem type
. - setType(URI) - Method in exception org.springframework.web.ErrorResponseException
-
Set the
type
field of the response body. - setUnmarshaller(Unmarshaller) - Method in class org.springframework.http.converter.xml.MarshallingHttpMessageConverter
-
Set the
Unmarshaller
to be used by this message converter. - setUnmarshallerProcessor(Function<Unmarshaller, Unmarshaller>) - Method in class org.springframework.http.codec.xml.Jaxb2XmlDecoder
-
Configure a processor function to customize Unmarshaller instances.
- setUpgrade(String) - Method in class org.springframework.http.HttpHeaders
-
Set the (new) value of the
Upgrade
header. - setUri(URI) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Set the URL to use.
- setUri(URI) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- setUriBuilderFactory(UriBuilderFactory) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Set the
UriBuilderFactory
that will be used to expand theHttpRequestValues.getUriTemplate()
. - setUriBuilderFactory(UriBuilderFactory) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- setUriTemplate(String) - Method in class org.springframework.http.client.observation.ClientRequestObservationContext
-
Set the URI template used for the current client exchange.
- setUriTemplate(String) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Set the request URL as a String template.
- setUriTemplate(String) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- setUriTemplateHandler(UriTemplateHandler) - Method in class org.springframework.web.client.RestTemplate
-
Configure a strategy for expanding URI templates.
- setUriVariable(String, String) - Method in class org.springframework.web.service.invoker.HttpRequestValues.Builder
-
Add a URI variable name-value pair.
- setUriVariable(String, String) - Method in class org.springframework.web.service.invoker.ReactiveHttpRequestValues.Builder
- setUrlDecode(boolean) - Method in class org.springframework.web.cors.UrlBasedCorsConfigurationSource
-
Deprecated.as of 5.3 in favor of using
UrlBasedCorsConfigurationSource.setUrlPathHelper(UrlPathHelper)
, if at all. For further details, please seeUrlBasedCorsConfigurationSource.setAllowInitLookupPath(boolean)
. - setUrlDecode(boolean) - Method in class org.springframework.web.util.UrlPathHelper
-
Whether the context path and request URI should be decoded -- both of which are returned undecoded by the Servlet API, in contrast to the servlet path.
- setUrlPathHelper(UrlPathHelper) - Method in class org.springframework.web.accept.PathExtensionContentNegotiationStrategy
-
Deprecated.Configure a
UrlPathHelper
to use inPathExtensionContentNegotiationStrategy.getMediaTypeKey(org.springframework.web.context.request.NativeWebRequest)
in order to derive the lookup path for a target request URL path. - setUrlPathHelper(UrlPathHelper) - Method in class org.springframework.web.cors.UrlBasedCorsConfigurationSource
-
Configure the
UrlPathHelper
to resolve the lookupPath. - setUseGlobalResources(boolean) - Method in class org.springframework.http.client.reactive.ReactorNetty2ResourceFactory
-
Whether to use global Reactor Netty resources via
HttpResources
. - setUseGlobalResources(boolean) - Method in class org.springframework.http.client.ReactorResourceFactory
-
Whether to use global Reactor Netty resources via
HttpResources
. - setUseJaf(boolean) - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
Deprecated.as of 5.0, in favor of
ContentNegotiationManagerFactoryBean.setUseRegisteredExtensionsOnly(boolean)
, which has reverse behavior. - setUseJaf(boolean) - Method in class org.springframework.web.accept.PathExtensionContentNegotiationStrategy
-
Deprecated.as of 5.0, in favor of
AbstractMappingContentNegotiationStrategy.setUseRegisteredExtensionsOnly(boolean)
. - setUseRegisteredExtensionsOnly(boolean) - Method in class org.springframework.web.accept.AbstractMappingContentNegotiationStrategy
-
Whether to only use the registered mappings to look up file extensions, or also to use dynamic resolution (e.g.
- setUseRegisteredExtensionsOnly(boolean) - Method in class org.springframework.web.accept.ContentNegotiationManagerFactoryBean
-
When
favorPathExtension
orContentNegotiationManagerFactoryBean.setFavorParameter(boolean)
is set, this property determines whether to use only registeredMediaType
mappings or to allow dynamic resolution, e.g. - setValidator(Validator) - Method in class org.springframework.web.bind.support.ConfigurableWebBindingInitializer
-
Set the Validator to apply after each binding step.
- setValue(ELContext, Object, Object, Object) - Method in class org.springframework.web.jsf.el.SpringBeanFacesELResolver
- setValue(ELContext, Object, Object, Object) - Method in class org.springframework.web.jsf.el.WebApplicationContextFacesELResolver
- setValue(Object) - Method in class org.springframework.http.converter.json.MappingJacksonValue
-
Modify the POJO to serialize.
- setValue(Object) - Method in class org.springframework.web.multipart.support.ByteArrayMultipartFileEditor
- setValue(Object) - Method in class org.springframework.web.multipart.support.StringMultipartFileEditor
- setVary(List<String>) - Method in class org.springframework.http.HttpHeaders
-
Set the request header names (e.g.
- setView(Object) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Set a View object to be used by the DispatcherServlet.
- setViewName(String) - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Set a view name to be resolved by the DispatcherServlet via a ViewResolver.
- setWarnLogCategory(String) - Method in class org.springframework.web.server.handler.ResponseStatusExceptionHandler
-
Set the log category for warn logging.
- setWebAppRootSystemProperty(ServletContext) - Static method in class org.springframework.web.util.WebUtils
-
Set a system property to the web application root directory.
- setWriteAcceptCharset(boolean) - Method in class org.springframework.http.converter.ObjectToStringHttpMessageConverter
- setWriteAcceptCharset(boolean) - Method in class org.springframework.http.converter.StringHttpMessageConverter
-
Whether the
Accept-Charset
header should be written to any outgoing request sourced from the value ofCharset.availableCharsets()
. - setWriteTimeout(int) - Method in class org.springframework.http.client.OkHttp3ClientHttpRequestFactory
-
Deprecated.Set the underlying write timeout in milliseconds.
- setWriteTimeout(Duration) - Method in class org.springframework.http.client.OkHttp3ClientHttpRequestFactory
-
Deprecated.Set the underlying write timeout in milliseconds.
- setWriteWeakETag(boolean) - Method in class org.springframework.web.filter.ShallowEtagHeaderFilter
-
Set whether the ETag value written to the response should be weak, as per RFC 7232.
- setZonedDateTime(String, ZonedDateTime) - Method in class org.springframework.http.HttpHeaders
-
Set the given date under the given header name after formatting it as a string using the RFC-1123 date-time formatter.
- ShallowEtagHeaderFilter - Class in org.springframework.web.filter
-
Filter
that generates anETag
value based on the content on the response. - ShallowEtagHeaderFilter() - Constructor for class org.springframework.web.filter.ShallowEtagHeaderFilter
- shouldBuffer(URI, HttpMethod) - Method in class org.springframework.http.client.BufferingClientHttpRequestFactory
-
Indicates whether the request/response exchange for the given URI and method should be buffered in memory.
- shouldConstructArgument(MethodParameter) - Method in class org.springframework.web.bind.ServletRequestDataBinder
- shouldConstructArgument(MethodParameter) - Method in class org.springframework.web.bind.support.WebExchangeDataBinder
- shouldConstructArgument(MethodParameter) - Method in class org.springframework.web.bind.support.WebRequestDataBinder
- shouldDecodeAndParseSegments() - Method in class org.springframework.http.server.PathContainer.Options
- shouldLog(HttpServletRequest) - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
Determine whether to call the
AbstractRequestLoggingFilter.beforeRequest(jakarta.servlet.http.HttpServletRequest, java.lang.String)
/AbstractRequestLoggingFilter.afterRequest(jakarta.servlet.http.HttpServletRequest, java.lang.String)
methods for the current request, i.e. - shouldLog(HttpServletRequest) - Method in class org.springframework.web.filter.CommonsRequestLoggingFilter
- shouldNotFilter(HttpServletRequest) - Method in class org.springframework.web.filter.ForwardedHeaderFilter
- shouldNotFilter(HttpServletRequest) - Method in class org.springframework.web.filter.OncePerRequestFilter
-
Can be overridden in subclasses for custom filtering control, returning
true
to avoid filtering of the given request. - shouldNotFilterAsyncDispatch() - Method in class org.springframework.web.filter.AbstractRequestLoggingFilter
-
The default value is "false" so that the filter may log a "before" message at the start of request processing and an "after" message at the end from when the last asynchronously dispatched thread is exiting.
- shouldNotFilterAsyncDispatch() - Method in class org.springframework.web.filter.ForwardedHeaderFilter
- shouldNotFilterAsyncDispatch() - Method in class org.springframework.web.filter.OncePerRequestFilter
-
The dispatcher type
jakarta.servlet.DispatcherType.ASYNC
means a filter can be invoked in more than one thread over the course of a single request. - shouldNotFilterAsyncDispatch() - Method in class org.springframework.web.filter.RequestContextFilter
-
Returns "false" so that the filter may set up the request context in each asynchronously dispatched thread.
- shouldNotFilterAsyncDispatch() - Method in class org.springframework.web.filter.ServerHttpObservationFilter
- shouldNotFilterAsyncDispatch() - Method in class org.springframework.web.filter.ShallowEtagHeaderFilter
-
The default value is
false
so that the filter may delay the generation of an ETag until the last asynchronously dispatched thread. - shouldNotFilterErrorDispatch() - Method in class org.springframework.web.filter.ForwardedHeaderFilter
- shouldNotFilterErrorDispatch() - Method in class org.springframework.web.filter.OncePerRequestFilter
-
Whether to filter error dispatches such as when the servlet container processes and error mapped in
web.xml
. - shouldNotFilterErrorDispatch() - Method in class org.springframework.web.filter.RequestContextFilter
-
Returns "false" so that the filter may set up the request context in an error dispatch.
- shouldParsePath() - Method in class org.springframework.web.util.DefaultUriBuilderFactory
-
Whether to parse the path into path segments if the encoding mode is set to
EncodingMode.URI_COMPONENT
. - shouldRemoveSemicolonContent() - Method in class org.springframework.web.util.UrlPathHelper
-
Whether configured to remove ";" (semicolon) content from the request URI.
- shouldValidateArguments() - Method in class org.springframework.web.method.HandlerMethod
-
Whether the method arguments are a candidate for method validation, which is the case when there are parameter
jakarta.validation.Constraint
annotations. - shouldValidateReturnValue() - Method in class org.springframework.web.method.HandlerMethod
-
Whether the method return value is a candidate for method validation, which is the case when there are method
jakarta.validation.Constraint
orjakarta.validation.Valid
annotations. - SimpleClientHttpRequestFactory - Class in org.springframework.http.client
-
ClientHttpRequestFactory
implementation that uses standard JDK facilities. - SimpleClientHttpRequestFactory() - Constructor for class org.springframework.http.client.SimpleClientHttpRequestFactory
- simpleDateFormat(String) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Define the date/time format with a
SimpleDateFormat
. - SimpleSessionStatus - Class in org.springframework.web.bind.support
-
Simple implementation of the
SessionStatus
interface, keeping thecomplete
flag as an instance variable. - SimpleSessionStatus() - Constructor for class org.springframework.web.bind.support.SimpleSessionStatus
- size() - Method in class org.springframework.http.HttpHeaders
- size() - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- size() - Method in class org.springframework.http.support.JettyHeadersAdapter
- size() - Method in class org.springframework.http.support.Netty4HeadersAdapter
- size() - Method in class org.springframework.http.support.Netty5HeadersAdapter
- size(Long) - Method in interface org.springframework.http.ContentDisposition.Builder
-
Deprecated.since 5.2.3 as per RFC 6266, Appendix B, to be removed in a future release.
- SKIP_VALUE - Static variable in interface org.springframework.web.util.UriComponents.UriTemplateVariables
-
Constant for a value that indicates a URI variable name should be ignored and left as is.
- sMaxAge(long, TimeUnit) - Method in class org.springframework.http.CacheControl
-
Add an "s-maxage" directive.
- sMaxAge(Duration) - Method in class org.springframework.http.CacheControl
-
Add an "s-maxage" directive.
- smile() - Static method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Obtain a
Jackson2ObjectMapperBuilder
instance in order to build a Smile data formatObjectMapper
instance. - sortByQualityValue(List<MediaType>) - Static method in class org.springframework.http.MediaType
-
Deprecated, for removal: This API element is subject to removal in a future version.As of 6.0, with no direct replacement
- sortBySpecificity(List<MediaType>) - Static method in class org.springframework.http.MediaType
-
Deprecated, for removal: This API element is subject to removal in a future version.As of 6.0, in favor of
MimeTypeUtils.sortBySpecificity(List)
- sortBySpecificityAndQuality(List<MediaType>) - Static method in class org.springframework.http.MediaType
-
Deprecated.As of 6.0, in favor of
MimeTypeUtils.sortBySpecificity(List)
- SourceHttpMessageConverter<T extends Source> - Class in org.springframework.http.converter.xml
-
Implementation of
HttpMessageConverter
that can read and writeSource
objects. - SourceHttpMessageConverter() - Constructor for class org.springframework.http.converter.xml.SourceHttpMessageConverter
- SPECIFICITY_COMPARATOR - Static variable in class org.springframework.http.MediaType
-
Deprecated, for removal: This API element is subject to removal in a future version.As of 6.0, with no direct replacement
- SPECIFICITY_COMPARATOR - Static variable in class org.springframework.web.util.pattern.PathPattern
-
Comparator that sorts patterns by specificity as follows: Null instances are last.
- SpringBeanAutowiringSupport - Class in org.springframework.web.context.support
-
Convenient base class for self-autowiring classes that gets constructed within a Spring-based web application.
- SpringBeanAutowiringSupport() - Constructor for class org.springframework.web.context.support.SpringBeanAutowiringSupport
-
This constructor performs injection on this instance, based on the current web application context.
- SpringBeanFacesELResolver - Class in org.springframework.web.jsf.el
-
JSF
ELResolver
that delegates to the Spring rootWebApplicationContext
, resolving name references to Spring-defined beans. - SpringBeanFacesELResolver() - Constructor for class org.springframework.web.jsf.el.SpringBeanFacesELResolver
- SpringHandlerInstantiator - Class in org.springframework.http.converter.json
-
Allows for creating Jackson (
JsonSerializer
,JsonDeserializer
,KeyDeserializer
,TypeResolverBuilder
,TypeIdResolver
) beans with autowiring against a SpringApplicationContext
. - SpringHandlerInstantiator(AutowireCapableBeanFactory) - Constructor for class org.springframework.http.converter.json.SpringHandlerInstantiator
-
Create a new SpringHandlerInstantiator for the given BeanFactory.
- SpringServletContainerInitializer - Class in org.springframework.web
-
A Spring-provided
ServletContainerInitializer
designed to support code-based configuration of the servlet container using Spring'sWebApplicationInitializer
SPI as opposed to (or possibly in combination with) the traditionalweb.xml
-based approach. - SpringServletContainerInitializer() - Constructor for class org.springframework.web.SpringServletContainerInitializer
- SpringWebBlockHoundIntegration() - Constructor for class org.springframework.web.server.adapter.WebHttpHandlerBuilder.SpringWebBlockHoundIntegration
- SpringWebConstraintValidatorFactory - Class in org.springframework.web.bind.support
-
JSR-303
ConstraintValidatorFactory
implementation that delegates to the current SpringWebApplicationContext
for creating autowiredConstraintValidator
instances. - SpringWebConstraintValidatorFactory() - Constructor for class org.springframework.web.bind.support.SpringWebConstraintValidatorFactory
- sslInfo(SslInfo) - Method in interface org.springframework.http.server.reactive.ServerHttpRequest.Builder
-
Set the SSL session information.
- SslInfo - Interface in org.springframework.http.server.reactive
-
A holder for SSL session information.
- staleIfError(long, TimeUnit) - Method in class org.springframework.http.CacheControl
-
Add a "stale-if-error" directive.
- staleIfError(Duration) - Method in class org.springframework.http.CacheControl
-
Add a "stale-if-error" directive.
- staleWhileRevalidate(long, TimeUnit) - Method in class org.springframework.http.CacheControl
-
Add a "stale-while-revalidate" directive.
- staleWhileRevalidate(Duration) - Method in class org.springframework.http.CacheControl
-
Add a "stale-while-revalidate" directive.
- StandardMultipartHttpServletRequest - Class in org.springframework.web.multipart.support
-
Spring MultipartHttpServletRequest adapter, wrapping a Servlet HttpServletRequest and its Part objects.
- StandardMultipartHttpServletRequest(HttpServletRequest) - Constructor for class org.springframework.web.multipart.support.StandardMultipartHttpServletRequest
-
Create a new StandardMultipartHttpServletRequest wrapper for the given request, immediately parsing the multipart content.
- StandardMultipartHttpServletRequest(HttpServletRequest, boolean) - Constructor for class org.springframework.web.multipart.support.StandardMultipartHttpServletRequest
-
Create a new StandardMultipartHttpServletRequest wrapper for the given request.
- StandardServletAsyncWebRequest - Class in org.springframework.web.context.request.async
-
A Servlet implementation of
AsyncWebRequest
. - StandardServletAsyncWebRequest(HttpServletRequest, HttpServletResponse) - Constructor for class org.springframework.web.context.request.async.StandardServletAsyncWebRequest
-
Create a new instance for the given request/response pair.
- StandardServletEnvironment - Class in org.springframework.web.context.support
-
Environment
implementation to be used byServlet
-based web applications. - StandardServletEnvironment() - Constructor for class org.springframework.web.context.support.StandardServletEnvironment
-
Create a new
StandardServletEnvironment
instance. - StandardServletEnvironment(MutablePropertySources) - Constructor for class org.springframework.web.context.support.StandardServletEnvironment
-
Create a new
StandardServletEnvironment
instance with a specificMutablePropertySources
instance. - StandardServletMultipartResolver - Class in org.springframework.web.multipart.support
-
Standard implementation of the
MultipartResolver
interface, based on the ServletPart
API. - StandardServletMultipartResolver() - Constructor for class org.springframework.web.multipart.support.StandardServletMultipartResolver
- StandardServletPartUtils - Class in org.springframework.web.multipart.support
-
Utility methods for standard Servlet
Part
handling. - StandardServletPartUtils() - Constructor for class org.springframework.web.multipart.support.StandardServletPartUtils
- start() - Method in class org.springframework.http.client.reactive.ReactorClientHttpConnector
- start() - Method in class org.springframework.http.client.ReactorNettyClientRequestFactory
- start() - Method in class org.springframework.http.client.ReactorResourceFactory
- start() - Method in interface org.springframework.http.server.ServerHttpAsyncRequestControl
-
Enable asynchronous processing after which the response remains open until a call to
ServerHttpAsyncRequestControl.complete()
is made or the server times out the request. - start() - Method in class org.springframework.http.server.ServletServerHttpAsyncRequestControl
- start() - Method in interface org.springframework.web.server.WebSession
-
Force the creation of a session causing the session id to be sent when
WebSession.save()
is called. - start(long) - Method in interface org.springframework.http.server.ServerHttpAsyncRequestControl
-
A variation on
ServerHttpAsyncRequestControl.start()
that allows specifying a timeout value to use for asynchronous processing. - start(long) - Method in class org.springframework.http.server.ServletServerHttpAsyncRequestControl
- startAsync() - Method in interface org.springframework.web.context.request.async.AsyncWebRequest
-
Mark the start of asynchronous request processing so that when the main processing thread exits, the response remains open for further processing in another thread.
- startAsync() - Method in class org.springframework.web.context.request.async.StandardServletAsyncWebRequest
- startCallableProcessing(Callable<?>, Object...) - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Start concurrent request processing and execute the given task with an
AsyncTaskExecutor
. - startCallableProcessing(WebAsyncTask<?>, Object...) - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Use the given
WebAsyncTask
to configure the task executor as well as the timeout value of theAsyncWebRequest
before delegating toWebAsyncManager.startCallableProcessing(Callable, Object...)
. - startDeferredResultProcessing(DeferredResult<?>, Object...) - Method in class org.springframework.web.context.request.async.WebAsyncManager
-
Start concurrent request processing and initialize the given
DeferredResult
with aDeferredResult.DeferredResultHandler
that saves the result and dispatches the request to resume processing of that result. - StaticWebApplicationContext - Class in org.springframework.web.context.support
-
Static
WebApplicationContext
implementation for testing. - StaticWebApplicationContext() - Constructor for class org.springframework.web.context.support.StaticWebApplicationContext
- status(int) - Static method in class org.springframework.http.ResponseEntity
-
Create a builder with the given status.
- status(ClientRequestObservationContext) - Method in class org.springframework.http.client.observation.DefaultClientRequestObservationConvention
- status(HttpStatusCode) - Static method in class org.springframework.http.ResponseEntity
-
Create a builder with the given status.
- status(ServerRequestObservationContext) - Method in class org.springframework.http.server.observation.DefaultServerRequestObservationConvention
- status(ServerRequestObservationContext) - Method in class org.springframework.http.server.reactive.observation.DefaultServerRequestObservationConvention
- STATUS - Enum constant in enum class org.springframework.http.client.observation.ClientHttpObservationDocumentation.LowCardinalityKeyNames
-
HTTP response raw status code, or
"IO_ERROR"
in case ofIOException
, or"CLIENT_ERROR"
if no response was received. - STATUS - Enum constant in enum class org.springframework.http.server.observation.ServerHttpObservationDocumentation.LowCardinalityKeyNames
-
HTTP response raw status code, or
"UNKNOWN"
if no response was created. - STATUS - Enum constant in enum class org.springframework.http.server.reactive.observation.ServerHttpObservationDocumentation.LowCardinalityKeyNames
-
HTTP response raw status code, or
"UNKNOWN"
if no response was created. - stop() - Method in class org.springframework.http.client.reactive.ReactorClientHttpConnector
- stop() - Method in class org.springframework.http.client.ReactorNettyClientRequestFactory
- stop() - Method in class org.springframework.http.client.ReactorResourceFactory
- stop(Runnable) - Method in class org.springframework.http.client.reactive.ReactorClientHttpConnector
- stop(Runnable) - Method in class org.springframework.http.client.ReactorNettyClientRequestFactory
- storeAttribute(WebRequest, String, Object) - Method in class org.springframework.web.bind.support.DefaultSessionAttributeStore
- storeAttribute(WebRequest, String, Object) - Method in interface org.springframework.web.bind.support.SessionAttributeStore
-
Store the supplied attribute in the backend session.
- storeAttributes(WebRequest, Map<String, ?>) - Method in class org.springframework.web.method.annotation.SessionAttributesHandler
-
Store a subset of the given attributes in the session.
- StreamingHttpOutputMessage - Interface in org.springframework.http
-
Represents an HTTP output message that allows for setting a streaming body.
- StreamingHttpOutputMessage.Body - Interface in org.springframework.http
-
Defines the contract for bodies that can be written directly to an
OutputStream
. - StringHttpMessageConverter - Class in org.springframework.http.converter
-
Implementation of
HttpMessageConverter
that can read and write strings. - StringHttpMessageConverter() - Constructor for class org.springframework.http.converter.StringHttpMessageConverter
-
A default constructor that uses
"ISO-8859-1"
as the default charset. - StringHttpMessageConverter(Charset) - Constructor for class org.springframework.http.converter.StringHttpMessageConverter
-
A constructor accepting a default charset to use if the requested content type does not specify one.
- StringMultipartFileEditor - Class in org.springframework.web.multipart.support
-
Custom
PropertyEditor
for convertingMultipartFiles
to Strings. - StringMultipartFileEditor() - Constructor for class org.springframework.web.multipart.support.StringMultipartFileEditor
-
Create a new
StringMultipartFileEditor
, using the default charset. - StringMultipartFileEditor(String) - Constructor for class org.springframework.web.multipart.support.StringMultipartFileEditor
-
Create a new
StringMultipartFileEditor
, using the given charset. - SUBMIT_IMAGE_SUFFIXES - Static variable in class org.springframework.web.util.WebUtils
-
Name suffixes in case of image buttons.
- subPath(int) - Method in interface org.springframework.http.server.PathContainer
-
Extract a sub-path from the given offset into the elements list.
- subPath(int, int) - Method in interface org.springframework.http.server.PathContainer
-
Extract a sub-path from the given start offset into the element list (inclusive) and to the end offset (exclusive).
- subscribe(Subscriber<? super Void>) - Method in class org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
- subscribe(Subscriber<? super Void>) - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
- subscribe(Subscriber<? super T>) - Method in class org.springframework.http.server.reactive.AbstractListenerReadPublisher
- subscribe(CoreSubscriber<? super Void>) - Method in class org.springframework.http.server.reactive.ChannelSendOperator
- SUCCESSFUL - Enum constant in enum class org.springframework.http.HttpStatus.Series
- supportedMimeTypes() - Method in class org.springframework.http.codec.KotlinSerializationSupport
-
Returns the supported mime types.
- supports(Class<?>) - Method in class org.springframework.http.converter.AbstractGenericHttpMessageConverter
- supports(Class<?>) - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
-
Indicates whether the given class is supported by this converter.
- supports(Class<?>) - Method in class org.springframework.http.converter.AbstractKotlinSerializationHttpMessageConverter
- supports(Class<?>) - Method in class org.springframework.http.converter.ByteArrayHttpMessageConverter
- supports(Class<?>) - Method in class org.springframework.http.converter.feed.AtomFeedHttpMessageConverter
- supports(Class<?>) - Method in class org.springframework.http.converter.feed.RssChannelHttpMessageConverter
- supports(Class<?>) - Method in class org.springframework.http.converter.ObjectToStringHttpMessageConverter
- supports(Class<?>) - Method in class org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter
- supports(Class<?>) - Method in class org.springframework.http.converter.ResourceHttpMessageConverter
- supports(Class<?>) - Method in class org.springframework.http.converter.StringHttpMessageConverter
- supports(Class<?>) - Method in class org.springframework.http.converter.xml.Jaxb2CollectionHttpMessageConverter
- supports(Class<?>) - Method in class org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter
- supports(Class<?>) - Method in class org.springframework.http.converter.xml.MarshallingHttpMessageConverter
- supports(Class<?>) - Method in class org.springframework.http.converter.xml.SourceHttpMessageConverter
- supportsContext(Observation.Context) - Method in interface org.springframework.http.client.observation.ClientRequestObservationConvention
- supportsContext(Observation.Context) - Method in interface org.springframework.http.server.observation.ServerRequestObservationConvention
- supportsContext(Observation.Context) - Method in interface org.springframework.http.server.reactive.observation.ServerRequestObservationConvention
- supportsMimeType(MimeType) - Method in class org.springframework.http.codec.json.Jackson2CodecSupport
- supportsMimeType(MimeType) - Method in class org.springframework.http.codec.protobuf.ProtobufCodecSupport
- supportsParameter(MethodParameter) - Method in class org.springframework.web.method.annotation.AbstractCookieValueMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.method.annotation.AbstractWebArgumentResolverAdapter
-
Actually resolve the value and check the resolved value is not
WebArgumentResolver.UNRESOLVED
absorbing _any_ exceptions. - supportsParameter(MethodParameter) - Method in class org.springframework.web.method.annotation.ErrorsMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.method.annotation.ExpressionValueMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.method.annotation.MapMethodProcessor
- supportsParameter(MethodParameter) - Method in class org.springframework.web.method.annotation.ModelAttributeMethodProcessor
-
Returns
true
if the parameter is annotated withModelAttribute
or, if in default resolution mode, for any method parameter that is not a simple type. - supportsParameter(MethodParameter) - Method in class org.springframework.web.method.annotation.ModelMethodProcessor
- supportsParameter(MethodParameter) - Method in class org.springframework.web.method.annotation.RequestHeaderMapMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.method.annotation.RequestHeaderMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.method.annotation.RequestParamMapMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.method.annotation.RequestParamMethodArgumentResolver
-
Supports the following: @RequestParam-annotated method arguments.
- supportsParameter(MethodParameter) - Method in class org.springframework.web.method.annotation.SessionStatusMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.web.method.support.CompositeUriComponentsContributor
- supportsParameter(MethodParameter) - Method in interface org.springframework.web.method.support.HandlerMethodArgumentResolver
-
Whether the given method parameter is supported by this resolver.
- supportsParameter(MethodParameter) - Method in class org.springframework.web.method.support.HandlerMethodArgumentResolverComposite
-
Whether the given method parameter is supported by any registered
HandlerMethodArgumentResolver
. - supportsParameter(MethodParameter) - Method in interface org.springframework.web.method.support.UriComponentsContributor
-
Whether this contributor supports the given method parameter.
- supportsRepeatableWrites(byte[]) - Method in class org.springframework.http.converter.ByteArrayHttpMessageConverter
- supportsRepeatableWrites(Message) - Method in class org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter
- supportsRepeatableWrites(Object) - Method in class org.springframework.http.converter.AbstractKotlinSerializationHttpMessageConverter
- supportsRepeatableWrites(Object) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
- supportsRepeatableWrites(Object) - Method in class org.springframework.http.converter.json.GsonHttpMessageConverter
- supportsRepeatableWrites(Object) - Method in class org.springframework.http.converter.json.JsonbHttpMessageConverter
- supportsRepeatableWrites(Object) - Method in class org.springframework.http.converter.ObjectToStringHttpMessageConverter
- supportsRepeatableWrites(Object) - Method in class org.springframework.http.converter.ResourceRegionHttpMessageConverter
- supportsRepeatableWrites(Object) - Method in class org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter
- supportsRepeatableWrites(Object) - Method in class org.springframework.http.converter.xml.MarshallingHttpMessageConverter
- supportsRepeatableWrites(String) - Method in class org.springframework.http.converter.StringHttpMessageConverter
- supportsRepeatableWrites(Resource) - Method in class org.springframework.http.converter.ResourceHttpMessageConverter
- supportsRepeatableWrites(T) - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
-
Indicates whether this message converter can write the given object multiple times.
- supportsRepeatableWrites(T) - Method in class org.springframework.http.converter.feed.AbstractWireFeedHttpMessageConverter
- supportsRepeatableWrites(T) - Method in class org.springframework.http.converter.xml.SourceHttpMessageConverter
- supportsRequestAttributes() - Method in class org.springframework.web.client.support.RestClientAdapter
- supportsRequestAttributes() - Method in class org.springframework.web.client.support.RestTemplateAdapter
- supportsRequestAttributes() - Method in interface org.springframework.web.service.invoker.HttpExchangeAdapter
-
Whether the underlying client supports use of request attributes.
- supportsReturnType(MethodParameter) - Method in class org.springframework.web.method.annotation.MapMethodProcessor
- supportsReturnType(MethodParameter) - Method in class org.springframework.web.method.annotation.ModelAttributeMethodProcessor
-
Return
true
if there is a method-level@ModelAttribute
or, in default resolution mode, for any return value type that is not a simple type. - supportsReturnType(MethodParameter) - Method in class org.springframework.web.method.annotation.ModelMethodProcessor
- supportsReturnType(MethodParameter) - Method in interface org.springframework.web.method.support.HandlerMethodReturnValueHandler
-
Whether the given method return type is supported by this handler.
- supportsReturnType(MethodParameter) - Method in class org.springframework.web.method.support.HandlerMethodReturnValueHandlerComposite
-
Whether the given method return type is supported by any registered
HandlerMethodReturnValueHandler
. - SWITCHING_PROTOCOLS - Enum constant in enum class org.springframework.http.HttpStatus
-
101 Switching Protocols
.
T
- TagUtils - Class in org.springframework.web.util
-
Utility class for tag library related code, exposing functionality such as translating
Strings
to web scopes. - TagUtils() - Constructor for class org.springframework.web.util.TagUtils
- TE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
TE
header field name. - TEMP_DIR_CONTEXT_ATTRIBUTE - Static variable in class org.springframework.web.util.WebUtils
-
Standard Servlet spec context attribute that specifies a temporary directory for the current web application, of type
java.io.File
. - TEMPLATE_AND_VALUES - Enum constant in enum class org.springframework.web.util.DefaultUriBuilderFactory.EncodingMode
-
Pre-encode the URI template first, then strictly encode URI variables when expanded, with the following rules: For the URI template replace only non-ASCII and illegal (within a given URI component type) characters with escaped octets.
- TEMPORARY_REDIRECT - Enum constant in enum class org.springframework.http.HttpStatus
-
307 Temporary Redirect
. - test(Class<?>) - Method in class org.springframework.web.method.HandlerTypePredicate
- TEXT_EVENT_STREAM - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
text/event-stream
. - TEXT_EVENT_STREAM_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.TEXT_EVENT_STREAM
. - TEXT_HTML - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
text/html
. - TEXT_HTML_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.TEXT_HTML
. - TEXT_MARKDOWN - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
text/markdown
. - TEXT_MARKDOWN_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.TEXT_MARKDOWN
. - TEXT_PLAIN - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
text/plain
. - TEXT_PLAIN_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.TEXT_PLAIN
. - TEXT_XML - Static variable in class org.springframework.http.MediaType
-
Public constant media type for
text/xml
. - TEXT_XML_VALUE - Static variable in class org.springframework.http.MediaType
-
A String equivalent of
MediaType.TEXT_XML
. - TimeoutCallableProcessingInterceptor - Class in org.springframework.web.context.request.async
-
Sends a 503 (SERVICE_UNAVAILABLE) in case of a timeout if the response is not already committed.
- TimeoutCallableProcessingInterceptor() - Constructor for class org.springframework.web.context.request.async.TimeoutCallableProcessingInterceptor
- TimeoutDeferredResultProcessingInterceptor - Class in org.springframework.web.context.request.async
-
Sends a 503 (SERVICE_UNAVAILABLE) in case of a timeout if the response is not already committed.
- TimeoutDeferredResultProcessingInterceptor() - Constructor for class org.springframework.web.context.request.async.TimeoutDeferredResultProcessingInterceptor
- timeZone(String) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Override the default
TimeZone
to use for formatting. - timeZone(TimeZone) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Override the default
TimeZone
to use for formatting. - title(String) - Method in interface org.springframework.web.ErrorResponse.Builder
-
Set the underlying
title
field. - titleMessageCode(String) - Method in interface org.springframework.web.ErrorResponse.Builder
-
Customize the
MessageSource
code to use to resolve the value forProblemDetail.setTitle(String)
. - toBodilessEntity() - Method in interface org.springframework.web.client.RestClient.ResponseSpec
-
Return a
ResponseEntity
without a body. - toCommaDelimitedString(List<String>) - Method in class org.springframework.http.HttpHeaders
-
Turn the given list of header values into a comma-delimited result.
- toDetailedString() - Method in exception org.springframework.web.util.pattern.PatternParseException
-
Return a detailed message that includes the original pattern text with a pointer to the error position, as well as the error message.
- toEntity(Class<T>) - Method in interface org.springframework.web.client.RestClient.ResponseSpec
-
Return a
ResponseEntity
with the body decoded to an Object of the given type. - toEntity(ParameterizedTypeReference<T>) - Method in interface org.springframework.web.client.RestClient.ResponseSpec
-
Return a
ResponseEntity
with the body decoded to an Object of the given type. - TomcatHttpHandlerAdapter - Class in org.springframework.http.server.reactive
-
ServletHttpHandlerAdapter
extension that uses Tomcat APIs for reading from the request and writing to the response withByteBuffer
. - TomcatHttpHandlerAdapter(HttpHandler) - Constructor for class org.springframework.http.server.reactive.TomcatHttpHandlerAdapter
- TOO_EARLY - Enum constant in enum class org.springframework.http.HttpStatus
-
425 Too Early
. - TOO_MANY_REQUESTS - Enum constant in enum class org.springframework.http.HttpStatus
-
429 Too Many Requests
. - toResourceRegion(Resource) - Method in class org.springframework.http.HttpRange
-
Turn a
Resource
into aResourceRegion
using the range information contained in the currentHttpRange
. - toResourceRegions(List<HttpRange>, Resource) - Static method in class org.springframework.http.HttpRange
-
Convert each
HttpRange
into aResourceRegion
, selecting the appropriate segment of the givenResource
using HTTP Range information. - toSingleValueMap() - Method in class org.springframework.http.HttpHeaders
- toSingleValueMap() - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- toSingleValueMap() - Method in class org.springframework.http.support.JettyHeadersAdapter
- toSingleValueMap() - Method in class org.springframework.http.support.Netty4HeadersAdapter
- toSingleValueMap() - Method in class org.springframework.http.support.Netty5HeadersAdapter
- toString() - Method in class org.springframework.http.CacheControl
- toString() - Method in class org.springframework.http.client.reactive.ClientHttpRequestDecorator
- toString() - Method in class org.springframework.http.client.reactive.ClientHttpResponseDecorator
- toString() - Method in class org.springframework.http.codec.ServerSentEvent
- toString() - Method in class org.springframework.http.ContentDisposition
-
Return the header value for this content disposition as defined in RFC 6266.
- toString() - Method in class org.springframework.http.HttpCookie
- toString() - Method in class org.springframework.http.HttpEntity
- toString() - Method in class org.springframework.http.HttpHeaders
- toString() - Method in class org.springframework.http.HttpMethod
- toString() - Method in enum class org.springframework.http.HttpStatus
-
Return a string representation of this status code.
- toString() - Method in class org.springframework.http.ProblemDetail
- toString() - Method in class org.springframework.http.RequestEntity
- toString() - Method in class org.springframework.http.RequestEntity.UriTemplateRequestEntity
- toString() - Method in class org.springframework.http.ResponseCookie
- toString() - Method in class org.springframework.http.ResponseEntity
- toString() - Method in class org.springframework.http.server.reactive.ServerHttpRequestDecorator
- toString() - Method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
- toString() - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- toString() - Method in class org.springframework.http.support.JettyHeadersAdapter
- toString() - Method in class org.springframework.http.support.Netty4HeadersAdapter
- toString() - Method in class org.springframework.http.support.Netty5HeadersAdapter
- toString() - Method in class org.springframework.web.context.request.FacesWebRequest
- toString() - Method in class org.springframework.web.context.request.ServletRequestAttributes
- toString() - Method in class org.springframework.web.context.request.ServletWebRequest
- toString() - Method in class org.springframework.web.context.support.RequestHandledEvent
- toString() - Method in class org.springframework.web.context.support.ServletRequestHandledEvent
- toString() - Method in class org.springframework.web.method.ControllerAdviceBean
- toString() - Method in class org.springframework.web.method.HandlerMethod
- toString() - Method in class org.springframework.web.method.support.ModelAndViewContainer
-
Return diagnostic information.
- toString() - Method in class org.springframework.web.server.handler.WebHandlerDecorator
- toString() - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- toString() - Method in class org.springframework.web.util.pattern.PathPattern.PathMatchInfo
- toString() - Method in class org.springframework.web.util.pattern.PathPattern
- toString() - Method in class org.springframework.web.util.UriComponents
-
A simple pass-through to
UriComponents.toUriString()
. - toString() - Method in class org.springframework.web.util.UriTemplate
- toString(Collection<HttpRange>) - Static method in class org.springframework.http.HttpRange
-
Return a string representation of the given list of
HttpRange
objects. - toString(Collection<MediaType>) - Static method in class org.springframework.http.MediaType
-
Return a string representation of the given list of
MediaType
objects. - touchDataBuffer(DataBuffer) - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
-
Allow subclasses to associate a hint with the data buffer if it is a pooled buffer and supports leak tracking.
- toUri() - Method in class org.springframework.web.util.UriComponents
-
Create a
URI
from this instance as follows: - toUriString() - Method in interface org.springframework.web.util.UriBuilder
-
Return a String representation of the URI by concatenating all URI component values into the fully formed URI String.
- toUriString() - Method in class org.springframework.web.util.UriComponents
-
Concatenate all URI components to return the fully formed URI String.
- toUriString() - Method in class org.springframework.web.util.UriComponentsBuilder
-
Build a URI String.
- TRACE - Enum constant in enum class org.springframework.web.bind.annotation.RequestMethod
- TRACE - Static variable in class org.springframework.http.HttpMethod
-
The HTTP method
TRACE
. - TRAILER - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Trailer
header field name. - TRANSFER_ENCODING - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Transfer-Encoding
header field name. - transferTo(File) - Method in interface org.springframework.http.codec.multipart.FilePart
-
Convenience method to copy the content of the file in this part to the given destination file.
- transferTo(File) - Method in interface org.springframework.web.multipart.MultipartFile
-
Transfer the received file to the given destination file.
- transferTo(Path) - Method in interface org.springframework.http.codec.multipart.FilePart
-
Convenience method to copy the content of the file in this part to the given destination file.
- transferTo(Path) - Method in interface org.springframework.web.multipart.MultipartFile
-
Transfer the received file to the given destination file.
- transform(Source, Result) - Method in class org.springframework.http.converter.xml.AbstractXmlHttpMessageConverter
-
Transforms the given
Source
to theResult
. - transformUrl(String) - Method in class org.springframework.web.server.adapter.DefaultServerWebExchange
- transformUrl(String) - Method in interface org.springframework.web.server.ServerWebExchange
-
Transform the given url according to the registered transformation function(s).
- transformUrl(String) - Method in class org.springframework.web.server.ServerWebExchangeDecorator
- type(URI) - Method in interface org.springframework.web.ErrorResponse.Builder
-
Set the underlying
type
field. - typeIdResolverInstance(MapperConfig<?>, Annotated, Class<?>) - Method in class org.springframework.http.converter.json.SpringHandlerInstantiator
- typeMessageCode(String) - Method in interface org.springframework.web.ErrorResponse.Builder
-
Customize the
MessageSource
code to use to resolve the value forProblemDetail.setType(URI)
. - typeResolverBuilderInstance(MapperConfig<?>, Annotated, Class<?>) - Method in class org.springframework.http.converter.json.SpringHandlerInstantiator
- types() - Element in annotation interface org.springframework.web.bind.annotation.SessionAttributes
-
The types of session attributes in the model that should be stored in the session or some conversational storage.
U
- UNAUTHORIZED - Enum constant in enum class org.springframework.http.HttpStatus
-
401 Unauthorized
. - UNAVAILABLE_FOR_LEGAL_REASONS - Enum constant in enum class org.springframework.http.HttpStatus
-
451 Unavailable For Legal Reasons
. - UndertowHttpHandlerAdapter - Class in org.springframework.http.server.reactive
-
Adapt
HttpHandler
to the UndertowHttpHandler
. - UndertowHttpHandlerAdapter(HttpHandler) - Constructor for class org.springframework.http.server.reactive.UndertowHttpHandlerAdapter
- UnknownContentTypeException - Exception in org.springframework.web.client
-
Raised when no suitable
HttpMessageConverter
could be found to extract the response. - UnknownContentTypeException(Type, MediaType, int, String, HttpHeaders, byte[]) - Constructor for exception org.springframework.web.client.UnknownContentTypeException
-
Construct a new instance of with the given response data.
- UnknownContentTypeException(Type, MediaType, HttpStatusCode, String, HttpHeaders, byte[]) - Constructor for exception org.springframework.web.client.UnknownContentTypeException
-
Construct a new instance of with the given response data.
- UnknownHttpStatusCodeException - Exception in org.springframework.web.client
-
Exception thrown when an unknown (or custom) HTTP status code is received.
- UnknownHttpStatusCodeException(int, String, HttpHeaders, byte[], Charset) - Constructor for exception org.springframework.web.client.UnknownHttpStatusCodeException
-
Construct a new instance of
HttpStatusCodeException
based on a status code, status text, and response body content. - UnknownHttpStatusCodeException(String, int, String, HttpHeaders, byte[], Charset) - Constructor for exception org.springframework.web.client.UnknownHttpStatusCodeException
-
Construct a new instance of
HttpStatusCodeException
based on a status code, status text, and response body content. - UNPROCESSABLE_ENTITY - Enum constant in enum class org.springframework.http.HttpStatus
-
422 Unprocessable Entity
. - unprocessableEntity() - Static method in class org.springframework.http.ResponseEntity
-
Create a builder with an UNPROCESSABLE_ENTITY status.
- UNRESOLVABLE - Static variable in class org.springframework.web.multipart.support.MultipartResolutionDelegate
-
Indicates an unresolvable value.
- UNRESOLVED - Static variable in interface org.springframework.web.bind.support.WebArgumentResolver
-
Marker to be returned when the resolver does not know how to handle the given method parameter.
- UnsatisfiedRequestParameterException - Exception in org.springframework.web.server
-
ServerWebInputException
subclass that indicates an unsatisfied parameter condition, as typically expressed using an@RequestMapping
annotation at the@Controller
type level. - UnsatisfiedRequestParameterException(List<String>, MultiValueMap<String, String>) - Constructor for exception org.springframework.web.server.UnsatisfiedRequestParameterException
- UnsatisfiedServletRequestParameterException - Exception in org.springframework.web.bind
-
ServletRequestBindingException
subclass that indicates an unsatisfied parameter condition, as typically expressed using an@RequestMapping
annotation at the@Controller
type level. - UnsatisfiedServletRequestParameterException(String[], Map<String, String[]>) - Constructor for exception org.springframework.web.bind.UnsatisfiedServletRequestParameterException
-
Create a new UnsatisfiedServletRequestParameterException.
- UnsatisfiedServletRequestParameterException(List<String[]>, Map<String, String[]>) - Constructor for exception org.springframework.web.bind.UnsatisfiedServletRequestParameterException
-
Create a new UnsatisfiedServletRequestParameterException.
- UNSUPPORTED_MEDIA_TYPE - Enum constant in enum class org.springframework.http.HttpStatus
-
415 Unsupported Media Type
. - UnsupportedMediaTypeStatusException - Exception in org.springframework.web.server
-
Exception for errors that fit response status 415 (unsupported media type).
- UnsupportedMediaTypeStatusException(String) - Constructor for exception org.springframework.web.server.UnsupportedMediaTypeStatusException
-
Constructor for when the specified Content-Type is invalid.
- UnsupportedMediaTypeStatusException(String, List<MediaType>) - Constructor for exception org.springframework.web.server.UnsupportedMediaTypeStatusException
-
Constructor for when the specified Content-Type is invalid.
- UnsupportedMediaTypeStatusException(MediaType, List<MediaType>) - Constructor for exception org.springframework.web.server.UnsupportedMediaTypeStatusException
-
Constructor for when the Content-Type can be parsed but is not supported.
- UnsupportedMediaTypeStatusException(MediaType, List<MediaType>, ResolvableType) - Constructor for exception org.springframework.web.server.UnsupportedMediaTypeStatusException
-
Constructor for when trying to encode from or decode to a specific Java type.
- UnsupportedMediaTypeStatusException(MediaType, List<MediaType>, ResolvableType, HttpMethod) - Constructor for exception org.springframework.web.server.UnsupportedMediaTypeStatusException
-
Constructor for when trying to encode from or decode to a specific Java type.
- UnsupportedMediaTypeStatusException(MediaType, List<MediaType>, HttpMethod) - Constructor for exception org.springframework.web.server.UnsupportedMediaTypeStatusException
-
Constructor that provides the HTTP method.
- update(String, boolean, String) - Method in class org.springframework.web.service.invoker.AbstractNamedValueArgumentResolver.NamedValueInfo
- updateAccessedSessionAttributes() - Method in class org.springframework.web.context.request.AbstractRequestAttributes
-
Update all session attributes that have been accessed during request processing, to expose their potentially updated state to the underlying session manager.
- updateAccessedSessionAttributes() - Method in class org.springframework.web.context.request.ServletRequestAttributes
-
Update all accessed session attributes through
session.setAttribute
calls, explicitly indicating to the container that they might have been modified. - updateAndGetBody(MessageSource, Locale) - Method in interface org.springframework.web.ErrorResponse
-
Use the given
MessageSource
to resolve thetype
,title
, anddetail
message codes, and then use the resolved values to update the corresponding fields inErrorResponse.getBody()
. - updateAndGetBody(MessageSource, Locale) - Method in exception org.springframework.web.server.ResponseStatusException
- updateLastAccessTime(WebSession) - Method in class org.springframework.web.server.session.InMemoryWebSessionStore
- updateLastAccessTime(WebSession) - Method in interface org.springframework.web.server.session.WebSessionStore
-
Update the last accessed timestamp to "now".
- updateModel(NativeWebRequest, ModelAndViewContainer) - Method in class org.springframework.web.method.annotation.ModelFactory
-
Promote model attributes listed as
@SessionAttributes
to the session. - UPGRADE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Upgrade
header field name. - UPGRADE_REQUIRED - Enum constant in enum class org.springframework.http.HttpStatus
-
426 Upgrade Required
. - uri(String, Object...) - Method in interface org.springframework.web.client.RestClient.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.client.RestClient.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.client.RestClient.UriSpec
-
Specify the URI for the request using a URI template and URI variables.
- uri(URI) - Method in interface org.springframework.http.server.reactive.ServerHttpRequest.Builder
-
Set the URI to use with the following conditions: If
path
is also set, it overrides the path of the URI provided here. - uri(URI) - Method in interface org.springframework.web.client.RestClient.UriSpec
-
Specify the URI using an absolute, fully constructed
URI
. - uri(URI) - Method in class org.springframework.web.util.UriComponentsBuilder
-
Initialize components of this builder from components of the given URI.
- uri(Function<UriBuilder, URI>) - Method in interface org.springframework.web.client.RestClient.UriSpec
-
Specify the URI by through a
UriBuilder
. - uri(ClientRequestObservationContext) - Method in class org.springframework.http.client.observation.DefaultClientRequestObservationConvention
- uri(ServerRequestObservationContext) - Method in class org.springframework.http.server.observation.DefaultServerRequestObservationConvention
- uri(ServerRequestObservationContext) - Method in class org.springframework.http.server.reactive.observation.DefaultServerRequestObservationConvention
- URI - Enum constant in enum class org.springframework.http.client.observation.ClientHttpObservationDocumentation.LowCardinalityKeyNames
-
URI template used for HTTP request, or "none" if none was provided.
- URI - Enum constant in enum class org.springframework.http.server.observation.ServerHttpObservationDocumentation.LowCardinalityKeyNames
-
URI pattern for the matching handler if available, falling back to
REDIRECTION
for 3xx responses,NOT_FOUND
for 404 responses,root
for requests with no path info, andUNKNOWN
for all other requests. - URI - Enum constant in enum class org.springframework.http.server.reactive.observation.ServerHttpObservationDocumentation.LowCardinalityKeyNames
-
URI pattern for the matching handler if available, falling back to
REDIRECTION
for 3xx responses,NOT_FOUND
for 404 responses,root
for requests with no path info, andUNKNOWN
for all other requests. - URI_COMPONENT - Enum constant in enum class org.springframework.web.util.DefaultUriBuilderFactory.EncodingMode
-
Expand URI variables first, and then encode the resulting URI component values, replacing only non-ASCII and illegal (within a given URI component type) characters, but not characters with reserved meaning.
- URI_TOO_LONG - Enum constant in enum class org.springframework.http.HttpStatus
-
414 URI Too Long
. - UriBuilder - Interface in org.springframework.web.util
-
Builder-style methods to prepare and expand a URI template with variables.
- uriBuilderFactory(UriBuilderFactory) - Method in interface org.springframework.web.client.RestClient.Builder
-
Provide a pre-configured
UriBuilderFactory
instance. - UriBuilderFactory - Interface in org.springframework.web.util
-
Factory to create
UriBuilder
instances with shared configuration such as a base URI, an encoding mode strategy, and others across all URI builder instances created through a factory. - UriBuilderFactoryArgumentResolver - Class in org.springframework.web.service.invoker
- UriBuilderFactoryArgumentResolver() - Constructor for class org.springframework.web.service.invoker.UriBuilderFactoryArgumentResolver
- uriComponents(UriComponents) - Method in class org.springframework.web.util.UriComponentsBuilder
-
Set or append individual URI components of this builder from the values of the given
UriComponents
instance. - UriComponents - Class in org.springframework.web.util
-
Represents an immutable collection of URI components, mapping component type to String values.
- UriComponents(String, String) - Constructor for class org.springframework.web.util.UriComponents
- UriComponents.UriTemplateVariables - Interface in org.springframework.web.util
-
Defines the contract for URI Template variables.
- UriComponentsBuilder - Class in org.springframework.web.util
-
Builder for
UriComponents
. - UriComponentsBuilder() - Constructor for class org.springframework.web.util.UriComponentsBuilder
-
Default constructor.
- UriComponentsBuilder(UriComponentsBuilder) - Constructor for class org.springframework.web.util.UriComponentsBuilder
-
Create a deep copy of the given UriComponentsBuilder.
- UriComponentsContributor - Interface in org.springframework.web.method.support
-
Strategy for contributing to the building of a
UriComponents
by looking at a method parameter and an argument value and deciding what part of the target URL should be updated. - uriString(String) - Method in class org.springframework.web.util.DefaultUriBuilderFactory
- uriString(String) - Method in interface org.springframework.web.util.UriBuilderFactory
-
Initialize a builder with the given URI template.
- UriTemplate - Class in org.springframework.web.util
-
Representation of a URI template that can be expanded with URI variables via
UriTemplate.expand(Map)
,UriTemplate.expand(Object[])
, or matched to a URL viaUriTemplate.match(String)
. - UriTemplate(String) - Constructor for class org.springframework.web.util.UriTemplate
-
Construct a new
UriTemplate
with the given URI String. - UriTemplateHandler - Interface in org.springframework.web.util
-
Defines methods for expanding a URI template with variables.
- UriUtils - Class in org.springframework.web.util
-
Utility methods for URI encoding and decoding based on RFC 3986.
- UriUtils() - Constructor for class org.springframework.web.util.UriUtils
- uriVariables(Map<String, Object>) - Method in class org.springframework.web.util.UriComponentsBuilder
-
Configure URI variables to be expanded at build time.
- url() - Element in annotation interface org.springframework.web.service.annotation.DeleteExchange
-
Alias for
HttpExchange.url()
. - url() - Element in annotation interface org.springframework.web.service.annotation.GetExchange
-
Alias for
HttpExchange.url()
. - url() - Element in annotation interface org.springframework.web.service.annotation.HttpExchange
-
The URL for the request, either a full URL or a path only that is relative to a URL declared in a type-level
@HttpExchange
, and/or a globally configured base URL. - url() - Element in annotation interface org.springframework.web.service.annotation.PatchExchange
-
Alias for
HttpExchange.url()
. - url() - Element in annotation interface org.springframework.web.service.annotation.PostExchange
-
Alias for
HttpExchange.url()
. - url() - Element in annotation interface org.springframework.web.service.annotation.PutExchange
-
Alias for
HttpExchange.url()
. - UrlArgumentResolver - Class in org.springframework.web.service.invoker
-
HttpServiceArgumentResolver
that resolves the URL for the request from aURI
argument. - UrlArgumentResolver() - Constructor for class org.springframework.web.service.invoker.UrlArgumentResolver
- UrlBasedCorsConfigurationSource - Class in org.springframework.web.cors.reactive
-
CorsConfigurationSource
that uses URL patterns to select theCorsConfiguration
for a request. - UrlBasedCorsConfigurationSource - Class in org.springframework.web.cors
-
CorsConfigurationSource
that uses URL path patterns to select theCorsConfiguration
for a request. - UrlBasedCorsConfigurationSource() - Constructor for class org.springframework.web.cors.reactive.UrlBasedCorsConfigurationSource
-
Construct a new
UrlBasedCorsConfigurationSource
instance with defaultPathPatternParser
. - UrlBasedCorsConfigurationSource() - Constructor for class org.springframework.web.cors.UrlBasedCorsConfigurationSource
-
Default constructor with
PathPatternParser.defaultInstance
. - UrlBasedCorsConfigurationSource(PathPatternParser) - Constructor for class org.springframework.web.cors.reactive.UrlBasedCorsConfigurationSource
-
Construct a new
UrlBasedCorsConfigurationSource
instance from the suppliedPathPatternParser
. - UrlBasedCorsConfigurationSource(PathPatternParser) - Constructor for class org.springframework.web.cors.UrlBasedCorsConfigurationSource
-
Constructor with a
PathPatternParser
to parse patterns with. - UrlPathHelper - Class in org.springframework.web.util
-
Helper class for URL path matching.
- UrlPathHelper() - Constructor for class org.springframework.web.util.UrlPathHelper
- USE_PROXY - Enum constant in enum class org.springframework.http.HttpStatus
-
Deprecated.due to security concerns regarding in-band configuration of a proxy
- USER_AGENT - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
User-Agent
header field name. - userInfo(String) - Method in interface org.springframework.web.util.UriBuilder
-
Set the URI user info which may contain URI template variables, and may also be
null
to clear the user info of this builder. - userInfo(String) - Method in class org.springframework.web.util.UriComponentsBuilder
V
- validateAllowCredentials() - Method in class org.springframework.web.cors.CorsConfiguration
-
Validate that when
allowCredentials
istrue
,allowedOrigins
does not contain the special value"*"
since in that case the "Access-Control-Allow-Origin" cannot be set to"*"
. - validateAllowPrivateNetwork() - Method in class org.springframework.web.cors.CorsConfiguration
-
Validate that when
allowPrivateNetwork
istrue
,allowedOrigins
does not contain the special value"*"
since this is insecure. - validateArguments(Object, Method, MethodParameter[], Object[], Class<?>[]) - Method in class org.springframework.web.method.annotation.HandlerMethodValidator
- validateIfApplicable(WebDataBinder, MethodParameter) - Method in class org.springframework.web.method.annotation.ModelAttributeMethodProcessor
-
Validate the model attribute if applicable.
- validateReturnValue(Object, Method, MethodParameter, Object, Class<?>[]) - Method in class org.springframework.web.method.annotation.HandlerMethodValidator
- value() - Method in interface org.springframework.http.codec.multipart.FormFieldPart
-
Return the form field value.
- value() - Method in interface org.springframework.http.codec.multipart.FormPartEvent
-
Return the form field value.
- value() - Method in enum class org.springframework.http.HttpStatus.Series
-
Return the integer value of this status series.
- value() - Method in enum class org.springframework.http.HttpStatus
- value() - Method in interface org.springframework.http.HttpStatusCode
-
Return the integer value of this status code.
- value() - Method in interface org.springframework.http.server.PathContainer.Element
-
The unmodified, original value of this element.
- value() - Method in interface org.springframework.http.server.PathContainer
-
The original path from which this instance was parsed.
- value() - Element in annotation interface org.springframework.web.bind.annotation.BindParam
-
The lookup name to use for the bind value.
- value() - Element in annotation interface org.springframework.web.bind.annotation.ControllerAdvice
-
Alias for the
ControllerAdvice.basePackages()
attribute. - value() - Element in annotation interface org.springframework.web.bind.annotation.CookieValue
-
Alias for
CookieValue.name()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.CrossOrigin
-
Alias for
CrossOrigin.origins()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.DeleteMapping
-
Alias for
RequestMapping.value()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.ExceptionHandler
-
Exceptions handled by the annotated method.
- value() - Element in annotation interface org.springframework.web.bind.annotation.GetMapping
-
Alias for
RequestMapping.value()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.InitBinder
-
The names of command/form attributes and/or request parameters that this init-binder method is supposed to apply to.
- value() - Element in annotation interface org.springframework.web.bind.annotation.MatrixVariable
-
Alias for
MatrixVariable.name()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.ModelAttribute
-
Alias for
ModelAttribute.name()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.PatchMapping
-
Alias for
RequestMapping.value()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.PathVariable
-
Alias for
PathVariable.name()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.PostMapping
-
Alias for
RequestMapping.value()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.PutMapping
-
Alias for
RequestMapping.value()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.RequestAttribute
-
Alias for
RequestAttribute.name()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.RequestHeader
-
Alias for
RequestHeader.name()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.RequestMapping
-
The path mapping URIs — for example,
"/profile"
. - value() - Element in annotation interface org.springframework.web.bind.annotation.RequestParam
-
Alias for
RequestParam.name()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.RequestPart
-
Alias for
RequestPart.name()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.ResponseStatus
-
Alias for
ResponseStatus.code()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.RestController
-
The value may indicate a suggestion for a logical component name, to be turned into a Spring bean in case of an autodetected component.
- value() - Element in annotation interface org.springframework.web.bind.annotation.RestControllerAdvice
-
Alias for the
RestControllerAdvice.basePackages()
attribute. - value() - Element in annotation interface org.springframework.web.bind.annotation.SessionAttribute
-
Alias for
SessionAttribute.name()
. - value() - Element in annotation interface org.springframework.web.bind.annotation.SessionAttributes
-
Alias for
SessionAttributes.names()
. - value() - Element in annotation interface org.springframework.web.service.annotation.DeleteExchange
-
Alias for
HttpExchange.value()
. - value() - Element in annotation interface org.springframework.web.service.annotation.GetExchange
-
Alias for
HttpExchange.value()
. - value() - Element in annotation interface org.springframework.web.service.annotation.HttpExchange
-
This is an alias for
HttpExchange.url()
. - value() - Element in annotation interface org.springframework.web.service.annotation.PatchExchange
-
Alias for
HttpExchange.value()
. - value() - Element in annotation interface org.springframework.web.service.annotation.PostExchange
-
Alias for
HttpExchange.value()
. - value() - Element in annotation interface org.springframework.web.service.annotation.PutExchange
-
Alias for
HttpExchange.value()
. - value(String) - Method in interface org.springframework.http.ResponseCookie.ResponseCookieBuilder
-
Set the cookie value.
- valueBound(HttpSessionBindingEvent) - Method in class org.springframework.web.context.request.DestructionCallbackBindingListener
- ValueConstants - Interface in org.springframework.web.bind.annotation
-
Common value constants shared between bind annotations.
- valueInstantiatorInstance(MapperConfig<?>, Annotated, Class<?>) - Method in class org.springframework.http.converter.json.SpringHandlerInstantiator
- valueOf(int) - Static method in enum class org.springframework.http.HttpStatus.Series
-
Return the
Series
enum constant for the supplied status code. - valueOf(int) - Static method in enum class org.springframework.http.HttpStatus
-
Return the
HttpStatus
enum constant with the specified numeric value. - valueOf(int) - Static method in interface org.springframework.http.HttpStatusCode
-
Return an
HttpStatusCode
object for the given integer value. - valueOf(String) - Static method in enum class org.springframework.http.client.observation.ClientHttpObservationDocumentation.HighCardinalityKeyNames
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.http.client.observation.ClientHttpObservationDocumentation.LowCardinalityKeyNames
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.http.client.observation.ClientHttpObservationDocumentation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in class org.springframework.http.HttpMethod
-
Return an
HttpMethod
object for the given value. - valueOf(String) - Static method in enum class org.springframework.http.HttpStatus.Series
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.http.HttpStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in class org.springframework.http.MediaType
-
Parse the given String value into a
MediaType
object, with this method name following the 'valueOf' naming convention (as supported byConversionService
. - valueOf(String) - Static method in enum class org.springframework.http.server.observation.ServerHttpObservationDocumentation.HighCardinalityKeyNames
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.http.server.observation.ServerHttpObservationDocumentation.LowCardinalityKeyNames
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.http.server.observation.ServerHttpObservationDocumentation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.http.server.reactive.observation.ServerHttpObservationDocumentation.HighCardinalityKeyNames
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.http.server.reactive.observation.ServerHttpObservationDocumentation.LowCardinalityKeyNames
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.http.server.reactive.observation.ServerHttpObservationDocumentation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.web.bind.annotation.RequestMethod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.web.util.DefaultUriBuilderFactory.EncodingMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.web.util.pattern.PatternParseException.PatternMessage
-
Returns the enum constant of this class with the specified name.
- valueOf(HttpStatus) - Static method in enum class org.springframework.http.HttpStatus.Series
-
Deprecated.as of 5.3, in favor of invoking
HttpStatus.series()
directly - valueResolver(ServletRequest, WebDataBinder) - Static method in class org.springframework.web.bind.ServletRequestDataBinder
-
Return a
ServletRequest
DataBinder.ValueResolver
. - values() - Static method in enum class org.springframework.http.client.observation.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.http.client.observation.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.http.client.observation.ClientHttpObservationDocumentation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Method in class org.springframework.http.HttpHeaders
- values() - Static method in class org.springframework.http.HttpMethod
-
Returns an array containing the standard HTTP methods.
- values() - Static method in enum class org.springframework.http.HttpStatus.Series
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.http.HttpStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.http.server.observation.ServerHttpObservationDocumentation.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.http.server.observation.ServerHttpObservationDocumentation.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.http.server.observation.ServerHttpObservationDocumentation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.http.server.reactive.observation.ServerHttpObservationDocumentation.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.http.server.reactive.observation.ServerHttpObservationDocumentation.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.http.server.reactive.observation.ServerHttpObservationDocumentation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Method in class org.springframework.http.support.HttpComponentsHeadersAdapter
- values() - Method in class org.springframework.http.support.JettyHeadersAdapter
- values() - Method in class org.springframework.http.support.Netty4HeadersAdapter
- values() - Method in class org.springframework.http.support.Netty5HeadersAdapter
- values() - Static method in enum class org.springframework.web.bind.annotation.RequestMethod
-
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.util.DefaultUriBuilderFactory.EncodingMode
-
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.util.pattern.PatternParseException.PatternMessage
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VALUES_ONLY - Enum constant in enum class org.springframework.web.util.DefaultUriBuilderFactory.EncodingMode
-
Does not encode the URI template and instead applies strict encoding to URI variables via
UriUtils.encodeUriVariables(java.util.Map<java.lang.String, ?>)
prior to expanding them into the template. - valueToMatch() - Method in interface org.springframework.http.server.PathContainer.PathSegment
-
Return the path segment value, decoded and sanitized, for path matching.
- valueToMatchAsChars() - Method in interface org.springframework.http.server.PathContainer.PathSegment
-
Expose
PathContainer.PathSegment.valueToMatch()
as a character array. - valueUnbound(HttpSessionBindingEvent) - Method in class org.springframework.web.context.request.DestructionCallbackBindingListener
- VARIANT_ALSO_NEGOTIATES - Enum constant in enum class org.springframework.http.HttpStatus
-
506 Variant Also Negotiates
- VARY - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Vary
header field name. - varyBy(String...) - Method in interface org.springframework.http.ResponseEntity.HeadersBuilder
-
Configure one or more request header names (e.g.
- VIA - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Via
header field name. - virtualPropertyWriterInstance(MapperConfig<?>, Class<?>) - Method in class org.springframework.http.converter.json.SpringHandlerInstantiator
- visibility(PropertyAccessor, JsonAutoDetect.Visibility) - Method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Specify visibility to limit what kind of properties are auto-detected.
- visitResults(HandlerMethodValidationException.Visitor) - Method in exception org.springframework.web.method.annotation.HandlerMethodValidationException
-
Provide a
Visitor
to handleParameterValidationResult
s through callback methods organized by controller method parameter type.
W
- WARNING - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
Warning
header field name. - wasFailure() - Method in class org.springframework.web.context.support.RequestHandledEvent
-
Return whether the request failed.
- WEB_APP_ROOT_KEY_PARAM - Static variable in class org.springframework.web.util.WebUtils
-
Web app root key parameter at the servlet context level (i.e.
- WEB_APPLICATION_CONTEXT_VARIABLE_NAME - Static variable in class org.springframework.web.jsf.el.WebApplicationContextFacesELResolver
-
Name of the exposed WebApplicationContext variable: "webApplicationContext".
- WEB_ASYNC_MANAGER_ATTRIBUTE - Static variable in class org.springframework.web.context.request.async.WebAsyncUtils
-
The name attribute containing the
WebAsyncManager
. - WEB_HANDLER_BEAN_NAME - Static variable in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Well-known name for the target WebHandler in the bean factory.
- WEB_SESSION_MANAGER_BEAN_NAME - Static variable in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Well-known name for the WebSessionManager in the bean factory.
- WebApplicationContext - Interface in org.springframework.web.context
-
Interface to provide configuration for a web application.
- WebApplicationContextFacesELResolver - Class in org.springframework.web.jsf.el
-
Special JSF
ELResolver
that exposes the SpringWebApplicationContext
instance under a variable named "webApplicationContext". - WebApplicationContextFacesELResolver() - Constructor for class org.springframework.web.jsf.el.WebApplicationContextFacesELResolver
- WebApplicationContextUtils - Class in org.springframework.web.context.support
-
Convenience methods for retrieving the root
WebApplicationContext
for a givenServletContext
. - WebApplicationContextUtils() - Constructor for class org.springframework.web.context.support.WebApplicationContextUtils
- WebApplicationInitializer - Interface in org.springframework.web
-
Interface to be implemented in Servlet environments in order to configure the
ServletContext
programmatically -- as opposed to (or possibly in conjunction with) the traditionalweb.xml
-based approach. - WebApplicationObjectSupport - Class in org.springframework.web.context.support
-
Convenient superclass for application objects running in a
WebApplicationContext
. - WebApplicationObjectSupport() - Constructor for class org.springframework.web.context.support.WebApplicationObjectSupport
- WebAppRootListener - Class in org.springframework.web.util
-
Listener that sets a system property to the web application root directory.
- WebAppRootListener() - Constructor for class org.springframework.web.util.WebAppRootListener
- WebArgumentResolver - Interface in org.springframework.web.bind.support
-
SPI for resolving custom arguments for a specific handler method parameter.
- WebAsyncManager - Class in org.springframework.web.context.request.async
-
The central class for managing asynchronous request processing, mainly intended as an SPI and not typically used directly by application classes.
- WebAsyncTask<V> - Class in org.springframework.web.context.request.async
-
Holder for a
Callable
, a timeout value, and a task executor. - WebAsyncTask(long, Callable<V>) - Constructor for class org.springframework.web.context.request.async.WebAsyncTask
-
Create a
WebAsyncTask
with a timeout value and aCallable
. - WebAsyncTask(Long, String, Callable<V>) - Constructor for class org.springframework.web.context.request.async.WebAsyncTask
-
Create a
WebAsyncTask
with a timeout value, an executor name, and aCallable
. - WebAsyncTask(Long, AsyncTaskExecutor, Callable<V>) - Constructor for class org.springframework.web.context.request.async.WebAsyncTask
-
Create a
WebAsyncTask
with a timeout value, an executor instance, and a Callable. - WebAsyncTask(Callable<V>) - Constructor for class org.springframework.web.context.request.async.WebAsyncTask
-
Create a
WebAsyncTask
wrapping the givenCallable
. - WebAsyncUtils - Class in org.springframework.web.context.request.async
-
Utility methods related to processing asynchronous web requests.
- WebAsyncUtils() - Constructor for class org.springframework.web.context.request.async.WebAsyncUtils
- WebBindingInitializer - Interface in org.springframework.web.bind.support
-
Callback interface for initializing a
WebDataBinder
for performing data binding in the context of a specific web request. - WebDataBinder - Class in org.springframework.web.bind
-
Special
DataBinder
for data binding from web request parameters to JavaBean objects. - WebDataBinder(Object) - Constructor for class org.springframework.web.bind.WebDataBinder
-
Create a new WebDataBinder instance, with default object name.
- WebDataBinder(Object, String) - Constructor for class org.springframework.web.bind.WebDataBinder
-
Create a new WebDataBinder instance.
- WebDataBinderFactory - Interface in org.springframework.web.bind.support
-
A factory for creating a
WebDataBinder
instance for a named target object. - WebExceptionHandler - Interface in org.springframework.web.server
-
Contract for handling exceptions during web server exchange processing.
- WebExchangeBindException - Exception in org.springframework.web.bind.support
-
ServerWebInputException
subclass that indicates a data binding or validation failure. - WebExchangeBindException(MethodParameter, BindingResult) - Constructor for exception org.springframework.web.bind.support.WebExchangeBindException
- WebExchangeDataBinder - Class in org.springframework.web.bind.support
-
Specialized
DataBinder
to perform data binding from URL query parameters or form data in the request data to Java objects. - WebExchangeDataBinder(Object) - Constructor for class org.springframework.web.bind.support.WebExchangeDataBinder
-
Create a new instance, with default object name.
- WebExchangeDataBinder(Object, String) - Constructor for class org.springframework.web.bind.support.WebExchangeDataBinder
-
Create a new instance.
- WebFilter - Interface in org.springframework.web.server
-
Contract for interception-style, chained processing of Web requests that may be used to implement cross-cutting, application-agnostic requirements such as security, timeouts, and others.
- WebFilterChain - Interface in org.springframework.web.server
-
Contract to allow a
WebFilter
to delegate to the next in the chain. - webHandler(WebHandler) - Static method in class org.springframework.web.server.adapter.WebHttpHandlerBuilder
-
Static factory method to create a new builder instance.
- WebHandler - Interface in org.springframework.web.server
-
Contract to handle a web request.
- WebHandlerDecorator - Class in org.springframework.web.server.handler
-
WebHandler
that decorates and delegates to anotherWebHandler
. - WebHandlerDecorator(WebHandler) - Constructor for class org.springframework.web.server.handler.WebHandlerDecorator
-
Create a
WebHandlerDecorator
for the given delegate. - WebHttpHandlerBuilder - Class in org.springframework.web.server.adapter
-
This builder has two purposes:
- WebHttpHandlerBuilder.SpringWebBlockHoundIntegration - Class in org.springframework.web.server.adapter
-
BlockHoundIntegration
for spring-web classes. - WebRequest - Interface in org.springframework.web.context.request
-
Generic interface for a web request.
- WebRequestDataBinder - Class in org.springframework.web.bind.support
-
Special
DataBinder
to perform data binding from web request parameters to JavaBeans, including support for multipart files. - WebRequestDataBinder(Object) - Constructor for class org.springframework.web.bind.support.WebRequestDataBinder
-
Create a new WebRequestDataBinder instance, with default object name.
- WebRequestDataBinder(Object, String) - Constructor for class org.springframework.web.bind.support.WebRequestDataBinder
-
Create a new WebRequestDataBinder instance.
- WebRequestInterceptor - Interface in org.springframework.web.context.request
-
Interface for general web request interception.
- WebSession - Interface in org.springframework.web.server
-
Main contract for using a server-side session that provides access to session attributes across HTTP requests.
- WebSessionIdResolver - Interface in org.springframework.web.server.session
-
Contract for session ID resolution strategies.
- WebSessionManager - Interface in org.springframework.web.server.session
-
Main class for access to the
WebSession
for an HTTP request. - WebSessionStore - Interface in org.springframework.web.server.session
-
Strategy for
WebSession
persistence. - WebUtils - Class in org.springframework.web.util
-
Miscellaneous utilities for web applications.
- WebUtils() - Constructor for class org.springframework.web.util.WebUtils
- withDefaultCodecConfig(Consumer<CodecConfigurer.DefaultCodecConfig>) - Method in interface org.springframework.http.codec.CodecConfigurer.CustomCodecs
-
Deprecated.
- writableHttpHeaders(HttpHeaders) - Static method in class org.springframework.http.HttpHeaders
-
Remove any read-only wrapper that may have been previously applied around the given headers via
HttpHeaders.readOnlyHttpHeaders(HttpHeaders)
. - write(BufferedImage, MediaType, HttpOutputMessage) - Method in class org.springframework.http.converter.BufferedImageHttpMessageConverter
- write(Publisher<?>, ResolvableType, ResolvableType, MediaType, ServerHttpRequest, ServerHttpResponse, Map<String, Object>) - Method in class org.springframework.http.codec.ServerSentEventHttpMessageWriter
- write(Publisher<?>, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.ServerSentEventHttpMessageWriter
- write(Publisher<? extends Message>, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.protobuf.ProtobufHttpMessageWriter
- write(Publisher<? extends Resource>, ResolvableType, ResolvableType, MediaType, ServerHttpRequest, ServerHttpResponse, Map<String, Object>) - Method in class org.springframework.http.codec.ResourceHttpMessageWriter
- write(Publisher<? extends Resource>, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.ResourceHttpMessageWriter
- write(Publisher<? extends Part>, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.multipart.PartHttpMessageWriter
- write(Publisher<? extends PartEvent>, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.multipart.PartEventHttpMessageWriter
- write(Publisher<? extends MultiValueMap<String, ?>>, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.multipart.MultipartHttpMessageWriter
- write(Publisher<? extends MultiValueMap<String, String>>, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.FormHttpMessageWriter
- write(Publisher<? extends T>, ResolvableType, ResolvableType, MediaType, ServerHttpRequest, ServerHttpResponse, Map<String, Object>) - Method in class org.springframework.http.codec.EncoderHttpMessageWriter
- write(Publisher<? extends T>, ResolvableType, ResolvableType, MediaType, ServerHttpRequest, ServerHttpResponse, Map<String, Object>) - Method in interface org.springframework.http.codec.HttpMessageWriter
-
Server-side only alternative to
HttpMessageWriter.write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map)
with additional context available. - write(Publisher<? extends T>, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map<String, Object>) - Method in class org.springframework.http.codec.EncoderHttpMessageWriter
- write(Publisher<? extends T>, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map<String, Object>) - Method in interface org.springframework.http.codec.HttpMessageWriter
-
Write a given stream of object to the output message.
- write(MultiValueMap<String, ?>, MediaType, HttpOutputMessage) - Method in class org.springframework.http.converter.FormHttpMessageConverter
- write(T) - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
-
Write the given item.
- write(T, Type, MediaType, HttpOutputMessage) - Method in class org.springframework.http.converter.AbstractGenericHttpMessageConverter
-
This implementation sets the default headers by calling
AbstractHttpMessageConverter.addDefaultHeaders(org.springframework.http.HttpHeaders, T, org.springframework.http.MediaType)
, and then callsAbstractGenericHttpMessageConverter.writeInternal(T, org.springframework.http.HttpOutputMessage)
. - write(T, Type, MediaType, HttpOutputMessage) - Method in interface org.springframework.http.converter.GenericHttpMessageConverter
-
Write a given object to the given output message.
- write(T, Type, MediaType, HttpOutputMessage) - Method in class org.springframework.http.converter.xml.Jaxb2CollectionHttpMessageConverter
- write(T, MediaType, HttpOutputMessage) - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
-
This implementation sets the default headers by calling
AbstractHttpMessageConverter.addDefaultHeaders(org.springframework.http.HttpHeaders, T, org.springframework.http.MediaType)
, and then callsAbstractHttpMessageConverter.writeInternal(T, org.springframework.http.HttpOutputMessage)
. - write(T, MediaType, HttpOutputMessage) - Method in interface org.springframework.http.converter.HttpMessageConverter
-
Write a given object to the given output message.
- writeAndFlushWith(Publisher<? extends Publisher<? extends DataBuffer>>) - Method in class org.springframework.http.client.reactive.ClientHttpRequestDecorator
- writeAndFlushWith(Publisher<? extends Publisher<? extends DataBuffer>>) - Method in interface org.springframework.http.ReactiveHttpOutputMessage
-
Use the given
Publisher
ofPublishers
to write the body of the HttpOutputMessage to the underlying HTTP layer, flushing after eachPublisher<DataBuffer>
. - writeAndFlushWith(Publisher<? extends Publisher<? extends DataBuffer>>) - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
- writeAndFlushWith(Publisher<? extends Publisher<? extends DataBuffer>>) - Method in class org.springframework.http.server.reactive.HttpHeadResponseDecorator
-
Invoke
ServerHttpResponseDecorator.setComplete()
without writing. - writeAndFlushWith(Publisher<? extends Publisher<? extends DataBuffer>>) - Method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
- writeAndFlushWithInternal(Publisher<? extends Publisher<? extends DataBuffer>>) - Method in class org.springframework.http.server.reactive.AbstractListenerServerHttpResponse
- writeAndFlushWithInternal(Publisher<? extends Publisher<? extends DataBuffer>>) - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
-
Write to the underlying the response, and flush after each
Publisher<DataBuffer>
. - writeContent(Resource, HttpOutputMessage) - Method in class org.springframework.http.converter.ResourceHttpMessageConverter
- writeInternal(byte[], HttpOutputMessage) - Method in class org.springframework.http.converter.ByteArrayHttpMessageConverter
- writeInternal(Message, HttpOutputMessage) - Method in class org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter
- writeInternal(Object, Type, Writer) - Method in class org.springframework.http.converter.json.AbstractJsonHttpMessageConverter
-
Template method that writes the JSON-bound object to the given
Writer
. - writeInternal(Object, Type, Writer) - Method in class org.springframework.http.converter.json.GsonHttpMessageConverter
- writeInternal(Object, Type, Writer) - Method in class org.springframework.http.converter.json.JsonbHttpMessageConverter
- writeInternal(Object, Type, HttpOutputMessage) - Method in class org.springframework.http.converter.AbstractKotlinSerializationHttpMessageConverter
- writeInternal(Object, Type, HttpOutputMessage) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
- writeInternal(Object, Type, HttpOutputMessage) - Method in class org.springframework.http.converter.json.AbstractJsonHttpMessageConverter
- writeInternal(Object, Type, HttpOutputMessage) - Method in class org.springframework.http.converter.ResourceRegionHttpMessageConverter
- writeInternal(Object, KSerializer<Object>, T, HttpOutputMessage) - Method in class org.springframework.http.converter.AbstractKotlinSerializationHttpMessageConverter
-
Write the given object to the output message with the given serializer and format.
- writeInternal(Object, KSerializer<Object>, T, HttpOutputMessage) - Method in class org.springframework.http.converter.KotlinSerializationBinaryHttpMessageConverter
- writeInternal(Object, KSerializer<Object>, T, HttpOutputMessage) - Method in class org.springframework.http.converter.KotlinSerializationStringHttpMessageConverter
- writeInternal(Object, HttpOutputMessage) - Method in class org.springframework.http.converter.ObjectToStringHttpMessageConverter
- writeInternal(String, HttpOutputMessage) - Method in class org.springframework.http.converter.StringHttpMessageConverter
- writeInternal(Resource, HttpOutputMessage) - Method in class org.springframework.http.converter.ResourceHttpMessageConverter
- writeInternal(T, Type, HttpOutputMessage) - Method in class org.springframework.http.converter.AbstractGenericHttpMessageConverter
-
Abstract template method that writes the actual body.
- writeInternal(T, HttpOutputMessage) - Method in class org.springframework.http.converter.AbstractGenericHttpMessageConverter
- writeInternal(T, HttpOutputMessage) - Method in class org.springframework.http.converter.AbstractHttpMessageConverter
-
Abstract template method that writes the actual body.
- writeInternal(T, HttpOutputMessage) - Method in class org.springframework.http.converter.feed.AbstractWireFeedHttpMessageConverter
- writeInternal(T, HttpOutputMessage) - Method in class org.springframework.http.converter.xml.AbstractXmlHttpMessageConverter
- writeInternal(T, HttpOutputMessage) - Method in class org.springframework.http.converter.xml.SourceHttpMessageConverter
- writePrefix(JsonGenerator, Object) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
-
Write a prefix before the main content.
- writePrefix(JsonGenerator, Object) - Method in class org.springframework.http.converter.json.MappingJackson2HttpMessageConverter
- writer(HttpMessageWriter<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.CustomCodecs
-
Deprecated.as of 5.1.13, use
CodecConfigurer.CustomCodecs.register(Object)
orCodecConfigurer.CustomCodecs.registerWithDefaultConfig(Object)
instead. - writer(HttpMessageWriter<?>) - Method in interface org.springframework.http.codec.CodecConfigurer.MultipartCodecs
-
Add a Part
HttpMessageWriter
. - writeResourceRegion(ResourceRegion, HttpOutputMessage) - Method in class org.springframework.http.converter.ResourceRegionHttpMessageConverter
- writeSuffix(JsonGenerator, Object) - Method in class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
-
Write a suffix after the main content.
- writeTo(OutputStream) - Method in interface org.springframework.http.StreamingHttpOutputMessage.Body
-
Write this body to the given
OutputStream
. - writeToResult(Object, HttpHeaders, Result) - Method in class org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter
- writeToResult(Object, HttpHeaders, Result) - Method in class org.springframework.http.converter.xml.MarshallingHttpMessageConverter
- writeToResult(T, HttpHeaders, Result) - Method in class org.springframework.http.converter.xml.AbstractXmlHttpMessageConverter
-
Abstract template method called from
AbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage)
. - writeToResult(T, HttpHeaders, Result) - Method in class org.springframework.http.converter.xml.Jaxb2CollectionHttpMessageConverter
- writeWith(File, long, long) - Method in interface org.springframework.http.ZeroCopyHttpOutputMessage
-
Use the given
File
to write the body of the message to the underlying HTTP layer. - writeWith(Path, long, long) - Method in interface org.springframework.http.ZeroCopyHttpOutputMessage
-
Use the given
Path
to write the body of the message to the underlying HTTP layer. - writeWith(Publisher<? extends DataBuffer>) - Method in class org.springframework.http.client.reactive.ClientHttpRequestDecorator
- writeWith(Publisher<? extends DataBuffer>) - Method in interface org.springframework.http.ReactiveHttpOutputMessage
-
Use the given
Publisher
to write the body of the message to the underlying HTTP layer. - writeWith(Publisher<? extends DataBuffer>) - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
- writeWith(Publisher<? extends DataBuffer>) - Method in class org.springframework.http.server.reactive.HttpHeadResponseDecorator
-
Consume and release the body without writing.
- writeWith(Publisher<? extends DataBuffer>) - Method in class org.springframework.http.server.reactive.ServerHttpResponseDecorator
- writeWithInternal(Publisher<? extends DataBuffer>) - Method in class org.springframework.http.server.reactive.AbstractListenerServerHttpResponse
- writeWithInternal(Publisher<? extends DataBuffer>) - Method in class org.springframework.http.server.reactive.AbstractServerHttpResponse
-
Write to the underlying the response.
- writingComplete() - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
-
Invoked after onComplete or onError notification.
- writingFailed(Throwable) - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
-
Invoked when an I/O error occurs during a write.
- writingPaused() - Method in class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
-
Deprecated.originally introduced for Undertow to stop write notifications when no data is available, but deprecated as of 5.0.6 since constant switching on every requested item causes a significant slowdown.
- WWW_AUTHENTICATE - Static variable in class org.springframework.http.HttpHeaders
-
The HTTP
WWW-Authenticate
header field name.
X
- X_PROTOBUF_MESSAGE_HEADER - Static variable in class org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter
-
The HTTP header containing the protobuf message.
- X_PROTOBUF_SCHEMA_HEADER - Static variable in class org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter
-
The HTTP header containing the protobuf schema.
- xml() - Static method in class org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
-
Obtain a
Jackson2ObjectMapperBuilder
instance in order to build anXmlMapper
instance. - XmlEventDecoder - Class in org.springframework.http.codec.xml
-
Decodes a
DataBuffer
stream into a stream ofXMLEvents
. - XmlEventDecoder() - Constructor for class org.springframework.http.codec.xml.XmlEventDecoder
- XmlWebApplicationContext - Class in org.springframework.web.context.support
-
WebApplicationContext
implementation which takes its configuration from XML documents, understood by anXmlBeanDefinitionReader
. - XmlWebApplicationContext() - Constructor for class org.springframework.web.context.support.XmlWebApplicationContext
Z
- ZeroCopyHttpOutputMessage - Interface in org.springframework.http
-
Sub-interface of
ReactiveOutputMessage
that has support for "zero-copy" file transfers.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form