org.eclipse.jetty.websocket.common.scopes

Class SimpleContainerScope

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.websocket.common.scopes.SimpleContainerScope

All Implemented Interfaces:

Container, Destroyable, Dumpable, LifeCycle, WebSocketContainerScope

public class SimpleContainerScope
extends ContainerLifeCycle
implements WebSocketContainerScope

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

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

KEY

Constructor Summary

Constructors

Constructor and Description
SimpleContainerScope(WebSocketPolicy policy)
SimpleContainerScope(WebSocketPolicy policy, ByteBufferPool bufferPool)
SimpleContainerScope(WebSocketPolicy policy, ByteBufferPool bufferPool, DecoratedObjectFactory objectFactory)
SimpleContainerScope(WebSocketPolicy policy, ByteBufferPool bufferPool, Executor executor, DecoratedObjectFactory objectFactory)
SimpleContainerScope(WebSocketPolicy policy, ByteBufferPool bufferPool, Executor executor, SslContextFactory ssl, DecoratedObjectFactory objectFactory)

Method Summary

Modifier and Type	Method and Description
void	addSessionListener(WebSocketSessionListener listener)
ByteBufferPool	getBufferPool() The configured Container Buffer Pool.
Executor	getExecutor() Executor in use by the container.
DecoratedObjectFactory	getObjectFactory() Object Factory used to create objects.
WebSocketPolicy	getPolicy() The policy the container is running on.
Collection<WebSocketSessionListener>	getSessionListeners()
SslContextFactory	getSslContextFactory() The SslContextFactory in use by the container.
void	removeSessionListener(WebSocketSessionListener listener)
void	setSslContextFactory(SslContextFactory sslContextFactory)

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, toString

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

dumpContainer, dumpIterable, dumpMapEntries, dumpObjects, dumpSelf, named

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

start, stop

Constructor Detail

SimpleContainerScope

public SimpleContainerScope(WebSocketPolicy policy)

SimpleContainerScope

public SimpleContainerScope(WebSocketPolicy policy,
                            ByteBufferPool bufferPool)

SimpleContainerScope

public SimpleContainerScope(WebSocketPolicy policy,
                            ByteBufferPool bufferPool,
                            DecoratedObjectFactory objectFactory)

SimpleContainerScope

public SimpleContainerScope(WebSocketPolicy policy,
                            ByteBufferPool bufferPool,
                            Executor executor,
                            DecoratedObjectFactory objectFactory)

SimpleContainerScope

public SimpleContainerScope(WebSocketPolicy policy,
                            ByteBufferPool bufferPool,
                            Executor executor,
                            SslContextFactory ssl,
                            DecoratedObjectFactory objectFactory)

Method Detail

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)

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.

getPolicy

public WebSocketPolicy getPolicy()

Description copied from interface: WebSocketContainerScope

The policy the container is running on.

Specified by:

getPolicy in interface WebSocketContainerScope

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)

setSslContextFactory

public void setSslContextFactory(SslContextFactory sslContextFactory)

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