org.glassfish.tyrus.core

Class AnnotatedEndpoint

java.lang.Object

javax.websocket.Endpoint

org.glassfish.tyrus.core.AnnotatedEndpoint

public class AnnotatedEndpoint
extends javax.websocket.Endpoint

AnnotatedEndpoint of a class annotated using the ServerEndpoint annotations.

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
static AnnotatedEndpoint	fromClass(Class<?> annotatedClass, ComponentProviderService componentProvider, boolean isServerEndpoint, ErrorCollector collector) Create AnnotatedEndpoint from class.
static AnnotatedEndpoint	fromInstance(Object annotatedInstance, ComponentProviderService componentProvider, boolean isServerEndpoint, ErrorCollector collector) Create AnnotatedEndpoint from instance.
javax.websocket.EndpointConfig	getEndpointConfig()
void	onClose(javax.websocket.Session session, javax.websocket.CloseReason closeReason)
void	onError(javax.websocket.Session session, Throwable thr)
void	onOpen(javax.websocket.Session session, javax.websocket.EndpointConfig configuration)

Methods inherited from class java.lang.Object

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

Method Detail

fromClass

public static AnnotatedEndpoint fromClass(Class<?> annotatedClass,
                          ComponentProviderService componentProvider,
                          boolean isServerEndpoint,
                          ErrorCollector collector)
                                   throws javax.websocket.DeploymentException

Create AnnotatedEndpoint from class.

Parameters:

annotatedClass - annotated class.

componentProvider - used for instantiating.

isServerEndpoint - true iff annotated endpoint is deployed on server side.

collector - error collector.

Returns:

new instance.

Throws:

javax.websocket.DeploymentException - TODO remove

fromInstance

public static AnnotatedEndpoint fromInstance(Object annotatedInstance,
                             ComponentProviderService componentProvider,
                             boolean isServerEndpoint,
                             ErrorCollector collector)
                                      throws javax.websocket.DeploymentException

Create AnnotatedEndpoint from instance.

Parameters:

annotatedInstance - annotated instance.

componentProvider - used for instantiating.

isServerEndpoint - true iff annotated endpoint is deployed on server side.

collector - error collector.

Returns:

new instance.

Throws:

javax.websocket.DeploymentException - TODO remove

onClose

public void onClose(javax.websocket.Session session,
           javax.websocket.CloseReason closeReason)

Overrides:

onClose in class javax.websocket.Endpoint

onError

public void onError(javax.websocket.Session session,
           Throwable thr)

Overrides:

onError in class javax.websocket.Endpoint

getEndpointConfig

public javax.websocket.EndpointConfig getEndpointConfig()

onOpen

public void onOpen(javax.websocket.Session session,
          javax.websocket.EndpointConfig configuration)

Specified by:

onOpen in class javax.websocket.Endpoint