Modifier and Type	Class and Description
public static enum	RemoteSession.DistributedMapKey

Modifier and Type	Field and Description
private final RemoteEndpoint.Async	asyncRemote
private final RemoteEndpoint.Basic	basicRemote
private final ClusterContext	clusterContext
private final String	connectionId
private final Map<RemoteSession.DistributedMapKey, Object>	distributedPropertyMap
private final TyrusEndpointWrapper	endpointWrapper
private final String	sessionId
private static final Integer	SYNC_SEND_TIMEOUT

Access	Constructor and Description
public	RemoteSession(final String session id. sessionId, final ClusterContext cluster context. clusterContext, final Map<RemoteSession.DistributedMapKey, Object> distributed property map. distributedPropertyMap, final TyrusEndpointWrapper used just to get encoders/decoders. endpointWrapper, final Session used just to get encoders/decoders. session) Constructor.

Method Summary

Modifier and Type	Method and Description
public void	addMessageHandler(MessageHandler nothing. handler) Implements jakarta.websocket.Session.addMessageHandler. This method is not supported on `RemoteSession`.
public <T> void	addMessageHandler(Class<T> nothing. clazz, MessageHandler.Whole<T> nothing. handler) Implements jakarta.websocket.Session.addMessageHandler. This method is not supported on `RemoteSession`.
public <T> void	addMessageHandler(Class<T> nothing. clazz, MessageHandler.Partial<T> nothing. handler) Implements jakarta.websocket.Session.addMessageHandler. This method is not supported on `RemoteSession`.
public void	close() Implements jakarta.websocket.Session.close. Close the current conversation with a normal status code and no reason phrase.
public void	close(CloseReason the reason for the closure. closeReason) Implements jakarta.websocket.Session.close. Close the current conversation, giving a reason for the closure.
public RemoteEndpoint.Async	Returns: the remote endpoint representation. getAsyncRemote() Implements jakarta.websocket.Session.getAsyncRemote. Get a reference a `RemoteEndpoint.Async` object representing the peer of this conversation that is able to send messages asynchronously to the peer.
public RemoteEndpoint.Basic	Returns: the remote endpoint representation. getBasicRemote() Implements jakarta.websocket.Session.getBasicRemote. Get a reference a `RemoteEndpoint.Basic` object representing the peer of this conversation that is able to send messages synchronously to the peer.
public WebSocketContainer	Returns: nothing. getContainer() Implements jakarta.websocket.Session.getContainer. This method is not supported on `RemoteSession`.
public Map<String, Object>	getDistributedProperties() Implements org.glassfish.tyrus.core.cluster.DistributedSession.getDistributedProperties. Get distributed properties.
public String	Returns: the unique identifier for this session instance. getId() Implements jakarta.websocket.Session.getId. Get a string containing the unique identifier assigned to this session.
public int	Returns: the maximum binary message size that can be buffered. getMaxBinaryMessageBufferSize() Implements jakarta.websocket.Session.getMaxBinaryMessageBufferSize. Get the maximum length of incoming binary messages that this Session can buffer.
public long	Returns: the timeout in milliseconds. getMaxIdleTimeout() Implements jakarta.websocket.Session.getMaxIdleTimeout. Get the number of milliseconds before this conversation may be closed by the container if it is inactive, i.e. no messages are either sent or received in that time.
public int	Returns: the maximum text message size that can be buffered. getMaxTextMessageBufferSize() Implements jakarta.websocket.Session.getMaxTextMessageBufferSize. Get the maximum length of incoming text messages that this Session can buffer.
public Set<MessageHandler>	Returns: nothing. getMessageHandlers() Implements jakarta.websocket.Session.getMessageHandlers. This method is not supported on `RemoteSession`.
public List<Extension>	Returns: the negotiated extensions. getNegotiatedExtensions() Implements jakarta.websocket.Session.getNegotiatedExtensions. Get the list of extensions currently in use for this conversation.
public String	Returns: the negotiated subprotocol, or the empty string if there isn't one. getNegotiatedSubprotocol() Implements jakarta.websocket.Session.getNegotiatedSubprotocol. Get the sub protocol agreed during the websocket handshake for this conversation.
public Set<Session>	Returns: nothing. getOpenSessions() Implements jakarta.websocket.Session.getOpenSessions. This method is not supported on `RemoteSession`.
public Map<String, String>	Returns: the unmodifiable map of path parameters. The key of the map is the parameter name, the values in the map are the parameter values. getPathParameters() Implements jakarta.websocket.Session.getPathParameters. Get a map of the path parameter names and values used associated with the request this session was opened under.
public String	Returns: the protocol version. getProtocolVersion() Implements jakarta.websocket.Session.getProtocolVersion. Get the version of the websocket protocol currently being used.
public String	Returns: the query string. getQueryString() Implements jakarta.websocket.Session.getQueryString. Get the query string associated with the request this session was opened under.
public Map<String, List<String>>	Returns: the unmodifiable map of the request parameters. getRequestParameterMap() Implements jakarta.websocket.Session.getRequestParameterMap. Get the request parameters associated with the request this session was opened under.
public URI	Returns: the request URI. getRequestURI() Implements jakarta.websocket.Session.getRequestURI. Get the `URI` under which this session was opened, including the query string if there is one.
public Principal	Returns: the user principal. getUserPrincipal() Implements jakarta.websocket.Session.getUserPrincipal. Get the authenticated user for this session or `null` if no user is authenticated for this session.
public Map<String, Object>	Returns: nothing. getUserProperties() Implements jakarta.websocket.Session.getUserProperties. This method is not supported on `RemoteSession`.
public boolean	Returns: `true` when the underlying socket is open, `false` otherwise. isOpen() Implements jakarta.websocket.Session.isOpen. Get the information about session state.
public boolean	Returns: `true` when the underlying socket is using a secure transport, `false` otherwise. isSecure() Implements jakarta.websocket.Session.isSecure. Get the information about secure transport.
public void	removeMessageHandler(MessageHandler nothing. handler) Implements jakarta.websocket.Session.removeMessageHandler. This method is not supported on `RemoteSession`.
public void	setMaxBinaryMessageBufferSize(int nothing. length) Implements jakarta.websocket.Session.setMaxBinaryMessageBufferSize. This method is not supported on `RemoteSession`.
public void	setMaxIdleTimeout(long nothing. milliseconds) Implements jakarta.websocket.Session.setMaxIdleTimeout. This method is not supported on `RemoteSession`.
public void	setMaxTextMessageBufferSize(int nothing. length) Implements jakarta.websocket.Session.setMaxTextMessageBufferSize. This method is not supported on `RemoteSession`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

