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

public class WebSocketServerFactory
extends ContainerLifeCycle
implements WebSocketCreator, WebSocketServletFactory

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.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(WebSocketPolicy policy)
WebSocketServerFactory(WebSocketPolicy policy, ByteBufferPool bufferPool)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptWebSocket(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	cleanup()
protected void	closeAllConnections()
WebSocketServletFactory	createFactory(WebSocketPolicy policy)
Object	createWebSocket(UpgradeRequest req, UpgradeResponse resp) Default Creator logic
protected void	doStop() Stops the managed lifecycle beans in the reverse order they were added.
static UpgradeContext	getActiveUpgradeContext()
WebSocketCreator	getCreator()
ExtensionFactory	getExtensionFactory()
WebSocketPolicy	getPolicy() Get the base policy in use for WebSockets.
void	init()
boolean	isUpgradeRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected String[]	parseProtocols(String protocol)
void	register(Class<?> websocketPojo) Register a websocket class pojo with the default WebSocketCreator.
boolean	sessionClosed(WebSocketSession session)
boolean	sessionOpened(WebSocketSession session)
protected static void	setActiveUpgradeContext(UpgradeContext connection)
void	setCreator(WebSocketCreator creator)
boolean	upgrade(ServletWebSocketRequest request, ServletWebSocketResponse response, EventDriver driver) Upgrade the request/response to a WebSocket Connection.

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

addBean, addBean, addBean, contains, destroy, doStart, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, dumpThis, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, setBeans, setStopTimeout, start, 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(WebSocketPolicy policy,
                      ByteBufferPool bufferPool)

Method Detail

getActiveUpgradeContext

public static UpgradeContext getActiveUpgradeContext()

setActiveUpgradeContext

protected static void setActiveUpgradeContext(UpgradeContext connection)

acceptWebSocket

public boolean acceptWebSocket(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
                        throws IOException

Specified by:

acceptWebSocket in interface WebSocketServletFactory

Throws:

IOException

cleanup

public void cleanup()

Specified by:

cleanup in interface WebSocketServletFactory

closeAllConnections

protected void closeAllConnections()

createFactory

public WebSocketServletFactory createFactory(WebSocketPolicy policy)

Specified by:

createFactory in interface WebSocketServletFactory

createWebSocket

public Object createWebSocket(UpgradeRequest req,
                     UpgradeResponse resp)

Default Creator logic

Specified by:

createWebSocket in interface WebSocketCreator

Parameters:

req - the request 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

getExtensionFactory

public ExtensionFactory getExtensionFactory()

Specified by:

getExtensionFactory in interface WebSocketServletFactory

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(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)

Specified by:

isUpgradeRequest in interface WebSocketServletFactory

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.

sessionClosed

public boolean sessionClosed(WebSocketSession session)

sessionOpened

public boolean sessionOpened(WebSocketSession session)

setCreator

public void setCreator(WebSocketCreator creator)

Specified by:

setCreator in interface WebSocketServletFactory

upgrade

public boolean upgrade(ServletWebSocketRequest request,
              ServletWebSocketResponse response,
              EventDriver driver)
                throws IOException

Upgrade the request/response to a WebSocket Connection.

This method will not normally return, but will instead throw a UpgradeConnectionException, to exit HTTP handling and initiate WebSocket handling of the connection.

Parameters:

request - The request to upgrade

response - The response to upgrade

driver - The websocket handler implementation to use

Throws:

IOException