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:

org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle, WebSocketContainerScope, WebSocketCreator, WebSocketServletFactory

public class WebSocketServerFactory
extends org.eclipse.jetty.util.component.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

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.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer

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 WebSocketServletFactory

WebSocketServletFactory.Loader

Field Summary

Fields

Modifier and Type	Field	Description
private final org.eclipse.jetty.io.ByteBufferPool	bufferPool
private final javax.servlet.ServletContext	context
private final ClassLoader	contextClassloader
private WebSocketCreator	creator
private final WebSocketPolicy	defaultPolicy
private final EventDriverFactory	eventDriverFactory
private Executor	executor
private final WebSocketExtensionFactory	extensionFactory
private final Map<Integer, WebSocketHandshake>	handshakes
private final List<WebSocketSessionListener>	listeners
private static final org.eclipse.jetty.util.log.Logger	LOG
private org.eclipse.jetty.util.DecoratedObjectFactory	objectFactory
private final List<Class<?>>	registeredSocketClasses
private final org.eclipse.jetty.util.thread.Scheduler	scheduler
private final List<SessionFactory>	sessionFactories
private final SessionTracker	sessionTracker
private final String	supportedVersions
private static final String	WEBSOCKET_DEFLATER_POOL_ATTRIBUTE
private static final String	WEBSOCKET_INFLATER_POOL_ATTRIBUTE

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, WebSocketPolicy policy)	Entry point for WebSocketServletFactory.Loader
	WebSocketServerFactory(javax.servlet.ServletContext context, WebSocketPolicy policy, org.eclipse.jetty.io.ByteBufferPool bufferPool)
private	WebSocketServerFactory(javax.servlet.ServletContext context, WebSocketPolicy policy, org.eclipse.jetty.util.DecoratedObjectFactory objectFactory, Executor executor, org.eclipse.jetty.io.ByteBufferPool bufferPool)
protected	WebSocketServerFactory(WebSocketPolicy policy, Executor executor, org.eclipse.jetty.io.ByteBufferPool bufferPool)	Protected entry point for WebSocketHandler

Method Summary

Modifier and Type	Method	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(WebSocketSessionListener listener)
private WebSocketSession	createSession(URI requestURI, EventDriver websocket, LogicalConnection connection)
Object	createWebSocket(ServletUpgradeRequest req, ServletUpgradeResponse resp)	Default Creator logic
protected void	doStart()
protected void	doStop()
private org.eclipse.jetty.util.DecoratedObjectFactory	findDecoratedObjectFactory()	Attempt to find the DecoratedObjectFactory that should be used.
private Executor	findExecutor()	Attempt to find the Executor that should be used.
Set<String>	getAvailableExtensionNames()	Get the set of available Extensions by registered name.
org.eclipse.jetty.io.ByteBufferPool	getBufferPool()	The configured Container Buffer Pool.
WebSocketCreator	getCreator()
EventDriverFactory	getEventDriverFactory()
Executor	getExecutor()	Executor in use by the container.
ExtensionFactory	getExtensionFactory()	Deprecated.
org.eclipse.jetty.util.DecoratedObjectFactory	getObjectFactory()	Object Factory used to create objects.
Collection<WebSocketSession>	getOpenSessions()
WebSocketPolicy	getPolicy()	The policy the container is running on.
private boolean	getSendServerVersion(org.eclipse.jetty.server.Connector connector)
Collection<WebSocketSessionListener>	getSessionListeners()
org.eclipse.jetty.util.ssl.SslContextFactory	getSslContextFactory()	The SslContextFactory in use by the container.
boolean	isUpgradeRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	register(Class<?> websocketPojo)	Register a websocket class pojo with the default WebSocketCreator.
void	removeSessionListener(WebSocketSessionListener listener)
void	setCreator(WebSocketCreator creator)
String	toString()
private boolean	upgrade(org.eclipse.jetty.server.HttpConnection http, ServletUpgradeRequest request, ServletUpgradeResponse response, EventDriver driver)	Upgrade the request/response to a WebSocket Connection.

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

addBean, addBean, addEventListener, addManaged, contains, destroy, 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 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.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface WebSocketContainerScope

getClassLoader, isRunning

Methods inherited from interface WebSocketServletFactory

start, stop

Field Details

LOG

private static final org.eclipse.jetty.util.log.Logger LOG

WEBSOCKET_INFLATER_POOL_ATTRIBUTE

private static final String WEBSOCKET_INFLATER_POOL_ATTRIBUTE

