org.glassfish.tyrus.spi

Class SPIEndpoint

java.lang.Object

javax.net.websocket.Endpoint

org.glassfish.tyrus.spi.SPIEndpoint

public abstract class SPIEndpoint
extends javax.net.websocket.Endpoint

The WebSocket SDK implements SPIEndpoint with its representation of a websocket endpoint mapped to a base URI that wishes to handle incoming messages.

Author:

dannycoward

Constructor Summary

Constructors

Constructor and Description
SPIEndpoint()

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	checkHandshake(SPIHandshakeRequest hr) This method must be called by the provider during its check for a successful websocket handshake.
abstract java.util.List<java.lang.String>	getSupportedProtocols(java.util.List<java.lang.String> subProtocols) Called by the provider during the handshake to determine a list of subprotocols this endpoint will support of those passed in.
abstract void	onClose(javax.net.websocket.RemoteEndpoint gs) Called by the provider when the web socket connection to the given remote endpoint has just closed.
abstract void	onConnect(javax.net.websocket.RemoteEndpoint gs) Called by the provider when the web socket connection is established.
abstract void	onMessage(javax.net.websocket.RemoteEndpoint gs, java.nio.ByteBuffer bytes) Called by the provider when the web socket connection has an incoming binary message from the given remote endpoint.
abstract void	onMessage(javax.net.websocket.RemoteEndpoint gs, java.lang.String messageString) Called by the provider when the web socket connection has an incoming text message from the given remote endpoint.
void	onOpen(javax.net.websocket.Session session)
abstract void	remove() Called by the provider after all connections have been closed to this endpoint, and after the endpoint has been removed from service.

Methods inherited from class javax.net.websocket.Endpoint

onClose, onError

Methods inherited from class java.lang.Object

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

Constructor Detail

SPIEndpoint

public SPIEndpoint()

Method Detail

checkHandshake

public abstract boolean checkHandshake(SPIHandshakeRequest hr)

This method must be called by the provider during its check for a successful websocket handshake. The provider must turn down the handshake if the method returns false. If the web socket handshake does complete, as determined by the provider, the endpoint must establish a connection and route all websocket events to this SDK provided component as appropriate.

Parameters:

hr - SPIHandshakeRequest that is going to be checked.

Returns:

true if handshake is successful false otherwise.

onConnect

public abstract void onConnect(javax.net.websocket.RemoteEndpoint gs)

Called by the provider when the web socket connection is established.

Parameters:

gs - SPIRemoteEndpoint who has just connected to this web socket endpoint.

onMessage

public abstract void onMessage(javax.net.websocket.RemoteEndpoint gs,
             java.lang.String messageString)

Called by the provider when the web socket connection has an incoming text message from the given remote endpoint.

Parameters:

gs - SPIRemoteEndpoint who sent the message.

messageString - the String message.

onMessage

public abstract void onMessage(javax.net.websocket.RemoteEndpoint gs,
             java.nio.ByteBuffer bytes)

Called by the provider when the web socket connection has an incoming binary message from the given remote endpoint.

Parameters:

gs - SPIRemoteEndpoint who sent the message.

bytes - the message.

onClose

public abstract void onClose(javax.net.websocket.RemoteEndpoint gs)

Called by the provider when the web socket connection to the given remote endpoint has just closed.

Parameters:

gs - SPIRemoteEndpoint who has just closed the connection.

getSupportedProtocols

public abstract java.util.List<java.lang.String> getSupportedProtocols(java.util.List<java.lang.String> subProtocols)

Called by the provider during the handshake to determine a list of subprotocols this endpoint will support of those passed in.

Parameters:

subProtocols - the subprotocols to be checked.

Returns:

List of supported subprotocols.

remove

public abstract void remove()

Called by the provider after all connections have been closed to this endpoint, and after the endpoint has been removed from service.

onOpen

public void onOpen(javax.net.websocket.Session session)

Specified by:

onOpen in class javax.net.websocket.Endpoint