Interface WebSocketContainerScope
- All Known Implementing Classes:
ClientContainer
,DelegatedContainerScope
,ServerContainer
,SimpleContainerScope
,WebSocketClient
,WebSocketServerFactory
public interface WebSocketContainerScope
Defined Scope for a WebSocketContainer.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addSessionListener
(WebSocketSessionListener listener) org.eclipse.jetty.io.ByteBufferPool
The configured Container Buffer Pool.default ClassLoader
The ClassLoader used to load classes for the WebSocketSession.Executor in use by the container.org.eclipse.jetty.util.DecoratedObjectFactory
Object Factory used to create objects.The policy the container is running on.org.eclipse.jetty.util.ssl.SslContextFactory
The SslContextFactory in use by the container.boolean
Test for if the container has been started.void
-
Method Details
-
getBufferPool
org.eclipse.jetty.io.ByteBufferPool getBufferPool()The configured Container Buffer Pool.- Returns:
- the buffer pool (never null)
-
getExecutor
Executor getExecutor()Executor in use by the container.- Returns:
- the Executor in use by the container.
-
getObjectFactory
org.eclipse.jetty.util.DecoratedObjectFactory getObjectFactory()Object Factory used to create objects.- Returns:
- Object Factory used to create instances of objects.
-
getPolicy
WebSocketPolicy getPolicy()The policy the container is running on.- Returns:
- the websocket policy
-
getSslContextFactory
org.eclipse.jetty.util.ssl.SslContextFactory getSslContextFactory()The SslContextFactory in use by the container.- Returns:
- the SslContextFactory in use by the container (can be null if no SSL context is defined)
-
getClassLoader
The ClassLoader used to load classes for the WebSocketSession.
By default this will be the ContextClassLoader at the time this method is called. However this will be overridden by the WebSocketClient to use the ContextClassLoader at the time it was created, this is because the client uses its own
ThreadPool
so the WebSocketSessions may be created when the ContextClassLoader is not set.- Returns:
- the classloader.
-
isRunning
boolean isRunning()Test for if the container has been started.- Returns:
- true if container is started and running
-
addSessionListener
-
removeSessionListener
-
getSessionListeners
Collection<WebSocketSessionListener> getSessionListeners()
-