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 current VaadinService. This should be done by calling CollaborationEngine.configure(VaadinService, CollaborationEngineConfiguration) in a VaadinServiceInitListener.

Constructor Summary

Constructors

Constructor and Description
CollaborationEngineConfiguration(LicenseEventHandler licenseEventHandler) Creates a new Collaboration Engine configuration with the provided handler for license events.

Method Summary

Modifier and Type	Method and Description
LicenseEventHandler	getLicenseEventHandler() Gets the license event handler of this configuration.

Methods inherited from class java.lang.Object

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

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, not null

Method Detail

getLicenseEventHandler

public LicenseEventHandler getLicenseEventHandler()

Gets the license event handler of this configuration.

Returns:

the license event handler