asyncRemote	back to summary
private final RemoteEndpoint.Async asyncRemote

basicRemote	back to summary
private final RemoteEndpoint.Basic basicRemote

clusterContext	back to summary
private final ClusterContext clusterContext

connectionId	back to summary
private final String connectionId

distributedPropertyMap	back to summary
private final Map<RemoteSession.DistributedMapKey, Object> distributedPropertyMap

endpointWrapper	back to summary
private final TyrusEndpointWrapper endpointWrapper

sessionId	back to summary
private final String sessionId

SYNC_SEND_TIMEOUT	back to summary
private static final Integer SYNC_SEND_TIMEOUT

Constructor Detail

RemoteSession	back to summary
public RemoteSession(final String sessionId, final ClusterContext clusterContext, final Map<RemoteSession.DistributedMapKey, Object> distributedPropertyMap, final TyrusEndpointWrapper endpointWrapper, final Session session) Constructor. Parameters sessionId:String session id. clusterContext:ClusterContext cluster context. distributedPropertyMap:Map<RemoteSession.DistributedMapKey, Object> distributed property map. endpointWrapper:TyrusEndpointWrapper used just to get encoders/decoders. session:Session used just to get encoders/decoders.

RemoteSession

back to summary

public RemoteSession(final String sessionId, final ClusterContext clusterContext, final Map<RemoteSession.DistributedMapKey, Object> distributedPropertyMap, final TyrusEndpointWrapper endpointWrapper, final Session session)

Constructor.

Parameters

sessionId:String: session id.
clusterContext:ClusterContext: cluster context.
distributedPropertyMap:Map<RemoteSession.DistributedMapKey, Object>: distributed property map.
endpointWrapper:TyrusEndpointWrapper: used just to get encoders/decoders.
session:Session: used just to get encoders/decoders.

Method Detail

addMessageHandler back to summary

