com.vaadin.collaborationengine.
Class CollaborationEngineConfiguration
- java.lang.Object
-
- com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
public class CollaborationEngineConfiguration extends Object
Configuration object for
CollaborationEngine
. When running in production mode, it is required to set this configuration for the Collaboration Engine associated with the currentVaadinService
. This should be done by callingCollaborationEngine.configure(VaadinService, CollaborationEngineConfiguration)
in aVaadinServiceInitListener
.
-
-
Constructor Summary
Constructors Constructor and Description CollaborationEngineConfiguration(LicenseEventHandler licenseEventHandler)
Creates a new Collaboration Engine configuration with the provided handler for license events.
-
Method Summary
All Methods Modifier and Type Method and Description String
getDataDir()
Gets the configured data-directory.
LicenseEventHandler
getLicenseEventHandler()
Gets the license event handler of this configuration.
void
setDataDir(String dataDir)
Sets the path to the data-directory, which is used by Collaboration Engine to store files.
-
-
-
Constructor Detail
-
CollaborationEngineConfiguration
public CollaborationEngineConfiguration(LicenseEventHandler licenseEventHandler)
Creates a new Collaboration Engine configuration with the provided handler for license events.
The handler will be invoked when license events occur, e.g. when the license is expired or when the end-user quota has entered the grace period. The handler can then be used for example to forward these events via e-mail or to a monitoring application to be alerted about the current status of the license.
See
LicenseEvent.LicenseEventType
for a list of license event types.Parameters:
licenseEventHandler
- the license event handler, notnull
-
-
Method Detail
-
getLicenseEventHandler
public LicenseEventHandler getLicenseEventHandler()
Gets the license event handler of this configuration.
Returns:
the license event handler
-
getDataDir
public String getDataDir()
Gets the configured data-directory.
Returns:
the data-directory
-
setDataDir
public void setDataDir(String dataDir)
Sets the path to the data-directory, which is used by Collaboration Engine to store files.
The data-directory can also be configured by setting the
vaadin.ce.dataDir
system property either in the command line or withSystem.setProperty(String, String)
. If a system property is set, it will take precedence over this setting.Parameters:
dataDir
- path to the data-directory
-
-