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

public class WebSocketServerFactory
extends ContainerLifeCycle
implements WebSocketCreator, WebSocketContainerScope, 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.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, STOP_ON_FAILURE, STOPPED, STOPPING

Constructor Summary

Constructors

Modifier	Constructor and Description
	WebSocketServerFactory() Entry point for Spring Boot's MockMVC framework
	WebSocketServerFactory(javax.servlet.ServletContext context)
	WebSocketServerFactory(javax.servlet.ServletContext context, ByteBufferPool bufferPool)
	WebSocketServerFactory(javax.servlet.ServletContext context, WebSocketPolicy policy) Entry point for WebSocketServletFactory.Loader
	WebSocketServerFactory(javax.servlet.ServletContext context, WebSocketPolicy policy, ByteBufferPool bufferPool)
protected	WebSocketServerFactory(WebSocketPolicy policy, java.util.concurrent.Executor executor, ByteBufferPool bufferPool) Protected entry point for WebSocketHandler

Method Summary

Modifier and Type	Method and Description
boolean	acceptWebSocket(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
boolean	acceptWebSocket(WebSocketCreator creator, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	addSessionFactory(SessionFactory sessionFactory)
void	addSessionListener(WebSocketSession.Listener listener)
java.lang.Object	createWebSocket(ServletUpgradeRequest req, ServletUpgradeResponse resp) Default Creator logic
protected void	doStart() Starts the managed lifecycle beans in the order they were added.
protected DecoratedObjectFactory	findDecorator() Attempt to find the DecoratedObjectFactory that should be used.
protected java.util.concurrent.Executor	findExecutor() Attempt to find the Executor that should be used.
ByteBufferPool	getBufferPool() The configured Container Buffer Pool.
WebSocketCreator	getCreator()
EventDriverFactory	getEventDriverFactory()
java.util.concurrent.Executor	getExecutor() Executor in use by the container.
ExtensionFactory	getExtensionFactory()
DecoratedObjectFactory	getObjectFactory() Object Factory used to create objects.
java.util.Collection<WebSocketSession>	getOpenSessions()
WebSocketPolicy	getPolicy() The policy the container is running on.
SslContextFactory	getSslContextFactory() The SslContextFactory in use by the container.
boolean	isUpgradeRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	onSessionClosed(WebSocketSession session) A Session has been closed
void	onSessionOpened(WebSocketSession session) A Session has been opened
void	register(java.lang.Class<?> websocketPojo) Register a websocket class pojo with the default WebSocketCreator.
void	removeSessionListener(WebSocketSession.Listener listener)
void	setCreator(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, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, 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, wait, wait, wait

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

isRunning

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

start, stop

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

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,
                              ByteBufferPool bufferPool)

WebSocketServerFactory

public WebSocketServerFactory(javax.servlet.ServletContext context,
                              WebSocketPolicy policy)

Entry point for WebSocketServletFactory.Loader

Parameters:

context - the servlet context

policy - the policy to use

WebSocketServerFactory

public WebSocketServerFactory(javax.servlet.ServletContext context,
                              WebSocketPolicy policy,
                              ByteBufferPool bufferPool)

WebSocketServerFactory

protected WebSocketServerFactory(WebSocketPolicy policy,
                                 java.util.concurrent.Executor executor,
                                 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(WebSocketSession.Listener listener)

removeSessionListener

public void removeSessionListener(WebSocketSession.Listener listener)

acceptWebSocket

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

Specified by:

acceptWebSocket in interface WebSocketServletFactory

Throws:

java.io.IOException

acceptWebSocket

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

Specified by:

acceptWebSocket in interface WebSocketServletFactory

Throws:

java.io.IOException

addSessionFactory

public void addSessionFactory(SessionFactory sessionFactory)

createWebSocket

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

doStart

protected void doStart()
                throws java.lang.Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class ContainerLifeCycle

Throws:

java.lang.Exception

findDecorator

protected DecoratedObjectFactory findDecorator()

Attempt to find the DecoratedObjectFactory that should be used.

Returns:

the DecoratedObjectFactory that should be used. (never null)

findExecutor

protected java.util.concurrent.Executor findExecutor()

Attempt to find the Executor that should be used.

Returns:

the Executor that should be used. (never null)

getBufferPool

public ByteBufferPool getBufferPool()

Description copied from interface: WebSocketContainerScope

The configured Container Buffer Pool.

Specified by:

getBufferPool in interface WebSocketContainerScope

Returns:

the buffer pool (never null)

getCreator

public WebSocketCreator getCreator()

Specified by:

getCreator in interface WebSocketServletFactory

getExecutor

public java.util.concurrent.Executor getExecutor()

Description copied from interface: WebSocketContainerScope

Executor in use by the container.

Specified by:

getExecutor in interface WebSocketContainerScope

Returns:

the Executor in use by the container.

getObjectFactory

public DecoratedObjectFactory getObjectFactory()

Description copied from interface: WebSocketContainerScope

Object Factory used to create objects.

Specified by:

getObjectFactory in interface WebSocketContainerScope

Returns:

Object Factory used to create instances of objects.

getEventDriverFactory

public EventDriverFactory getEventDriverFactory()

getExtensionFactory

public ExtensionFactory getExtensionFactory()

Specified by:

getExtensionFactory in interface WebSocketServletFactory

getOpenSessions

public java.util.Collection<WebSocketSession> getOpenSessions()

getPolicy

public WebSocketPolicy getPolicy()

Description copied from interface: WebSocketContainerScope

The policy the container is running on.

Specified by:

getPolicy in interface WebSocketContainerScope

Specified by:

getPolicy in interface WebSocketServletFactory

Returns:

the websocket policy

getSslContextFactory

public SslContextFactory getSslContextFactory()

Description copied from interface: WebSocketContainerScope

The SslContextFactory in use by the container.

Specified by:

getSslContextFactory in interface WebSocketContainerScope

Returns:

the SslContextFactory in use by the container (can be null if no SSL context is defined)

isUpgradeRequest

public boolean isUpgradeRequest(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)

Specified by:

isUpgradeRequest in interface WebSocketServletFactory

onSessionOpened

public void onSessionOpened(WebSocketSession session)

Description copied from interface: WebSocketContainerScope

A Session has been opened

Specified by:

onSessionOpened in interface WebSocketContainerScope

Parameters:

session - the session that was opened

onSessionClosed

public void onSessionClosed(WebSocketSession session)

Description copied from interface: WebSocketContainerScope

A Session has been closed

Specified by:

onSessionClosed in interface WebSocketContainerScope

Parameters:

session - the session that was closed

register

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object