Package org.atmosphere.websocket

Class DefaultWebSocketProcessor

java.lang.Object

org.atmosphere.websocket.DefaultWebSocketProcessor

All Implemented Interfaces:

java.io.Serializable, WebSocketPingPongListener, WebSocketProcessor

public class DefaultWebSocketProcessor
extends java.lang.Object
implements WebSocketProcessor, java.io.Serializable, WebSocketPingPongListener

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, WebSocketProcessor.WebSocketHandlerProxy

Constructor Summary

Constructors

Constructor	Description
DefaultWebSocketProcessor()

Method Summary

Modifier and Type	Method	Description
int	byteBufferMaxSize()
DefaultWebSocketProcessor	byteBufferMaxSize(int byteBufferMaxSize)
int	charBufferMaxSize()
DefaultWebSocketProcessor	charBufferMaxSize(int charBufferMaxSize)
void	close(WebSocket webSocket, int closeCode)	Invked when the WebServer is closing the native WebSocket
long	closingTime()
WebSocketProcessor	configure(AtmosphereConfig config)	Configure, or post construct a WebSocketProcessor
static java.util.Map<java.lang.String,java.lang.String>	configureHeader(AtmosphereRequest request)
void	destroy()	Destroy all resources associated with this class.
boolean	destroyable()
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, java.io.Reader r)
protected void	dispatchStream(WebSocket webSocket, java.io.InputStream is)
boolean	executeAsync()
void	executeClose(WebSocket webSocket, int closeCode)
java.util.Map<java.lang.String,WebSocketProcessor.WebSocketHandlerProxy>	handlers()
boolean	handshake(javax.servlet.http.HttpServletRequest request)	Determine if the WebSocket's handshake data can be processed, or if the request be cancelled.
boolean	invokeInterceptors()
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, java.io.InputStream stream)	Invoked when a WebSocket message gets received from the underlying container
void	invokeWebSocketProtocol(WebSocket webSocket, java.io.Reader reader)	Invoked when a WebSocket message gets received from the underlying container
void	invokeWebSocketProtocol(WebSocket webSocket, java.lang.String webSocketMessage)	Invoked when a WebSocket message gets received from the underlying container
EndpointMapper<WebSocketProcessor.WebSocketHandlerProxy>	mapper()
void	notifyListener(WebSocket webSocket, WebSocketEventListener.WebSocketEvent event)	Notify all WebSocketEventListener
void	onPing(WebSocket webSocket, byte[] payload, int offset, int length)	Handle WebSocket PING
void	onPong(WebSocket webSocket, byte[] payload, int offset, int length)	Handle WebSocket PONG
void	open(WebSocket webSocket, AtmosphereRequest request, AtmosphereResponse response)	Invoked when a WebSocket gets opened by the underlying container
protected void	optimizeMapping()
protected WebSocketHandler	postProcessMapping(WebSocket webSocket, AtmosphereRequest request, WebSocketProcessor.WebSocketHandlerProxy w)
WebSocketProcessor	registerWebSocketHandler(java.lang.String path, WebSocketProcessor.WebSocketHandlerProxy webSockethandler)	Register a WebSocketHandler
boolean	wildcardMapping()
DefaultWebSocketProcessor	wildcardMapping(boolean wildcardMapping)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWebSocketProcessor

public DefaultWebSocketProcessor()

Method Detail

configure

public WebSocketProcessor configure(AtmosphereConfig config)

Description copied from interface: WebSocketProcessor

Configure, or post construct a WebSocketProcessor

Specified by:

configure in interface WebSocketProcessor

Parameters:

config - an AtmosphereConfig

Returns:

this

handshake

public boolean handshake(javax.servlet.http.HttpServletRequest request)

Description copied from interface: WebSocketProcessor

Determine if the WebSocket's handshake data can be processed, or if the request be cancelled. Since it's container related native API, the HttpServletRequest might be null, so implementation must check for null.

Specified by:

handshake in interface WebSocketProcessor

Parameters:

request - HttpServletRequest

