Nested and Inner Type Summary

Modifier and Type	Class and Description
private abstract class	AnnotatedEndpoint.MessageHandlerFactory
pack-priv static interface	AnnotatedEndpoint.ParameterExtractor
pack-priv static class	AnnotatedEndpoint.ParamValue
private class	AnnotatedEndpoint.PartialHandler
private class	AnnotatedEndpoint.WholeHandler

Field Summary

Modifier and Type	Field and Description
private final Class<?>	annotatedClass
private final Object	annotatedInstance
private final ComponentProviderService	componentProvider
private final EndpointConfig	configuration
private final EndpointEventListener	endpointEventListener
private static final Logger	LOGGER
private final Set<AnnotatedEndpoint.MessageHandlerFactory>	messageHandlerFactories
private final Method	onCloseMethod
private final AnnotatedEndpoint.ParameterExtractor[]	onCloseParameters
private final Method	onErrorMethod
private final AnnotatedEndpoint.ParameterExtractor[]	onErrorParameters
private final Method	onOpenMethod
private final AnnotatedEndpoint.ParameterExtractor[]	onOpenParameters

Constructor Summary

Access	Constructor and Description
private	AnnotatedEndpoint(Class<?> annotatedClass, Object instance, ComponentProviderService componentProvider, Boolean isServerEndpoint, int incomingBufferSize, ErrorCollector collector, EndpointEventListener endpointEventListener, Set<Extension> extensions)

Method Summary

Modifier and Type	Method and Description
private Object	callMethod(Method method, AnnotatedEndpoint.ParameterExtractor[] extractors, Session session, boolean callOnError, Object... params)
private EndpointConfig	createEndpointConfig(Class<?> annotatedClass, boolean isServerEndpoint, ErrorCollector collector, Set<Extension> extensions)
public static AnnotatedEndpoint	Returns: new instance. fromClass(Class<?> annotated class. annotatedClass, ComponentProviderService used for instantiating. componentProvider, boolean `true` iff annotated endpoint is deployed on server side. isServerEndpoint, int size limit of the incoming buffer. incomingBufferSize, ErrorCollector error collector. collector, EndpointEventListener listener of monitored endpoint events. endpointEventListener) Create `AnnotatedEndpoint` from class.
public static AnnotatedEndpoint	Returns: new instance. fromClass(Class<?> annotated class. annotatedClass, ComponentProviderService used for instantiating. componentProvider, boolean `true` iff annotated endpoint is deployed on server side. isServerEndpoint, int size limit of the incoming buffer. incomingBufferSize, ErrorCollector error collector. collector, EndpointEventListener listener of monitored endpoint events. endpointEventListener, Set<Extension> installed extentions. extensions) Create `AnnotatedEndpoint` from class.
public static AnnotatedEndpoint	Returns: new instance. fromInstance(Object annotated instance. annotatedInstance, ComponentProviderService used for instantiating. componentProvider, boolean `true` iff annotated endpoint is deployed on server side. isServerEndpoint, int size limit of the incoming buffer incomingBufferSize, ErrorCollector error collector. collector) Create `AnnotatedEndpoint` from instance.
public static AnnotatedEndpoint	Returns: new instance. fromInstance(Object annotated instance. annotatedInstance, ComponentProviderService used for instantiating. componentProvider, boolean `true` iff annotated endpoint is deployed on server side. isServerEndpoint, int size limit of the incoming buffer incomingBufferSize, ErrorCollector error collector. collector, Set<Extension> installed extentions. extensions) Create `AnnotatedEndpoint` from instance.
pack-priv static Class<?>	getDecoderClassType(Class<? extends Decoder> decoder)
pack-priv static Class<?>	getEncoderClassType(Class<? extends Encoder> encoder)
public EndpointConfig	getEndpointConfig()
private AnnotatedEndpoint.ParameterExtractor[]	getOnCloseParameterExtractors(final Method method, Map<Integer, Class<?>> unknownParams, ErrorCollector collector)
private AnnotatedEndpoint.ParameterExtractor[]	getParameterExtractors(final Method method, Map<Integer, Class<?>> unknownParams, ErrorCollector collector)
private AnnotatedEndpoint.ParameterExtractor[]	getParameterExtractors(final Method method, Map<Integer, Class<?>> unknownParams, Set<Class<?>> params, ErrorCollector collector)
private String	getPathParamName(Annotation[] annotations)
pack-priv void	onClose(CloseReason closeReason, Session session)
public void	onClose(Session the session about to be closed. session, CloseReason the reason the session was closed. closeReason) Overrides jakarta.websocket.Endpoint.onClose. This method is called immediately prior to the session with the remote peer being closed.
public void	onError(Session the session in use when the error occurs. session, Throwable the throwable representing the problem. thr) Overrides jakarta.websocket.Endpoint.onError. Developers may implement this method when the web socket session creates some kind of error that is not modeled in the web socket protocol.
public void	onOpen(Session the session that has just been activated. session, EndpointConfig the configuration used to configure this endpoint. configuration) Implements abstract jakarta.websocket.Endpoint.onOpen. Developers must implement this method to be notified when a new conversation has just begun.

