public abstract class AbstractStandardUpgradeStrategy extends Object implements RequestUpgradeStrategy
RequestUpgradeStrategy
implementations that build
on the standard WebSocket API for Java (JSR-356).Constructor and Description |
---|
AbstractStandardUpgradeStrategy() |
Modifier and Type | Method and Description |
---|---|
protected ServerContainer |
getContainer(HttpServletRequest request) |
protected HttpServletRequest |
getHttpServletRequest(org.springframework.http.server.ServerHttpRequest request) |
protected HttpServletResponse |
getHttpServletResponse(org.springframework.http.server.ServerHttpResponse response) |
protected List<WebSocketExtension> |
getInstalledExtensions(WebSocketContainer container) |
List<WebSocketExtension> |
getSupportedExtensions(org.springframework.http.server.ServerHttpRequest request)
Return the WebSocket protocol extensions supported by the underlying WebSocket server.
|
void |
upgrade(org.springframework.http.server.ServerHttpRequest request,
org.springframework.http.server.ServerHttpResponse response,
String selectedProtocol,
List<WebSocketExtension> selectedExtensions,
Principal user,
WebSocketHandler wsHandler,
Map<String,Object> attrs)
Perform runtime specific steps to complete the upgrade.
|
protected abstract void |
upgradeInternal(org.springframework.http.server.ServerHttpRequest request,
org.springframework.http.server.ServerHttpResponse response,
String selectedProtocol,
List<Extension> selectedExtensions,
Endpoint endpoint) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getSupportedVersions
protected final Log logger
protected ServerContainer getContainer(HttpServletRequest request)
protected final HttpServletRequest getHttpServletRequest(org.springframework.http.server.ServerHttpRequest request)
protected final HttpServletResponse getHttpServletResponse(org.springframework.http.server.ServerHttpResponse response)
public List<WebSocketExtension> getSupportedExtensions(org.springframework.http.server.ServerHttpRequest request)
RequestUpgradeStrategy
getSupportedExtensions
in interface RequestUpgradeStrategy
protected List<WebSocketExtension> getInstalledExtensions(WebSocketContainer container)
public void upgrade(org.springframework.http.server.ServerHttpRequest request, org.springframework.http.server.ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler wsHandler, Map<String,Object> attrs) throws HandshakeFailureException
RequestUpgradeStrategy
upgrade
in interface RequestUpgradeStrategy
request
- the current requestresponse
- the current responseselectedProtocol
- the selected sub-protocol, if anyselectedExtensions
- the selected WebSocket protocol extensionsuser
- the user to associate with the WebSocket sessionwsHandler
- the handler for WebSocket messagesattrs
- handshake request specific attributes to be set on the WebSocket
session via HandshakeInterceptor
and
thus made available to the WebSocketHandler
HandshakeFailureException
- thrown when handshake processing failed to
complete due to an internal, unrecoverable error, i.e. a server error as
opposed to a failure to successfully negotiate the requirements of the
handshake request.protected abstract void upgradeInternal(org.springframework.http.server.ServerHttpRequest request, org.springframework.http.server.ServerHttpResponse response, String selectedProtocol, List<Extension> selectedExtensions, Endpoint endpoint) throws HandshakeFailureException
HandshakeFailureException