Package org.atmosphere.websocket

Class DefaultWebSocketProcessor

java.lang.Object

org.atmosphere.websocket.DefaultWebSocketProcessor

All Implemented Interfaces:

Serializable, WebSocketPingPongListener, WebSocketProcessor

public class DefaultWebSocketProcessor
extends Object
implements WebSocketProcessor, 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.

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()	Create a new, unconfigured processor.

Method Summary

Modifier and Type	Method	Description
int	byteBufferMaxSize()	Return the maximum size in bytes for the internal ByteBuffer used when buffering binary WebSocket streams.
DefaultWebSocketProcessor	byteBufferMaxSize(int byteBufferMaxSize)	Set the maximum size in bytes for the internal ByteBuffer used when buffering binary WebSocket streams.
int	charBufferMaxSize()	Return the maximum size in characters for the internal CharBuffer used when buffering text WebSocket streams.
DefaultWebSocketProcessor	charBufferMaxSize(int charBufferMaxSize)	Set the maximum size in characters for the internal CharBuffer used when buffering text WebSocket streams.
void	close(WebSocket webSocket, int closeCode)	Invked when the WebServer is closing the native WebSocket
long	closingTime()	Return the delay in milliseconds before a WebSocket close is finalized.
WebSocketProcessor	configure(AtmosphereConfig config)	Configure, or post construct a WebSocketProcessor
static Map<String,String>	configureHeader(AtmosphereRequest request)	Build a header map from the given request's parameters and inject the HeaderConfig.X_ATMOSPHERE_TRANSPORT header set to HeaderConfig.WEBSOCKET_TRANSPORT.
void	destroy()	Destroy all resources associated with this class.
boolean	destroyable()	Return whether the processor recycles AtmosphereRequest and AtmosphereResponse instances after use.
final 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)
boolean	executeAsync()	Return whether WebSocket protocol messages are dispatched asynchronously via the async executor.
void	executeClose(WebSocket webSocket, int closeCode)	Perform the actual close of the given WebSocket by ending the associated AtmosphereResource request and notifying WebSocketEventListeners.
Map<String,WebSocketProcessor.WebSocketHandlerProxy>	handlers()	Return the registered WebSocketProcessor.WebSocketHandlerProxy instances keyed by their mapped path.
boolean	handshake(HttpServletRequest request)	Determine if the WebSocket's handshake data can be processed, or if the request be cancelled.
boolean	invokeInterceptors()	Return whether AtmosphereInterceptors are invoked for incoming WebSocket 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
EndpointMapper<WebSocketProcessor.WebSocketHandlerProxy>	mapper()	Return the EndpointMapper used to resolve incoming WebSocket requests to their registered WebSocketProcessor.WebSocketHandlerProxy.
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
final 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(String path, WebSocketProcessor.WebSocketHandlerProxy webSockethandler)	Register a WebSocketHandler
boolean	wildcardMapping()	Return whether wildcard URI-template mapping (paths containing {param}) is enabled.
DefaultWebSocketProcessor	wildcardMapping(boolean wildcardMapping)	Enable or disable wildcard URI-template mapping.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultWebSocketProcessor

public DefaultWebSocketProcessor()

Create a new, unconfigured processor. Callers must invoke configure(AtmosphereConfig) before this processor can handle WebSocket events.

