org.glassfish.tyrus.core

Class EndpointWrapper

java.lang.Object

org.glassfish.tyrus.spi.SPIEndpoint

org.glassfish.tyrus.core.EndpointWrapper

public class EndpointWrapper
extends SPIEndpoint

Wraps the registered application class. There is one EndpointWrapper 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)

Constructor Summary

Constructors

Constructor and Description
EndpointWrapper(Class<?> endpointClass, javax.websocket.EndpointConfig configuration, ComponentProviderService componentProvider, BaseContainer container, String contextPath, ErrorCollector collector, javax.websocket.server.ServerEndpointConfig.Configurator configurator) Create EndpointWrapper for class that extends Endpoint.
EndpointWrapper(javax.websocket.Endpoint endpoint, javax.websocket.EndpointConfig configuration, ComponentProviderService componentProvider, BaseContainer container, String contextPath, ErrorCollector collector, javax.websocket.server.ServerEndpointConfig.Configurator configurator) Create EndpointWrapper for Endpoint instance or AnnotatedEndpoint instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkHandshake(SPIHandshakeRequest hr)
javax.websocket.Session	createSessionForRemoteEndpoint(SPIRemoteEndpoint re, String subprotocol, List<javax.websocket.Extension> extensions)
javax.websocket.EndpointConfig	getEndpointConfig()
String	getEndpointPath()
List<javax.websocket.Extension>	getNegotiatedExtensions(List<javax.websocket.Extension> clientExtensions)
String	getNegotiatedProtocol(List<String> clientProtocols)
Set<javax.websocket.Session>	getOpenSessions()
javax.websocket.WebSocketContainer	getWebSocketContainer()
void	onClose(SPIRemoteEndpoint gs, javax.websocket.CloseReason closeReason)
void	onConnect(SPIRemoteEndpoint gs, String subprotocol, List<javax.websocket.Extension> extensions)
void	onMessage(SPIRemoteEndpoint gs, ByteBuffer messageBytes)
void	onMessage(SPIRemoteEndpoint gs, String messageString)
void	onPartialMessage(SPIRemoteEndpoint gs, ByteBuffer partialBytes, boolean last)
void	onPartialMessage(SPIRemoteEndpoint gs, String partialString, boolean last)
void	onPing(SPIRemoteEndpoint gs, ByteBuffer bytes)
void	onPong(SPIRemoteEndpoint gs, ByteBuffer bytes)
void	remove()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointWrapper

public EndpointWrapper(Class<?> endpointClass,
               javax.websocket.EndpointConfig configuration,
               ComponentProviderService componentProvider,
               BaseContainer container,
               String contextPath,
               ErrorCollector collector,
               javax.websocket.server.ServerEndpointConfig.Configurator configurator)

Create EndpointWrapper 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.

contextPath - context path.

collector - error collector.

EndpointWrapper

public EndpointWrapper(javax.websocket.Endpoint endpoint,
               javax.websocket.EndpointConfig configuration,
               ComponentProviderService componentProvider,
               BaseContainer container,
               String contextPath,
               ErrorCollector collector,
               javax.websocket.server.ServerEndpointConfig.Configurator configurator)

Create EndpointWrapper 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.

contextPath - context path.

collector - error collector.

Method Detail

checkHandshake

public boolean checkHandshake(SPIHandshakeRequest hr)

Specified by:

checkHandshake in class SPIEndpoint

getEndpointPath

public String getEndpointPath()

Specified by:

getEndpointPath in class SPIEndpoint

getWebSocketContainer

public javax.websocket.WebSocketContainer getWebSocketContainer()

Specified by:

getWebSocketContainer in class SPIEndpoint

getNegotiatedExtensions

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

Specified by:

getNegotiatedExtensions in class SPIEndpoint

getNegotiatedProtocol

public String getNegotiatedProtocol(List<String> clientProtocols)

Specified by:

getNegotiatedProtocol in class SPIEndpoint

getOpenSessions

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

Specified by:

getOpenSessions in class SPIEndpoint

createSessionForRemoteEndpoint

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

Specified by:

createSessionForRemoteEndpoint in class SPIEndpoint

remove

public void remove()

Specified by:

remove in class SPIEndpoint

onConnect

public void onConnect(SPIRemoteEndpoint gs,
             String subprotocol,
             List<javax.websocket.Extension> extensions)

Specified by:

onConnect in class SPIEndpoint

onMessage

public void onMessage(SPIRemoteEndpoint gs,
             ByteBuffer messageBytes)

Specified by:

onMessage in class SPIEndpoint

onMessage

public void onMessage(SPIRemoteEndpoint gs,
             String messageString)

Specified by:

onMessage in class SPIEndpoint

onPartialMessage

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

Specified by:

onPartialMessage in class SPIEndpoint

onPartialMessage

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

Specified by:

onPartialMessage in class SPIEndpoint

onPong

public void onPong(SPIRemoteEndpoint gs,
          ByteBuffer bytes)

Specified by:

onPong in class SPIEndpoint

onPing

public void onPing(SPIRemoteEndpoint gs,
          ByteBuffer bytes)

Specified by:

onPing in class SPIEndpoint

onClose

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

Specified by:

onClose in class SPIEndpoint

getEndpointConfig

public javax.websocket.EndpointConfig getEndpointConfig()

Specified by:

getEndpointConfig in class SPIEndpoint

toString

public String toString()

Overrides:

toString in class Object