Package org.atmosphere.websocket

Class WebSocketProcessorAdapter

java.lang.Object

org.atmosphere.websocket.WebSocketProcessorAdapter

All Implemented Interfaces:

WebSocketProcessor

public class WebSocketProcessorAdapter
extends java.lang.Object
implements WebSocketProcessor

Simple Adapter fpr WebSocketProcessor

Author:

Jeanfrancois Arcand

Nested Class Summary

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

WebSocketProcessor.WebSocketException, WebSocketProcessor.WebSocketHandlerProxy

Constructor Summary

Constructors

Constructor	Description
WebSocketProcessorAdapter()

Method Summary

Modifier and Type	Method	Description
void	close(WebSocket webSocket, int closeCode)	Invked when the WebServer is closing the native WebSocket
WebSocketProcessor	configure(AtmosphereConfig config)	Configure, or post construct a WebSocketProcessor
void	destroy()	Destroy all resources associated with this class.
boolean	handshake(jakarta.servlet.http.HttpServletRequest request)	Determine if the WebSocket's handshake data can be processed, or if the request be cancelled.
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
void	notifyListener(WebSocket webSocket, WebSocketEventListener.WebSocketEvent webSocketEvent)	Notify all WebSocketEventListener
void	open(WebSocket webSocket, AtmosphereRequest request, AtmosphereResponse response)	Invoked when a WebSocket gets opened by the underlying container
WebSocketProcessor	registerWebSocketHandler(java.lang.String path, WebSocketProcessor.WebSocketHandlerProxy webSockethandler)	Register a WebSocketHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketProcessorAdapter

public WebSocketProcessorAdapter()

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(jakarta.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 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

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,
                                    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

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

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

notifyListener

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

Description copied from interface: WebSocketProcessor

Notify all WebSocketEventListener

Specified by:

notifyListener in interface WebSocketProcessor

destroy

public void destroy()

Description copied from interface: WebSocketProcessor

Destroy all resources associated with this class.

Specified by:

destroy in interface WebSocketProcessor