org.glassfish.tyrus.core

Class TyrusEndpointWrapper

java.lang.Object

org.glassfish.tyrus.core.TyrusEndpointWrapper

public class TyrusEndpointWrapper
extends Object

Wraps the registered application class. There is one TyrusEndpointWrapper for each application class, which handles all the methods.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TyrusEndpointWrapper.SessionListener Session listener.

Constructor Summary

Constructors

Constructor and Description
TyrusEndpointWrapper(Class<? extends Endpoint> endpointClass, EndpointConfig configuration, ComponentProviderService componentProvider, WebSocketContainer container, String contextPath, ServerEndpointConfig.Configurator configurator, TyrusEndpointWrapper.SessionListener sessionListener, ClusterContext clusterContext, EndpointEventListener endpointEventListener) Create TyrusEndpointWrapper for class that extends Endpoint.
TyrusEndpointWrapper(Endpoint endpoint, EndpointConfig configuration, ComponentProviderService componentProvider, WebSocketContainer container, String contextPath, ServerEndpointConfig.Configurator configurator, TyrusEndpointWrapper.SessionListener sessionListener, ClusterContext clusterContext, EndpointEventListener endpointEventListener) Create TyrusEndpointWrapper for Endpoint instance or AnnotatedEndpoint instance.

Method Summary

Methods

Modifier and Type	Method and Description
Map<Session,Future<?>>	broadcast(ByteBuffer message) Broadcasts binary message to all connected clients.
Map<Session,Future<?>>	broadcast(String message) Broadcasts text message to all connected clients.
Session	createSessionForRemoteEndpoint(TyrusWebSocket socket, String subprotocol, List<Extension> extensions) Creates a Session based on the TyrusWebSocket, subprotocols and extensions.
TyrusWebSocket	createSocket(ProtocolHandler handler) Factory method to create new TyrusWebSocket instances.
Object	doEncode(Session session, Object message)
EndpointConfig	getEndpointConfig() Get Endpoint configuration.
String	getEndpointPath() Server-side; Get Endpoint absolute path.
List<Extension>	getNegotiatedExtensions(List<Extension> clientExtensions) Server-side; Get the negotiated extensions' names based on the extensions supported by client.
String	getNegotiatedProtocol(List<String> clientProtocols) Server-side; Compute the sub-protocol which will be used.
Set<Session>	getOpenSessions(TyrusSession tyrusSession) Get the endpoint's open Sessions.
String	getServerEndpointPath() Server-side; Get server endpoint path.
void	onClose(TyrusWebSocket socket, CloseReason closeReason) Called by the provider when the web socket connection to the given remote endpoint has just closed.
Session	onConnect(TyrusWebSocket socket, UpgradeRequest upgradeRequest, String subProtocol, List<Extension> extensions, String connectionId) Called by the provider when the web socket connection is established.
boolean	onError(TyrusWebSocket socket, Throwable t) This method will be invoked if an unexpected exception is caught by the WebSocket runtime.
void	onHandShakeResponse(UpgradeRequest request, UpgradeResponse response) Invoked when server side handshake is ready to send response.
void	onMessage(TyrusWebSocket socket, ByteBuffer messageBytes) Called by the provider when the web socket connection has an incoming text message from the given remote endpoint.
void	onMessage(TyrusWebSocket socket, String messageString) Called by the provider when the web socket connection has an incoming text message from the given remote endpoint.
void	onPartialMessage(TyrusWebSocket socket, ByteBuffer partialBytes, boolean last) Called by the provider when the web socket connection has an incoming partial binary message from the given remote endpoint.
void	onPartialMessage(TyrusWebSocket socket, String partialString, boolean last) Called by the provider when the web socket connection has an incoming partial text message from the given remote endpoint.
void	onPing(TyrusWebSocket socket, ByteBuffer bytes) Called by the provider when the web socket connection has an incoming ping message from the given remote endpoint.
void	onPong(TyrusWebSocket socket, ByteBuffer bytes) Called by the provider when the web socket connection has an incoming pong message from the given remote endpoint.
String	toString()
boolean	upgrade(UpgradeRequest request) Server side check for protocol specific information to determine whether the request can be upgraded.

Methods inherited from class java.lang.Object

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

Constructor Detail

TyrusEndpointWrapper

public TyrusEndpointWrapper(Class<? extends Endpoint> endpointClass,
                    EndpointConfig configuration,
                    ComponentProviderService componentProvider,
                    WebSocketContainer container,
                    String contextPath,
                    ServerEndpointConfig.Configurator configurator,
                    TyrusEndpointWrapper.SessionListener sessionListener,
                    ClusterContext clusterContext,
                    EndpointEventListener endpointEventListener)
                     throws DeploymentException

Create TyrusEndpointWrapper for class that extends Endpoint.

Parameters:

endpointClass - endpoint class for which the wrapper is created.

configuration - endpoint configuration.

componentProvider - component provider.

container - container where the wrapper is running.

clusterContext - cluster context instance. null indicates standalone mode.

endpointEventListener - endpoint event listener.

Throws:

DeploymentException

TyrusEndpointWrapper

