Class WebSocketHttpRequestHandler
- java.lang.Object
- org.springframework.web.socket.server.support.WebSocketHttpRequestHandler
- All Implemented Interfaces:
Aware
,Lifecycle
,ServletContextAware
,HttpRequestHandler
public class WebSocketHttpRequestHandler extends Object implements HttpRequestHandler, Lifecycle, ServletContextAware
AHttpRequestHandler
for processing WebSocket handshake requests.This is the main class to use when configuring a server WebSocket at a specific URL. It is a very thin wrapper around a
WebSocketHandler
and aHandshakeHandler
, also adapting theHttpServletRequest
andHttpServletResponse
toServerHttpRequest
andServerHttpResponse
, respectively.- Since:
- 4.0
- Author:
- Rossen Stoyanchev
Constructor Summary
Constructors Constructor Description WebSocketHttpRequestHandler(WebSocketHandler wsHandler)
WebSocketHttpRequestHandler(WebSocketHandler wsHandler, HandshakeHandler handshakeHandler)
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description HandshakeHandler
getHandshakeHandler()
Return the HandshakeHandler.List<HandshakeInterceptor>
getHandshakeInterceptors()
Return the configured WebSocket handshake request interceptors.WebSocketHandler
getWebSocketHandler()
Return the WebSocketHandler.void
handleRequest(HttpServletRequest servletRequest, HttpServletResponse servletResponse)
Process the given request, generating a response.boolean
isRunning()
Check whether this component is currently running.void
setHandshakeInterceptors(List<HandshakeInterceptor> interceptors)
Configure one or more WebSocket handshake request interceptors.void
setServletContext(ServletContext servletContext)
Set theServletContext
that this object runs in.void
start()
Start this component.void
stop()
Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.
Constructor Detail
WebSocketHttpRequestHandler
public WebSocketHttpRequestHandler(WebSocketHandler wsHandler)
WebSocketHttpRequestHandler
public WebSocketHttpRequestHandler(WebSocketHandler wsHandler, HandshakeHandler handshakeHandler)
Method Detail
getWebSocketHandler
public WebSocketHandler getWebSocketHandler()
Return the WebSocketHandler.
getHandshakeHandler
public HandshakeHandler getHandshakeHandler()
Return the HandshakeHandler.
setHandshakeInterceptors
public void setHandshakeInterceptors(List<HandshakeInterceptor> interceptors)
Configure one or more WebSocket handshake request interceptors.
getHandshakeInterceptors
public List<HandshakeInterceptor> getHandshakeInterceptors()
Return the configured WebSocket handshake request interceptors.
setServletContext
public void setServletContext(ServletContext servletContext)
Description copied from interface:ServletContextAware
Set theServletContext
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'ssetApplicationContext
.- Specified by:
setServletContext
in interfaceServletContextAware
- Parameters:
servletContext
- ServletContext object to be used by this object- See Also:
InitializingBean.afterPropertiesSet()
,ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
start
public void start()
Description copied from interface:Lifecycle
Start this component.Should not throw an exception if the component is already running.
In the case of a container, this will propagate the start signal to all components that apply.
- Specified by:
start
in interfaceLifecycle
- See Also:
SmartLifecycle.isAutoStartup()
stop
public void stop()
Description copied from interface:Lifecycle
Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementingSmartLifecycle
and itsstop(Runnable)
variant when asynchronous stop behavior is necessary.Note that this stop notification is not guaranteed to come before destruction: On regular shutdown,
Lifecycle
beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront.Should not throw an exception if the component is not running (not started yet).
In the case of a container, this will propagate the stop signal to all components that apply.
- Specified by:
stop
in interfaceLifecycle
- See Also:
SmartLifecycle.stop(Runnable)
,DisposableBean.destroy()
isRunning
public boolean isRunning()
Description copied from interface:Lifecycle
Check whether this component is currently running.In the case of a container, this will return
true
only if all components that apply are currently running.
handleRequest
public void handleRequest(HttpServletRequest servletRequest, HttpServletResponse servletResponse) throws ServletException, IOException
Description copied from interface:HttpRequestHandler
Process the given request, generating a response.- Specified by:
handleRequest
in interfaceHttpRequestHandler
- Parameters:
servletRequest
- current HTTP requestservletResponse
- current HTTP response- Throws:
ServletException
- in case of general errorsIOException
- in case of I/O errors