See Also:

• Constant Field Values

WEBSOCKET_DEFLATER_POOL_ATTRIBUTE

private static final String WEBSOCKET_DEFLATER_POOL_ATTRIBUTE

See Also:

• Constant Field Values

contextClassloader

private final ClassLoader contextClassloader

handshakes

private final Map<Integer, WebSocketHandshake> handshakes

scheduler

private final org.eclipse.jetty.util.thread.Scheduler scheduler

listeners

private final List<WebSocketSessionListener> listeners

supportedVersions

private final String supportedVersions

defaultPolicy

private final WebSocketPolicy defaultPolicy

eventDriverFactory

private final EventDriverFactory eventDriverFactory

bufferPool

private final org.eclipse.jetty.io.ByteBufferPool bufferPool

extensionFactory

private final WebSocketExtensionFactory extensionFactory

context

private final javax.servlet.ServletContext context

sessionFactories

private final List<SessionFactory> sessionFactories

sessionTracker

private final SessionTracker sessionTracker

registeredSocketClasses

private final List<Class<?>> registeredSocketClasses

executor

private Executor executor

objectFactory

private org.eclipse.jetty.util.DecoratedObjectFactory objectFactory

creator

private WebSocketCreator creator

Constructor Details

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,
 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,
 org.eclipse.jetty.io.ByteBufferPool bufferPool)

WebSocketServerFactory

protected WebSocketServerFactory(WebSocketPolicy policy,
 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

WebSocketServerFactory

private WebSocketServerFactory(javax.servlet.ServletContext context,
 WebSocketPolicy policy,
 org.eclipse.jetty.util.DecoratedObjectFactory objectFactory,
 Executor executor,
 org.eclipse.jetty.io.ByteBufferPool bufferPool)

Method Details

addSessionListener

public void addSessionListener(WebSocketSessionListener listener)

Specified by:

addSessionListener in interface WebSocketContainerScope

removeSessionListener

public void removeSessionListener(WebSocketSessionListener listener)

Specified by:

removeSessionListener in interface WebSocketContainerScope

getSessionListeners

public Collection<WebSocketSessionListener> getSessionListeners()

Specified by:

getSessionListeners in interface WebSocketContainerScope

acceptWebSocket

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

Specified by:

acceptWebSocket in interface WebSocketServletFactory

Throws:

IOException

acceptWebSocket

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

Specified by:

acceptWebSocket in interface WebSocketServletFactory

Throws:

IOException

addSessionFactory

public void addSessionFactory(SessionFactory sessionFactory)

createSession

private WebSocketSession createSession(URI requestURI,
 EventDriver websocket,
 LogicalConnection connection)

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.

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

Exception

findDecoratedObjectFactory

private org.eclipse.jetty.util.DecoratedObjectFactory findDecoratedObjectFactory()

Attempt to find the DecoratedObjectFactory that should be used.

Returns:

the DecoratedObjectFactory that should be used. (never null)

findExecutor

private Executor findExecutor()

Attempt to find the Executor that should be used.

Returns:

the Executor that should be used. (never null)

getBufferPool

public org.eclipse.jetty.io.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 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 org.eclipse.jetty.util.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()

getAvailableExtensionNames

public Set<String> getAvailableExtensionNames()

Description copied from interface: WebSocketServletFactory

Get the set of available Extensions by registered name.

Specified by:

getAvailableExtensionNames in interface WebSocketServletFactory

Returns:

the set of available extensions by registered name.

getExtensionFactory

@Deprecated
public ExtensionFactory getExtensionFactory()

Deprecated.

Description copied from interface: WebSocketServletFactory

Get the registered extensions for this WebSocket factory.

Specified by:

getExtensionFactory in interface WebSocketServletFactory

Returns:

the ExtensionFactory

See Also:

• WebSocketServletFactory.getAvailableExtensionNames()

getOpenSessions

public 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 org.eclipse.jetty.util.ssl.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

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

upgrade

private boolean upgrade(org.eclipse.jetty.server.HttpConnection http,
 ServletUpgradeRequest request,
 ServletUpgradeResponse 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:

http - the raw http connection

request - The request to upgrade

response - The response to upgrade

driver - The websocket handler implementation to use

Throws:

IOException

getSendServerVersion

private boolean getSendServerVersion(org.eclipse.jetty.server.Connector connector)

toString

public String toString()

Overrides:

toString in class org.eclipse.jetty.util.component.AbstractLifeCycle