Package org.eclipse.jetty.websocket.server

Class WebSocketServerFactory

  • All Implemented Interfaces:
    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.common.scopes.WebSocketContainerScope, org.eclipse.jetty.websocket.common.WebSocketSessionListener, org.eclipse.jetty.websocket.servlet.WebSocketCreator, org.eclipse.jetty.websocket.servlet.WebSocketServletFactory
    public class WebSocketServerFactory
extends org.eclipse.jetty.util.component.ContainerLifeCycle
implements org.eclipse.jetty.websocket.servlet.WebSocketCreator, org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope, org.eclipse.jetty.websocket.servlet.WebSocketServletFactory, org.eclipse.jetty.websocket.common.WebSocketSessionListener
    Factory to create WebSocket connections

    • 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.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.LifeCycle

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

      • Nested classes/interfaces inherited from interface org.eclipse.jetty.websocket.servlet.WebSocketServletFactory

        org.eclipse.jetty.websocket.servlet.WebSocketServletFactory.Loader

    • 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 
      Modifier Constructor Description
        WebSocketServerFactory()
      Entry point for Spring Boot's MockMVC framework
        WebSocketServerFactory​(javax.servlet.ServletContext context)  
        WebSocketServerFactory​(javax.servlet.ServletContext context, org.eclipse.jetty.io.ByteBufferPool bufferPool)  
        WebSocketServerFactory​(javax.servlet.ServletContext context, org.eclipse.jetty.websocket.api.WebSocketPolicy policy)
      Entry point for WebSocketServletFactory.Loader
        WebSocketServerFactory​(javax.servlet.ServletContext context, org.eclipse.jetty.websocket.api.WebSocketPolicy policy, org.eclipse.jetty.io.ByteBufferPool bufferPool)  
      protected WebSocketServerFactory​(org.eclipse.jetty.websocket.api.WebSocketPolicy policy, java.util.concurrent.Executor executor, org.eclipse.jetty.io.ByteBufferPool bufferPool)
      Protected entry point for WebSocketHandler

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean acceptWebSocket​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)  
      boolean acceptWebSocket​(org.eclipse.jetty.websocket.servlet.WebSocketCreator creator, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)  
      void addSessionFactory​(org.eclipse.jetty.websocket.common.SessionFactory sessionFactory)  
      void addSessionListener​(org.eclipse.jetty.websocket.common.WebSocketSessionListener listener)  
      java.lang.Object createWebSocket​(org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest req, org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse resp)
      Default Creator logic
      protected void doStart()  
      org.eclipse.jetty.io.ByteBufferPool getBufferPool()  
      org.eclipse.jetty.websocket.servlet.WebSocketCreator getCreator()  
      org.eclipse.jetty.websocket.common.events.EventDriverFactory getEventDriverFactory()  
      java.util.concurrent.Executor getExecutor()  
      org.eclipse.jetty.websocket.api.extensions.ExtensionFactory getExtensionFactory()  
      org.eclipse.jetty.util.DecoratedObjectFactory getObjectFactory()  
      java.util.Collection<org.eclipse.jetty.websocket.common.WebSocketSession> getOpenSessions()  
      org.eclipse.jetty.websocket.api.WebSocketPolicy getPolicy()  
      java.util.Collection<org.eclipse.jetty.websocket.common.WebSocketSessionListener> getSessionListeners()  
      org.eclipse.jetty.util.ssl.SslContextFactory getSslContextFactory()  
      boolean isUpgradeRequest​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)  
      void onSessionClosed​(org.eclipse.jetty.websocket.common.WebSocketSession session)  
      void onSessionOpened​(org.eclipse.jetty.websocket.common.WebSocketSession session)  
      void register​(java.lang.Class<?> websocketPojo)  
      void removeSessionListener​(org.eclipse.jetty.websocket.common.WebSocketSessionListener listener)  
      void setCreator​(org.eclipse.jetty.websocket.servlet.WebSocketCreator creator)  
      java.lang.String toString()  

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

        addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, doStop, 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

        dumpSelf

      • Methods inherited from interface org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope

        isRunning

      • Methods inherited from interface org.eclipse.jetty.websocket.servlet.WebSocketServletFactory

        start, stop

    • Constructor Detail

      • WebSocketServerFactory

        public WebSocketServerFactory()
        Entry point for Spring Boot's MockMVC framework

      • WebSocketServerFactory

        public WebSocketServerFactory​(javax.servlet.ServletContext context)

      • WebSocketServerFactory

        public WebSocketServerFactory​(javax.servlet.ServletContext context,
                              org.eclipse.jetty.io.ByteBufferPool bufferPool)

      • WebSocketServerFactory

        public WebSocketServerFactory​(javax.servlet.ServletContext context,
                              org.eclipse.jetty.websocket.api.WebSocketPolicy policy)
        Entry point for WebSocketServletFactory.Loader
        Parameters:
        context - the servlet context
        policy - the policy to use

      • WebSocketServerFactory

        public WebSocketServerFactory​(javax.servlet.ServletContext context,
                              org.eclipse.jetty.websocket.api.WebSocketPolicy policy,
                              org.eclipse.jetty.io.ByteBufferPool bufferPool)

      • WebSocketServerFactory

        protected WebSocketServerFactory​(org.eclipse.jetty.websocket.api.WebSocketPolicy policy,
                                 java.util.concurrent.Executor executor,
                                 org.eclipse.jetty.io.ByteBufferPool bufferPool)
        Protected entry point for WebSocketHandler
        Parameters:
        policy - the policy to use
        executor - the executor to use
        bufferPool - the buffer pool to use

    • Method Detail

      • addSessionListener

        public void addSessionListener​(org.eclipse.jetty.websocket.common.WebSocketSessionListener listener)
        Specified by:
        addSessionListener in interface org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope

      • removeSessionListener

        public void removeSessionListener​(org.eclipse.jetty.websocket.common.WebSocketSessionListener listener)
        Specified by:
        removeSessionListener in interface org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope

      • getSessionListeners

        public java.util.Collection<org.eclipse.jetty.websocket.common.WebSocketSessionListener> getSessionListeners()
        Specified by:
        getSessionListeners in interface org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope

      • acceptWebSocket

        public boolean acceptWebSocket​(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws java.io.IOException
        Specified by:
        acceptWebSocket in interface org.eclipse.jetty.websocket.servlet.WebSocketServletFactory
        Throws:
        java.io.IOException

      • acceptWebSocket

        public boolean acceptWebSocket​(org.eclipse.jetty.websocket.servlet.WebSocketCreator creator,
                               javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws java.io.IOException
        Specified by:
        acceptWebSocket in interface org.eclipse.jetty.websocket.servlet.WebSocketServletFactory
        Throws:
        java.io.IOException

      • addSessionFactory

        public void addSessionFactory​(org.eclipse.jetty.websocket.common.SessionFactory sessionFactory)

      • createWebSocket

        public java.lang.Object createWebSocket​(org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest req,
                                        org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse resp)
        Default Creator logic
        Specified by:
        createWebSocket in interface org.eclipse.jetty.websocket.servlet.WebSocketCreator

      • doStart

        protected void doStart()
                throws java.lang.Exception
        Overrides:
        doStart in class org.eclipse.jetty.util.component.ContainerLifeCycle
        Throws:
        java.lang.Exception

      • getBufferPool

        public org.eclipse.jetty.io.ByteBufferPool getBufferPool()
        Specified by:
        getBufferPool in interface org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope

      • getCreator

        public org.eclipse.jetty.websocket.servlet.WebSocketCreator getCreator()
        Specified by:
        getCreator in interface org.eclipse.jetty.websocket.servlet.WebSocketServletFactory

      • getExecutor

        public java.util.concurrent.Executor getExecutor()
        Specified by:
        getExecutor in interface org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope

      • getObjectFactory

        public org.eclipse.jetty.util.DecoratedObjectFactory getObjectFactory()
        Specified by:
        getObjectFactory in interface org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope

      • getEventDriverFactory

        public org.eclipse.jetty.websocket.common.events.EventDriverFactory getEventDriverFactory()

      • getExtensionFactory

        public org.eclipse.jetty.websocket.api.extensions.ExtensionFactory getExtensionFactory()
        Specified by:
        getExtensionFactory in interface org.eclipse.jetty.websocket.servlet.WebSocketServletFactory

      • getOpenSessions

        public java.util.Collection<org.eclipse.jetty.websocket.common.WebSocketSession> getOpenSessions()

      • getPolicy

        public org.eclipse.jetty.websocket.api.WebSocketPolicy getPolicy()
        Specified by:
        getPolicy in interface org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope
        Specified by:
        getPolicy in interface org.eclipse.jetty.websocket.servlet.WebSocketServletFactory

      • getSslContextFactory

        public org.eclipse.jetty.util.ssl.SslContextFactory getSslContextFactory()
        Specified by:
        getSslContextFactory in interface org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope

      • isUpgradeRequest

        public boolean isUpgradeRequest​(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
        Specified by:
        isUpgradeRequest in interface org.eclipse.jetty.websocket.servlet.WebSocketServletFactory

      • onSessionOpened

        public void onSessionOpened​(org.eclipse.jetty.websocket.common.WebSocketSession session)
        Specified by:
        onSessionOpened in interface org.eclipse.jetty.websocket.common.WebSocketSessionListener

      • onSessionClosed

        public void onSessionClosed​(org.eclipse.jetty.websocket.common.WebSocketSession session)
        Specified by:
        onSessionClosed in interface org.eclipse.jetty.websocket.common.WebSocketSessionListener

      • register

        public void register​(java.lang.Class<?> websocketPojo)
        Specified by:
        register in interface org.eclipse.jetty.websocket.servlet.WebSocketServletFactory

      • setCreator

        public void setCreator​(org.eclipse.jetty.websocket.servlet.WebSocketCreator creator)
        Specified by:
        setCreator in interface org.eclipse.jetty.websocket.servlet.WebSocketServletFactory

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class org.eclipse.jetty.util.component.AbstractLifeCycle