Package com.vaadin.collaborationengine
Class SystemConnectionContext
- java.lang.Object
-
- com.vaadin.collaborationengine.SystemConnectionContext
-
- All Implemented Interfaces:
ConnectionContext
public class SystemConnectionContext extends Object implements ConnectionContext
A connection context that is always active. This context is intended to be used in cases when Collaboration Engine is used in situations that aren't directly associated with a UI, such as from a background thread or when integrating with external services.An instance can be acquired using
getInstance()
in any situation whereCollaborationEngine.getInstance()
is available. Other situations can useCollaborationEngine.getSystemContext()
or create a new context instance using the constructor.- Author:
- Vaadin Ltd
-
-
Constructor Summary
Constructors Constructor Description SystemConnectionContext(CollaborationEngine ce)
Creates a new system connection context instance for the given Collaboration Engine instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SystemConnectionContext
getInstance()
Gets the system connection context associated with the current Collaboration Engine instance.Registration
init(ActivationHandler activationHandler, Executor executor)
Initializes the connection context with aActivationHandler
and anExecutor
.
-
-
-
Constructor Detail
-
SystemConnectionContext
public SystemConnectionContext(CollaborationEngine ce)
Creates a new system connection context instance for the given Collaboration Engine instance. It is typically recommended reusing an existing instance throughgetInstance()
orCollaborationEngine.getSystemContext()
rather than creating new instances.- Parameters:
ce
- the collaboration engine instance to use, notnull
-
-
Method Detail
-
getInstance
public static SystemConnectionContext getInstance()
Gets the system connection context associated with the current Collaboration Engine instance. This method can be used only whenCollaborationEngine.getInstance()
is available.- Returns:
- a system connection context instance, not
null
- Throws:
IllegalStateException
- in case no current collaboration engine instance is available
-
init
public Registration init(ActivationHandler activationHandler, Executor executor)
Description copied from interface:ConnectionContext
Initializes the connection context with aActivationHandler
and anExecutor
.The method
Consumer.accept(Object)
from the providedActivationHandler
should be called with anActionDispatcher
when this ConnectionContext is activated. When this ConnectionContext is deactivated, it should callConsumer.accept(Object)
with a null parameter.The
ActionDispatcher
should ensure synchronization within the context of this ConnectionContext.- Specified by:
init
in interfaceConnectionContext
- Parameters:
activationHandler
- the handler for activation changesexecutor
- executor that should be used by the handler to execute background tasks. Notnull
- Returns:
- the registration for any logic that needs to be cleaned up if the
connection is closed permanently, or
null
if there is nothing to clean up
-
-