org.glassfish.tyrus.websockets

Class WebSocketApplication

java.lang.Object

org.glassfish.tyrus.websockets.WebSocketApplication

All Implemented Interfaces:

WebSocketListener

public abstract class WebSocketApplication
extends Object
implements WebSocketListener

Abstract server-side WebSocket application, which will handle application WebSockets events.

Author:

Alexey Stashok, Pavel Bucek (pavel.bucek at oracle.com)

Constructor Summary

Constructors

Constructor and Description
WebSocketApplication()

Method Summary

Methods

Modifier and Type	Method and Description
WebSocket	createSocket(ProtocolHandler handler, WebSocketRequest requestPacket, WebSocketListener... listeners) Factory method to create new WebSocket instances.
List<Extension>	getSupportedExtensions() Return the websocket extensions supported by this WebSocketApplication.
List<String>	getSupportedProtocols(List<String> subProtocol)
protected Set<WebSocket>	getWebSockets() Returns a set of WebSockets, registered with the application.
protected void	handshake(HandShake handshake) This method will be called, when initial WebSocket handshake process has been completed, but allows the application to perform further negotiation/validation.
protected abstract boolean	isApplicationRequest(WebSocketRequest request) Checks application specific criteria to determine if this application can process the request as a WebSocket connection.
void	onClose(WebSocket socket, ClosingFrame frame) When a WebSocket.onClose(org.glassfish.tyrus.websockets.draft06.ClosingFrame) is invoked, the WebSocket will be unassociated with this application and closed.
void	onConnect(WebSocket socket) When a new WebSocket connection is made to this application, the WebSocket will be associated with this application.
boolean	onError(WebSocket webSocket, Throwable t) This method will be invoked if an unexpected exception is caught by the WebSocket runtime.
void	onExtensionNegotiation(List<Extension> extensions) Invoked during the handshake if the client has advertised extensions it may use and one or more extensions intersect with those returned by getSupportedExtensions().
abstract void	onHandShakeResponse(WebSocketRequest request, WebSocketResponse response) Invoked when server side handshake is ready to send response.
boolean	upgrade(WebSocketRequest request) Checks protocol specific information can and should be upgraded.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.glassfish.tyrus.websockets.WebSocketListener

onFragment, onFragment, onMessage, onMessage, onPing, onPong

Constructor Detail

WebSocketApplication

public WebSocketApplication()

Method Detail

createSocket

public WebSocket createSocket(ProtocolHandler handler,
                     WebSocketRequest requestPacket,
                     WebSocketListener... listeners)

Factory method to create new WebSocket instances. Developers may wish to override this to return customized WebSocket implementations.

Parameters:

handler - the ProtocolHandler to use with the newly created WebSocket.

requestPacket - the WebSocketRequest that triggered the creation of the WebSocket connection.

listeners - the WebSocketListeners to associate with the new WebSocket.

Returns:

TODO

onClose

public void onClose(WebSocket socket,
           ClosingFrame frame)

When a WebSocket.onClose(org.glassfish.tyrus.websockets.draft06.ClosingFrame) is invoked, the WebSocket will be unassociated with this application and closed.

Specified by:

onClose in interface WebSocketListener

Parameters:

socket - the WebSocket being closed.

frame - the closing frame.

onConnect

public void onConnect(WebSocket socket)

When a new WebSocket connection is made to this application, the WebSocket will be associated with this application.

Specified by:

onConnect in interface WebSocketListener

Parameters:

socket - the new WebSocket connection.

onExtensionNegotiation

public void onExtensionNegotiation(List<Extension> extensions)

Invoked during the handshake if the client has advertised extensions it may use and one or more extensions intersect with those returned by getSupportedExtensions().

The Extensions passed to this method will include any extension parameters included by the client. It's up to this method to re-order and or adjust any parameter values within the list. This method must not add any extensions that weren't originally in the list, but it is acceptable to remove one or all extensions if for some reason they can't be supported.

If not overridden, the List will be sent as-is back to the client.

Parameters:

extensions - the intersection of extensions between client and application.

Since:

2.3

upgrade

public final boolean upgrade(WebSocketRequest request)

Checks protocol specific information can and should be upgraded.

The default implementation will check for the presence of the Upgrade header with a value of WebSocket. If present, isApplicationRequest(WebSocketRequest) will be invoked to determine if the request is a valid websocket request.

Parameters:

request - TODO

Returns:

true if the request should be upgraded to a WebSocket connection

onError

public boolean onError(WebSocket webSocket,
              Throwable t)

This method will be invoked if an unexpected exception is caught by the WebSocket runtime.

Parameters:

webSocket - the websocket being processed at the time the exception occurred.

t - the unexpected exception.

Returns:

true if the WebSocket should be closed otherwise false.

onHandShakeResponse

public abstract void onHandShakeResponse(WebSocketRequest request,
                       WebSocketResponse response)

Invoked when server side handshake is ready to send response.

Changes in response parameter will be reflected in data sent back to client.

Parameters:

request - original request which caused this handshake.

response - response to be send.

isApplicationRequest

protected abstract boolean isApplicationRequest(WebSocketRequest request)

Checks application specific criteria to determine if this application can process the request as a WebSocket connection.

Parameters:

request - the incoming HTTP request.

Returns:

true if this application can service this request

getSupportedExtensions

public List<Extension> getSupportedExtensions()

Return the websocket extensions supported by this WebSocketApplication. The Extensions added to this List should not include any Extension.Parameters as they will be ignored. This is used exclusively for matching the requested extensions.

Returns:

the websocket extensions supported by this WebSocketApplication.

getSupportedProtocols

public List<String> getSupportedProtocols(List<String> subProtocol)

Parameters:

subProtocol - TODO

Returns:

TODO

getWebSockets

protected Set<WebSocket> getWebSockets()

Returns a set of WebSockets, registered with the application. The returned set is unmodifiable, the possible modifications may cause exceptions.

Returns:

a set of WebSockets, registered with the application.

handshake

protected void handshake(HandShake handshake)
                  throws HandshakeException

This method will be called, when initial WebSocket handshake process has been completed, but allows the application to perform further negotiation/validation.

Parameters:

handshake - TODO

Throws:

HandshakeException - error occurred during the handshake.