Package 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:

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 org.eclipse.jetty.websocket.servlet.WebSocketServletFactory

WebSocketServletFactory.Loader

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

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, org.eclipse.jetty.websocket.api.WebSocketPolicy policy)	Entry point for WebSocketServletFactory.Loader
	WebSocketServerFactory(javax.servlet.ServletContext context, org.eclipse.jetty.websocket.api.WebSocketPolicy policy, org.eclipse.jetty.io.ByteBufferPool bufferPool)
protected	WebSocketServerFactory(org.eclipse.jetty.websocket.api.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)
Object	createWebSocket(ServletUpgradeRequest req, ServletUpgradeResponse resp)	Default Creator logic
protected void	doStart()
protected void	doStop()
Set<String>	getAvailableExtensionNames()
org.eclipse.jetty.io.ByteBufferPool	getBufferPool()
WebSocketCreator	getCreator()
EventDriverFactory	getEventDriverFactory()
Executor	getExecutor()
org.eclipse.jetty.websocket.api.extensions.ExtensionFactory	getExtensionFactory()	Deprecated.
org.eclipse.jetty.util.DecoratedObjectFactory	getObjectFactory()
Collection<WebSocketSession>	getOpenSessions()
org.eclipse.jetty.websocket.api.WebSocketPolicy	getPolicy()
Collection<WebSocketSessionListener>	getSessionListeners()
org.eclipse.jetty.util.ssl.SslContextFactory	getSslContextFactory()
boolean	isUpgradeRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	register(Class<?> websocketPojo)
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, 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 java.lang.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 org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope

getClassLoader, isRunning

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

start, stop

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,
 org.eclipse.jetty.websocket.api.WebSocketPolicy policy)

Entry point for WebSocketServletFactory.Loader

Parameters:

context - the servlet context

policy - the policy to use

WebSocketServerFactory

public WebSocketServerFactory(javax.servlet.ServletContext context,
 org.eclipse.jetty.websocket.api.WebSocketPolicy policy,
 org.eclipse.jetty.io.ByteBufferPool bufferPool)

WebSocketServerFactory

protected WebSocketServerFactory(org.eclipse.jetty.websocket.api.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

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)

createWebSocket

public Object createWebSocket(ServletUpgradeRequest req,
 ServletUpgradeResponse resp)

Default Creator logic

Specified by:

createWebSocket in interface WebSocketCreator

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

getBufferPool

public org.eclipse.jetty.io.ByteBufferPool getBufferPool()

Specified by:

getBufferPool in interface WebSocketContainerScope

getCreator

public WebSocketCreator getCreator()

Specified by:

getCreator in interface WebSocketServletFactory

getExecutor

public Executor getExecutor()

Specified by:

getExecutor in interface WebSocketContainerScope

getObjectFactory

public org.eclipse.jetty.util.DecoratedObjectFactory getObjectFactory()

Specified by:

getObjectFactory in interface WebSocketContainerScope

getEventDriverFactory

public EventDriverFactory getEventDriverFactory()

getAvailableExtensionNames

public Set<String> getAvailableExtensionNames()

Specified by:

getAvailableExtensionNames in interface WebSocketServletFactory

getExtensionFactory

@Deprecated
public org.eclipse.jetty.websocket.api.extensions.ExtensionFactory getExtensionFactory()

Deprecated.

Specified by:

getExtensionFactory in interface WebSocketServletFactory

getOpenSessions

public Collection<WebSocketSession> getOpenSessions()

getPolicy

public org.eclipse.jetty.websocket.api.WebSocketPolicy getPolicy()

Specified by:

getPolicy in interface WebSocketContainerScope

Specified by:

getPolicy in interface WebSocketServletFactory

getSslContextFactory

public org.eclipse.jetty.util.ssl.SslContextFactory getSslContextFactory()

Specified by:

getSslContextFactory in interface WebSocketContainerScope

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)

Specified by:

register in interface WebSocketServletFactory

setCreator

public void setCreator(WebSocketCreator creator)

Specified by:

setCreator in interface WebSocketServletFactory

toString

public String toString()

Overrides:

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