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:

java.io.Closeable, java.lang.AutoCloseable, Connection.Listener, Container, Destroyable, Dumpable, LifeCycle, IncomingFrames, 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

AbstractLifeCycle.AbstractLifeCycleListener

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

Connection.Listener.Adapter

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

Container.InheritedListener, Container.Listener

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

LifeCycle.Listener

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 and Description
JsrSession(ClientContainer container, java.lang.String id, java.net.URI requestURI, EventDriver websocket, LogicalConnection connection)

Method Summary

Modifier and Type	Method and Description
void	addMessageHandler(javax.websocket.MessageHandler handler)
void	close(javax.websocket.CloseReason closeReason)
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()
java.lang.String	getId()
int	getMaxBinaryMessageBufferSize()
long	getMaxIdleTimeout()
int	getMaxTextMessageBufferSize()
MessageHandlerFactory	getMessageHandlerFactory()
java.util.Set<javax.websocket.MessageHandler>	getMessageHandlers()
MessageHandlerWrapper	getMessageHandlerWrapper(MessageType type)
java.util.List<javax.websocket.Extension>	getNegotiatedExtensions()
java.lang.String	getNegotiatedSubprotocol()
java.util.Set<javax.websocket.Session>	getOpenSessions()
java.util.Map<java.lang.String,java.lang.String>	getPathParameters()
java.lang.String	getQueryString()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getRequestParameterMap()
java.security.Principal	getUserPrincipal()
java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.String> pathParams)

Methods inherited from class org.eclipse.jetty.websocket.common.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, 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, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.websocket.Session

close, getProtocolVersion, getRequestURI, isOpen, isSecure

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

dumpObjects

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

start, stop

Constructor Detail

JsrSession

public JsrSession(ClientContainer container,
                  java.lang.String id,
                  java.net.URI requestURI,
                  EventDriver websocket,
                  LogicalConnection connection)

Method Detail

addMessageHandler

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

Throws:

java.lang.IllegalStateException

close

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

Throws:

java.io.IOException

getAsyncRemote

public javax.websocket.RemoteEndpoint.Async getAsyncRemote()

getBasicRemote

public javax.websocket.RemoteEndpoint.Basic getBasicRemote()

getContainer

public javax.websocket.WebSocketContainer getContainer()

getDecoderFactory

public DecoderFactory getDecoderFactory()

getEncoderFactory

public EncoderFactory getEncoderFactory()

getEndpointConfig

public javax.websocket.EndpointConfig getEndpointConfig()

getEndpointMetadata

public EndpointMetadata getEndpointMetadata()

getId

public java.lang.String getId()

getMaxBinaryMessageBufferSize

public int getMaxBinaryMessageBufferSize()

getMaxIdleTimeout

public long getMaxIdleTimeout()

getMaxTextMessageBufferSize

public int getMaxTextMessageBufferSize()

getMessageHandlerFactory

public MessageHandlerFactory getMessageHandlerFactory()

getMessageHandlers

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

getMessageHandlerWrapper

public MessageHandlerWrapper getMessageHandlerWrapper(MessageType type)

getNegotiatedExtensions

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

getNegotiatedSubprotocol

public java.lang.String getNegotiatedSubprotocol()

getOpenSessions

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

getPathParameters

public java.util.Map<java.lang.String,java.lang.String> getPathParameters()

getQueryString

public java.lang.String getQueryString()

getRequestParameterMap

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getRequestParameterMap()

getUserPrincipal

public java.security.Principal getUserPrincipal()

getUserProperties

public java.util.Map<java.lang.String,java.lang.Object> getUserProperties()

init

public void init(javax.websocket.EndpointConfig config)

Specified by:

init in interface Configurable

removeMessageHandler

public void removeMessageHandler(javax.websocket.MessageHandler handler)

setMaxBinaryMessageBufferSize

public void setMaxBinaryMessageBufferSize(int length)

setMaxIdleTimeout

public void setMaxIdleTimeout(long milliseconds)

setMaxTextMessageBufferSize

public void setMaxTextMessageBufferSize(int length)

setPathParameters

public void setPathParameters(java.util.Map<java.lang.String,java.lang.String> pathParams)

getBatchMode

public BatchMode getBatchMode()

Overrides:

getBatchMode in class WebSocketSession

Returns:

the default (initial) value for the batching mode.