Package org.eclipse.jetty.websocket.jsr356

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, 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.LifeCycle, org.eclipse.jetty.websocket.api.extensions.IncomingFrames, org.eclipse.jetty.websocket.api.Session, org.eclipse.jetty.websocket.common.io.IOState.ConnectionStateListener, org.eclipse.jetty.websocket.common.RemoteEndpointFactory, org.eclipse.jetty.websocket.common.scopes.WebSocketSessionScope, Configurable

public class JsrSession
extends org.eclipse.jetty.websocket.common.WebSocketSession
implements Session, Configurable

Session for the JSR.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.websocket.common.WebSocketSession

org.eclipse.jetty.websocket.common.WebSocketSession.DisconnectCallback, org.eclipse.jetty.websocket.common.WebSocketSession.Listener, org.eclipse.jetty.websocket.common.WebSocketSession.OnCloseLocalCallback

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

Field Summary

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, org.eclipse.jetty.websocket.common.events.EventDriver websocket, org.eclipse.jetty.websocket.common.LogicalConnection connection)

Method Summary

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

Methods inherited from class org.eclipse.jetty.websocket.common.WebSocketSession

abort, close, close, close, disconnect, dispatch, doStart, doStop, dump, equals, getBufferPool, getClassLoader, getConnection, getContainerScope, getExtensionFactory, getIdleTimeout, getIncomingHandler, getLocalAddress, getOutgoingHandler, getPolicy, getProtocolVersion, getRemote, getRemoteAddress, getRequestURI, getUpgradeRequest, getUpgradeResponse, getWebSocketSession, hashCode, incomingError, incomingFrame, isOpen, isSecure, newRemoteEndpoint, notifyClose, notifyError, onClosed, onConnectionStateChange, onOpened, open, setExtensionFactory, setFuture, setIdleTimeout, setOutgoingHandler, setPolicy, setUpgradeRequest, setUpgradeResponse, suspend, toString

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

addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, 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 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.websocket.Session

close, getProtocolVersion, getRequestURI, isOpen, isSecure

Constructor Detail

JsrSession

public JsrSession(ClientContainer container,
                  String id,
                  URI requestURI,
                  org.eclipse.jetty.websocket.common.events.EventDriver websocket,
                  org.eclipse.jetty.websocket.common.LogicalConnection connection)

Method Detail

addMessageHandler

public void addMessageHandler(MessageHandler handler)
                       throws IllegalStateException

Specified by:

addMessageHandler in interface Session

Throws:

IllegalStateException

close

public void close(CloseReason closeReason)
           throws IOException

Specified by:

close in interface Session

Throws:

IOException

getAsyncRemote

public RemoteEndpoint.Async getAsyncRemote()

Specified by:

getAsyncRemote in interface Session

getBasicRemote

public RemoteEndpoint.Basic getBasicRemote()

Specified by:

getBasicRemote in interface Session

getContainer

public WebSocketContainer getContainer()

Specified by:

getContainer in interface Session

getDecoderFactory

public DecoderFactory getDecoderFactory()

getEncoderFactory

public EncoderFactory getEncoderFactory()

getEndpointConfig

public EndpointConfig getEndpointConfig()

getEndpointMetadata

public EndpointMetadata getEndpointMetadata()

getId

public String getId()

Specified by:

getId in interface Session

getMaxBinaryMessageBufferSize

public int getMaxBinaryMessageBufferSize()

Specified by:

getMaxBinaryMessageBufferSize in interface Session

getMaxIdleTimeout

public long getMaxIdleTimeout()

Specified by:

getMaxIdleTimeout in interface Session

getMaxTextMessageBufferSize

public int getMaxTextMessageBufferSize()

Specified by:

getMaxTextMessageBufferSize in interface Session

getMessageHandlerFactory

public MessageHandlerFactory getMessageHandlerFactory()

getMessageHandlers

public Set<MessageHandler> getMessageHandlers()

Specified by:

getMessageHandlers in interface Session

getMessageHandlerWrapper

public MessageHandlerWrapper getMessageHandlerWrapper(MessageType type)

getNegotiatedExtensions

public List<Extension> getNegotiatedExtensions()

Specified by:

getNegotiatedExtensions in interface Session

getNegotiatedSubprotocol

public String getNegotiatedSubprotocol()

Specified by:

getNegotiatedSubprotocol in interface Session

getOpenSessions

public Set<Session> getOpenSessions()

Specified by:

getOpenSessions in interface Session

getPathParameters

public Map<String,String> getPathParameters()

Specified by:

getPathParameters in interface Session

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface Session

getRequestParameterMap

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

Specified by:

getRequestParameterMap in interface Session

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface Session

getUserProperties

public Map<String,Object> getUserProperties()

Specified by:

getUserProperties in interface Session

init

public void init(EndpointConfig config)

Specified by:

init in interface Configurable

removeMessageHandler

public void removeMessageHandler(MessageHandler handler)

Specified by:

removeMessageHandler in interface Session

setMaxBinaryMessageBufferSize

public void setMaxBinaryMessageBufferSize(int length)

Specified by:

setMaxBinaryMessageBufferSize in interface Session

setMaxIdleTimeout

public void setMaxIdleTimeout(long milliseconds)

Specified by:

setMaxIdleTimeout in interface Session

setMaxTextMessageBufferSize

public void setMaxTextMessageBufferSize(int length)

Specified by:

setMaxTextMessageBufferSize in interface Session

setPathParameters

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

getBatchMode

public org.eclipse.jetty.websocket.api.BatchMode getBatchMode()

Overrides:

getBatchMode in class org.eclipse.jetty.websocket.common.WebSocketSession