Class JsrSession

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.websocket.common.WebSocketSession

org.eclipse.jetty.websocket.jsr356.JsrSession

All Implemented Interfaces:

Closeable, AutoCloseable, javax.websocket.Session, org.eclipse.jetty.io.Connection.Listener, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle, IncomingFrames, OutgoingFrames, Session, RemoteEndpointFactory, WebSocketSessionScope, Configurable

public class JsrSession
extends WebSocketSession
implements javax.websocket.Session, Configurable

Session for the JSR.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.io.Connection.Listener

org.eclipse.jetty.io.Connection.Listener.Adapter

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
private JsrAsyncRemote	asyncRemote
private JsrBasicRemote	basicRemote
private final javax.websocket.EndpointConfig	config
private final ClientContainer	container
private final DecoderFactory	decoderFactory
private final EncoderFactory	encoderFactory
private final String	id
private static final org.eclipse.jetty.util.log.Logger	LOG
private final MessageHandlerFactory	messageHandlerFactory	Factory for MessageHandlers
private Set<javax.websocket.MessageHandler>	messageHandlerSet
private final EndpointMetadata	metadata
private List<javax.websocket.Extension>	negotiatedExtensions
private Map<String,String>	pathParameters
private final MessageHandlerWrapper[]	wrappers	Array of MessageHandlerWrappers, indexed by Enum.ordinal()

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
JsrSession(ClientContainer container, String id, URI requestURI, EventDriver websocket, LogicalConnection connection)

Method Summary

Modifier and Type	Method	Description
void	addMessageHandler(javax.websocket.MessageHandler handler)
void	close(javax.websocket.CloseReason closeReason)
void	destroy()
javax.websocket.RemoteEndpoint.Async	getAsyncRemote()
javax.websocket.RemoteEndpoint.Basic	getBasicRemote()
BatchMode	getBatchMode()
javax.websocket.WebSocketContainer	getContainer()
DecoderFactory	getDecoderFactory()
EncoderFactory	getEncoderFactory()
javax.websocket.EndpointConfig	getEndpointConfig()
EndpointMetadata	getEndpointMetadata()
String	getId()
int	getMaxBinaryMessageBufferSize()
long	getMaxIdleTimeout()
int	getMaxTextMessageBufferSize()
MessageHandlerFactory	getMessageHandlerFactory()
Set<javax.websocket.MessageHandler>	getMessageHandlers()
MessageHandlerWrapper	getMessageHandlerWrapper(MessageType type)
List<javax.websocket.Extension>	getNegotiatedExtensions()
String	getNegotiatedSubprotocol()
Set<javax.websocket.Session>	getOpenSessions()
Map<String,String>	getPathParameters()
String	getQueryString()
Map<String, List<String>>	getRequestParameterMap()
Principal	getUserPrincipal()
Map<String,Object>	getUserProperties()
void	init(javax.websocket.EndpointConfig config)
void	removeMessageHandler(javax.websocket.MessageHandler handler)
void	setMaxBinaryMessageBufferSize(int length)
void	setMaxIdleTimeout(long milliseconds)
void	setMaxTextMessageBufferSize(int length)
void	setPathParameters(Map<String,String> pathParams)
private void	updateMessageHandlerSet()

Methods inherited from class WebSocketSession

callApplicationOnClose, callApplicationOnError, close, close, close, close, disconnect, dispatch, doStart, doStop, dumpSelf, getBufferPool, getClassLoader, getConnection, getContainerScope, getExtensionFactory, getIdleTimeout, getIncomingHandler, getLocalAddress, getOutgoingHandler, getPolicy, getProtocolVersion, getRemote, getRemoteAddress, getRequestURI, getUpgradeRequest, getUpgradeResponse, getWebSocketSession, incomingFrame, isOpen, isSecure, newRemoteEndpoint, onClosed, onOpened, open, outgoingFrame, setExtensionFactory, setFuture, setIdleTimeout, setOutgoingHandler, setPolicy, setUpgradeRequest, setUpgradeResponse, suspend, toString

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class Object

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

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface javax.websocket.Session

close, getProtocolVersion, getRequestURI, isOpen, isSecure

Field Details

LOG

private static final org.eclipse.jetty.util.log.Logger LOG

container

private final ClientContainer container

id

private final String id

config

private final javax.websocket.EndpointConfig config

metadata

private final EndpointMetadata metadata

decoderFactory

private final DecoderFactory decoderFactory

encoderFactory

private final EncoderFactory encoderFactory

messageHandlerFactory

private final MessageHandlerFactory messageHandlerFactory

Factory for MessageHandlers

wrappers

private final MessageHandlerWrapper[] wrappers

Array of MessageHandlerWrappers, indexed by Enum.ordinal()

