Class CollaborationEngineConfiguration

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

• 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 with System.setProperty(String, String). If a system property is set, it will take precedence over this setting.

  Parameters:

  dataDir - path to the data-directory

• setAutomaticallyActivatePush

  public void setAutomaticallyActivatePush(boolean automaticallyActivatePush)

  Sets whether server push should be automatically activated if needed. When enabled, which is the default, Collaboration Engine will automatically activate PushMode.AUTOMATIC if neither push nor polling is active for a UI where CollaborationEngine is used. When disabled, no automatic changes are made to the application's push configuration.

  Parameters:

  automaticallyActivatePush - true to automatically activate server push if needed, false to not make any automatic changes to the push configuration

• isAutomaticallyActivatePush

  public boolean isAutomaticallyActivatePush()

  Checks whether automatic push activation is enabled.

  Returns:

  true if automatic server push configuration is enabled, false if it's no enabled

  See Also:

  setAutomaticallyActivatePush(boolean)