addMessageHandler	back to summary
public void addMessageHandler(MessageHandler handler) throws IllegalStateException Implements jakarta.websocket.Session.addMessageHandler. This method is not supported on `RemoteSession`. Each invocation will throw an `UnsupportedOperationException`. Parameters handler:MessageHandler nothing. Annotations @Override Exceptions IllegalStateException: Doc from jakarta.websocket.Session.addMessageHandler. if there is already a MessageHandler registered for the same native websocket message type as this handler.

public void addMessageHandler(MessageHandler handler) throws IllegalStateException

Implements jakarta.websocket.Session.addMessageHandler.

This method is not supported on RemoteSession. Each invocation will throw an UnsupportedOperationException.

Parameters

handler:MessageHandler: nothing.

Annotations

@Override

Exceptions

IllegalStateException:

Doc from jakarta.websocket.Session.addMessageHandler.

if there is already a MessageHandler registered for the same native websocket message type as this handler.

addMessageHandler back to summary

addMessageHandler	back to summary
public <T> void addMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler) Implements jakarta.websocket.Session.addMessageHandler. This method is not supported on `RemoteSession`. Each invocation will throw an `UnsupportedOperationException`. Parameters <T> Doc from jakarta.websocket.Session.addMessageHandler. type of message that the given handler is intended for. clazz:Class<T> nothing. handler:MessageHandler.Whole<T> nothing. Annotations @Override

public <T> void addMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler)

Implements jakarta.websocket.Session.addMessageHandler.

This method is not supported on RemoteSession. Each invocation will throw an UnsupportedOperationException.

Parameters

<T>: Doc from jakarta.websocket.Session.addMessageHandler. type of message that the given handler is intended for.
clazz:Class<T>: nothing.
handler:MessageHandler.Whole<T>: nothing.

Annotations

@Override

addMessageHandler back to summary

addMessageHandler	back to summary
public <T> void addMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler) Implements jakarta.websocket.Session.addMessageHandler. This method is not supported on `RemoteSession`. Each invocation will throw an `UnsupportedOperationException`. Parameters <T> Doc from jakarta.websocket.Session.addMessageHandler. type of message that the given handler is intended for. clazz:Class<T> nothing. handler:MessageHandler.Partial<T> nothing. Annotations @Override

public <T> void addMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler)

Implements jakarta.websocket.Session.addMessageHandler.

This method is not supported on RemoteSession. Each invocation will throw an UnsupportedOperationException.

Parameters

<T>: Doc from jakarta.websocket.Session.addMessageHandler. type of message that the given handler is intended for.
clazz:Class<T>: nothing.
handler:MessageHandler.Partial<T>: nothing.

Annotations

@Override

close	back to summary
public void close() throws IOException Implements jakarta.websocket.Session.close. Close the current conversation with a normal status code and no reason phrase. Annotations @Override Exceptions IOException: if there was a connection error closing the connection.

back to summary

public void close() throws IOException

Implements jakarta.websocket.Session.close.

Close the current conversation with a normal status code and no reason phrase.

Annotations

@Override

Exceptions

IOException:: if there was a connection error closing the connection.

close back to summary

close	back to summary
public void close(CloseReason closeReason) throws IOException Implements jakarta.websocket.Session.close. Close the current conversation, giving a reason for the closure. The close call causes the implementation to attempt notify the client of the close as soon as it can. This may cause the sending of unsent messages immediately prior to the close notification. After the close notification has been sent the implementation notifies the endpoint's onClose method. Note the websocket specification defines the acceptable uses of status codes and reason phrases. If the application cannot determine a suitable close code to use for the closeReason, it is recommended to use `CloseReason.CloseCodes#NO_STATUS_CODE`. Parameters closeReason:CloseReason the reason for the closure. Annotations @Override Exceptions IOException: if there was a connection error closing the connection.

public void close(CloseReason closeReason) throws IOException

Implements jakarta.websocket.Session.close.

Close the current conversation, giving a reason for the closure. The close call causes the implementation to attempt notify the client of the close as soon as it can. This may cause the sending of unsent messages immediately prior to the close notification. After the close notification has been sent the implementation notifies the endpoint's onClose method. Note the websocket specification defines the acceptable uses of status codes and reason phrases. If the application cannot determine a suitable close code to use for the closeReason, it is recommended to use CloseReason.CloseCodes#NO_STATUS_CODE.

Parameters

closeReason:CloseReason: the reason for the closure.

Annotations

@Override

Exceptions

IOException:: if there was a connection error closing the connection.

getAsyncRemote back to summary

