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, SessionListener, WebSocketCreator, WebSocketServletFactory

public class WebSocketServerFactory
extends ContainerLifeCycle
implements WebSocketCreator, 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

Methods

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	doStop() Stops the managed lifecycle beans in the reverse order they were added.
WebSocketCreator	getCreator()
EventDriverFactory	getEventDriverFactory()
ExtensionFactory	getExtensionFactory()
Set<WebSocketSession>	getOpenSessions()
WebSocketPolicy	getPolicy() Get the base policy in use for WebSockets.
void	init()
boolean	isUpgradeRequest(HttpServletRequest request, HttpServletResponse response)
void	onSessionClosed(WebSocketSession session)
void	onSessionOpened(WebSocketSession session)
protected String[]	parseProtocols(String protocol)
void	register(Class<?> websocketPojo) Register a websocket class pojo with the default WebSocketCreator.
void	setCreator(WebSocketCreator creator)
protected void	shutdownAllConnections()

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

addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, doStart, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, dumpThis, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, 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

shutdownAllConnections

protected void shutdownAllConnections()

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

Parameters:

req - the request details

resp - the response details

Returns:

a websocket object to use, or null if no websocket should be created from this request.

doStop

protected void doStop()
               throws Exception

Description copied from class: ContainerLifeCycle

Stops the managed lifecycle beans in the reverse order they were added.

Overrides:

doStop in class ContainerLifeCycle

Throws:

Exception

getCreator

public WebSocketCreator getCreator()

Specified by:

getCreator in interface WebSocketServletFactory

getEventDriverFactory

public EventDriverFactory getEventDriverFactory()

getExtensionFactory

public ExtensionFactory getExtensionFactory()

Specified by:

getExtensionFactory in interface WebSocketServletFactory

getOpenSessions

public Set<WebSocketSession> getOpenSessions()

getPolicy

public WebSocketPolicy getPolicy()

Description copied from interface: WebSocketServletFactory

Get the base policy in use for WebSockets.

Note: individual WebSocket implementations can override some of the values in here by using the @WebSocket annotation.

Specified by:

getPolicy in interface WebSocketServletFactory

Returns:

the base policy

init

public void init()
          throws Exception

Specified by:

init in interface WebSocketServletFactory

Throws:

Exception

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)

Description copied from interface: WebSocketServletFactory

Register a websocket class pojo with the default WebSocketCreator.

Note: only required if using the default WebSocketCreator provided by this factory.

Specified by:

register in interface WebSocketServletFactory

Parameters:

websocketPojo - the class to instantiate for each incoming websocket upgrade request.

setCreator

public void setCreator(WebSocketCreator creator)

Specified by:

setCreator in interface WebSocketServletFactory