Package org.eclipse.jetty.websocket.common.scopes

Class DelegatedContainerScope

java.lang.Object

org.eclipse.jetty.websocket.common.scopes.DelegatedContainerScope

All Implemented Interfaces:

WebSocketContainerScope

public class DelegatedContainerScope
extends Object
implements WebSocketContainerScope

Constructor Summary

Constructors

Constructor	Description
DelegatedContainerScope(org.eclipse.jetty.websocket.api.WebSocketPolicy policy, WebSocketContainerScope parentScope)

Method Summary

Modifier and Type	Method	Description
org.eclipse.jetty.io.ByteBufferPool	getBufferPool()	The configured Container Buffer Pool.
Executor	getExecutor()	Executor in use by the container.
org.eclipse.jetty.util.DecoratedObjectFactory	getObjectFactory()	Object Factory used to create objects.
org.eclipse.jetty.websocket.api.WebSocketPolicy	getPolicy()	The policy the container is running on.
org.eclipse.jetty.util.ssl.SslContextFactory	getSslContextFactory()	The SslContextFactory in use by the container.
boolean	isRunning()	Test for if the container has been started.
void	onSessionClosed(WebSocketSession session)	A Session has been closed
void	onSessionOpened(WebSocketSession session)	A Session has been opened

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DelegatedContainerScope

public DelegatedContainerScope(org.eclipse.jetty.websocket.api.WebSocketPolicy policy,
                               WebSocketContainerScope parentScope)

Method Detail

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)

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.

getPolicy

public org.eclipse.jetty.websocket.api.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 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)

isRunning

public boolean isRunning()

Description copied from interface: WebSocketContainerScope

Test for if the container has been started.

Specified by:

isRunning in interface WebSocketContainerScope

Returns:

true if container is started and running

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