getAsyncRemote	back to summary
public RemoteEndpoint.Async getAsyncRemote() Implements jakarta.websocket.Session.getAsyncRemote. Get a reference a `RemoteEndpoint.Async` object representing the peer of this conversation that is able to send messages asynchronously to the peer. Returns:RemoteEndpoint.Async the remote endpoint representation. Annotations @Override

public RemoteEndpoint.Async getAsyncRemote()

Implements jakarta.websocket.Session.getAsyncRemote.

Get a reference a RemoteEndpoint.Async object representing the peer of this conversation that is able to send messages asynchronously to the peer.

Returns:RemoteEndpoint.Async

the remote endpoint representation.

Annotations

@Override

getBasicRemote back to summary

getBasicRemote	back to summary
public RemoteEndpoint.Basic getBasicRemote() Implements jakarta.websocket.Session.getBasicRemote. Get a reference a `RemoteEndpoint.Basic` object representing the peer of this conversation that is able to send messages synchronously to the peer. Returns:RemoteEndpoint.Basic the remote endpoint representation. Annotations @Override

public RemoteEndpoint.Basic getBasicRemote()

Implements jakarta.websocket.Session.getBasicRemote.

Get a reference a RemoteEndpoint.Basic object representing the peer of this conversation that is able to send messages synchronously to the peer.

Returns:RemoteEndpoint.Basic

the remote endpoint representation.

Annotations

@Override

getContainer back to summary

getContainer	back to summary
public WebSocketContainer getContainer() Implements jakarta.websocket.Session.getContainer. This method is not supported on `RemoteSession`. Each invocation will throw an `UnsupportedOperationException`. Returns:WebSocketContainer nothing. Annotations @Override

public WebSocketContainer getContainer()

Implements jakarta.websocket.Session.getContainer.

This method is not supported on RemoteSession. Each invocation will throw an UnsupportedOperationException.

Returns:WebSocketContainer

nothing.

Annotations

@Override

getDistributedProperties back to summary

getDistributedProperties	back to summary
public Map<String, Object> getDistributedProperties() Implements org.glassfish.tyrus.core.cluster.DistributedSession.getDistributedProperties. Doc from org.glassfish.tyrus.core.cluster.DistributedSession.getDistributedProperties. Get distributed properties. Values put into this map must be `Serializable` or serializable by other, implementation-dependent alternative. Content of this map is synchronized among all cluster nodes, so putting an entry on any of the nodes will be visible on all other nodes which have reference to current session (in form of `TyrusSession` or `RemoteSession`). Please note that when not running in the distributed environment, this map behaves similarly to `getUserProperties()`, so no serialization or deserialization is performed when values are read from or stored to the returned map. Returns:Map<String, Object> map of distributed properties. Annotations @Override

public Map<String, Object> getDistributedProperties()

Implements org.glassfish.tyrus.core.cluster.DistributedSession.getDistributedProperties.

Doc from org.glassfish.tyrus.core.cluster.DistributedSession.getDistributedProperties.

Get distributed properties.

Values put into this map must be Serializable or serializable by other, implementation-dependent alternative.

Content of this map is synchronized among all cluster nodes, so putting an entry on any of the nodes will be visible on all other nodes which have reference to current session (in form of TyrusSession or RemoteSession).

Please note that when not running in the distributed environment, this map behaves similarly to getUserProperties(), so no serialization or deserialization is performed when values are read from or stored to the returned map.

Returns:Map<String, Object>

map of distributed properties.

Annotations

@Override

getId	back to summary
public String getId() Implements jakarta.websocket.Session.getId. Get a string containing the unique identifier assigned to this session. The identifier is assigned by the web socket implementation and is implementation dependent. Returns:String the unique identifier for this session instance. Annotations @Override

getId

back to summary

public String getId()

Implements jakarta.websocket.Session.getId.

Get a string containing the unique identifier assigned to this session. The identifier is assigned by the web socket implementation and is implementation dependent.

Returns:String

the unique identifier for this session instance.

Annotations

@Override

getMaxBinaryMessageBufferSize back to summary

getMaxBinaryMessageBufferSize	back to summary
public int getMaxBinaryMessageBufferSize() Implements jakarta.websocket.Session.getMaxBinaryMessageBufferSize. Get the maximum length of incoming binary messages that this Session can buffer. If the implementation receives a binary message that it cannot buffer because it is too large, it must close the session with a close code of `CloseReason.CloseCodes#TOO_BIG`. Returns:int the maximum binary message size that can be buffered. Annotations @Override

