org.atmosphere.websocket
Class DefaultWebSocketProcessor

java.lang.Object
  org.atmosphere.websocket.DefaultWebSocketProcessor

All Implemented Interfaces:

Serializable, WebSocketProcessor

public class DefaultWebSocketProcessor
extends Object
implements WebSocketProcessor, Serializable

Like the AsynchronousProcessor class, this class is responsible for dispatching WebSocket request to the proper WebSocket implementation. This class can be extended in order to support any protocol running on top websocket.

Author:

Jeanfrancois Arcand

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.atmosphere.websocket.WebSocketProcessor

WebSocketProcessor.WebSocketException

Constructor Summary

DefaultWebSocketProcessor(AtmosphereFramework framework)

Method Summary

void	close(WebSocket webSocket, int closeCode) Invked when the WebServer is closing the native WebSocket
static Map<String,String>	configureHeader(AtmosphereRequest request)
void	destroy() Destroy all resources associated with this class.
void	dispatch(WebSocket webSocket, AtmosphereRequest request, AtmosphereResponse r) Dispatch to request/response to the AsyncSupport implementation as it was a normal HTTP request.
protected void	dispatchReader(WebSocket webSocket, Reader r)
protected void	dispatchStream(WebSocket webSocket, InputStream is)
int	getByteBufferMaxSize() Obtain the current maximum size (in bytes) of the buffer used for binary messages.
int	getCharBufferMaxSize() Obtain the current maximum size (in characters) of the buffer used for binary messages.
void	invokeWebSocketProtocol(WebSocket webSocket, byte[] data, int offset, int length) Invoked when a WebSocket message gets received from the underlying container
void	invokeWebSocketProtocol(WebSocket webSocket, InputStream stream) Invoked when a WebSocket message gets received from the underlying container
void	invokeWebSocketProtocol(WebSocket webSocket, Reader reader) Invoked when a WebSocket message gets received from the underlying container
void	invokeWebSocketProtocol(WebSocket webSocket, String webSocketMessage) Invoked when a WebSocket message gets received from the underlying container
void	notifyListener(WebSocket webSocket, WebSocketEventListener.WebSocketEvent event) Notify all WebSocketEventListener
void	open(WebSocket webSocket, AtmosphereRequest request, AtmosphereResponse response) Invoked when a WebSocket gets opened by the underlying container
WebSocketProcessor	registerWebSocketHandler(String path, WebSocketHandler webSockethandler) Register a WebSocketHandler
void	setByteBufferMaxSize(int byteBufferMaxSize) Set the maximum size (in bytes) of the buffer used for binary messages.
void	setCharBufferMaxSize(int charBufferMaxSize) Set the maximum size (in characters) of the buffer used for textual messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWebSocketProcessor

public DefaultWebSocketProcessor(AtmosphereFramework framework)

Method Detail

registerWebSocketHandler

public WebSocketProcessor registerWebSocketHandler(String path,
                                                   WebSocketHandler webSockethandler)

Description copied from interface: WebSocketProcessor

Register a WebSocketHandler

Specified by:

registerWebSocketHandler in interface WebSocketProcessor

Parameters:

path - the URI mapping the WebSocketHandler

webSockethandler - an instance of WebSocketHandler

Returns:

this

open

public final void open(WebSocket webSocket,
                       AtmosphereRequest request,
                       AtmosphereResponse response)
                throws IOException

Invoked when a WebSocket gets opened by the underlying container

Specified by:

open in interface WebSocketProcessor

Throws:

IOException

invokeWebSocketProtocol

public void invokeWebSocketProtocol(WebSocket webSocket,
                                    String webSocketMessage)

Invoked when a WebSocket message gets received from the underlying container

Specified by:

invokeWebSocketProtocol in interface WebSocketProcessor

invokeWebSocketProtocol

public void invokeWebSocketProtocol(WebSocket webSocket,
                                    byte[] data,
                                    int offset,
                                    int length)

Invoked when a WebSocket message gets received from the underlying container

Specified by:

invokeWebSocketProtocol in interface WebSocketProcessor

invokeWebSocketProtocol

public void invokeWebSocketProtocol(WebSocket webSocket,
                                    InputStream stream)

Invoked when a WebSocket message gets received from the underlying container

Specified by:

invokeWebSocketProtocol in interface WebSocketProcessor

invokeWebSocketProtocol

public void invokeWebSocketProtocol(WebSocket webSocket,
                                    Reader reader)

Invoked when a WebSocket message gets received from the underlying container

Specified by:

invokeWebSocketProtocol in interface WebSocketProcessor

dispatch

public final void dispatch(WebSocket webSocket,
                           AtmosphereRequest request,
                           AtmosphereResponse r)

Dispatch to request/response to the AsyncSupport implementation as it was a normal HTTP request.

Parameters:

request - a AtmosphereRequest

r - a AtmosphereResponse

close

public void close(WebSocket webSocket,
                  int closeCode)

Invked when the WebServer is closing the native WebSocket

Specified by:

close in interface WebSocketProcessor

notifyListener

public void notifyListener(WebSocket webSocket,
                           WebSocketEventListener.WebSocketEvent event)

Notify all WebSocketEventListener

Specified by:

notifyListener in interface WebSocketProcessor

destroy

public void destroy()

Destroy all resources associated with this class.

Specified by:

destroy in interface WebSocketProcessor

configureHeader

public static final Map<String,String> configureHeader(AtmosphereRequest request)

dispatchStream

protected void dispatchStream(WebSocket webSocket,
                              InputStream is)
                       throws IOException

Throws:

IOException

dispatchReader

protected void dispatchReader(WebSocket webSocket,
                              Reader r)
                       throws IOException

Throws:

IOException

getByteBufferMaxSize

public final int getByteBufferMaxSize()

Obtain the current maximum size (in bytes) of the buffer used for binary messages.

setByteBufferMaxSize

public final void setByteBufferMaxSize(int byteBufferMaxSize)

Set the maximum size (in bytes) of the buffer used for binary messages.

getCharBufferMaxSize

public final int getCharBufferMaxSize()

Obtain the current maximum size (in characters) of the buffer used for binary messages.

setCharBufferMaxSize

public final void setCharBufferMaxSize(int charBufferMaxSize)

Set the maximum size (in characters) of the buffer used for textual messages.