Package org.flowable.common.engine.impl

Interface EngineConfigurator

All Known Implementing Classes:
AbstractEngineConfigurator, AbstractProcessEngineConfigurator, CmmnEngineConfigurator, DmnEngineConfigurator, EventRegistryEngineConfigurator, FlowableProfiler, ProcessEngineConfigurator, ProcessExecutionLoggerConfigurator, SpringCmmnEngineConfigurator, SpringDmnEngineConfigurator, SpringEventRegistryConfigurator, SpringProcessEngineConfigurator
public interface EngineConfigurator
Implementations of this class can be plugged into a AbstractEngineConfiguration. Such implementations can configure the engine in any way programmatically possible.
Author:
Joram Barrez, Tijs Rademakers

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    beforeInit(AbstractEngineConfiguration engineConfiguration)
    Called before any initialisation has been done.
    void
    configure(AbstractEngineConfiguration engineConfiguration)
    Called when the engine boots up, before it is usable, but after the initialisation of internal objects is done.
    int
    getPriority()
    When the EngineConfigurator instances are used, they are first ordered by this priority number (lowest to highest).

  • Method Details

    • beforeInit

      void beforeInit(AbstractEngineConfiguration engineConfiguration)
      Called before any initialisation has been done. This can for example be useful to change configuration settings before anything that uses those properties is created. Allows to tweak the engine by passing the AbstractEngineConfiguration which allows tweaking it programmatically. An example is the jdbc url. When a EngineConfigurator instance wants to change it, it needs to do it in this method, or otherwise the datasource would already have been created with the 'old' value for the jdbc url.

    • configure

      void configure(AbstractEngineConfiguration engineConfiguration)
      Called when the engine boots up, before it is usable, but after the initialisation of internal objects is done. Allows to tweak the engine by passing the AbstractEngineConfiguration which allows tweaking it programmatically. An example is the ldap user/group manager, which is an addition to the engine. No default properties need to be overridden for this (otherwise the beforeInit(AbstractEngineConfiguration) method should be used) so the logic contained in this method is executed after initialisation of the default objects. Probably a better name would be 'afterInit' (cfr beforeInit(AbstractEngineConfiguration)), but not possible due to backwards compatibility.

    • getPriority

      int getPriority()
      When the EngineConfigurator instances are used, they are first ordered by this priority number (lowest to highest). If you have dependencies between EngineConfigurator instances, use the priorities accordingly to order them as needed.