public int getMaxBinaryMessageBufferSize()

Implements jakarta.websocket.Session.getMaxBinaryMessageBufferSize.

Get the maximum length of incoming binary messages that this Session can buffer. If the implementation receives a binary message that it cannot buffer because it is too large, it must close the session with a close code of CloseReason.CloseCodes#TOO_BIG.

Returns:int

the maximum binary message size that can be buffered.

Annotations

@Override

getMaxIdleTimeout	back to summary
public long getMaxIdleTimeout() Implements jakarta.websocket.Session.getMaxIdleTimeout. Get the number of milliseconds before this conversation may be closed by the container if it is inactive, i.e. no messages are either sent or received in that time. Returns:long the timeout in milliseconds. Annotations @Override

getMaxIdleTimeout

back to summary

public long getMaxIdleTimeout()

Implements jakarta.websocket.Session.getMaxIdleTimeout.

Get the number of milliseconds before this conversation may be closed by the container if it is inactive, i.e. no messages are either sent or received in that time.

Returns:long

the timeout in milliseconds.

Annotations

@Override

getMaxTextMessageBufferSize back to summary

getMaxTextMessageBufferSize	back to summary
public int getMaxTextMessageBufferSize() Implements jakarta.websocket.Session.getMaxTextMessageBufferSize. Get the maximum length of incoming text messages that this Session can buffer. If the implementation receives a text message that it cannot buffer because it is too large, it must close the session with a close code of `CloseReason.CloseCodes#TOO_BIG`. Returns:int the maximum text message size that can be buffered. Annotations @Override

public int getMaxTextMessageBufferSize()

Implements jakarta.websocket.Session.getMaxTextMessageBufferSize.

Get the maximum length of incoming text messages that this Session can buffer. If the implementation receives a text message that it cannot buffer because it is too large, it must close the session with a close code of CloseReason.CloseCodes#TOO_BIG.

Returns:int

the maximum text message size that can be buffered.

Annotations

@Override

getMessageHandlers back to summary

getMessageHandlers	back to summary
public Set<MessageHandler> getMessageHandlers() Implements jakarta.websocket.Session.getMessageHandlers. This method is not supported on `RemoteSession`. Each invocation will throw an `UnsupportedOperationException`. Returns:Set<MessageHandler> nothing. Annotations @Override

public Set<MessageHandler> getMessageHandlers()

Implements jakarta.websocket.Session.getMessageHandlers.

This method is not supported on RemoteSession. Each invocation will throw an UnsupportedOperationException.

Returns:Set<MessageHandler>

nothing.

Annotations

@Override

getNegotiatedExtensions	back to summary
public List<Extension> getNegotiatedExtensions() Implements jakarta.websocket.Session.getNegotiatedExtensions. Get the list of extensions currently in use for this conversation. Returns:List<Extension> the negotiated extensions. Annotations @Override

getNegotiatedExtensions

back to summary

public List<Extension> getNegotiatedExtensions()

Implements jakarta.websocket.Session.getNegotiatedExtensions.

Get the list of extensions currently in use for this conversation.

Returns:List<Extension>

the negotiated extensions.

Annotations

@Override

getNegotiatedSubprotocol	back to summary
public String getNegotiatedSubprotocol() Implements jakarta.websocket.Session.getNegotiatedSubprotocol. Get the sub protocol agreed during the websocket handshake for this conversation. Returns:String the negotiated subprotocol, or the empty string if there isn't one. Annotations @Override

getNegotiatedSubprotocol

back to summary

public String getNegotiatedSubprotocol()

Implements jakarta.websocket.Session.getNegotiatedSubprotocol.

Get the sub protocol agreed during the websocket handshake for this conversation.

Returns:String

the negotiated subprotocol, or the empty string if there isn't one.

Annotations

@Override

getOpenSessions back to summary

getOpenSessions	back to summary
public Set<Session> getOpenSessions() Implements jakarta.websocket.Session.getOpenSessions. This method is not supported on `RemoteSession`. Each invocation will throw an `UnsupportedOperationException`. Returns:Set<Session> nothing. Annotations @Override

public Set<Session> getOpenSessions()

Implements jakarta.websocket.Session.getOpenSessions.