Field Detail

annotatedClass	back to summary
private final Class<?> annotatedClass

annotatedInstance	back to summary
private final Object annotatedInstance

componentProvider	back to summary
private final ComponentProviderService componentProvider

configuration	back to summary
private final EndpointConfig configuration

endpointEventListener	back to summary
private final EndpointEventListener endpointEventListener

LOGGER	back to summary
private static final Logger LOGGER

messageHandlerFactories	back to summary
private final Set<AnnotatedEndpoint.MessageHandlerFactory> messageHandlerFactories

onCloseMethod	back to summary
private final Method onCloseMethod

onCloseParameters	back to summary
private final AnnotatedEndpoint.ParameterExtractor[] onCloseParameters

onErrorMethod	back to summary
private final Method onErrorMethod

onErrorParameters	back to summary
private final AnnotatedEndpoint.ParameterExtractor[] onErrorParameters

onOpenMethod	back to summary
private final Method onOpenMethod

onOpenParameters	back to summary
private final AnnotatedEndpoint.ParameterExtractor[] onOpenParameters

Constructor Detail

AnnotatedEndpoint	back to summary
private AnnotatedEndpoint(Class<?> annotatedClass, Object instance, ComponentProviderService componentProvider, Boolean isServerEndpoint, int incomingBufferSize, ErrorCollector collector, EndpointEventListener endpointEventListener, Set<Extension> extensions)

Method Detail

callMethod	back to summary
private Object callMethod(Method method, AnnotatedEndpoint.ParameterExtractor[] extractors, Session session, boolean callOnError, Object... params)

createEndpointConfig	back to summary
private EndpointConfig createEndpointConfig(Class<?> annotatedClass, boolean isServerEndpoint, ErrorCollector collector, Set<Extension> extensions)

fromClass back to summary

fromClass	back to summary
public static AnnotatedEndpoint fromClass(Class<?> annotatedClass, ComponentProviderService componentProvider, boolean isServerEndpoint, int incomingBufferSize, ErrorCollector collector, EndpointEventListener endpointEventListener) Create `AnnotatedEndpoint` from class. Parameters annotatedClass:Class<?> annotated class. componentProvider:ComponentProviderService used for instantiating. isServerEndpoint:boolean `true` iff annotated endpoint is deployed on server side. incomingBufferSize:int size limit of the incoming buffer. collector:ErrorCollector error collector. endpointEventListener:EndpointEventListener listener of monitored endpoint events. Returns:AnnotatedEndpoint new instance.

public static AnnotatedEndpoint fromClass(Class<?> annotatedClass, ComponentProviderService componentProvider, boolean isServerEndpoint, int incomingBufferSize, ErrorCollector collector, EndpointEventListener endpointEventListener)

