org.fujion.websocket

Class WebSocketHandler

java.lang.Object

org.springframework.web.socket.handler.AbstractWebSocketHandler

org.fujion.websocket.WebSocketHandler

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.config.BeanPostProcessor, org.springframework.web.context.ServletContextAware, org.springframework.web.socket.WebSocketHandler

public class WebSocketHandler
extends org.springframework.web.socket.handler.AbstractWebSocketHandler
implements org.springframework.beans.factory.config.BeanPostProcessor, org.springframework.web.context.ServletContextAware

Handler for all web socket communications.

Constructor Summary

Constructors

Constructor and Description
WebSocketHandler()

Method Summary

Modifier and Type	Method and Description
void	afterConnectionClosed(org.springframework.web.socket.WebSocketSession socket, org.springframework.web.socket.CloseStatus status)
void	afterConnectionEstablished(org.springframework.web.socket.WebSocketSession socket)
protected void	handleBinaryMessage(org.springframework.web.socket.WebSocketSession socket, org.springframework.web.socket.BinaryMessage message) Processes a client request containing a BLOB payload sent via the web socket session.
protected void	handleTextMessage(org.springframework.web.socket.WebSocketSession socket, org.springframework.web.socket.TextMessage message) Processes a client request sent via the web socket session.
Object	postProcessAfterInitialization(Object bean, String beanName) Detects and registers request handlers.
Object	postProcessBeforeInitialization(Object bean, String beanName) NOP
static void	registerRequestHandler(IRequestHandler handler) Register a request handler.
static void	send(ClientInvocation invocation) Sends a client invocation request to the client via the web socket session derived from the current execution context.
static void	send(Collection<ClientInvocation> invocations) Sends multiple client invocation requests to the client via the web socket session derived from the current execution context.
static void	send(org.springframework.web.socket.WebSocketSession socket, ClientInvocation invocation) Sends a client invocation request to the client via the web socket session.
static void	send(org.springframework.web.socket.WebSocketSession socket, Iterable<ClientInvocation> invocations) Sends multiple client invocation requests to the client via the web socket session.
static void	sendError(org.springframework.web.socket.WebSocketSession socket, Throwable exception) Sends an exception to the client for display via the web socket session.
void	setServletContext(javax.servlet.ServletContext servletContext)
boolean	supportsPartialMessages()

Methods inherited from class org.springframework.web.socket.handler.AbstractWebSocketHandler

handleMessage, handlePongMessage, handleTransportError

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketHandler

public WebSocketHandler()

Method Detail

registerRequestHandler

public static void registerRequestHandler(IRequestHandler handler)

Register a request handler.

Parameters:

handler - The request handler.

send

public static void send(ClientInvocation invocation)

Sends a client invocation request to the client via the web socket session derived from the current execution context.

Parameters:

invocation - The client invocation request.

send

public static void send(org.springframework.web.socket.WebSocketSession socket,
                        ClientInvocation invocation)

Sends a client invocation request to the client via the web socket session.

Parameters:

socket - The web socket session. If null, the session is derived from the current execution context.

invocation - The client invocation request.

send

public static void send(Collection<ClientInvocation> invocations)

Sends multiple client invocation requests to the client via the web socket session derived from the current execution context.

Parameters:

invocations - The client invocation requests.

send

public static void send(org.springframework.web.socket.WebSocketSession socket,
                        Iterable<ClientInvocation> invocations)

Sends multiple client invocation requests to the client via the web socket session.

Parameters:

socket - The web socket session. If null, the session is derived from the current execution context.

invocations - The client invocation requests.

sendError

public static void sendError(org.springframework.web.socket.WebSocketSession socket,
                             Throwable exception)

Sends an exception to the client for display via the web socket session.

Parameters:

socket - The web socket session. If null, the session is derived from the current execution context.

exception - The exception.

handleTextMessage

protected void handleTextMessage(org.springframework.web.socket.WebSocketSession socket,
                                 org.springframework.web.socket.TextMessage message)

Processes a client request sent via the web socket session. Extracts the client request from the message, creates a new execution context, and invokes registered request handlers. If no registered request handler is capable of processing the request, an exception will be sent to the client.

Overrides:

handleTextMessage in class org.springframework.web.socket.handler.AbstractWebSocketHandler

Parameters:

socket - The web socket session transmitting the request.

message - The message containing the client request.

handleBinaryMessage

protected void handleBinaryMessage(org.springframework.web.socket.WebSocketSession socket,
                                   org.springframework.web.socket.BinaryMessage message)
                            throws Exception

Processes a client request containing a BLOB payload sent via the web socket session. Extracts the client request from the message, creates a new execution context, and invokes registered request handlers. If no registered request handler is capable of processing the request, an exception will be sent to the client.

Overrides:

handleBinaryMessage in class org.springframework.web.socket.handler.AbstractWebSocketHandler

Parameters:

socket - The web socket session transmitting the request.

message - The message containing the client request.

Throws:

Exception

afterConnectionEstablished

public void afterConnectionEstablished(org.springframework.web.socket.WebSocketSession socket)
                                throws Exception

Specified by:

afterConnectionEstablished in interface org.springframework.web.socket.WebSocketHandler

Overrides:

afterConnectionEstablished in class org.springframework.web.socket.handler.AbstractWebSocketHandler

Throws:

Exception

afterConnectionClosed

public void afterConnectionClosed(org.springframework.web.socket.WebSocketSession socket,
                                  org.springframework.web.socket.CloseStatus status)
                           throws Exception

Specified by:

afterConnectionClosed in interface org.springframework.web.socket.WebSocketHandler

Overrides:

afterConnectionClosed in class org.springframework.web.socket.handler.AbstractWebSocketHandler

Throws:

Exception

supportsPartialMessages

public boolean supportsPartialMessages()

Specified by:

supportsPartialMessages in interface org.springframework.web.socket.WebSocketHandler

Overrides:

supportsPartialMessages in class org.springframework.web.socket.handler.AbstractWebSocketHandler

postProcessBeforeInitialization

public Object postProcessBeforeInitialization(Object bean,
                                              String beanName)
                                       throws org.springframework.beans.BeansException

NOP

Specified by:

postProcessBeforeInitialization in interface org.springframework.beans.factory.config.BeanPostProcessor

Throws:

org.springframework.beans.BeansException

postProcessAfterInitialization

public Object postProcessAfterInitialization(Object bean,
                                             String beanName)
                                      throws org.springframework.beans.BeansException

Detects and registers request handlers.

Specified by:

postProcessAfterInitialization in interface org.springframework.beans.factory.config.BeanPostProcessor

Throws:

org.springframework.beans.BeansException

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Specified by:

setServletContext in interface org.springframework.web.context.ServletContextAware