Class AbstractHttpSendingTransportHandler

java.lang.Object

org.springframework.web.socket.sockjs.transport.handler.AbstractTransportHandler

org.springframework.web.socket.sockjs.transport.handler.AbstractHttpSendingTransportHandler

All Implemented Interfaces:

SockJsSessionFactory, TransportHandler

Direct Known Subclasses:

EventSourceTransportHandler, HtmlFileTransportHandler, XhrPollingTransportHandler, XhrStreamingTransportHandler

public abstract class AbstractHttpSendingTransportHandler
extends AbstractTransportHandler
implements SockJsSessionFactory

Base class for HTTP transport handlers that push messages to connected clients.

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields inherited from class AbstractTransportHandler

logger

Constructor Summary

Constructors

Constructor	Description
AbstractHttpSendingTransportHandler()

Method Summary

Modifier and Type	Method	Description
protected final @Nullable String	getCallbackParam(org.springframework.http.server.ServerHttpRequest request)
protected abstract org.springframework.http.MediaType	getContentType()
protected abstract SockJsFrameFormat	getFrameFormat(org.springframework.http.server.ServerHttpRequest request)
final void	handleRequest(org.springframework.http.server.ServerHttpRequest request, org.springframework.http.server.ServerHttpResponse response, WebSocketHandler wsHandler, SockJsSession wsSession)	Handle the given request and delegate messages to the provided WebSocketHandler.
protected void	handleRequestInternal(org.springframework.http.server.ServerHttpRequest request, org.springframework.http.server.ServerHttpResponse response, AbstractHttpSockJsSession sockJsSession)

Methods inherited from class AbstractTransportHandler

getServiceConfig, initialize

Methods inherited from class Object

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

Methods inherited from interface SockJsSessionFactory

createSession

Methods inherited from interface TransportHandler

checkSessionType, getTransportType

Constructor Details

AbstractHttpSendingTransportHandler

public AbstractHttpSendingTransportHandler()

Method Details

handleRequest

public final void handleRequest(org.springframework.http.server.ServerHttpRequest request,
 org.springframework.http.server.ServerHttpResponse response,
 WebSocketHandler wsHandler,
 SockJsSession wsSession)
                         throws SockJsException

Description copied from interface: TransportHandler

Handle the given request and delegate messages to the provided WebSocketHandler.

Specified by:

handleRequest in interface TransportHandler

Parameters:

request - the current request

response - the current response

wsHandler - the target WebSocketHandler (never null)

wsSession - the SockJS session (never null)

Throws:

SockJsException - raised when request processing fails as explained in SockJsService

handleRequestInternal

protected void handleRequestInternal(org.springframework.http.server.ServerHttpRequest request,
 org.springframework.http.server.ServerHttpResponse response,
 AbstractHttpSockJsSession sockJsSession)
                              throws SockJsException

Throws:

SockJsException

getContentType

protected abstract org.springframework.http.MediaType getContentType()

getFrameFormat

protected abstract SockJsFrameFormat getFrameFormat(org.springframework.http.server.ServerHttpRequest request)

getCallbackParam

protected final @Nullable String getCallbackParam(org.springframework.http.server.ServerHttpRequest request)