Method Details

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(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(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 IOException

Description copied from interface: WebSocketProcessor

Invoked when a WebSocket gets opened by the underlying container

Specified by:

open in interface WebSocketProcessor

Parameters:

request -

Throws:

IOException

postProcessMapping

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

invokeWebSocketProtocol

public void invokeWebSocketProtocol(WebSocket webSocket,
 String webSocketMessage)

Description copied from interface: WebSocketProcessor

Invoked when a WebSocket message gets received from the underlying container

Specified by:

invokeWebSocketProtocol in interface WebSocketProcessor

Parameters:

webSocketMessage -

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

Parameters:

data -

invokeWebSocketProtocol

public void invokeWebSocketProtocol(WebSocket webSocket,
 InputStream stream)

Description copied from interface: WebSocketProcessor

Invoked when a WebSocket message gets received from the underlying container

Specified by:

invokeWebSocketProtocol in interface WebSocketProcessor

Parameters:

stream -

invokeWebSocketProtocol

public void invokeWebSocketProtocol(WebSocket webSocket,
 Reader reader)

Description copied from interface: WebSocketProcessor

Invoked when a WebSocket message gets received from the underlying container

Specified by:

invokeWebSocketProtocol in interface WebSocketProcessor

Parameters:

reader -

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

Parameters:

closeCode -

executeClose

public void executeClose(WebSocket webSocket,
 int closeCode)

Perform the actual close of the given WebSocket by ending the associated AtmosphereResource request and notifying WebSocketEventListeners. This method is separated from close(WebSocket, int) to allow deferred invocation (e.g. Firefox delayed-close workaround).

Parameters:

webSocket - the WebSocket being closed

closeCode - the WebSocket close status code

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

Parameters:

event -

configureHeader

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

Build a header map from the given request's parameters and inject the HeaderConfig.X_ATMOSPHERE_TRANSPORT header set to HeaderConfig.WEBSOCKET_TRANSPORT. The resulting map is typically applied to the request via AtmosphereRequest.headers(Map).

Parameters:

request - the incoming atmosphere request whose parameters are copied as headers

Returns:

a mutable map of header name/value pairs

dispatchStream

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

Throws:

IOException

dispatchReader

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

Throws:

IOException

optimizeMapping

protected void optimizeMapping()

wildcardMapping

public boolean wildcardMapping()

Return whether wildcard URI-template mapping (paths containing {param}) is enabled.

Returns:

true if at least one registered handler path contains URI-template variables

wildcardMapping

public DefaultWebSocketProcessor wildcardMapping(boolean wildcardMapping)

Enable or disable wildcard URI-template mapping.

Parameters:

wildcardMapping - true to enable wildcard mapping

Returns:

this processor for method chaining

handlers

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

Return the registered WebSocketProcessor.WebSocketHandlerProxy instances keyed by their mapped path.

Returns:

an unmodifiable view is not guaranteed; callers should treat the returned map as read-only

executeAsync

public boolean executeAsync()

Return whether WebSocket protocol messages are dispatched asynchronously via the async executor. Controlled by the ApplicationConfig.WEBSOCKET_PROTOCOL_EXECUTION init parameter.

Returns:

true if async dispatch is enabled

destroyable

public boolean destroyable()

Return whether the processor recycles AtmosphereRequest and AtmosphereResponse instances after use. Controlled by the ApplicationConfig.RECYCLE_ATMOSPHERE_REQUEST_RESPONSE init parameter.

Returns:

true if request/response recycling is enabled

byteBufferMaxSize

public int byteBufferMaxSize()

Return the maximum size in bytes for the internal ByteBuffer used when buffering binary WebSocket streams. Defaults to 2 MB.

Returns:

the byte buffer max size

byteBufferMaxSize

public DefaultWebSocketProcessor byteBufferMaxSize(int byteBufferMaxSize)

Set the maximum size in bytes for the internal ByteBuffer used when buffering binary WebSocket streams.

Parameters:

byteBufferMaxSize - the new max size in bytes

Returns:

this processor for method chaining

charBufferMaxSize

public int charBufferMaxSize()

Return the maximum size in characters for the internal CharBuffer used when buffering text WebSocket streams. Defaults to 2 MB.

Returns:

the char buffer max size

charBufferMaxSize

public DefaultWebSocketProcessor charBufferMaxSize(int charBufferMaxSize)

Set the maximum size in characters for the internal CharBuffer used when buffering text WebSocket streams.

Parameters:

charBufferMaxSize - the new max size in characters

Returns:

this processor for method chaining

closingTime

public long closingTime()

Return the delay in milliseconds before a WebSocket close is finalized. A non-zero value enables delayed-close behavior, used as a workaround for Firefox reconnection issues. Controlled by the ApplicationConfig.CLOSED_ATMOSPHERE_THINK_TIME init parameter.

Returns:

the closing delay in milliseconds, or 0 for immediate close

mapper

public EndpointMapper<WebSocketProcessor.WebSocketHandlerProxy> mapper()

Return the EndpointMapper used to resolve incoming WebSocket requests to their registered WebSocketProcessor.WebSocketHandlerProxy.

Returns:

the endpoint mapper

invokeInterceptors

public boolean invokeInterceptors()

Return whether AtmosphereInterceptors are invoked for incoming WebSocket messages. Controlled by the ApplicationConfig.INVOKE_ATMOSPHERE_INTERCEPTOR_ON_WEBSOCKET_MESSAGE init parameter. Defaults to true.

Returns:

true if interceptors are invoked on each WebSocket message

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