Uses of Interface
org.springframework.http.server.ServerHttpRequest
Package
Description
Contains an abstraction over server-side HTTP.
Support for CORS (Cross-Origin Resource Sharing),
based on a common
CorsProcessor
strategy.Support classes for the multipart resolution framework.
MVC infrastructure for annotation-based handler method processing, building on the
org.springframework.web.method.annotation
package.Server-side abstractions for WebSocket interactions.
Server-side support for the Jetty WebSocket API.
Server-side classes for use with standard JSR-356 WebSocket endpoints.
Server-side support classes including container-specific strategies
for upgrading a request.
Top-level SockJS types.
Support classes for SockJS including an
AbstractSockJsService
implementation.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
.TransportHandler
implementation classes as well as a concrete
SockJsService
.SockJS specific implementations of
WebSocketSession
.-
Uses of ServerHttpRequest in org.springframework.http.server
Modifier and TypeClassDescriptionclass
ServerHttpRequest
implementation that is based on aHttpServletRequest
. -
Uses of ServerHttpRequest in org.springframework.web.cors
Modifier and TypeMethodDescriptionprotected boolean
DefaultCorsProcessor.handleInternal
(ServerHttpRequest request, ServerHttpResponse response, CorsConfiguration config, boolean preFlightRequest) Handle the given request. -
Uses of ServerHttpRequest in org.springframework.web.multipart.support
Modifier and TypeClassDescriptionclass
ServerHttpRequest
implementation that accesses one part of a multipart request. -
Uses of ServerHttpRequest in org.springframework.web.servlet.mvc.method.annotation
Modifier and TypeMethodDescriptionfinal Object
AbstractMappingJacksonResponseBodyAdvice.beforeBodyWrite
(Object body, MethodParameter returnType, MediaType contentType, Class<? extends HttpMessageConverter<?>> converterType, ServerHttpRequest request, ServerHttpResponse response) ResponseBodyAdvice.beforeBodyWrite
(T body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) Invoked after anHttpMessageConverter
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 isMappingJackson2HttpMessageConverter
.protected void
JsonViewResponseBodyAdvice.beforeBodyWriteInternal
(MappingJacksonValue bodyContainer, MediaType contentType, MethodParameter returnType, ServerHttpRequest request, ServerHttpResponse response) -
Uses of ServerHttpRequest in org.springframework.web.socket.server
Modifier and TypeMethodDescriptionvoid
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.RequestUpgradeStrategy.getSupportedExtensions
(ServerHttpRequest request) Return the WebSocket protocol extensions supported by the underlying WebSocket server.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. -
Uses of ServerHttpRequest in org.springframework.web.socket.server.jetty
Modifier and TypeMethodDescriptionJettyRequestUpgradeStrategy.getSupportedExtensions
(ServerHttpRequest request) void
JettyRequestUpgradeStrategy.upgrade
(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler handler, Map<String, Object> attributes) -
Uses of ServerHttpRequest in org.springframework.web.socket.server.standard
Modifier and TypeMethodDescriptionprotected final HttpServletRequest
AbstractStandardUpgradeStrategy.getHttpServletRequest
(ServerHttpRequest request) AbstractStandardUpgradeStrategy.getSupportedExtensions
(ServerHttpRequest request) void
AbstractStandardUpgradeStrategy.upgrade
(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler wsHandler, Map<String, Object> attrs) protected abstract void
AbstractStandardUpgradeStrategy.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) protected void
StandardWebSocketUpgradeStrategy.upgradeInternal
(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<Extension> selectedExtensions, Endpoint endpoint) -
Uses of ServerHttpRequest in org.springframework.web.socket.server.support
Modifier and TypeMethodDescriptionvoid
HttpSessionHandshakeInterceptor.afterHandshake
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception ex) void
OriginHandshakeInterceptor.afterHandshake
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception) void
HandshakeInterceptorChain.applyAfterHandshake
(ServerHttpRequest request, ServerHttpResponse response, Exception failure) boolean
HandshakeInterceptorChain.applyBeforeHandshake
(ServerHttpRequest request, ServerHttpResponse response, Map<String, Object> attributes) boolean
HttpSessionHandshakeInterceptor.beforeHandshake
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String, Object> attributes) boolean
OriginHandshakeInterceptor.beforeHandshake
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String, Object> attributes) protected Principal
AbstractHandshakeHandler.determineUser
(ServerHttpRequest request, WebSocketHandler wsHandler, Map<String, Object> attributes) A method that can be used to associate a user with the WebSocket session in the process of being established.final boolean
AbstractHandshakeHandler.doHandshake
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String, Object> attributes) protected List<WebSocketExtension>
AbstractHandshakeHandler.filterRequestedExtensions
(ServerHttpRequest request, List<WebSocketExtension> requestedExtensions, List<WebSocketExtension> supportedExtensions) Filter the list of requested WebSocket extensions.protected void
AbstractHandshakeHandler.handleInvalidConnectHeader
(ServerHttpRequest request, ServerHttpResponse response) protected void
AbstractHandshakeHandler.handleInvalidUpgradeHeader
(ServerHttpRequest request, ServerHttpResponse response) protected void
AbstractHandshakeHandler.handleWebSocketVersionNotSupported
(ServerHttpRequest request, ServerHttpResponse response) protected boolean
AbstractHandshakeHandler.isValidOrigin
(ServerHttpRequest request) Return whether the requestOrigin
header value is valid or not. -
Uses of ServerHttpRequest in org.springframework.web.socket.sockjs
Modifier and TypeMethodDescriptionvoid
SockJsService.handleRequest
(ServerHttpRequest request, ServerHttpResponse response, String sockJsPath, WebSocketHandler handler) Process a SockJS HTTP request. -
Uses of ServerHttpRequest in org.springframework.web.socket.sockjs.support
Modifier and TypeMethodDescriptionprotected 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.final 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. -
Uses of ServerHttpRequest in org.springframework.web.socket.sockjs.transport
Modifier and TypeMethodDescriptionprotected 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 providedWebSocketHandler
.protected void
TransportHandlingSockJsService.handleTransportRequest
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler handler, String sessionId, String transport) -
Uses of ServerHttpRequest in org.springframework.web.socket.sockjs.transport.handler
Modifier and TypeMethodDescriptionboolean
WebSocketTransportHandler.doHandshake
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler handler, Map<String, Object> attributes) protected final String
AbstractHttpSendingTransportHandler.getCallbackParam
(ServerHttpRequest request) protected abstract SockJsFrameFormat
AbstractHttpSendingTransportHandler.getFrameFormat
(ServerHttpRequest request) protected SockJsFrameFormat
EventSourceTransportHandler.getFrameFormat
(ServerHttpRequest request) protected SockJsFrameFormat
HtmlFileTransportHandler.getFrameFormat
(ServerHttpRequest request) protected SockJsFrameFormat
XhrPollingTransportHandler.getFrameFormat
(ServerHttpRequest request) protected SockJsFrameFormat
XhrStreamingTransportHandler.getFrameFormat
(ServerHttpRequest request) final void
AbstractHttpReceivingTransportHandler.handleRequest
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, SockJsSession wsSession) final void
AbstractHttpSendingTransportHandler.handleRequest
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, SockJsSession wsSession) void
WebSocketTransportHandler.handleRequest
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, SockJsSession wsSession) protected void
AbstractHttpReceivingTransportHandler.handleRequestInternal
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, AbstractHttpSockJsSession sockJsSession) protected void
AbstractHttpSendingTransportHandler.handleRequestInternal
(ServerHttpRequest request, ServerHttpResponse response, AbstractHttpSockJsSession sockJsSession) void
HtmlFileTransportHandler.handleRequestInternal
(ServerHttpRequest request, ServerHttpResponse response, AbstractHttpSockJsSession sockJsSession) protected abstract String[]
AbstractHttpReceivingTransportHandler.readMessages
(ServerHttpRequest request) protected String[]
XhrReceivingTransportHandler.readMessages
(ServerHttpRequest request) -
Uses of ServerHttpRequest in org.springframework.web.socket.sockjs.transport.session
Modifier and TypeMethodDescriptionprotected abstract byte[]
StreamingSockJsSession.getPrelude
(ServerHttpRequest request) Get the prelude to write to the response before any other data.void
AbstractHttpSockJsSession.handleInitialRequest
(ServerHttpRequest request, ServerHttpResponse response, SockJsFrameFormat frameFormat) Handle the first request for receiving messages on a SockJS HTTP transport based session.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) protected void
StreamingSockJsSession.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.