This method is not supported on RemoteSession. Each invocation will throw an UnsupportedOperationException.

Returns:Set<Session>

nothing.

Annotations

@Override

getPathParameters	back to summary
public Map<String, String> getPathParameters() Implements jakarta.websocket.Session.getPathParameters. Get a map of the path parameter names and values used associated with the request this session was opened under. Returns:Map<String, String> the unmodifiable map of path parameters. The key of the map is the parameter name, the values in the map are the parameter values. Annotations @Override

getPathParameters

back to summary

public Map<String, String> getPathParameters()

Implements jakarta.websocket.Session.getPathParameters.

Get a map of the path parameter names and values used associated with the request this session was opened under.

Returns:Map<String, String>

the unmodifiable map of path parameters. The key of the map is the parameter name, the values in the map are the parameter values.

Annotations

@Override

getProtocolVersion	back to summary
public String getProtocolVersion() Implements jakarta.websocket.Session.getProtocolVersion. Get the version of the websocket protocol currently being used. This is taken as the value of the Sec-WebSocket-Version header used in the opening handshake. i.e. "13". Returns:String the protocol version. Annotations @Override

getProtocolVersion

back to summary

public String getProtocolVersion()

Implements jakarta.websocket.Session.getProtocolVersion.

Get the version of the websocket protocol currently being used. This is taken as the value of the Sec-WebSocket-Version header used in the opening handshake. i.e. "13".

Returns:String

the protocol version.

Annotations

@Override

getQueryString	back to summary
public String getQueryString() Implements jakarta.websocket.Session.getQueryString. Get the query string associated with the request this session was opened under. Returns:String the query string. Annotations @Override

getQueryString

back to summary

public String getQueryString()

Implements jakarta.websocket.Session.getQueryString.

Get the query string associated with the request this session was opened under.

Returns:String

the query string.

Annotations

@Override

getRequestParameterMap	back to summary
public Map<String, List<String>> getRequestParameterMap() Implements jakarta.websocket.Session.getRequestParameterMap. Get the request parameters associated with the request this session was opened under. Returns:Map<String, List<String>> the unmodifiable map of the request parameters. Annotations @Override

getRequestParameterMap

back to summary

public Map<String, List<String>> getRequestParameterMap()

Implements jakarta.websocket.Session.getRequestParameterMap.

Get the request parameters associated with the request this session was opened under.

Returns:Map<String, List<String>>

the unmodifiable map of the request parameters.

Annotations

@Override

getRequestURI back to summary

getRequestURI	back to summary
public URI getRequestURI() Implements jakarta.websocket.Session.getRequestURI. Get the `URI` under which this session was opened, including the query string if there is one. Returns:URI the request URI. Annotations @Override

public URI getRequestURI()

Implements jakarta.websocket.Session.getRequestURI.

Get the URI under which this session was opened, including the query string if there is one.

Returns:URI

the request URI.

Annotations

@Override

getUserPrincipal back to summary

getUserPrincipal	back to summary
public Principal getUserPrincipal() Implements jakarta.websocket.Session.getUserPrincipal. Get the authenticated user for this session or `null` if no user is authenticated for this session. Returns:Principal the user principal. Annotations @Override

public Principal getUserPrincipal()

Implements jakarta.websocket.Session.getUserPrincipal.

Get the authenticated user for this session or null if no user is authenticated for this session.

Returns:Principal

the user principal.

Annotations

@Override

getUserProperties back to summary

getUserProperties	back to summary
public Map<String, Object> getUserProperties() Implements jakarta.websocket.Session.getUserProperties. This method is not supported on `RemoteSession`. Each invocation will throw an `UnsupportedOperationException`. Returns:Map<String, Object> nothing. Annotations @Override See Also `getDistributedProperties()`

public Map<String, Object> getUserProperties()

Implements jakarta.websocket.Session.getUserProperties.

This method is not supported on RemoteSession. Each invocation will throw an UnsupportedOperationException.

Returns:Map<String, Object>

nothing.

Annotations

@Override

See Also

getDistributedProperties()

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Implements jakarta.websocket.Session.isOpen. Get the information about session state. Returns:boolean `true` when the underlying socket is open, `false` otherwise. Annotations @Override

public boolean isOpen()

Implements jakarta.websocket.Session.isOpen.

Get the information about session state.

Returns:boolean

true when the underlying socket is open, false otherwise.

Annotations

@Override

isSecure back to summary