Create AnnotatedEndpoint from class.

Parameters

annotatedClass:Class<?>: annotated class.
componentProvider:ComponentProviderService: used for instantiating.
isServerEndpoint:boolean: true iff annotated endpoint is deployed on server side.
incomingBufferSize:int: size limit of the incoming buffer.
collector:ErrorCollector: error collector.
endpointEventListener:EndpointEventListener: listener of monitored endpoint events.

Returns:AnnotatedEndpoint

new instance.

fromClass back to summary

fromClass	back to summary
public static AnnotatedEndpoint fromClass(Class<?> annotatedClass, ComponentProviderService componentProvider, boolean isServerEndpoint, int incomingBufferSize, ErrorCollector collector, EndpointEventListener endpointEventListener, Set<Extension> extensions) Create `AnnotatedEndpoint` from class. Parameters annotatedClass:Class<?> annotated class. componentProvider:ComponentProviderService used for instantiating. isServerEndpoint:boolean `true` iff annotated endpoint is deployed on server side. incomingBufferSize:int size limit of the incoming buffer. collector:ErrorCollector error collector. endpointEventListener:EndpointEventListener listener of monitored endpoint events. extensions:Set<Extension> installed extentions. Returns:AnnotatedEndpoint new instance.

Create AnnotatedEndpoint from class.

Parameters

annotatedClass:Class<?>: annotated class.
componentProvider:ComponentProviderService: used for instantiating.
isServerEndpoint:boolean: true iff annotated endpoint is deployed on server side.
incomingBufferSize:int: size limit of the incoming buffer.
collector:ErrorCollector: error collector.
endpointEventListener:EndpointEventListener: listener of monitored endpoint events.
extensions:Set<Extension>: installed extentions.

Returns:AnnotatedEndpoint

new instance.

fromInstance back to summary

fromInstance	back to summary
public static AnnotatedEndpoint fromInstance(Object annotatedInstance, ComponentProviderService componentProvider, boolean isServerEndpoint, int incomingBufferSize, ErrorCollector collector) Create `AnnotatedEndpoint` from instance. Parameters annotatedInstance:Object annotated instance. componentProvider:ComponentProviderService used for instantiating. isServerEndpoint:boolean `true` iff annotated endpoint is deployed on server side. incomingBufferSize:int size limit of the incoming buffer collector:ErrorCollector error collector. Returns:AnnotatedEndpoint new instance.

public static AnnotatedEndpoint fromInstance(Object annotatedInstance, ComponentProviderService componentProvider, boolean isServerEndpoint, int incomingBufferSize, ErrorCollector collector)

Create AnnotatedEndpoint from instance.

Parameters

annotatedInstance:Object: annotated instance.
componentProvider:ComponentProviderService: used for instantiating.
isServerEndpoint:boolean: true iff annotated endpoint is deployed on server side.
incomingBufferSize:int: size limit of the incoming buffer
collector:ErrorCollector: error collector.

Returns:AnnotatedEndpoint

new instance.

fromInstance back to summary

fromInstance	back to summary
public static AnnotatedEndpoint fromInstance(Object annotatedInstance, ComponentProviderService componentProvider, boolean isServerEndpoint, int incomingBufferSize, ErrorCollector collector, Set<Extension> extensions) Create `AnnotatedEndpoint` from instance. Parameters annotatedInstance:Object annotated instance. componentProvider:ComponentProviderService used for instantiating. isServerEndpoint:boolean `true` iff annotated endpoint is deployed on server side. incomingBufferSize:int size limit of the incoming buffer collector:ErrorCollector error collector. extensions:Set<Extension> installed extentions. Returns:AnnotatedEndpoint new instance.

public static AnnotatedEndpoint fromInstance(Object annotatedInstance, ComponentProviderService componentProvider, boolean isServerEndpoint, int incomingBufferSize, ErrorCollector collector, Set<Extension> extensions)

Create AnnotatedEndpoint from instance.

