org.glassfish.tyrus.spi

Class SPIEndpoint

java.lang.Object

org.glassfish.tyrus.spi.SPIEndpoint

public abstract class SPIEndpoint
extends Object

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

Author:

Danny Coward (danny.coward at oracle.com), Stepan Kopriva (stepan.kopriva at oracle.com), Pavel Bucek (pavel.bucek at oracle.com)

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 javax.websocket.Session	createSessionForRemoteEndpoint(SPIRemoteEndpoint re, String subprotocol, List<javax.websocket.Extension> extensions) Creates a Session based on the SPIRemoteEndpoint, subprotocols and extensions.
abstract javax.websocket.EndpointConfig	getEndpointConfig() Get Endpoint configuration.
abstract List<javax.websocket.Extension>	getNegotiatedExtensions(List<javax.websocket.Extension> clientExtensions) Get the negotiated extensions' names based on the extensions supported by client.
abstract String	getNegotiatedProtocol(List<String> clientProtocols) Compute the sub - protocol which will be used.
abstract Set<javax.websocket.Session>	getOpenSessions() Get the endpoint's open Sessions.
abstract void	onClose(SPIRemoteEndpoint gs, javax.websocket.CloseReason closeReason) Called by the provider when the web socket connection to the given remote endpoint has just closed.
abstract void	onConnect(SPIRemoteEndpoint gs, String subprotocol, List<javax.websocket.Extension> extensions) Called by the provider when the web socket connection is established.
abstract void	onMessage(SPIRemoteEndpoint gs, ByteBuffer bytes) Called by the provider when the web socket connection has an incoming binary message from the given remote endpoint.
abstract void	onMessage(SPIRemoteEndpoint gs, String messageString) Called by the provider when the web socket connection has an incoming text message from the given remote endpoint.
abstract void	onPartialMessage(SPIRemoteEndpoint gs, ByteBuffer partialBytes, boolean last) Called by the provider when the web socket connection has an incoming partial binary message from the given remote endpoint.
abstract void	onPartialMessage(SPIRemoteEndpoint gs, String partialString, boolean last) Called by the provider when the web socket connection has an incoming partial text message from the given remote endpoint.
abstract void	onPing(SPIRemoteEndpoint gs, ByteBuffer bytes) Called by the provider when the web socket connection has an incoming ping message from the given remote endpoint.
abstract void	onPong(SPIRemoteEndpoint gs, ByteBuffer bytes) Called by the provider when the web socket connection has an incoming pong message from the given remote endpoint.
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 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(SPIRemoteEndpoint gs,
             String subprotocol,
             List<javax.websocket.Extension> extensions)

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(SPIRemoteEndpoint gs,
             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.

onPartialMessage

public abstract void onPartialMessage(SPIRemoteEndpoint gs,
                    String partialString,
                    boolean last)

Called by the provider when the web socket connection has an incoming partial text message from the given remote endpoint. Partial text messages are passed in sequential order, one piece at a time. If an implementation does not support streaming, it will need to reconstruct the message here and pass the whole thing along.

Parameters:

gs - SPIRemoteEndpoint who sent the message.

partialString - the String message.

last - to indicate if this is the last partial string in the sequence

onPartialMessage

public abstract void onPartialMessage(SPIRemoteEndpoint gs,
                    ByteBuffer partialBytes,
                    boolean last)

Called by the provider when the web socket connection has an incoming partial binary message from the given remote endpoint. Partial binary messages are passed in sequential order, one piece at a time. If an implementation does not support streaming, it will need to reconstruct the message here and pass the whole thing along.

Parameters:

gs - SPIRemoteEndpoint who sent the message.

partialBytes - the piece of the binary message.

last - to indicate if this is the last partial byte buffer in the sequence

onMessage

public abstract void onMessage(SPIRemoteEndpoint gs,
             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.

onPong

public abstract void onPong(SPIRemoteEndpoint gs,
          ByteBuffer bytes)

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

Parameters:

gs - SPIRemoteEndpoint who sent the message.

bytes - the message.

onPing

public abstract void onPing(SPIRemoteEndpoint gs,
          ByteBuffer bytes)

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

Parameters:

gs - SPIRemoteEndpoint who sent the message.

bytes - the message.

onClose

public abstract void onClose(SPIRemoteEndpoint gs,
           javax.websocket.CloseReason closeReason)

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.

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.

getNegotiatedExtensions

public abstract List<javax.websocket.Extension> getNegotiatedExtensions(List<javax.websocket.Extension> clientExtensions)

Get the negotiated extensions' names based on the extensions supported by client.

Parameters:

clientExtensions - names of the extensions' supported by client.

Returns:

names of extensions supported by both client and class that implements this one.

getNegotiatedProtocol

public abstract String getNegotiatedProtocol(List<String> clientProtocols)

Compute the sub - protocol which will be used.

Parameters:

clientProtocols - sub - protocols supported by client.

Returns:

negotiated sub - protocol, null if none found.

getOpenSessions

public abstract Set<javax.websocket.Session> getOpenSessions()

Get the endpoint's open Sessions.

Returns:

open sessions.

createSessionForRemoteEndpoint

public abstract javax.websocket.Session createSessionForRemoteEndpoint(SPIRemoteEndpoint re,
                                                     String subprotocol,
                                                     List<javax.websocket.Extension> extensions)

Creates a Session based on the SPIRemoteEndpoint, subprotocols and extensions.

Parameters:

re - the other end of the connection.

subprotocol - used.

extensions - extensions used.

Returns:

Session representing the connection.

getEndpointConfig

public abstract javax.websocket.EndpointConfig getEndpointConfig()

Get Endpoint configuration.

Returns:

configuration.