isSecure	back to summary
public boolean isSecure() Implements jakarta.websocket.Session.isSecure. Get the information about secure transport. Returns:boolean `true` when the underlying socket is using a secure transport, `false` otherwise. Annotations @Override

public boolean isSecure()

Implements jakarta.websocket.Session.isSecure.

Get the information about secure transport.

Returns:boolean

true when the underlying socket is using a secure transport, false otherwise.

Annotations

@Override

removeMessageHandler back to summary

removeMessageHandler	back to summary
public void removeMessageHandler(MessageHandler handler) Implements jakarta.websocket.Session.removeMessageHandler. This method is not supported on `RemoteSession`. Each invocation will throw an `UnsupportedOperationException`. Parameters handler:MessageHandler nothing. Annotations @Override

public void removeMessageHandler(MessageHandler handler)

Implements jakarta.websocket.Session.removeMessageHandler.

This method is not supported on RemoteSession. Each invocation will throw an UnsupportedOperationException.

Parameters

handler:MessageHandler: nothing.

Annotations

@Override

setMaxBinaryMessageBufferSize back to summary

setMaxBinaryMessageBufferSize	back to summary
public void setMaxBinaryMessageBufferSize(int length) Implements jakarta.websocket.Session.setMaxBinaryMessageBufferSize. This method is not supported on `RemoteSession`. Each invocation will throw an `UnsupportedOperationException`. Parameters length:int nothing. Annotations @Override

public void setMaxBinaryMessageBufferSize(int length)

Implements jakarta.websocket.Session.setMaxBinaryMessageBufferSize.

This method is not supported on RemoteSession. Each invocation will throw an UnsupportedOperationException.

Parameters

length:int: nothing.

Annotations

@Override

setMaxIdleTimeout back to summary

setMaxIdleTimeout	back to summary
public void setMaxIdleTimeout(long milliseconds) Implements jakarta.websocket.Session.setMaxIdleTimeout. This method is not supported on `RemoteSession`. Each invocation will throw an `UnsupportedOperationException`. Parameters milliseconds:long nothing. Annotations @Override

public void setMaxIdleTimeout(long milliseconds)

Implements jakarta.websocket.Session.setMaxIdleTimeout.

This method is not supported on RemoteSession. Each invocation will throw an UnsupportedOperationException.

Parameters

milliseconds:long: nothing.

Annotations

@Override

setMaxTextMessageBufferSize back to summary

setMaxTextMessageBufferSize	back to summary
public void setMaxTextMessageBufferSize(int length) Implements jakarta.websocket.Session.setMaxTextMessageBufferSize. This method is not supported on `RemoteSession`. Each invocation will throw an `UnsupportedOperationException`. Parameters length:int nothing. Annotations @Override

public void setMaxTextMessageBufferSize(int length)

Implements jakarta.websocket.Session.setMaxTextMessageBufferSize.

This method is not supported on RemoteSession. Each invocation will throw an UnsupportedOperationException.

Parameters

length:int: nothing.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.glassfish.tyrus.core.cluster back to summary

public final Enum RemoteSession.DistributedMapKey

Class Inheritance

extends Enum<RemoteSession.DistributedMapKey>
implements Serializable

java.lang.Object
java.lang.Enum
org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey

All Implemented Interfaces

java.io.Serializable

Field Summary

Modifier and Type	Field and Description
public static final RemoteSession.DistributedMapKey	CONNECTION_ID Cluster connection Id. (internal property).
private final String	key
public static final RemoteSession.DistributedMapKey	MAX_BINARY_MESSAGE_BUFFER_SIZE Max binary buffer size.
public static final RemoteSession.DistributedMapKey	MAX_IDLE_TIMEOUT Max idle timeout.
public static final RemoteSession.DistributedMapKey	MAX_TEXT_MESSAGE_BUFFER_SIZE Max text buffer size.
public static final RemoteSession.DistributedMapKey	NEGOTIATED_EXTENSIONS Negotiated extensions.
public static final RemoteSession.DistributedMapKey	NEGOTIATED_SUBPROTOCOL Negotiated subprotocol.
public static final RemoteSession.DistributedMapKey	PATH_PARAMETERS Path parameters.
public static final RemoteSession.DistributedMapKey	QUERY_STRING Query string.
public static final RemoteSession.DistributedMapKey	REQUEST_PARAMETER_MAP Request Parameter map.
public static final RemoteSession.DistributedMapKey	REQUEST_URI Request URI.
public static final RemoteSession.DistributedMapKey	SECURE Secure flag.
public static final RemoteSession.DistributedMapKey	USER_PRINCIPAL User principal.

