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

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, java.util.concurrent.Executor executor, DecoratedObjectFactory objectFactory)

Method Summary

Modifier and Type	Method and Description
protected void	doStart() Starts the managed lifecycle beans in the order they were added.
protected void	doStop() Stops the managed lifecycle beans in the reverse order they were added.
ByteBufferPool	getBufferPool() The configured Container Buffer Pool.
java.util.concurrent.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.
SslContextFactory	getSslContextFactory() The SslContextFactory in use by the container.
void	onSessionClosed(WebSocketSession session) A Session has been closed
void	onSessionOpened(WebSocketSession session) A Session has been opened
void	setSslContextFactory(SslContextFactory sslContextFactory)

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

addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, 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, toString, wait, wait, wait

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

isRunning

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,
                            java.util.concurrent.Executor executor,
                            DecoratedObjectFactory objectFactory)

Method Detail

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

doStop

protected void doStop()
               throws java.lang.Exception

Description copied from class: ContainerLifeCycle

Stops the managed lifecycle beans in the reverse order they were added.

Overrides:

doStop in class ContainerLifeCycle

Throws:

java.lang.Exception

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

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)

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