Package org.camunda.bpm.container.impl.metadata.spi

Interface ProcessEngineXml

All Known Implementing Classes:
ProcessEngineXmlImpl
public interface ProcessEngineXml

Java API representation of a ProcessEngine definition inside an XML deployment descriptor.

Author:
Daniel Meyer

  • Method Details

    • getName

      String getName()
      Returns:
      the name of the process engine. Must not be null.

    • isDefault

      boolean isDefault()
      Returns:
      true if the process engine is the default process engine.

    • getConfigurationClass

      String getConfigurationClass()
      Returns:
      the name of the Java Class that is to be used in order to create the process engine instance. Must be a subclass of ProcessEngineConfiguration. If no value is specified, StandaloneProcessEngineConfiguration is used.

    • getDatasource

      String getDatasource()
      Returns:
      the JNDI Name of the datasource to be used.

    • getProperties

      Map<String,String> getProperties()
      Returns:
      a set of additional properties. The properties are directly set on the ProcessEngineConfiguration class (see getConfigurationClass()). This means that each property name used here must be a bean property name on the process engine configuration class and the bean property must be of type String, Integer or Boolean.

    • getJobAcquisitionName

      String getJobAcquisitionName()
      Returns:
      the name of the job acquisition to be used.

    • getPlugins

      List<ProcessEnginePluginXml> getPlugins()
      Returns:
      a list of ProcessEnginePlugin definitions.