Package org.eclipse.jetty.websocket.jsr356

Class JsrSession

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.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, org.eclipse.jetty.websocket.api.extensions.IncomingFrames, org.eclipse.jetty.websocket.api.extensions.OutgoingFrames, org.eclipse.jetty.websocket.api.Session, 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 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 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, java.lang.String id, java.net.URI requestURI, org.eclipse.jetty.websocket.common.events.EventDriver websocket, org.eclipse.jetty.websocket.common.LogicalConnection connection)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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()  
      org.eclipse.jetty.websocket.api.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, 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 java.lang.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

    • Constructor Detail

      • JsrSession

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

    • Method Detail

      • addMessageHandler

        public void addMessageHandler​(javax.websocket.MessageHandler handler)
                       throws java.lang.IllegalStateException
        Specified by:
        addMessageHandler in interface javax.websocket.Session
        Throws:
        java.lang.IllegalStateException

      • close

        public void close​(javax.websocket.CloseReason closeReason)
           throws java.io.IOException
        Specified by:
        close in interface javax.websocket.Session
        Throws:
        java.io.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

      • getEndpointConfig

        public javax.websocket.EndpointConfig getEndpointConfig()

      • getId

        public java.lang.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

      • getMessageHandlers

        public java.util.Set<javax.websocket.MessageHandler> getMessageHandlers()
        Specified by:
        getMessageHandlers in interface javax.websocket.Session

      • getNegotiatedExtensions

        public java.util.List<javax.websocket.Extension> getNegotiatedExtensions()
        Specified by:
        getNegotiatedExtensions in interface javax.websocket.Session

      • getNegotiatedSubprotocol

        public java.lang.String getNegotiatedSubprotocol()
        Specified by:
        getNegotiatedSubprotocol in interface javax.websocket.Session

      • getOpenSessions

        public java.util.Set<javax.websocket.Session> getOpenSessions()
        Specified by:
        getOpenSessions in interface javax.websocket.Session

      • getPathParameters

        public java.util.Map<java.lang.String,​java.lang.String> getPathParameters()
        Specified by:
        getPathParameters in interface javax.websocket.Session

      • getQueryString

        public java.lang.String getQueryString()
        Specified by:
        getQueryString in interface javax.websocket.Session

      • getRequestParameterMap

        public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getRequestParameterMap()
        Specified by:
        getRequestParameterMap in interface javax.websocket.Session

      • getUserPrincipal

        public java.security.Principal getUserPrincipal()
        Specified by:
        getUserPrincipal in interface javax.websocket.Session

      • getUserProperties

        public java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.String> pathParams)

      • getBatchMode

        public org.eclipse.jetty.websocket.api.BatchMode getBatchMode()
        Overrides:
        getBatchMode in class org.eclipse.jetty.websocket.common.WebSocketSession