messageHandlerSet

private Set<javax.websocket.MessageHandler> messageHandlerSet

negotiatedExtensions

private List<javax.websocket.Extension> negotiatedExtensions

pathParameters

private Map<String,String> pathParameters

asyncRemote

private JsrAsyncRemote asyncRemote

basicRemote

private JsrBasicRemote basicRemote

Constructor Details

JsrSession

public JsrSession(ClientContainer container,
 String id,
 URI requestURI,
 EventDriver websocket,
 LogicalConnection connection)

Method Details

addMessageHandler

public void addMessageHandler(javax.websocket.MessageHandler handler)
                       throws IllegalStateException

Specified by:

addMessageHandler in interface javax.websocket.Session

Throws:

IllegalStateException

close

public void close(javax.websocket.CloseReason closeReason)
           throws IOException

Specified by:

close in interface javax.websocket.Session

Throws:

IOException

getAsyncRemote

public javax.websocket.RemoteEndpoint.Async getAsyncRemote()

Specified by:

getAsyncRemote in interface javax.websocket.Session

getBasicRemote

public javax.websocket.RemoteEndpoint.Basic getBasicRemote()

Specified by:

getBasicRemote in interface javax.websocket.Session

getContainer

public javax.websocket.WebSocketContainer getContainer()

Specified by:

getContainer in interface javax.websocket.Session

getDecoderFactory

public DecoderFactory getDecoderFactory()

getEncoderFactory

public EncoderFactory getEncoderFactory()

getEndpointConfig

public javax.websocket.EndpointConfig getEndpointConfig()

getEndpointMetadata

public EndpointMetadata getEndpointMetadata()

getId

public String getId()

Specified by:

getId in interface javax.websocket.Session

getMaxBinaryMessageBufferSize

public int getMaxBinaryMessageBufferSize()

Specified by:

getMaxBinaryMessageBufferSize in interface javax.websocket.Session

getMaxIdleTimeout

public long getMaxIdleTimeout()

Specified by:

getMaxIdleTimeout in interface javax.websocket.Session

getMaxTextMessageBufferSize

public int getMaxTextMessageBufferSize()

Specified by:

getMaxTextMessageBufferSize in interface javax.websocket.Session

getMessageHandlerFactory

public MessageHandlerFactory getMessageHandlerFactory()

getMessageHandlers

public Set<javax.websocket.MessageHandler> getMessageHandlers()

Specified by:

getMessageHandlers in interface javax.websocket.Session

getMessageHandlerWrapper

public MessageHandlerWrapper getMessageHandlerWrapper(MessageType type)

getNegotiatedExtensions

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

Specified by:

getNegotiatedExtensions in interface javax.websocket.Session

getNegotiatedSubprotocol

public String getNegotiatedSubprotocol()

Specified by:

getNegotiatedSubprotocol in interface javax.websocket.Session

getOpenSessions

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

Specified by:

getOpenSessions in interface javax.websocket.Session

getPathParameters

public Map<String,String> getPathParameters()

Specified by:

getPathParameters in interface javax.websocket.Session

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface javax.websocket.Session

getRequestParameterMap

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

Specified by:

getRequestParameterMap in interface javax.websocket.Session

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface javax.websocket.Session

getUserProperties

public Map<String,Object> getUserProperties()

Specified by:

getUserProperties in interface javax.websocket.Session

init

public void init(javax.websocket.EndpointConfig config)

Specified by:

init in interface Configurable

destroy

public void destroy()

Specified by:

destroy in interface Configurable

Specified by:

destroy in interface org.eclipse.jetty.util.component.Destroyable

Overrides:

destroy in class org.eclipse.jetty.util.component.ContainerLifeCycle

removeMessageHandler

public void removeMessageHandler(javax.websocket.MessageHandler handler)

Specified by:

removeMessageHandler in interface javax.websocket.Session

setMaxBinaryMessageBufferSize

public void setMaxBinaryMessageBufferSize(int length)

Specified by:

setMaxBinaryMessageBufferSize in interface javax.websocket.Session

setMaxIdleTimeout

public void setMaxIdleTimeout(long milliseconds)

Specified by:

setMaxIdleTimeout in interface javax.websocket.Session

setMaxTextMessageBufferSize

public void setMaxTextMessageBufferSize(int length)

Specified by:

setMaxTextMessageBufferSize in interface javax.websocket.Session

setPathParameters

public void setPathParameters(Map<String,String> pathParams)

updateMessageHandlerSet

private void updateMessageHandlerSet()

getBatchMode

public BatchMode getBatchMode()

Overrides:

getBatchMode in class WebSocketSession

Returns:

the default (initial) value for the batching mode.