Package | Description |
---|---|
org.springframework.http.server |
Contains an abstraction over server-side HTTP.
|
org.springframework.web.cors |
Support for CORS (Cross-Origin Resource Sharing),
based on a common
CorsProcessor strategy. |
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.socket.server |
Server-side abstractions for WebSocket interactions.
|
org.springframework.web.socket.server.jetty |
Server-side support for the Jetty 9+ WebSocket API.
|
org.springframework.web.socket.server.standard |
Server-side classes for use with standard JSR-356 WebSocket endpoints.
|
org.springframework.web.socket.server.support |
Server-side support classes including container-specific strategies
for upgrading a request.
|
org.springframework.web.socket.sockjs |
Top-level SockJS types.
|
org.springframework.web.socket.sockjs.support |
Support classes for SockJS including an
AbstractSockJsService
implementation. |
org.springframework.web.socket.sockjs.transport |
Server-side support for SockJS transports including
TransportHandler implementations
for processing incoming requests, their
session
counterparts for sending messages over the various transports, and
DefaultSockJsService . |
org.springframework.web.socket.sockjs.transport.handler |
TransportHandler
implementation classes as well as a concrete
SockJsService . |
org.springframework.web.socket.sockjs.transport.session |
SockJS specific implementations of
WebSocketSession . |
Modifier and Type | Class and Description |
---|---|
class |
DelegatingServerHttpResponse
Implementation of
ServerHttpResponse that delegates all calls to a
given target ServerHttpResponse . |
class |
ServletServerHttpResponse
ServerHttpResponse implementation that is based on a HttpServletResponse . |
Modifier and Type | Method and Description |
---|---|
ServerHttpResponse |
DelegatingServerHttpResponse.getDelegate()
Returns the target response that this response delegates to.
|
Modifier and Type | Method and Description |
---|---|
ServerHttpAsyncRequestControl |
ServerHttpRequest.getAsyncRequestControl(ServerHttpResponse response)
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.
|
ServerHttpAsyncRequestControl |
ServletServerHttpRequest.getAsyncRequestControl(ServerHttpResponse response) |
Constructor and Description |
---|
DelegatingServerHttpResponse(ServerHttpResponse delegate)
Create a new
DelegatingServerHttpResponse . |
Modifier and Type | Method and Description |
---|---|
protected boolean |
DefaultCorsProcessor.handleInternal(ServerHttpRequest request,
ServerHttpResponse response,
CorsConfiguration config,
boolean preFlightRequest)
Handle the given request.
|
protected void |
DefaultCorsProcessor.rejectRequest(ServerHttpResponse response)
Invoked when one of the CORS checks failed.
|
Modifier and Type | Method and Description |
---|---|
Object |
AbstractMappingJacksonResponseBodyAdvice.beforeBodyWrite(Object body,
MethodParameter returnType,
MediaType contentType,
Class<? extends HttpMessageConverter<?>> converterType,
ServerHttpRequest request,
ServerHttpResponse response) |
T |
ResponseBodyAdvice.beforeBodyWrite(T body,
MethodParameter returnType,
MediaType selectedContentType,
Class<? extends HttpMessageConverter<?>> selectedConverterType,
ServerHttpRequest request,
ServerHttpResponse response)
Invoked after an
HttpMessageConverter is selected and just before
its write method is invoked. |
protected abstract void |
AbstractMappingJacksonResponseBodyAdvice.beforeBodyWriteInternal(MappingJacksonValue bodyContainer,
MediaType contentType,
MethodParameter returnType,
ServerHttpRequest request,
ServerHttpResponse response)
Invoked only if the converter type is
MappingJackson2HttpMessageConverter . |
protected void |
JsonViewResponseBodyAdvice.beforeBodyWriteInternal(MappingJacksonValue bodyContainer,
MediaType contentType,
MethodParameter returnType,
ServerHttpRequest request,
ServerHttpResponse response) |
protected void |
SseEmitter.extendResponse(ServerHttpResponse outputMessage) |
protected void |
ResponseBodyEmitter.extendResponse(ServerHttpResponse outputMessage)
Invoked after the response is updated with the status code and headers,
if the ResponseBodyEmitter is wrapped in a ResponseEntity, but before the
response is committed, i.e.
|
Modifier and Type | Method and Description |
---|---|
void |
HandshakeInterceptor.afterHandshake(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
Exception exception)
Invoked after the handshake is done.
|
boolean |
HandshakeInterceptor.beforeHandshake(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
Map<String,Object> attributes)
Invoked before the handshake is processed.
|
boolean |
HandshakeHandler.doHandshake(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
Map<String,Object> attributes)
Initiate the handshake.
|
void |
RequestUpgradeStrategy.upgrade(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<WebSocketExtension> selectedExtensions,
Principal user,
WebSocketHandler wsHandler,
Map<String,Object> attributes)
Perform runtime specific steps to complete the upgrade.
|
Modifier and Type | Method and Description |
---|---|
void |
Jetty10RequestUpgradeStrategy.upgrade(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<WebSocketExtension> selectedExtensions,
Principal user,
WebSocketHandler handler,
Map<String,Object> attributes) |
void |
JettyRequestUpgradeStrategy.upgrade(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<WebSocketExtension> selectedExtensions,
Principal user,
WebSocketHandler wsHandler,
Map<String,Object> attributes) |
Modifier and Type | Method and Description |
---|---|
protected HttpServletResponse |
AbstractStandardUpgradeStrategy.getHttpServletResponse(ServerHttpResponse response) |
void |
AbstractStandardUpgradeStrategy.upgrade(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<WebSocketExtension> selectedExtensions,
Principal user,
WebSocketHandler wsHandler,
Map<String,Object> attrs) |
protected void |
UndertowRequestUpgradeStrategy.upgradeInternal(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<Extension> selectedExtensions,
Endpoint endpoint) |
void |
AbstractTyrusRequestUpgradeStrategy.upgradeInternal(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<Extension> extensions,
Endpoint endpoint) |
void |
WebSphereRequestUpgradeStrategy.upgradeInternal(ServerHttpRequest httpRequest,
ServerHttpResponse httpResponse,
String selectedProtocol,
List<Extension> selectedExtensions,
Endpoint endpoint) |
void |
TomcatRequestUpgradeStrategy.upgradeInternal(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<Extension> selectedExtensions,
Endpoint endpoint) |
protected abstract void |
AbstractStandardUpgradeStrategy.upgradeInternal(ServerHttpRequest request,
ServerHttpResponse response,
String selectedProtocol,
List<Extension> selectedExtensions,
Endpoint endpoint) |
Modifier and Type | Method and Description |
---|---|
void |
OriginHandshakeInterceptor.afterHandshake(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
Exception exception) |
void |
HttpSessionHandshakeInterceptor.afterHandshake(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
Exception ex) |
void |
HandshakeInterceptorChain.applyAfterHandshake(ServerHttpRequest request,
ServerHttpResponse response,
Exception failure) |
boolean |
HandshakeInterceptorChain.applyBeforeHandshake(ServerHttpRequest request,
ServerHttpResponse response,
Map<String,Object> attributes) |
boolean |
OriginHandshakeInterceptor.beforeHandshake(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
Map<String,Object> attributes) |
boolean |
HttpSessionHandshakeInterceptor.beforeHandshake(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
Map<String,Object> attributes) |
boolean |
AbstractHandshakeHandler.doHandshake(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
Map<String,Object> attributes) |
protected void |
AbstractHandshakeHandler.handleInvalidConnectHeader(ServerHttpRequest request,
ServerHttpResponse response) |
protected void |
AbstractHandshakeHandler.handleInvalidUpgradeHeader(ServerHttpRequest request,
ServerHttpResponse response) |
protected void |
AbstractHandshakeHandler.handleWebSocketVersionNotSupported(ServerHttpRequest request,
ServerHttpResponse response) |
Modifier and Type | Method and Description |
---|---|
void |
SockJsService.handleRequest(ServerHttpRequest request,
ServerHttpResponse response,
String sockJsPath,
WebSocketHandler handler)
Process a SockJS HTTP request.
|
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractSockJsService.addCacheHeaders(ServerHttpResponse response) |
protected void |
AbstractSockJsService.addNoCacheHeaders(ServerHttpResponse response) |
protected boolean |
AbstractSockJsService.checkOrigin(ServerHttpRequest request,
ServerHttpResponse response,
HttpMethod... httpMethods) |
protected abstract void |
AbstractSockJsService.handleRawWebSocketRequest(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler webSocketHandler)
Handle request for raw WebSocket communication, i.e.
|
void |
AbstractSockJsService.handleRequest(ServerHttpRequest request,
ServerHttpResponse response,
String sockJsPath,
WebSocketHandler wsHandler)
This method determines the SockJS path and handles SockJS static URLs.
|
protected abstract void |
AbstractSockJsService.handleTransportRequest(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler webSocketHandler,
String sessionId,
String transport)
Handle a SockJS session URL (i.e.
|
protected void |
AbstractSockJsService.sendMethodNotAllowed(ServerHttpResponse response,
HttpMethod... httpMethods) |
Modifier and Type | Method and Description |
---|---|
protected void |
TransportHandlingSockJsService.handleRawWebSocketRequest(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler handler) |
void |
TransportHandler.handleRequest(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler handler,
SockJsSession session)
Handle the given request and delegate messages to the provided
WebSocketHandler . |
protected void |
TransportHandlingSockJsService.handleTransportRequest(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler handler,
String sessionId,
String transport) |
Modifier and Type | Method and Description |
---|---|
boolean |
WebSocketTransportHandler.doHandshake(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler handler,
Map<String,Object> attributes) |
void |
WebSocketTransportHandler.handleRequest(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
SockJsSession wsSession) |
void |
AbstractHttpSendingTransportHandler.handleRequest(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
SockJsSession wsSession) |
void |
AbstractHttpReceivingTransportHandler.handleRequest(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
SockJsSession wsSession) |
void |
HtmlFileTransportHandler.handleRequestInternal(ServerHttpRequest request,
ServerHttpResponse response,
AbstractHttpSockJsSession sockJsSession) |
protected void |
AbstractHttpSendingTransportHandler.handleRequestInternal(ServerHttpRequest request,
ServerHttpResponse response,
AbstractHttpSockJsSession sockJsSession) |
protected void |
AbstractHttpReceivingTransportHandler.handleRequestInternal(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
AbstractHttpSockJsSession sockJsSession) |
Modifier and Type | Method and Description |
---|---|
void |
AbstractHttpSockJsSession.handleInitialRequest(ServerHttpRequest request,
ServerHttpResponse response,
SockJsFrameFormat frameFormat)
Handle the first request for receiving messages on a SockJS HTTP transport
based session.
|
protected void |
StreamingSockJsSession.handleRequestInternal(ServerHttpRequest request,
ServerHttpResponse response,
boolean initialRequest) |
protected abstract void |
AbstractHttpSockJsSession.handleRequestInternal(ServerHttpRequest request,
ServerHttpResponse response,
boolean initialRequest)
Invoked when a SockJS transport request is received.
|
protected void |
PollingSockJsSession.handleRequestInternal(ServerHttpRequest request,
ServerHttpResponse response,
boolean initialRequest) |
void |
AbstractHttpSockJsSession.handleSuccessiveRequest(ServerHttpRequest request,
ServerHttpResponse response,
SockJsFrameFormat frameFormat)
Handle all requests, except the first one, to receive messages on a SockJS
HTTP transport based session.
|