Constructor Summary

Access	Constructor and Description
private	DistributedMapKey(String key)

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static RemoteSession.DistributedMapKey	valueOf(String name)
public static RemoteSession.DistributedMapKey[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

CONNECTION_ID back to summary

CONNECTION_ID	back to summary
public static final RemoteSession.DistributedMapKey CONNECTION_ID Cluster connection Id. (internal property). Value must be `String`.

public static final RemoteSession.DistributedMapKey CONNECTION_ID

Cluster connection Id. (internal property).

Value must be String.

key	back to summary
private final String key

MAX_BINARY_MESSAGE_BUFFER_SIZE back to summary

MAX_BINARY_MESSAGE_BUFFER_SIZE	back to summary
public static final RemoteSession.DistributedMapKey MAX_BINARY_MESSAGE_BUFFER_SIZE Max binary buffer size. Value must be `int` or `java.lang.Integer`. See Also `jakarta.websocket.Session#getMaxBinaryMessageBufferSize()`

public static final RemoteSession.DistributedMapKey MAX_BINARY_MESSAGE_BUFFER_SIZE

Max binary buffer size.

Value must be int or java.lang.Integer.

See Also: jakarta.websocket.Session#getMaxBinaryMessageBufferSize()

MAX_IDLE_TIMEOUT back to summary

public static final RemoteSession.DistributedMapKey MAX_IDLE_TIMEOUT

Max idle timeout.

Value must be long or java.lang.Long.

See Also: jakarta.websocket.Session#getMaxIdleTimeout()

MAX_TEXT_MESSAGE_BUFFER_SIZE back to summary

public static final RemoteSession.DistributedMapKey MAX_TEXT_MESSAGE_BUFFER_SIZE

Max text buffer size.

Value must be int or java.lang.Integer.

See Also: jakarta.websocket.Session#getMaxTextMessageBufferSize()

NEGOTIATED_EXTENSIONS back to summary

public static final RemoteSession.DistributedMapKey NEGOTIATED_EXTENSIONS

Negotiated extensions.

Value must be List<Extension>.

See Also: jakarta.websocket.Session#getNegotiatedExtensions()

NEGOTIATED_SUBPROTOCOL back to summary

public static final RemoteSession.DistributedMapKey NEGOTIATED_SUBPROTOCOL

Negotiated subprotocol.

Value must be String.

See Also: jakarta.websocket.Session#getNegotiatedSubprotocol()

PATH_PARAMETERS back to summary

public static final RemoteSession.DistributedMapKey PATH_PARAMETERS

Path parameters.

Value must be java.util.Map<String, String>.

See Also: jakarta.websocket.Session#getPathParameters()

QUERY_STRING back to summary

public static final RemoteSession.DistributedMapKey QUERY_STRING

Query string.

Value must be String.

See Also: jakarta.websocket.Session#getQueryString()

REQUEST_PARAMETER_MAP back to summary

public static final RemoteSession.DistributedMapKey REQUEST_PARAMETER_MAP

Request Parameter map.

Value must be java.util.Map<String, java.util.List<String>>.

See Also: jakarta.websocket.Session#getRequestParameterMap()

REQUEST_URI back to summary

public static final RemoteSession.DistributedMapKey REQUEST_URI

Request URI.

Value must be URI.

See Also: jakarta.websocket.Session#getRequestURI()

SECURE back to summary

public static final RemoteSession.DistributedMapKey SECURE

Secure flag.

Value must be boolean or java.lang.Boolean.

See Also: jakarta.websocket.Session#isSecure()

USER_PRINCIPAL back to summary

public static final RemoteSession.DistributedMapKey USER_PRINCIPAL

User principal.

Value must be java.security.Principal.

See Also: jakarta.websocket.Session#getUserPrincipal()

Constructor Detail

DistributedMapKey	back to summary
private DistributedMapKey(String key)

Method Detail

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations

@Override

valueOf	back to summary
public static RemoteSession.DistributedMapKey valueOf(String name)

values	back to summary
public static RemoteSession.DistributedMapKey[] values()

public Class RemoteSession

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum RemoteSession.DistributedMapKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail