org.springframework.web.socket.sockjs.support

Class SockJsHttpRequestHandler

java.lang.Object

org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler

All Implemented Interfaces:

HttpRequestHandler

public class SockJsHttpRequestHandler
extends java.lang.Object
implements HttpRequestHandler

An HttpRequestHandler for processing SockJS requests. This is the main class to use when configuring a SockJS service at a specific URL. It is a very thin wrapper around a SockJsService and a WebSocketHandler instance also adapting the HttpServletRequest and HttpServletResponse to ServerHttpRequest and ServerHttpResponse respectively.

The decorateWebSocketHandler(WebSocketHandler) method decorates the given WebSocketHandler with a logging and exception handling decorators. This method can be overridden to change that.

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private SockJsService	sockJsService
private WebSocketHandler	webSocketHandler

Constructor Summary

Constructors

Constructor and Description
SockJsHttpRequestHandler(SockJsService sockJsService, WebSocketHandler webSocketHandler) Create a new SockJsHttpRequestHandler.

Method Summary

Modifier and Type	Method and Description
protected WebSocketHandler	decorateWebSocketHandler(WebSocketHandler handler) Decorate the WebSocketHandler provided to the class constructor.
void	handleRequest(HttpServletRequest request, HttpServletResponse response) Process the given request, generating a response.

Methods inherited from class java.lang.Object

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

Field Detail

sockJsService

private final SockJsService sockJsService

webSocketHandler

private final WebSocketHandler webSocketHandler

Constructor Detail

SockJsHttpRequestHandler

public SockJsHttpRequestHandler(SockJsService sockJsService,
                        WebSocketHandler webSocketHandler)

Create a new SockJsHttpRequestHandler.

Parameters:

sockJsService - the SockJS service

webSocketHandler - the websocket handler

Method Detail

decorateWebSocketHandler

protected WebSocketHandler decorateWebSocketHandler(WebSocketHandler handler)

Decorate the WebSocketHandler provided to the class constructor.

By default ExceptionWebSocketHandlerDecorator and LoggingWebSocketHandlerDecorator are applied are added.

handleRequest

public void handleRequest(HttpServletRequest request,
                 HttpServletResponse response)
                   throws ServletException,
                          java.io.IOException

Description copied from interface: HttpRequestHandler

Process the given request, generating a response.

Specified by:

handleRequest in interface HttpRequestHandler

Parameters:

request - current HTTP request

response - current HTTP response

Throws:

ServletException - in case of general errors

java.io.IOException - in case of I/O errors