Returns:

true if the processing can continue, false if not.

registerWebSocketHandler

public WebSocketProcessor registerWebSocketHandler(java.lang.String path,
                                                   WebSocketProcessor.WebSocketHandlerProxy 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 WebSocketProcessor.WebSocketHandlerProxy

Returns:

this

open

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

Description copied from interface: WebSocketProcessor

Invoked when a WebSocket gets opened by the underlying container

Specified by:

open in interface WebSocketProcessor

Throws:

java.io.IOException

postProcessMapping

protected WebSocketHandler postProcessMapping(WebSocket webSocket,
                                              AtmosphereRequest request,
                                              WebSocketProcessor.WebSocketHandlerProxy w)

invokeWebSocketProtocol

public void invokeWebSocketProtocol(WebSocket webSocket,
                                    java.lang.String webSocketMessage)

Description copied from interface: WebSocketProcessor

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)

Description copied from interface: WebSocketProcessor

Invoked when a WebSocket message gets received from the underlying container

Specified by:

invokeWebSocketProtocol in interface WebSocketProcessor

invokeWebSocketProtocol

public void invokeWebSocketProtocol(WebSocket webSocket,
                                    java.io.InputStream stream)

Description copied from interface: WebSocketProcessor

Invoked when a WebSocket message gets received from the underlying container

Specified by:

invokeWebSocketProtocol in interface WebSocketProcessor

invokeWebSocketProtocol

public void invokeWebSocketProtocol(WebSocket webSocket,
                                    java.io.Reader reader)

Description copied from interface: WebSocketProcessor

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)

Description copied from interface: WebSocketProcessor

Invked when the WebServer is closing the native WebSocket

Specified by:

close in interface WebSocketProcessor

executeClose

public void executeClose(WebSocket webSocket,
                         int closeCode)

destroy

public void destroy()

Description copied from interface: WebSocketProcessor

Destroy all resources associated with this class.

Specified by:

destroy in interface WebSocketProcessor

notifyListener

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

Description copied from interface: WebSocketProcessor

Notify all WebSocketEventListener

Specified by:

notifyListener in interface WebSocketProcessor

configureHeader

public static final java.util.Map<java.lang.String,java.lang.String> configureHeader(AtmosphereRequest request)

dispatchStream

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

Throws:

java.io.IOException

dispatchReader

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

Throws:

java.io.IOException

optimizeMapping

protected void optimizeMapping()

wildcardMapping

public boolean wildcardMapping()

wildcardMapping

public DefaultWebSocketProcessor wildcardMapping(boolean wildcardMapping)

handlers

public java.util.Map<java.lang.String,WebSocketProcessor.WebSocketHandlerProxy> handlers()

executeAsync

public boolean executeAsync()

destroyable

public boolean destroyable()

byteBufferMaxSize

public int byteBufferMaxSize()

byteBufferMaxSize

public DefaultWebSocketProcessor byteBufferMaxSize(int byteBufferMaxSize)

charBufferMaxSize

public int charBufferMaxSize()

charBufferMaxSize

public DefaultWebSocketProcessor charBufferMaxSize(int charBufferMaxSize)

closingTime

public long closingTime()

mapper

public EndpointMapper<WebSocketProcessor.WebSocketHandlerProxy> mapper()

invokeInterceptors

public boolean invokeInterceptors()

onPong

public void onPong(WebSocket webSocket,
                   byte[] payload,
                   int offset,
                   int length)

Description copied from interface: WebSocketPingPongListener

Handle WebSocket PONG

Specified by:

onPong in interface WebSocketPingPongListener

Parameters:

webSocket - WebSocket

payload - the received bytes

offset - the offset

length - the length

onPing

public void onPing(WebSocket webSocket,
                   byte[] payload,
                   int offset,
                   int length)

Description copied from interface: WebSocketPingPongListener

Handle WebSocket PING

Specified by:

onPing in interface WebSocketPingPongListener

Parameters:

webSocket - WebSocket

payload - the received bytes

offset - the offset

length - the length