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, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor and Description
WebSocketServerFactory() Entry point for Spring Boot's MockMVC framework
WebSocketServerFactory(ServletContext context)
WebSocketServerFactory(ServletContext context, ByteBufferPool bufferPool)
WebSocketServerFactory(ServletContext context, WebSocketPolicy policy) Entry point for WebSocketServletFactory.Loader
WebSocketServerFactory(ServletContext context, 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	addSessionListener(WebSocketSessionListener listener)
Object	createWebSocket(ServletUpgradeRequest req, ServletUpgradeResponse resp) Default Creator logic
Set<String>	getAvailableExtensionNames() Get the set of available Extensions by registered name.
ByteBufferPool	getBufferPool() The configured Container Buffer Pool.
WebSocketCreator	getCreator()
EventDriverFactory	getEventDriverFactory()
Executor	getExecutor() Executor in use by the container.
ExtensionFactory	getExtensionFactory() Deprecated.
DecoratedObjectFactory	getObjectFactory() Object Factory used to create objects.
Collection<WebSocketSession>	getOpenSessions()
WebSocketPolicy	getPolicy() The policy the container is running on.
Collection<WebSocketSessionListener>	getSessionListeners()
SslContextFactory	getSslContextFactory() The SslContextFactory in use by the container.
boolean	isUpgradeRequest(HttpServletRequest request, 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()

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

addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dump, dump, dumpObject, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, 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

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

dumpContainer, dumpIterable, dumpMapEntries, dumpObjects, dumpSelf, named

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(ServletContext context)

WebSocketServerFactory

public WebSocketServerFactory(ServletContext context,
                              ByteBufferPool bufferPool)

WebSocketServerFactory

public WebSocketServerFactory(ServletContext context,
                              WebSocketPolicy policy)

Entry point for WebSocketServletFactory.Loader

Parameters:

context - the servlet context

policy - the policy to use

WebSocketServerFactory

public WebSocketServerFactory(ServletContext context,
                              WebSocketPolicy policy,
                              ByteBufferPool bufferPool)

Method Detail

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(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)

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.

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 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()

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 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(HttpServletRequest request,
                                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

toString

public String toString()

Overrides:

toString in class AbstractLifeCycle