Parameters

annotatedInstance:Object: annotated instance.
componentProvider:ComponentProviderService: used for instantiating.
isServerEndpoint:boolean: true iff annotated endpoint is deployed on server side.
incomingBufferSize:int: size limit of the incoming buffer
collector:ErrorCollector: error collector.
extensions:Set<Extension>: installed extentions.

Returns:AnnotatedEndpoint

new instance.

getDecoderClassType	back to summary
pack-priv static Class<?> getDecoderClassType(Class<? extends Decoder> decoder)

getEncoderClassType	back to summary
pack-priv static Class<?> getEncoderClassType(Class<? extends Encoder> encoder)

getEndpointConfig	back to summary
public EndpointConfig getEndpointConfig()

getOnCloseParameterExtractors	back to summary
private AnnotatedEndpoint.ParameterExtractor[] getOnCloseParameterExtractors(final Method method, Map<Integer, Class<?>> unknownParams, ErrorCollector collector)

getParameterExtractors	back to summary
private AnnotatedEndpoint.ParameterExtractor[] getParameterExtractors(final Method method, Map<Integer, Class<?>> unknownParams, ErrorCollector collector)

getParameterExtractors	back to summary
private AnnotatedEndpoint.ParameterExtractor[] getParameterExtractors(final Method method, Map<Integer, Class<?>> unknownParams, Set<Class<?>> params, ErrorCollector collector)

getPathParamName	back to summary
private String getPathParamName(Annotation[] annotations)

onClose	back to summary
pack-priv void onClose(CloseReason closeReason, Session session)

onClose	back to summary
public void onClose(Session session, CloseReason closeReason) Overrides jakarta.websocket.Endpoint.onClose. Doc from jakarta.websocket.Endpoint.onClose. This method is called immediately prior to the session with the remote peer being closed. It is called whether the session is being closed because the remote peer initiated a close and sent a close frame, or whether the local websocket container or this endpoint requests to close the session. The developer may take this last opportunity to retrieve session attributes such as the ID, or any application data it holds before it becomes unavailable after the completion of the method. Developers should not attempt to modify the session from within this method, or send new messages from this call as the underlying connection will not be able to send them at this stage. Parameters session:Session the session about to be closed. closeReason:CloseReason the reason the session was closed. Annotations @Override

onClose

back to summary

public void onClose(Session session, CloseReason closeReason)

Overrides jakarta.websocket.Endpoint.onClose.

Doc from jakarta.websocket.Endpoint.onClose.

This method is called immediately prior to the session with the remote peer being closed. It is called whether the session is being closed because the remote peer initiated a close and sent a close frame, or whether the local websocket container or this endpoint requests to close the session. The developer may take this last opportunity to retrieve session attributes such as the ID, or any application data it holds before it becomes unavailable after the completion of the method. Developers should not attempt to modify the session from within this method, or send new messages from this call as the underlying connection will not be able to send them at this stage.

Parameters

session:Session: the session about to be closed.
closeReason:CloseReason: the reason the session was closed.

Annotations

@Override

onError back to summary

onError	back to summary
public void onError(Session session, Throwable thr) Overrides jakarta.websocket.Endpoint.onError. Doc from jakarta.websocket.Endpoint.onError. Developers may implement this method when the web socket session creates some kind of error that is not modeled in the web socket protocol. This may for example be a notification that an incoming message is too big to handle, or that the incoming message could not be encoded. There are a number of categories of exception that this method is (currently) defined to handle: connection problems, for example, a socket failure that occurs before the web socket connection can be formally closed. These are modeled as `SessionException`s runtime errors thrown by developer created message handlers calls. conversion errors encoding incoming messages before any message handler has been called. These are modeled as `DecodeException`s Parameters session:Session the session in use when the error occurs. thr:Throwable the throwable representing the problem. Annotations @Override

public void onError(Session session, Throwable thr)

Overrides jakarta.websocket.Endpoint.onError.

