org.eclipse.jetty.websocket.server

Class WebSocketServerFactory

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.websocket.server.WebSocketServerFactory

All Implemented Interfaces:

Container, Destroyable, Dumpable, LifeCycle, WebSocketContainerScope, SessionListener, WebSocketCreator, WebSocketServletFactory

public class WebSocketServerFactory
extends ContainerLifeCycle
implements WebSocketCreator, WebSocketContainerScope, WebSocketServletFactory, SessionListener

Factory to create WebSocket connections

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.websocket.servlet.WebSocketServletFactory

WebSocketServletFactory.Loader

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

Constructor Summary

Constructors

Constructor and Description
WebSocketServerFactory()
WebSocketServerFactory(ByteBufferPool bufferPool)
WebSocketServerFactory(WebSocketPolicy policy)
WebSocketServerFactory(WebSocketPolicy policy, ByteBufferPool bufferPool)

Method Summary

Modifier and Type	Method and Description
boolean	acceptWebSocket(HttpServletRequest request, HttpServletResponse response)
boolean	acceptWebSocket(WebSocketCreator creator, HttpServletRequest request, HttpServletResponse response)
void	addSessionFactory(SessionFactory sessionFactory)
void	cleanup()
WebSocketServletFactory	createFactory(WebSocketPolicy policy)
Object	createWebSocket(ServletUpgradeRequest req, ServletUpgradeResponse resp) Default Creator logic
protected void	doStart()
ByteBufferPool	getBufferPool()
WebSocketCreator	getCreator()
EventDriverFactory	getEventDriverFactory()
Executor	getExecutor()
ExtensionFactory	getExtensionFactory()
DecoratedObjectFactory	getObjectFactory()
Collection<WebSocketSession>	getOpenSessions()
WebSocketPolicy	getPolicy()
SslContextFactory	getSslContextFactory()
void	init(ServletContext context)
void	init(ServletContextHandler context)
boolean	isUpgradeRequest(HttpServletRequest request, HttpServletResponse response)
void	onSessionClosed(WebSocketSession session)
void	onSessionOpened(WebSocketSession session)
protected String[]	parseProtocols(String protocol)
void	register(Class<?> websocketPojo)
void	setCreator(WebSocketCreator creator)

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, dumpStdErr, dumpThis, getBean, getBeans, getBeans, isManaged, 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, toString, wait, wait, wait

Constructor Detail

WebSocketServerFactory

public WebSocketServerFactory()

WebSocketServerFactory

public WebSocketServerFactory(WebSocketPolicy policy)

WebSocketServerFactory

public WebSocketServerFactory(ByteBufferPool bufferPool)

WebSocketServerFactory

public WebSocketServerFactory(WebSocketPolicy policy,
                              ByteBufferPool bufferPool)

Method Detail

acceptWebSocket

public boolean acceptWebSocket(HttpServletRequest request,
                               HttpServletResponse response)
                        throws IOException

Specified by:

acceptWebSocket in interface WebSocketServletFactory

Throws:

IOException

acceptWebSocket

public boolean acceptWebSocket(WebSocketCreator creator,
                               HttpServletRequest request,
                               HttpServletResponse response)
                        throws IOException

Specified by:

acceptWebSocket in interface WebSocketServletFactory

Throws:

IOException

addSessionFactory

public void addSessionFactory(SessionFactory sessionFactory)

cleanup

public void cleanup()

Specified by:

cleanup in interface WebSocketServletFactory

createFactory

public WebSocketServletFactory createFactory(WebSocketPolicy policy)

Specified by:

createFactory in interface WebSocketServletFactory

createWebSocket

public Object createWebSocket(ServletUpgradeRequest req,
                              ServletUpgradeResponse resp)

Default Creator logic

Specified by:

createWebSocket in interface WebSocketCreator

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class ContainerLifeCycle

Throws:

Exception

getBufferPool

public ByteBufferPool getBufferPool()

Specified by:

getBufferPool in interface WebSocketContainerScope

getCreator

public WebSocketCreator getCreator()

Specified by:

getCreator in interface WebSocketServletFactory

getExecutor

public Executor getExecutor()

Specified by:

getExecutor in interface WebSocketContainerScope

getObjectFactory

public DecoratedObjectFactory getObjectFactory()

Specified by:

getObjectFactory in interface WebSocketContainerScope

getEventDriverFactory

public EventDriverFactory getEventDriverFactory()

getExtensionFactory

public ExtensionFactory getExtensionFactory()

Specified by:

getExtensionFactory in interface WebSocketServletFactory

getOpenSessions

public Collection<WebSocketSession> getOpenSessions()

getPolicy

public WebSocketPolicy getPolicy()

Specified by:

getPolicy in interface WebSocketContainerScope

Specified by:

getPolicy in interface WebSocketServletFactory

getSslContextFactory

public SslContextFactory getSslContextFactory()

Specified by:

getSslContextFactory in interface WebSocketContainerScope

init

public void init(ServletContextHandler context)
          throws ServletException

Throws:

ServletException

init

public void init(ServletContext context)
          throws ServletException

Specified by:

init in interface WebSocketServletFactory

Throws:

ServletException

isUpgradeRequest

public boolean isUpgradeRequest(HttpServletRequest request,
                                HttpServletResponse response)

Specified by:

isUpgradeRequest in interface WebSocketServletFactory

onSessionClosed

public void onSessionClosed(WebSocketSession session)

Specified by:

onSessionClosed in interface SessionListener

onSessionOpened

public void onSessionOpened(WebSocketSession session)

Specified by:

onSessionOpened in interface SessionListener

parseProtocols

protected String[] parseProtocols(String protocol)

register

public void register(Class<?> websocketPojo)

Specified by:

register in interface WebSocketServletFactory

setCreator

public void setCreator(WebSocketCreator creator)

Specified by:

setCreator in interface WebSocketServletFactory