public TyrusEndpointWrapper(Endpoint endpoint,
                    EndpointConfig configuration,
                    ComponentProviderService componentProvider,
                    WebSocketContainer container,
                    String contextPath,
                    ServerEndpointConfig.Configurator configurator,
                    TyrusEndpointWrapper.SessionListener sessionListener,
                    ClusterContext clusterContext,
                    EndpointEventListener endpointEventListener)
                     throws DeploymentException

Create TyrusEndpointWrapper for Endpoint instance or AnnotatedEndpoint instance.

Parameters:

endpoint - endpoint instance for which the wrapper is created.

configuration - endpoint configuration.

componentProvider - component provider.

container - container where the wrapper is running.

clusterContext - cluster context instance. null indicates standalone mode.

endpointEventListener - endpoint event listener.

Throws:

DeploymentException

Method Detail

doEncode

public Object doEncode(Session session,
              Object message)
                throws EncodeException,
                       IOException

Throws:

EncodeException

IOException

getEndpointPath

public String getEndpointPath()

Server-side; Get Endpoint absolute path.

Returns:

endpoint absolute path.

getServerEndpointPath

public String getServerEndpointPath()

Server-side; Get server endpoint path.

In this context, server endpoint path is exactly what is present in ServerEndpoint annotation or returned from ServerEndpointConfig.getPath() method call. Context path is not included.

Returns:

server endpoint path.

See Also:

ServerEndpoint.value(), ServerEndpointConfig.getPath()

getNegotiatedExtensions

public List<Extension> getNegotiatedExtensions(List<Extension> clientExtensions)

Server-side; 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 String getNegotiatedProtocol(List<String> clientProtocols)

Server-side; 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 Set<Session> getOpenSessions(TyrusSession tyrusSession)

Get the endpoint's open Sessions.

Parameters:

tyrusSession - only for clustering purpose (local encoder will be used when needed).

Returns:

open sessions.

createSessionForRemoteEndpoint

public Session createSessionForRemoteEndpoint(TyrusWebSocket socket,
                                     String subprotocol,
                                     List<Extension> extensions)

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

Parameters:

socket - the other end of the connection.

subprotocol - used.

extensions - extensions used.

Returns:

Session representing the connection.

onConnect

public Session onConnect(TyrusWebSocket socket,
                UpgradeRequest upgradeRequest,
                String subProtocol,
                List<Extension> extensions,
                String connectionId)

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

Parameters:

socket - TyrusWebSocket who has just connected to this web socket endpoint.

upgradeRequest - request associated with accepted connection.

Returns:

Created Session instance or null when session was not created properly (max sessions limit on endpoint or application or issues with endpoint validation).

onMessage

public void onMessage(TyrusWebSocket socket,
             ByteBuffer messageBytes)

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

Parameters:

socket - TyrusWebSocket who sent the message.

messageBytes - the message.

onMessage

public void onMessage(TyrusWebSocket socket,
             String messageString)

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

Parameters:

socket - TyrusWebSocket who sent the message.

messageString - the message.

onPartialMessage

public void onPartialMessage(TyrusWebSocket socket,
                    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:

socket - TyrusWebSocket who sent the message.

partialString - the String message.

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

onPartialMessage

public void onPartialMessage(TyrusWebSocket socket,
                    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:

socket - TyrusWebSocket 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

onPong

public void onPong(TyrusWebSocket socket,
          ByteBuffer bytes)

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

Parameters:

socket - TyrusWebSocket who sent the message.

bytes - the message.

onPing

public void onPing(TyrusWebSocket socket,
          ByteBuffer bytes)

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

The endpoint needs to respond as soon as possible (see the websocket RFC). No involvement from application layer, there is no ping listener.

Parameters:

socket - TyrusWebSocket who sent the message.

bytes - the message.

onClose

public void onClose(TyrusWebSocket socket,
           CloseReason closeReason)

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

Parameters:

socket - TyrusWebSocket who has just closed the connection.

getEndpointConfig

public EndpointConfig getEndpointConfig()

Get Endpoint configuration.

Returns:

configuration.

broadcast

public Map<Session,Future<?>> broadcast(String message)

Broadcasts text message to all connected clients.

Parameters:

message - message to be broadcasted.

Returns:

map of sessions and futures for user to get the information about status of the message. Messages send from other cluster nodes are not included.

broadcast

public Map<Session,Future<?>> broadcast(ByteBuffer message)

Broadcasts binary message to all connected clients.

Parameters:

message - message to be broadcasted.

Returns:

map of sessions and futures for user to get the information about status of the message. Messages send from other cluster nodes are not included.

toString

public String toString()

Overrides:

toString in class Object

upgrade

public final boolean upgrade(UpgradeRequest request)

Server side check for protocol specific information to determine whether the request can be upgraded.

The default implementation will check for the presence of the Upgrade header with a value of WebSocket.

Parameters:

request - TODO

Returns:

true if the request should be upgraded to a WebSocket connection

createSocket

public TyrusWebSocket createSocket(ProtocolHandler handler)

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

Parameters:

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

Returns:

TODO

onError

public boolean onError(TyrusWebSocket socket,
              Throwable t)

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

Parameters:

socket - 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 void onHandShakeResponse(UpgradeRequest request,
                       UpgradeResponse 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.