Doc from jakarta.websocket.Endpoint.onError.

Developers may implement this method when the web socket session creates some kind of error that is not modeled in the web socket protocol. This may for example be a notification that an incoming message is too big to handle, or that the incoming message could not be encoded.

There are a number of categories of exception that this method is (currently) defined to handle:

connection problems, for example, a socket failure that occurs before the web socket connection can be formally closed. These are modeled as SessionExceptions
runtime errors thrown by developer created message handlers calls.
conversion errors encoding incoming messages before any message handler has been called. These are modeled as DecodeExceptions

Parameters

session:Session: the session in use when the error occurs.
thr:Throwable: the throwable representing the problem.

Annotations

@Override

onOpen back to summary

onOpen	back to summary
public void onOpen(Session session, EndpointConfig configuration) Implements abstract jakarta.websocket.Endpoint.onOpen. Doc from jakarta.websocket.Endpoint.onOpen. Developers must implement this method to be notified when a new conversation has just begun. Note: It is permitted to send messages from this method. It is permitted to add `MessageHandler`s from this method. No messages will be mapped to the appropriate `MessageHandler` until this method has completed. Parameters session:Session the session that has just been activated. configuration:EndpointConfig the configuration used to configure this endpoint. Annotations @Override

public void onOpen(Session session, EndpointConfig configuration)

Implements abstract jakarta.websocket.Endpoint.onOpen.

Doc from jakarta.websocket.Endpoint.onOpen.

Developers must implement this method to be notified when a new conversation has just begun.

Note:

It is permitted to send messages from this method.
It is permitted to add MessageHandlers from this method. No messages will be mapped to the appropriate MessageHandler until this method has completed.

Parameters

session:Session: the session that has just been activated.
configuration:EndpointConfig: the configuration used to configure this endpoint.

Annotations

@Override

org.glassfish.tyrus.core back to summary

private abstract Class AnnotatedEndpoint.MessageHandlerFactory

Class Inheritance

extends Object

java.lang.Object
org.glassfish.tyrus.core.AnnotatedEndpoint.MessageHandlerFactory

Known Direct Subclasses

org.glassfish.tyrus.core.AnnotatedEndpoint.WholeHandler, org.glassfish.tyrus.core.AnnotatedEndpoint.PartialHandler

Field Summary

Modifier and Type	Field and Description
pack-priv final AnnotatedEndpoint.ParameterExtractor[]	extractors
pack-priv final long	maxMessageSize
pack-priv final Method	method
pack-priv final Class<?>	type

Constructor Summary

Access	Constructor and Description
pack-priv	MessageHandlerFactory(Method method, AnnotatedEndpoint.ParameterExtractor[] extractors, Class<?> type, long maxMessageSize)

Method Summary

Modifier and Type	Method and Description
pack-priv abstract MessageHandler	create(Session session)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

extractors	back to summary
pack-priv final AnnotatedEndpoint.ParameterExtractor[] extractors

maxMessageSize	back to summary
pack-priv final long maxMessageSize

method	back to summary
pack-priv final Method method

type	back to summary
pack-priv final Class<?> type

Constructor Detail

MessageHandlerFactory	back to summary
pack-priv MessageHandlerFactory(Method method, AnnotatedEndpoint.ParameterExtractor[] extractors, Class<?> type, long maxMessageSize)

Method Detail

create	back to summary
pack-priv abstract MessageHandler create(Session session)

org.glassfish.tyrus.core back to summary

pack-priv Interface AnnotatedEndpoint.ParameterExtractor

Known Direct Implementers: org.glassfish.tyrus.core.AnnotatedEndpoint.ParamValue

Method Summary

Modifier and Type	Method and Description
public Object	value(Session session, Object... paramValues)

Method Detail

value	back to summary
public Object value(Session session, Object... paramValues) throws DecodeException

org.glassfish.tyrus.core back to summary

pack-priv Class AnnotatedEndpoint.ParamValue

Class Inheritance

