Package | Description |
---|---|
org.springframework.http |
Contains a basic abstraction over client/server-side HTTP.
|
org.springframework.http.client |
Contains an abstraction over client-side HTTP.
|
org.springframework.http.client.reactive |
Abstractions for reactive HTTP client support including
ClientHttpRequest and
ClientHttpResponse as well as a
ClientHttpConnector . |
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.multipart |
Multipart support.
|
org.springframework.http.converter |
Provides an HttpMessageConverter abstraction to convert between Java objects and HTTP input/output messages.
|
org.springframework.http.converter.json |
Provides HttpMessageConverter implementations for handling JSON.
|
org.springframework.http.converter.xml |
Provides HttpMessageConverter implementations for handling XML.
|
org.springframework.http.server |
Contains an abstraction over server-side HTTP.
|
org.springframework.http.server.reactive |
Abstractions for reactive HTTP server support including a
ServerHttpRequest and
ServerHttpResponse along with an
HttpHandler for processing. |
org.springframework.mock.http |
Mock implementations of client/server-side HTTP abstractions.
|
org.springframework.mock.http.client.reactive |
Mock implementations of reactive HTTP client contracts.
|
org.springframework.mock.web |
A comprehensive set of Servlet API 4.0 mock objects, targeted at usage with
Spring's Web MVC framework.
|
org.springframework.mock.web.reactive.function.server |
Mock objects for the functional web framework.
|
org.springframework.test.web.client.response |
Contains built-in
ResponseCreator
implementations. |
org.springframework.test.web.reactive.server |
Support for testing Spring WebFlux server endpoints via
WebTestClient . |
org.springframework.test.web.servlet.request |
Contains built-in
RequestBuilder
implementations. |
org.springframework.test.web.servlet.result |
Contains built-in
ResultMatcher and ResultHandler implementations. |
org.springframework.web.client |
Core package of the client-side web support.
|
org.springframework.web.multipart |
Multipart resolution framework for handling file uploads.
|
org.springframework.web.multipart.support |
Support classes for the multipart resolution framework.
|
org.springframework.web.reactive.function.client |
Provides a reactive
WebClient
that builds on top of the
org.springframework.http.client.reactive reactive HTTP adapter layer. |
org.springframework.web.reactive.function.client.support |
Classes supporting the
org.springframework.web.reactive.function.client package. |
org.springframework.web.reactive.function.server |
Provides the types that make up Spring's functional web framework for Reactive environments.
|
org.springframework.web.reactive.function.server.support |
Classes supporting the
org.springframework.web.reactive.function.server package. |
org.springframework.web.reactive.resource |
Support classes for serving static resources.
|
org.springframework.web.reactive.result.view |
Support for result handling through view resolution.
|
org.springframework.web.reactive.socket |
Abstractions and support classes for reactive WebSocket interactions.
|
org.springframework.web.reactive.socket.client |
Client support for WebSocket interactions.
|
org.springframework.web.server |
Core interfaces and classes for Spring's generic, reactive web support.
|
org.springframework.web.servlet |
Provides servlets that integrate with the application context
infrastructure, and the core interfaces and classes for the
Spring web MVC framework.
|
org.springframework.web.servlet.function |
Provides the types that make up Spring's functional web framework for Servlet environments.
|
org.springframework.web.servlet.mvc.method.annotation |
MVC infrastructure for annotation-based handler method processing, building on the
org.springframework.web.method.annotation package. |
org.springframework.web.servlet.resource |
Support classes for serving static resources.
|
org.springframework.web.socket |
Common abstractions and Spring configuration support for WebSocket applications.
|
org.springframework.web.socket.adapter.jetty |
Adapter classes for the Jetty WebSocket API.
|
org.springframework.web.socket.adapter.standard |
Adapter classes for the standard Java WebSocket API.
|
org.springframework.web.socket.client |
Client-side abstractions for WebSocket applications.
|
org.springframework.web.socket.client.jetty |
Client-side support for the Jetty WebSocket API.
|
org.springframework.web.socket.client.standard |
Client-side classes for use with standard Java WebSocket endpoints.
|
org.springframework.web.socket.handler |
Convenient
WebSocketHandler
implementations and decorators. |
org.springframework.web.socket.sockjs.client |
SockJS client implementation of
WebSocketClient . |
org.springframework.web.socket.sockjs.transport.session |
SockJS specific implementations of
WebSocketSession . |
Modifier and Type | Field and Description |
---|---|
static HttpHeaders |
HttpHeaders.EMPTY
An empty
HttpHeaders instance (immutable). |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
HttpMessage.getHeaders()
Return the headers of this message.
|
HttpHeaders |
HttpEntity.getHeaders()
Returns the headers of this entity.
|
static HttpHeaders |
HttpHeaders.readOnlyHttpHeaders(HttpHeaders headers)
Apply a read-only
HttpHeaders wrapper around the given headers, if necessary. |
static HttpHeaders |
HttpHeaders.readOnlyHttpHeaders(MultiValueMap<String,String> headers)
Apply a read-only
HttpHeaders wrapper around the given headers, if necessary. |
static HttpHeaders |
HttpHeaders.writableHttpHeaders(HttpHeaders headers)
Remove any read-only wrapper that may have been previously applied around
the given headers via
readOnlyHttpHeaders(HttpHeaders) . |
Modifier and Type | Method and Description |
---|---|
B |
ResponseEntity.HeadersBuilder.headers(HttpHeaders headers)
Copy the given headers into the entity's headers map.
|
B |
RequestEntity.HeadersBuilder.headers(HttpHeaders headers)
Copy the given headers into the entity's headers map.
|
static HttpHeaders |
HttpHeaders.readOnlyHttpHeaders(HttpHeaders headers)
Apply a read-only
HttpHeaders wrapper around the given headers, if necessary. |
static HttpHeaders |
HttpHeaders.writableHttpHeaders(HttpHeaders headers)
Remove any read-only wrapper that may have been previously applied around
the given headers via
readOnlyHttpHeaders(HttpHeaders) . |
Modifier and Type | Method and Description |
---|---|
B |
ResponseEntity.HeadersBuilder.headers(Consumer<HttpHeaders> headersConsumer)
Manipulate this entity's headers with the given consumer.
|
B |
RequestEntity.HeadersBuilder.headers(Consumer<HttpHeaders> headersConsumer)
Manipulate this entity's headers with the given consumer.
|
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
AbstractClientHttpRequest.getHeaders() |
Modifier and Type | Method and Description |
---|---|
protected abstract ClientHttpResponse |
AbstractClientHttpRequest.executeInternal(HttpHeaders headers)
Abstract template method that writes the given headers and content to the HTTP request.
|
protected abstract OutputStream |
AbstractClientHttpRequest.getBodyInternal(HttpHeaders headers)
Abstract template method that returns the body.
|
Modifier and Type | Method and Description |
---|---|
MultipartBodyBuilder.PartBuilder |
MultipartBodyBuilder.PartBuilder.headers(Consumer<HttpHeaders> headersConsumer)
Manipulate the part headers through the given consumer.
|
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
ClientHttpResponseDecorator.getHeaders() |
HttpHeaders |
ClientHttpRequestDecorator.getHeaders() |
HttpHeaders |
AbstractClientHttpRequest.getHeaders() |
HttpHeaders |
AbstractClientHttpResponse.getHeaders() |
protected HttpHeaders |
AbstractClientHttpRequest.initReadOnlyHeaders()
Initialize the read-only headers after the request is committed.
|
Constructor and Description |
---|
AbstractClientHttpRequest(HttpHeaders headers) |
AbstractClientHttpResponse(int statusCode,
HttpHeaders headers,
MultiValueMap<String,ResponseCookie> cookies,
reactor.core.publisher.Flux<DataBuffer> body) |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
HttpRequestWrapper.getHeaders()
Return the headers of the wrapped request.
|
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
Part.headers()
Return the headers associated with the part.
|
Modifier and Type | Method and Description |
---|---|
protected reactor.core.publisher.Mono<DataBuffer> |
MultipartWriterSupport.generatePartHeaders(HttpHeaders headers,
DataBufferFactory bufferFactory) |
Modifier and Type | Method and Description |
---|---|
protected void |
StringHttpMessageConverter.addDefaultHeaders(HttpHeaders headers,
String s,
MediaType type) |
protected void |
AbstractHttpMessageConverter.addDefaultHeaders(HttpHeaders headers,
T t,
MediaType contentType)
Add default headers to the output message.
|
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
MappingJacksonInputMessage.getHeaders() |
Constructor and Description |
---|
MappingJacksonInputMessage(InputStream body,
HttpHeaders headers) |
MappingJacksonInputMessage(InputStream body,
HttpHeaders headers,
Class<?> deserializationView) |
Modifier and Type | Method and Description |
---|---|
protected Object |
MarshallingHttpMessageConverter.readFromSource(Class<?> clazz,
HttpHeaders headers,
Source source) |
protected Object |
Jaxb2RootElementHttpMessageConverter.readFromSource(Class<?> clazz,
HttpHeaders headers,
Source source) |
protected T |
Jaxb2CollectionHttpMessageConverter.readFromSource(Class<? extends T> clazz,
HttpHeaders headers,
Source source) |
protected abstract T |
AbstractXmlHttpMessageConverter.readFromSource(Class<? extends T> clazz,
HttpHeaders headers,
Source source)
Abstract template method called from
AbstractHttpMessageConverter.read(Class, HttpInputMessage) . |
protected void |
MarshallingHttpMessageConverter.writeToResult(Object o,
HttpHeaders headers,
Result result) |
protected void |
Jaxb2RootElementHttpMessageConverter.writeToResult(Object o,
HttpHeaders headers,
Result result) |
protected void |
Jaxb2CollectionHttpMessageConverter.writeToResult(T t,
HttpHeaders headers,
Result result) |
protected abstract void |
AbstractXmlHttpMessageConverter.writeToResult(T t,
HttpHeaders headers,
Result result)
Abstract template method called from
AbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage) . |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
ServletServerHttpResponse.getHeaders() |
HttpHeaders |
ServletServerHttpRequest.getHeaders() |
HttpHeaders |
DelegatingServerHttpResponse.getHeaders() |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
AbstractServerHttpResponse.getHeaders() |
HttpHeaders |
ServerHttpRequestDecorator.getHeaders() |
HttpHeaders |
AbstractServerHttpRequest.getHeaders() |
HttpHeaders |
ServerHttpResponseDecorator.getHeaders() |
Modifier and Type | Method and Description |
---|---|
ServerHttpRequest.Builder |
ServerHttpRequest.Builder.headers(Consumer<HttpHeaders> headersConsumer)
Manipulate request headers.
|
Constructor and Description |
---|
AbstractListenerServerHttpResponse(DataBufferFactory bufferFactory,
HttpHeaders headers) |
AbstractServerHttpRequest(URI uri,
String contextPath,
HttpHeaders headers)
Constructor with the URI and headers for the request.
|
AbstractServerHttpResponse(DataBufferFactory dataBufferFactory,
HttpHeaders headers) |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
MockHttpInputMessage.getHeaders() |
HttpHeaders |
MockHttpOutputMessage.getHeaders()
Return the headers.
|
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
MockClientHttpResponse.getHeaders() |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
MockPart.getHeaders()
Return the
HttpHeaders backing header related accessor methods,
allowing for populating selected header entries. |
HttpHeaders |
MockMultipartHttpServletRequest.getMultipartHeaders(String paramOrFileName) |
HttpHeaders |
MockMultipartHttpServletRequest.getRequestHeaders() |
Modifier and Type | Method and Description |
---|---|
MockServerRequest.Builder |
MockServerRequest.Builder.headers(HttpHeaders headers) |
Modifier and Type | Method and Description |
---|---|
DefaultResponseCreator |
DefaultResponseCreator.headers(HttpHeaders headers)
Copy all given headers.
|
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
ExchangeResult.getRequestHeaders()
Return the request headers sent to the server.
|
HttpHeaders |
ExchangeResult.getResponseHeaders()
Return the response headers received from the server.
|
Modifier and Type | Method and Description |
---|---|
WebTestClient.Builder |
WebTestClient.Builder.defaultHeaders(Consumer<HttpHeaders> headersConsumer)
Manipulate the default headers with the given consumer.
|
S |
WebTestClient.RequestHeadersSpec.headers(Consumer<HttpHeaders> headersConsumer)
Manipulate the request's headers with the given consumer.
|
Modifier and Type | Method and Description |
---|---|
MockHttpServletRequestBuilder |
MockHttpServletRequestBuilder.headers(HttpHeaders httpHeaders)
Add all headers to the request.
|
Modifier and Type | Method and Description |
---|---|
protected HttpHeaders |
PrintingResultHandler.getRequestHeaders(MockHttpServletRequest request) |
protected HttpHeaders |
PrintingResultHandler.getResponseHeaders(MockHttpServletResponse response) |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
UnknownContentTypeException.getResponseHeaders()
Return the HTTP response headers.
|
HttpHeaders |
RestClientResponseException.getResponseHeaders()
Return the HTTP response headers.
|
HttpHeaders |
RestOperations.headForHeaders(String url,
Map<String,?> uriVariables)
Retrieve all headers of the resource specified by the URI template.
|
HttpHeaders |
RestTemplate.headForHeaders(String url,
Map<String,?> uriVariables) |
HttpHeaders |
RestOperations.headForHeaders(String url,
Object... uriVariables)
Retrieve all headers of the resource specified by the URI template.
|
HttpHeaders |
RestTemplate.headForHeaders(String url,
Object... uriVariables) |
HttpHeaders |
RestOperations.headForHeaders(URI url)
Retrieve all headers of the resource specified by the URL.
|
HttpHeaders |
RestTemplate.headForHeaders(URI url) |
Modifier and Type | Method and Description |
---|---|
protected ResponseExtractor<HttpHeaders> |
RestTemplate.headersExtractor()
Return a response extractor for
HttpHeaders . |
protected ResponseExtractor<HttpHeaders> |
AsyncRestTemplate.headersExtractor()
Deprecated.
Returns a response extractor for
HttpHeaders . |
ListenableFuture<HttpHeaders> |
AsyncRestOperations.headForHeaders(String url,
Map<String,?> uriVariables)
Deprecated.
Asynchronously retrieve all headers of the resource specified by the URI template.
|
ListenableFuture<HttpHeaders> |
AsyncRestTemplate.headForHeaders(String url,
Map<String,?> uriVariables)
Deprecated.
|
ListenableFuture<HttpHeaders> |
AsyncRestOperations.headForHeaders(String url,
Object... uriVariables)
Deprecated.
Asynchronously retrieve all headers of the resource specified by the URI template.
|
ListenableFuture<HttpHeaders> |
AsyncRestTemplate.headForHeaders(String url,
Object... uriVariables)
Deprecated.
|
ListenableFuture<HttpHeaders> |
AsyncRestOperations.headForHeaders(URI url)
Deprecated.
Asynchronously retrieve all headers of the resource specified by the URL.
|
ListenableFuture<HttpHeaders> |
AsyncRestTemplate.headForHeaders(URI url)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static HttpClientErrorException |
HttpClientErrorException.create(HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Create
HttpClientErrorException or an HTTP status specific subclass. |
static HttpServerErrorException |
HttpServerErrorException.create(HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Create an
HttpServerErrorException or an HTTP status specific subclass. |
static HttpClientErrorException |
HttpClientErrorException.create(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Variant of
HttpClientErrorException.create(HttpStatus, String, HttpHeaders, byte[], Charset)
with an optional prepared message. |
static HttpServerErrorException |
HttpServerErrorException.create(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Variant of
HttpServerErrorException.create(String, HttpStatus, String, HttpHeaders, byte[], Charset)
with an optional prepared message. |
Constructor and Description |
---|
HttpClientErrorException(HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset responseCharset)
Constructor with a status code and status text, headers, and content.
|
HttpClientErrorException(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset responseCharset)
Constructor with a status code and status text, headers, and content,
and a prepared message.
|
HttpServerErrorException(HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Constructor with a status code and status text, headers, and content.
|
HttpServerErrorException(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Constructor with a status code and status text, headers, content, and a
prepared message.
|
HttpStatusCodeException(HttpStatus statusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct instance with an
HttpStatus , status text, content, and
a response charset. |
HttpStatusCodeException(String message,
HttpStatus statusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct instance with an
HttpStatus , status text, content, and
a response charset. |
RestClientResponseException(String message,
int statusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct a new instance of with the given response data.
|
UnknownContentTypeException(Type targetType,
MediaType contentType,
int statusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody)
Construct a new instance of with the given response data.
|
UnknownHttpStatusCodeException(int rawStatusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct a new instance of
HttpStatusCodeException based on an
HttpStatus , status text, and response body content. |
UnknownHttpStatusCodeException(String message,
int rawStatusCode,
String statusText,
HttpHeaders responseHeaders,
byte[] responseBody,
Charset responseCharset)
Construct a new instance of
HttpStatusCodeException based on an
HttpStatus , status text, and response body content. |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
MultipartHttpServletRequest.getMultipartHeaders(String paramOrFileName)
Return the headers for the specified part of the multipart request.
|
HttpHeaders |
MultipartHttpServletRequest.getRequestHeaders()
Return this request's headers as a convenient HttpHeaders instance.
|
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
RequestPartServletServerHttpRequest.getHeaders() |
HttpHeaders |
StandardMultipartHttpServletRequest.getMultipartHeaders(String paramOrFileName) |
HttpHeaders |
DefaultMultipartHttpServletRequest.getMultipartHeaders(String paramOrFileName) |
HttpHeaders |
AbstractMultipartHttpServletRequest.getRequestHeaders() |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
ClientResponse.Headers.asHttpHeaders()
Return the headers as an
HttpHeaders instance. |
HttpHeaders |
WebClientResponseException.getHeaders()
Return the HTTP response headers.
|
HttpHeaders |
WebClientRequestException.getHeaders()
Return the HTTP request headers.
|
HttpHeaders |
ClientRequest.headers()
Return the headers of this request.
|
Modifier and Type | Method and Description |
---|---|
static WebClientResponseException |
WebClientResponseException.create(int statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Create
WebClientResponseException or an HTTP status specific subclass. |
static WebClientResponseException |
WebClientResponseException.create(int statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset,
HttpRequest request)
Create
WebClientResponseException or an HTTP status specific subclass. |
Modifier and Type | Method and Description |
---|---|
WebClient.Builder |
WebClient.Builder.defaultHeaders(Consumer<HttpHeaders> headersConsumer)
Provides access to every
WebClient.Builder.defaultHeader(String, String...)
declared so far with the possibility to add, replace, or remove. |
ClientResponse.Builder |
ClientResponse.Builder.headers(Consumer<HttpHeaders> headersConsumer)
Manipulate this response's headers with the given consumer.
|
ClientRequest.Builder |
ClientRequest.Builder.headers(Consumer<HttpHeaders> headersConsumer)
Manipulate this request's headers with the given consumer.
|
S |
WebClient.RequestHeadersSpec.headers(Consumer<HttpHeaders> headersConsumer)
Provides access to every header declared so far with the possibility
to add, replace, or remove values.
|
Constructor and Description |
---|
UnknownHttpStatusCodeException(int statusCode,
HttpHeaders headers,
byte[] responseBody,
Charset responseCharset)
Create a new instance of the
UnknownHttpStatusCodeException with the given
parameters. |
UnknownHttpStatusCodeException(int statusCode,
HttpHeaders headers,
byte[] responseBody,
Charset responseCharset,
HttpRequest request)
Create a new instance of the
UnknownHttpStatusCodeException with the given
parameters. |
WebClientRequestException(Throwable ex,
HttpMethod method,
URI uri,
HttpHeaders headers)
Constructor for throwable.
|
WebClientResponseException(int statusCode,
String statusText,
HttpHeaders headers,
byte[] body,
Charset charset)
Constructor with response data only, and a default message.
|
WebClientResponseException(int status,
String reasonPhrase,
HttpHeaders headers,
byte[] body,
Charset charset,
HttpRequest request)
Constructor with response data only, and a default message.
|
WebClientResponseException(String message,
int statusCode,
String statusText,
HttpHeaders headers,
byte[] responseBody,
Charset charset)
Constructor with a prepared message.
|
WebClientResponseException(String message,
int statusCode,
String statusText,
HttpHeaders headers,
byte[] responseBody,
Charset charset,
HttpRequest request)
Constructor with a prepared message.
|
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
ClientResponseWrapper.HeadersWrapper.asHttpHeaders() |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
ServerRequest.Headers.asHttpHeaders()
Get the headers as an instance of
HttpHeaders . |
HttpHeaders |
ServerResponse.headers()
Return the headers of this response.
|
Modifier and Type | Method and Description |
---|---|
RenderingResponse.Builder |
RenderingResponse.Builder.headers(HttpHeaders headers)
Copy the given headers into the entity's headers map.
|
EntityResponse.Builder<T> |
EntityResponse.Builder.headers(HttpHeaders headers)
Copy the given headers into the entity's headers map.
|
Modifier and Type | Method and Description |
---|---|
ServerRequest.Builder |
ServerRequest.Builder.headers(Consumer<HttpHeaders> headersConsumer)
Manipulate this request's headers with the given consumer.
|
B |
ServerResponse.HeadersBuilder.headers(Consumer<HttpHeaders> headersConsumer)
Manipulate this response's headers with the given consumer.
|
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
ServerRequestWrapper.HeadersWrapper.asHttpHeaders() |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
HttpResource.getResponseHeaders()
The HTTP headers to be contributed to the HTTP response
that serves the current resource.
|
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
Rendering.headers()
Return headers to add to the response.
|
Modifier and Type | Method and Description |
---|---|
B |
Rendering.Builder.headers(HttpHeaders headers)
Specify headers to add to the response.
|
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
HandshakeInfo.getHeaders()
Return the HTTP headers from the handshake request, either server request
headers for a server session or the client response headers for a client
session.
|
Constructor and Description |
---|
HandshakeInfo(URI uri,
HttpHeaders headers,
reactor.core.publisher.Mono<Principal> principal,
String protocol)
Constructor with basic information about the handshake.
|
HandshakeInfo(URI uri,
HttpHeaders headers,
reactor.core.publisher.Mono<Principal> principal,
String protocol,
InetSocketAddress remoteAddress,
Map<String,Object> attributes,
String logPrefix)
Deprecated.
as of 5.3.5 in favor of
HandshakeInfo(URI, HttpHeaders, MultiValueMap, Mono, String, InetSocketAddress, Map, String) |
HandshakeInfo(URI uri,
HttpHeaders headers,
MultiValueMap<String,HttpCookie> cookies,
reactor.core.publisher.Mono<Principal> principal,
String protocol,
InetSocketAddress remoteAddress,
Map<String,Object> attributes,
String logPrefix)
Constructor targeting server-side use with extra information such as the
cookies, remote address, attributes, and a log prefix.
|
Modifier and Type | Method and Description |
---|---|
reactor.core.publisher.Mono<Void> |
StandardWebSocketClient.execute(URI url,
HttpHeaders headers,
WebSocketHandler handler) |
reactor.core.publisher.Mono<Void> |
ReactorNettyWebSocketClient.execute(URI url,
HttpHeaders requestHeaders,
WebSocketHandler handler) |
reactor.core.publisher.Mono<Void> |
UndertowWebSocketClient.execute(URI url,
HttpHeaders headers,
WebSocketHandler handler) |
reactor.core.publisher.Mono<Void> |
JettyWebSocketClient.execute(URI url,
HttpHeaders headers,
WebSocketHandler handler) |
reactor.core.publisher.Mono<Void> |
WebSocketClient.execute(URI url,
HttpHeaders headers,
WebSocketHandler handler)
A variant of
WebSocketClient.execute(URI, WebSocketHandler) with custom headers. |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
NotAcceptableStatusException.getResponseHeaders()
Return HttpHeaders with an "Accept" header, or an empty instance.
|
HttpHeaders |
ResponseStatusException.getResponseHeaders()
Return headers associated with the exception that should be added to the
error response, e.g.
|
HttpHeaders |
MethodNotAllowedException.getResponseHeaders()
Return HttpHeaders with an "Allow" header.
|
HttpHeaders |
UnsupportedMediaTypeStatusException.getResponseHeaders() |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
NoHandlerFoundException.getHeaders() |
Constructor and Description |
---|
NoHandlerFoundException(String httpMethod,
String requestURL,
HttpHeaders headers)
Constructor for NoHandlerFoundException.
|
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
ServerRequest.Headers.asHttpHeaders()
Get the headers as an instance of
HttpHeaders . |
HttpHeaders |
ServerResponse.headers()
Return the headers of this response.
|
Modifier and Type | Method and Description |
---|---|
RenderingResponse.Builder |
RenderingResponse.Builder.headers(Consumer<HttpHeaders> headersConsumer)
Manipulate this response's headers with the given consumer.
|
EntityResponse.Builder<T> |
EntityResponse.Builder.headers(Consumer<HttpHeaders> headersConsumer)
Manipulate this response's headers with the given consumer.
|
ServerRequest.Builder |
ServerRequest.Builder.headers(Consumer<HttpHeaders> headersConsumer)
Manipulate this request's headers with the given consumer.
|
B |
ServerResponse.HeadersBuilder.headers(Consumer<HttpHeaders> headersConsumer)
Manipulate this response's headers with the given consumer.
|
Modifier and Type | Method and Description |
---|---|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest webRequest)
Customize the response for AsyncRequestTimeoutException.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleBindException(BindException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
Customize the response for BindException.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleConversionNotSupported(ConversionNotSupportedException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
Customize the response for ConversionNotSupportedException.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleExceptionInternal(Exception ex,
Object body,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
A single place to customize the response body of all exception types.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleHttpMediaTypeNotAcceptable(HttpMediaTypeNotAcceptableException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
Customize the response for HttpMediaTypeNotAcceptableException.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
Customize the response for HttpMediaTypeNotSupportedException.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleHttpMessageNotReadable(HttpMessageNotReadableException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
Customize the response for HttpMessageNotReadableException.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleHttpMessageNotWritable(HttpMessageNotWritableException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
Customize the response for HttpMessageNotWritableException.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
Customize the response for HttpRequestMethodNotSupportedException.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleMethodArgumentNotValid(MethodArgumentNotValidException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
Customize the response for MethodArgumentNotValidException.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleMissingPathVariable(MissingPathVariableException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
Customize the response for MissingPathVariableException.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleMissingServletRequestParameter(MissingServletRequestParameterException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
Customize the response for MissingServletRequestParameterException.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleMissingServletRequestPart(MissingServletRequestPartException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
Customize the response for MissingServletRequestPartException.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleNoHandlerFoundException(NoHandlerFoundException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
Customize the response for NoHandlerFoundException.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleServletRequestBindingException(ServletRequestBindingException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
Customize the response for ServletRequestBindingException.
|
protected ResponseEntity<Object> |
ResponseEntityExceptionHandler.handleTypeMismatch(TypeMismatchException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest request)
Customize the response for TypeMismatchException.
|
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
HttpResource.getResponseHeaders()
The HTTP headers to be contributed to the HTTP response
that serves the current resource.
|
Modifier and Type | Class and Description |
---|---|
class |
WebSocketHttpHeaders
An
HttpHeaders variant that adds support for
the HTTP headers defined by the WebSocket specification RFC 6455. |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
WebSocketSession.getHandshakeHeaders()
Return the headers used in the handshake request (never
null ). |
Constructor and Description |
---|
WebSocketHttpHeaders(HttpHeaders headers)
Create an instance that wraps the given pre-existing HttpHeaders and also
propagate all changes to it.
|
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
JettyWebSocketSession.getHandshakeHeaders() |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
StandardWebSocketSession.getHandshakeHeaders() |
Constructor and Description |
---|
StandardWebSocketSession(HttpHeaders headers,
Map<String,Object> attributes,
InetSocketAddress localAddress,
InetSocketAddress remoteAddress)
Constructor for a standard WebSocket session.
|
StandardWebSocketSession(HttpHeaders headers,
Map<String,Object> attributes,
InetSocketAddress localAddress,
InetSocketAddress remoteAddress,
Principal user)
Constructor that associates a user with the WebSocket session.
|
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
WebSocketConnectionManager.getHeaders()
Return the default headers for the WebSocket handshake request.
|
Modifier and Type | Method and Description |
---|---|
protected abstract ListenableFuture<WebSocketSession> |
AbstractWebSocketClient.doHandshakeInternal(WebSocketHandler webSocketHandler,
HttpHeaders headers,
URI uri,
List<String> subProtocols,
List<WebSocketExtension> extensions,
Map<String,Object> attributes)
Perform the actual handshake to establish a connection to the server.
|
void |
WebSocketConnectionManager.setHeaders(HttpHeaders headers)
Provide default headers to add to the WebSocket handshake request.
|
Modifier and Type | Method and Description |
---|---|
ListenableFuture<WebSocketSession> |
JettyWebSocketClient.doHandshakeInternal(WebSocketHandler wsHandler,
HttpHeaders headers,
URI uri,
List<String> protocols,
List<WebSocketExtension> extensions,
Map<String,Object> attributes) |
Modifier and Type | Method and Description |
---|---|
protected ListenableFuture<WebSocketSession> |
StandardWebSocketClient.doHandshakeInternal(WebSocketHandler webSocketHandler,
HttpHeaders headers,
URI uri,
List<String> protocols,
List<WebSocketExtension> extensions,
Map<String,Object> attributes) |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
WebSocketSessionDecorator.getHandshakeHeaders() |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
AbstractClientSockJsSession.getHandshakeHeaders() |
HttpHeaders |
TransportRequest.getHandshakeHeaders()
Return the headers to send with the connect request.
|
HttpHeaders |
XhrClientSockJsSession.getHeaders() |
HttpHeaders |
TransportRequest.getHttpRequestHeaders()
Return the headers to add to all other HTTP requests besides the handshake
request such as XHR receive and send requests.
|
Modifier and Type | Method and Description |
---|---|
protected abstract void |
AbstractXhrTransport.connectInternal(TransportRequest request,
WebSocketHandler handler,
URI receiveUrl,
HttpHeaders handshakeHeaders,
XhrClientSockJsSession session,
SettableListenableFuture<WebSocketSession> connectFuture) |
protected void |
JettyXhrTransport.connectInternal(TransportRequest transportRequest,
WebSocketHandler handler,
URI url,
HttpHeaders handshakeHeaders,
XhrClientSockJsSession session,
SettableListenableFuture<WebSocketSession> connectFuture) |
protected void |
UndertowXhrTransport.connectInternal(TransportRequest request,
WebSocketHandler handler,
URI receiveUrl,
HttpHeaders handshakeHeaders,
XhrClientSockJsSession session,
SettableListenableFuture<WebSocketSession> connectFuture) |
protected void |
RestTemplateXhrTransport.connectInternal(TransportRequest transportRequest,
WebSocketHandler handler,
URI receiveUrl,
HttpHeaders handshakeHeaders,
XhrClientSockJsSession session,
SettableListenableFuture<WebSocketSession> connectFuture) |
String |
AbstractXhrTransport.executeInfoRequest(URI infoUrl,
HttpHeaders headers) |
String |
InfoReceiver.executeInfoRequest(URI infoUrl,
HttpHeaders headers)
Perform an HTTP request to the SockJS "Info" URL.
|
protected abstract ResponseEntity<String> |
AbstractXhrTransport.executeInfoRequestInternal(URI infoUrl,
HttpHeaders headers) |
protected ResponseEntity<String> |
JettyXhrTransport.executeInfoRequestInternal(URI infoUrl,
HttpHeaders headers) |
protected ResponseEntity<String> |
UndertowXhrTransport.executeInfoRequestInternal(URI infoUrl,
HttpHeaders headers) |
protected ResponseEntity<String> |
RestTemplateXhrTransport.executeInfoRequestInternal(URI infoUrl,
HttpHeaders headers) |
protected ResponseEntity<String> |
JettyXhrTransport.executeRequest(URI url,
org.eclipse.jetty.http.HttpMethod method,
HttpHeaders headers,
String body) |
protected ResponseEntity<String> |
UndertowXhrTransport.executeRequest(URI url,
io.undertow.util.HttpString method,
HttpHeaders headers,
String body) |
void |
AbstractXhrTransport.executeSendRequest(URI url,
HttpHeaders headers,
TextMessage message) |
void |
XhrTransport.executeSendRequest(URI transportUrl,
HttpHeaders headers,
TextMessage message)
Execute a request to send the message to the server.
|
protected abstract ResponseEntity<String> |
AbstractXhrTransport.executeSendRequestInternal(URI url,
HttpHeaders headers,
TextMessage message) |
ResponseEntity<String> |
JettyXhrTransport.executeSendRequestInternal(URI url,
HttpHeaders headers,
TextMessage message) |
protected ResponseEntity<String> |
UndertowXhrTransport.executeSendRequestInternal(URI url,
HttpHeaders headers,
TextMessage message) |
ResponseEntity<String> |
RestTemplateXhrTransport.executeSendRequestInternal(URI url,
HttpHeaders headers,
TextMessage message) |
Modifier and Type | Method and Description |
---|---|
HttpHeaders |
WebSocketServerSockJsSession.getHandshakeHeaders() |
HttpHeaders |
AbstractHttpSockJsSession.getHandshakeHeaders() |