org.springframework.web.socket.server.support

Class DefaultHandshakeHandler

java.lang.Object

org.springframework.web.socket.server.support.AbstractHandshakeHandler

org.springframework.web.socket.server.support.DefaultHandshakeHandler

All Implemented Interfaces:

Aware, Lifecycle, ServletContextAware, HandshakeHandler

public class DefaultHandshakeHandler
extends AbstractHandshakeHandler
implements ServletContextAware

A default HandshakeHandler implementation. Performs initial validation of the WebSocket handshake request -- possibly rejecting it through the appropriate HTTP status code -- while also allowing sub-classes to override various parts of the negotiation process (e.g. origin validation, sub-protocol negotiation, extensions negotiation, etc).

If the negotiation succeeds, the actual upgrade is delegated to a server-specific RequestUpgradeStrategy, which will update the response as necessary and initialize the WebSocket. Currently supported servers are Tomcat 7 and 8, Jetty 9, and GlassFish 4.

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields inherited from class org.springframework.web.socket.server.support.AbstractHandshakeHandler

logger

Constructor Summary

Constructors

Constructor and Description
DefaultHandshakeHandler()
DefaultHandshakeHandler(RequestUpgradeStrategy requestUpgradeStrategy)

Method Summary

Modifier and Type	Method and Description
void	setServletContext(ServletContext servletContext) Set the ServletContext that this object runs in.

Methods inherited from class org.springframework.web.socket.server.support.AbstractHandshakeHandler

determineHandlerSupportedProtocols, determineUser, doHandshake, doStart, doStop, filterRequestedExtensions, getRequestUpgradeStrategy, getSupportedProtocols, getSupportedVersions, handleInvalidConnectHeader, handleInvalidUpgradeHeader, handleWebSocketVersionNotSupported, isRunning, isValidOrigin, isWebSocketVersionSupported, selectProtocol, setSupportedProtocols, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultHandshakeHandler

public DefaultHandshakeHandler()

DefaultHandshakeHandler

public DefaultHandshakeHandler(RequestUpgradeStrategy requestUpgradeStrategy)

Method Detail

setServletContext

public void setServletContext(ServletContext servletContext)

Description copied from interface: ServletContextAware

Set the ServletContext that this object runs in.

Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked after ApplicationContextAware's setApplicationContext.

Specified by:

setServletContext in interface ServletContextAware

Parameters:

servletContext - ServletContext object to be used by this object

See Also:

InitializingBean.afterPropertiesSet(), ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)