extends Object
implements ParameterExtractor

java.lang.Object
org.glassfish.tyrus.core.AnnotatedEndpoint.ParamValue

All Implemented Interfaces

org.glassfish.tyrus.core.AnnotatedEndpoint.ParameterExtractor

Field Summary

Modifier and Type	Field and Description
private final int	index

Constructor Summary

Access	Constructor and Description
pack-priv	ParamValue(int index)

Method Summary

Modifier and Type	Method and Description
public Object	value(Session session, Object... paramValues) Implements org.glassfish.tyrus.core.AnnotatedEndpoint.ParameterExtractor.value.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

index	back to summary
private final int index

Constructor Detail

ParamValue	back to summary
pack-priv ParamValue(int index)

Method Detail

value

back to summary

public Object value(Session session, Object... paramValues)

Implements org.glassfish.tyrus.core.AnnotatedEndpoint.ParameterExtractor.value.

Annotations

@Override

org.glassfish.tyrus.core back to summary

private Class AnnotatedEndpoint.PartialHandler

Class Inheritance

extends MessageHandlerFactory

java.lang.Object
org.glassfish.tyrus.core.AnnotatedEndpoint.MessageHandlerFactory
org.glassfish.tyrus.core.AnnotatedEndpoint.PartialHandler

Field Summary

Inherited from org.glassfish.tyrus.core.AnnotatedEndpoint.MessageHandlerFactory:: extractors maxMessageSize method type

Constructor Summary

Access	Constructor and Description
pack-priv	PartialHandler(Method method, AnnotatedEndpoint.ParameterExtractor[] extractors, Class<?> type, long maxMessageSize)

Method Summary

Modifier and Type	Method and Description
public MessageHandler	create(final Session session) Implements abstract org.glassfish.tyrus.core.AnnotatedEndpoint.MessageHandlerFactory.create.

Constructor Detail

PartialHandler	back to summary
pack-priv PartialHandler(Method method, AnnotatedEndpoint.ParameterExtractor[] extractors, Class<?> type, long maxMessageSize)

Method Detail

create

back to summary

public MessageHandler create(final Session session)

Implements abstract org.glassfish.tyrus.core.AnnotatedEndpoint.MessageHandlerFactory.create.

Annotations

@Override

org.glassfish.tyrus.core back to summary

private Class AnnotatedEndpoint.WholeHandler

Class Inheritance

extends MessageHandlerFactory

java.lang.Object
org.glassfish.tyrus.core.AnnotatedEndpoint.MessageHandlerFactory
org.glassfish.tyrus.core.AnnotatedEndpoint.WholeHandler

Field Summary

Inherited from org.glassfish.tyrus.core.AnnotatedEndpoint.MessageHandlerFactory:: extractors maxMessageSize method type

Constructor Summary

Access	Constructor and Description
pack-priv	WholeHandler(Method method, AnnotatedEndpoint.ParameterExtractor[] extractors, Class<?> type, long maxMessageSize)

Method Summary

Modifier and Type	Method and Description
public MessageHandler	create(final Session session) Implements abstract org.glassfish.tyrus.core.AnnotatedEndpoint.MessageHandlerFactory.create.

Constructor Detail

WholeHandler	back to summary
pack-priv WholeHandler(Method method, AnnotatedEndpoint.ParameterExtractor[] extractors, Class<?> type, long maxMessageSize)

Method Detail

create

back to summary

public MessageHandler create(final Session session)

Implements abstract org.glassfish.tyrus.core.AnnotatedEndpoint.MessageHandlerFactory.create.

Annotations

@Override

public Class AnnotatedEndpoint

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private abstract Class AnnotatedEndpoint.MessageHandlerFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface AnnotatedEndpoint.ParameterExtractor

Method Summary

Method Detail

pack-priv Class AnnotatedEndpoint.ParamValue

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class AnnotatedEndpoint.PartialHandler

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class AnnotatedEndpoint.WholeHandler

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail