ProcessEngineConfiguration (Activiti

java.lang.Object
- org.activiti.engine.ProcessEngineConfiguration

All Implemented Interfaces:

EngineServices
```
public abstract class ProcessEngineConfiguration
extends Object
implements EngineServices
```
Configuration information from which a process engine can be build.
Most common is to create a process engine based on the default configuration file:
```
ProcessEngine processEngine = ProcessEngineConfiguration
   .createProcessEngineConfigurationFromResourceDefault()
   .buildProcessEngine();
 
```
To create a process engine programatic, without a configuration file, the first option is createStandaloneProcessEngineConfiguration()
```
ProcessEngine processEngine = ProcessEngineConfiguration
   .createStandaloneProcessEngineConfiguration()
   .buildProcessEngine();
 
```
This creates a new process engine with all the defaults to connect to a remote h2 database (jdbc:h2:tcp://localhost/activiti) in standalone mode. Standalone mode means that Activiti will manage the transactions on the JDBC connections that it creates. One transaction per service method. For a description of how to write the configuration files, see the userguide.

The second option is great for testing: #createStandalonInMemeProcessEngineConfiguration()
```
ProcessEngine processEngine = ProcessEngineConfiguration
   .createStandaloneInMemProcessEngineConfiguration()
   .buildProcessEngine();
 
```
This creates a new process engine with all the defaults to connect to an memory h2 database (jdbc:h2:tcp://localhost/activiti) in standalone mode. The DB schema strategy default is in this case create-drop. Standalone mode means that Activiti will manage the transactions on the JDBC connections that it creates. One transaction per service method.

On all forms of creating a process engine, you can first customize the configuration before calling the buildProcessEngine() method by calling any of the setters like this:
```
ProcessEngine processEngine = ProcessEngineConfiguration
   .createProcessEngineConfigurationFromResourceDefault()
   .setMailServerHost("gmail.com")
   .setJdbcUsername("mickey")
   .setJdbcPassword("mouse")
   .buildProcessEngine();
 
```
Author:

Tom Baeyens

See Also:
ProcessEngines

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`activityFontName`
`protected ClassLoader`	`classLoader`
`protected String`	`databaseSchemaUpdate`
`protected String`	`databaseType`
`protected DataSource`	`dataSource`
`protected String`	`dataSourceJndiName`
`static String`	`DB_SCHEMA_UPDATE_CREATE_DROP` Creates the schema when the process engine is being created and drops the schema when the process engine is being closed.
`static String`	`DB_SCHEMA_UPDATE_FALSE` Checks the version of the DB schema against the library when the process engine is being created and throws an exception if the versions don't match.
`static String`	`DB_SCHEMA_UPDATE_TRUE` Upon building of the process engine, a check is performed and an update of the schema is performed if it is necessary.
`protected String`	`defaultCamelContext`
`protected String`	`history`
`protected int`	`idBlockSize`
`protected String`	`jdbcDriver`
`protected int`	`jdbcMaxActiveConnections`
`protected int`	`jdbcMaxCheckoutTime`
`protected int`	`jdbcMaxIdleConnections`
`protected int`	`jdbcMaxWaitTime`
`protected String`	`jdbcPassword`
`protected int`	`jdbcPingConnectionNotUsedFor`
`protected boolean`	`jdbcPingEnabled`
`protected String`	`jdbcPingQuery`
`protected String`	`jdbcUrl`
`protected String`	`jdbcUsername`
`protected boolean`	`jobExecutorActivate`
`protected boolean`	`jpaCloseEntityManager`
`protected Object`	`jpaEntityManagerFactory`
`protected boolean`	`jpaHandleTransaction`
`protected String`	`jpaPersistenceUnitName`
`protected String`	`mailServerDefaultFrom`
`protected String`	`mailServerHost`
`protected String`	`mailServerPassword`
`protected int`	`mailServerPort`
`protected String`	`mailServerUsername`
`protected ProcessEngineLifecycleListener`	`processEngineLifecycleListener`
`protected String`	`processEngineName`
`protected boolean`	`transactionsExternallyManaged`
`protected boolean`	`useSSL`
`protected boolean`	`useTLS`

Constructor Summary

Constructors
Modifier Constructor and Description

protected ProcessEngineConfiguration()
use one of the static createXxxx methods instead

Constructors
Modifier	Constructor and Description
`protected`	`ProcessEngineConfiguration()` use one of the static createXxxx methods instead

Method Summary

Methods
Modifier and Type	Method and Description
`abstract ProcessEngine`	`buildProcessEngine()`
`static ProcessEngineConfiguration`	`createProcessEngineConfigurationFromInputStream(InputStream inputStream)`
`static ProcessEngineConfiguration`	`createProcessEngineConfigurationFromInputStream(InputStream inputStream, String beanName)`
`static ProcessEngineConfiguration`	`createProcessEngineConfigurationFromResource(String resource)`
`static ProcessEngineConfiguration`	`createProcessEngineConfigurationFromResource(String resource, String beanName)`
`static ProcessEngineConfiguration`	`createProcessEngineConfigurationFromResourceDefault()`
`static ProcessEngineConfiguration`	`createStandaloneInMemProcessEngineConfiguration()`
`static ProcessEngineConfiguration`	`createStandaloneProcessEngineConfiguration()`
`String`	`getActivityFontName()`
`ClassLoader`	`getClassLoader()`
`String`	`getDatabaseSchemaUpdate()`
`String`	`getDatabaseType()`
`DataSource`	`getDataSource()`
`String`	`getDataSourceJndiName()`
`String`	`getDefaultCamelContext()`
`String`	`getHistory()`
`int`	`getIdBlockSize()`
`String`	`getJdbcDriver()`
`int`	`getJdbcMaxActiveConnections()`
`int`	`getJdbcMaxCheckoutTime()`
`int`	`getJdbcMaxIdleConnections()`
`int`	`getJdbcMaxWaitTime()`
`String`	`getJdbcPassword()`
`int`	`getJdbcPingConnectionNotUsedFor()`
`String`	`getJdbcPingQuery()`
`String`	`getJdbcUrl()`
`String`	`getJdbcUsername()`
`Object`	`getJpaEntityManagerFactory()`
`String`	`getJpaPersistenceUnitName()`
`String`	`getMailServerDefaultFrom()`
`String`	`getMailServerHost()`
`String`	`getMailServerPassword()`
`int`	`getMailServerPort()`
`String`	`getMailServerUsername()`
`boolean`	`getMailServerUseSSL()`
`boolean`	`getMailServerUseTLS()`
`ProcessEngineLifecycleListener`	`getProcessEngineLifecycleListener()`
`String`	`getProcessEngineName()`
`boolean`	`isJdbcPingEnabled()`
`boolean`	`isJobExecutorActivate()`
`boolean`	`isJpaCloseEntityManager()`
`boolean`	`isJpaHandleTransaction()`
`boolean`	`isTransactionsExternallyManaged()`
`void`	`setActivityFontName(String activityFontName)`
`ProcessEngineConfiguration`	`setClassLoader(ClassLoader classLoader)`
`ProcessEngineConfiguration`	`setDatabaseSchemaUpdate(String databaseSchemaUpdate)`
`ProcessEngineConfiguration`	`setDatabaseType(String databaseType)`
`ProcessEngineConfiguration`	`setDataSource(DataSource dataSource)`
`void`	`setDataSourceJndiName(String dataSourceJndiName)`
`ProcessEngineConfiguration`	`setDefaultCamelContext(String defaultCamelContext)`
`ProcessEngineConfiguration`	`setHistory(String history)`
`ProcessEngineConfiguration`	`setIdBlockSize(int idBlockSize)`
`ProcessEngineConfiguration`	`setJdbcDriver(String jdbcDriver)`
`ProcessEngineConfiguration`	`setJdbcMaxActiveConnections(int jdbcMaxActiveConnections)`
`ProcessEngineConfiguration`	`setJdbcMaxCheckoutTime(int jdbcMaxCheckoutTime)`
`ProcessEngineConfiguration`	`setJdbcMaxIdleConnections(int jdbcMaxIdleConnections)`
`ProcessEngineConfiguration`	`setJdbcMaxWaitTime(int jdbcMaxWaitTime)`
`ProcessEngineConfiguration`	`setJdbcPassword(String jdbcPassword)`
`ProcessEngineConfiguration`	`setJdbcPingConnectionNotUsedFor(int jdbcPingNotUsedFor)`
`ProcessEngineConfiguration`	`setJdbcPingEnabled(boolean jdbcPingEnabled)`
`ProcessEngineConfiguration`	`setJdbcPingQuery(String jdbcPingQuery)`
`ProcessEngineConfiguration`	`setJdbcUrl(String jdbcUrl)`
`ProcessEngineConfiguration`	`setJdbcUsername(String jdbcUsername)`
`ProcessEngineConfiguration`	`setJobExecutorActivate(boolean jobExecutorActivate)`
`ProcessEngineConfiguration`	`setJpaCloseEntityManager(boolean jpaCloseEntityManager)`
`ProcessEngineConfiguration`	`setJpaEntityManagerFactory(Object jpaEntityManagerFactory)`
`ProcessEngineConfiguration`	`setJpaHandleTransaction(boolean jpaHandleTransaction)`
`void`	`setJpaPersistenceUnitName(String jpaPersistenceUnitName)`
`ProcessEngineConfiguration`	`setMailServerDefaultFrom(String mailServerDefaultFrom)`
`ProcessEngineConfiguration`	`setMailServerHost(String mailServerHost)`
`ProcessEngineConfiguration`	`setMailServerPassword(String mailServerPassword)`
`ProcessEngineConfiguration`	`setMailServerPort(int mailServerPort)`
`ProcessEngineConfiguration`	`setMailServerUsername(String mailServerUsername)`
`ProcessEngineConfiguration`	`setMailServerUseSSL(boolean useSSL)`
`ProcessEngineConfiguration`	`setMailServerUseTLS(boolean useTLS)`
`void`	`setProcessEngineLifecycleListener(ProcessEngineLifecycleListener processEngineLifecycleListener)`
`ProcessEngineConfiguration`	`setProcessEngineName(String processEngineName)`
`ProcessEngineConfiguration`	`setTransactionsExternallyManaged(boolean transactionsExternallyManaged)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.activiti.engine.EngineServices
getFormService, getHistoryService, getIdentityService, getManagementService, getRepositoryService, getRuntimeService, getTaskService

Field Detail

DB_SCHEMA_UPDATE_FALSE
```
public static final String DB_SCHEMA_UPDATE_FALSE
```
Checks the version of the DB schema against the library when the process engine is being created and throws an exception if the versions don't match.

See Also:
Constant Field Values

DB_SCHEMA_UPDATE_CREATE_DROP
```
public static final String DB_SCHEMA_UPDATE_CREATE_DROP
```
Creates the schema when the process engine is being created and drops the schema when the process engine is being closed.

See Also:
Constant Field Values

DB_SCHEMA_UPDATE_TRUE
```
public static final String DB_SCHEMA_UPDATE_TRUE
```
Upon building of the process engine, a check is performed and an update of the schema is performed if it is necessary.

See Also:
Constant Field Values

processEngineName
```
protected String processEngineName
```

idBlockSize
```
protected int idBlockSize
```

history
```
protected String history
```

jobExecutorActivate
```
protected boolean jobExecutorActivate
```

mailServerHost
```
protected String mailServerHost
```

mailServerUsername
```
protected String mailServerUsername
```

mailServerPassword
```
protected String mailServerPassword
```

mailServerPort
```
protected int mailServerPort
```

useSSL
```
protected boolean useSSL
```

useTLS
```
protected boolean useTLS
```

mailServerDefaultFrom
```
protected String mailServerDefaultFrom
```

databaseType
```
protected String databaseType
```

databaseSchemaUpdate
```
protected String databaseSchemaUpdate
```

jdbcDriver
```
protected String jdbcDriver
```

jdbcUrl
```
protected String jdbcUrl
```

jdbcUsername
```
protected String jdbcUsername
```

jdbcPassword
```
protected String jdbcPassword
```

dataSourceJndiName
```
protected String dataSourceJndiName
```

jdbcMaxActiveConnections
```
protected int jdbcMaxActiveConnections
```

jdbcMaxIdleConnections
```
protected int jdbcMaxIdleConnections
```

jdbcMaxCheckoutTime
```
protected int jdbcMaxCheckoutTime
```

jdbcMaxWaitTime
```
protected int jdbcMaxWaitTime
```

jdbcPingEnabled
```
protected boolean jdbcPingEnabled
```

jdbcPingQuery
```
protected String jdbcPingQuery
```

jdbcPingConnectionNotUsedFor

protected int jdbcPingConnectionNotUsedFor

dataSource
```
protected DataSource dataSource
```

transactionsExternallyManaged

protected boolean transactionsExternallyManaged

jpaPersistenceUnitName

protected String jpaPersistenceUnitName

jpaEntityManagerFactory

protected Object jpaEntityManagerFactory

jpaHandleTransaction
```
protected boolean jpaHandleTransaction
```

jpaCloseEntityManager

protected boolean jpaCloseEntityManager

defaultCamelContext
```
protected String defaultCamelContext
```

activityFontName
```
protected String activityFontName
```

classLoader
```
protected ClassLoader classLoader
```

processEngineLifecycleListener

protected ProcessEngineLifecycleListener processEngineLifecycleListener

Constructor Detail
- ProcessEngineConfiguration
```
protected ProcessEngineConfiguration()
```
  use one of the static createXxxx methods instead

Method Detail

buildProcessEngine

public abstract ProcessEngine buildProcessEngine()

createProcessEngineConfigurationFromResourceDefault

public static ProcessEngineConfiguration createProcessEngineConfigurationFromResourceDefault()

createProcessEngineConfigurationFromResource

public static ProcessEngineConfiguration createProcessEngineConfigurationFromResource(String resource)

createProcessEngineConfigurationFromResource

public static ProcessEngineConfiguration createProcessEngineConfigurationFromResource(String resource,
                                                                      String beanName)

createProcessEngineConfigurationFromInputStream

public static ProcessEngineConfiguration createProcessEngineConfigurationFromInputStream(InputStream inputStream)

createProcessEngineConfigurationFromInputStream

public static ProcessEngineConfiguration createProcessEngineConfigurationFromInputStream(InputStream inputStream,
                                                                         String beanName)

createStandaloneProcessEngineConfiguration

public static ProcessEngineConfiguration createStandaloneProcessEngineConfiguration()

createStandaloneInMemProcessEngineConfiguration

public static ProcessEngineConfiguration createStandaloneInMemProcessEngineConfiguration()

getProcessEngineName
```
public String getProcessEngineName()
```

setProcessEngineName

public ProcessEngineConfiguration setProcessEngineName(String processEngineName)

getIdBlockSize
```
public int getIdBlockSize()
```

setIdBlockSize

public ProcessEngineConfiguration setIdBlockSize(int idBlockSize)

getHistory
```
public String getHistory()
```

setHistory

public ProcessEngineConfiguration setHistory(String history)

getMailServerHost
```
public String getMailServerHost()
```

setMailServerHost

public ProcessEngineConfiguration setMailServerHost(String mailServerHost)

getMailServerUsername
```
public String getMailServerUsername()
```

setMailServerUsername

public ProcessEngineConfiguration setMailServerUsername(String mailServerUsername)

getMailServerPassword
```
public String getMailServerPassword()
```

setMailServerPassword

public ProcessEngineConfiguration setMailServerPassword(String mailServerPassword)

getMailServerPort
```
public int getMailServerPort()
```

setMailServerPort

public ProcessEngineConfiguration setMailServerPort(int mailServerPort)

getMailServerUseSSL
```
public boolean getMailServerUseSSL()
```

setMailServerUseSSL

public ProcessEngineConfiguration setMailServerUseSSL(boolean useSSL)

getMailServerUseTLS
```
public boolean getMailServerUseTLS()
```

setMailServerUseTLS

public ProcessEngineConfiguration setMailServerUseTLS(boolean useTLS)

getMailServerDefaultFrom

public String getMailServerDefaultFrom()

setMailServerDefaultFrom

public ProcessEngineConfiguration setMailServerDefaultFrom(String mailServerDefaultFrom)

getDatabaseType
```
public String getDatabaseType()
```

setDatabaseType

public ProcessEngineConfiguration setDatabaseType(String databaseType)

getDatabaseSchemaUpdate

public String getDatabaseSchemaUpdate()

setDatabaseSchemaUpdate

public ProcessEngineConfiguration setDatabaseSchemaUpdate(String databaseSchemaUpdate)

getDataSource
```
public DataSource getDataSource()
```

setDataSource

public ProcessEngineConfiguration setDataSource(DataSource dataSource)

getJdbcDriver
```
public String getJdbcDriver()
```

setJdbcDriver

public ProcessEngineConfiguration setJdbcDriver(String jdbcDriver)

getJdbcUrl
```
public String getJdbcUrl()
```

setJdbcUrl

public ProcessEngineConfiguration setJdbcUrl(String jdbcUrl)

getJdbcUsername
```
public String getJdbcUsername()
```

setJdbcUsername

public ProcessEngineConfiguration setJdbcUsername(String jdbcUsername)

getJdbcPassword
```
public String getJdbcPassword()
```

setJdbcPassword

public ProcessEngineConfiguration setJdbcPassword(String jdbcPassword)

isTransactionsExternallyManaged

public boolean isTransactionsExternallyManaged()

setTransactionsExternallyManaged

public ProcessEngineConfiguration setTransactionsExternallyManaged(boolean transactionsExternallyManaged)

getJdbcMaxActiveConnections

public int getJdbcMaxActiveConnections()

setJdbcMaxActiveConnections

public ProcessEngineConfiguration setJdbcMaxActiveConnections(int jdbcMaxActiveConnections)

getJdbcMaxIdleConnections

public int getJdbcMaxIdleConnections()

setJdbcMaxIdleConnections

public ProcessEngineConfiguration setJdbcMaxIdleConnections(int jdbcMaxIdleConnections)

getJdbcMaxCheckoutTime
```
public int getJdbcMaxCheckoutTime()
```

setJdbcMaxCheckoutTime

public ProcessEngineConfiguration setJdbcMaxCheckoutTime(int jdbcMaxCheckoutTime)

getJdbcMaxWaitTime
```
public int getJdbcMaxWaitTime()
```

setJdbcMaxWaitTime

public ProcessEngineConfiguration setJdbcMaxWaitTime(int jdbcMaxWaitTime)

isJdbcPingEnabled
```
public boolean isJdbcPingEnabled()
```

setJdbcPingEnabled

public ProcessEngineConfiguration setJdbcPingEnabled(boolean jdbcPingEnabled)

getJdbcPingQuery
```
public String getJdbcPingQuery()
```

setJdbcPingQuery

public ProcessEngineConfiguration setJdbcPingQuery(String jdbcPingQuery)

getJdbcPingConnectionNotUsedFor

public int getJdbcPingConnectionNotUsedFor()

setJdbcPingConnectionNotUsedFor

public ProcessEngineConfiguration setJdbcPingConnectionNotUsedFor(int jdbcPingNotUsedFor)

isJobExecutorActivate

public boolean isJobExecutorActivate()

setJobExecutorActivate

public ProcessEngineConfiguration setJobExecutorActivate(boolean jobExecutorActivate)

getClassLoader
```
public ClassLoader getClassLoader()
```

setClassLoader

public ProcessEngineConfiguration setClassLoader(ClassLoader classLoader)

getJpaEntityManagerFactory

public Object getJpaEntityManagerFactory()

setJpaEntityManagerFactory

public ProcessEngineConfiguration setJpaEntityManagerFactory(Object jpaEntityManagerFactory)

isJpaHandleTransaction

public boolean isJpaHandleTransaction()

setJpaHandleTransaction

public ProcessEngineConfiguration setJpaHandleTransaction(boolean jpaHandleTransaction)

isJpaCloseEntityManager

public boolean isJpaCloseEntityManager()

setJpaCloseEntityManager

public ProcessEngineConfiguration setJpaCloseEntityManager(boolean jpaCloseEntityManager)

getJpaPersistenceUnitName

public String getJpaPersistenceUnitName()

setJpaPersistenceUnitName

public void setJpaPersistenceUnitName(String jpaPersistenceUnitName)

getDataSourceJndiName
```
public String getDataSourceJndiName()
```

setDataSourceJndiName

public void setDataSourceJndiName(String dataSourceJndiName)

getDefaultCamelContext

public String getDefaultCamelContext()

setDefaultCamelContext

public ProcessEngineConfiguration setDefaultCamelContext(String defaultCamelContext)

getActivityFontName
```
public String getActivityFontName()
```

setActivityFontName

public void setActivityFontName(String activityFontName)

setProcessEngineLifecycleListener

public void setProcessEngineLifecycleListener(ProcessEngineLifecycleListener processEngineLifecycleListener)

getProcessEngineLifecycleListener

public ProcessEngineLifecycleListener getProcessEngineLifecycleListener()

Class ProcessEngineConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.activiti.engine.EngineServices

Field Detail

DB_SCHEMA_UPDATE_FALSE

DB_SCHEMA_UPDATE_CREATE_DROP

DB_SCHEMA_UPDATE_TRUE

processEngineName

idBlockSize

history

jobExecutorActivate

mailServerHost

mailServerUsername

mailServerPassword

mailServerPort

useSSL

useTLS

mailServerDefaultFrom

databaseType

databaseSchemaUpdate

jdbcDriver

jdbcUrl

jdbcUsername

jdbcPassword

dataSourceJndiName

jdbcMaxActiveConnections

jdbcMaxIdleConnections

jdbcMaxCheckoutTime

jdbcMaxWaitTime

jdbcPingEnabled

jdbcPingQuery

jdbcPingConnectionNotUsedFor

dataSource

transactionsExternallyManaged

jpaPersistenceUnitName

jpaEntityManagerFactory

jpaHandleTransaction

jpaCloseEntityManager

defaultCamelContext

activityFontName

classLoader

processEngineLifecycleListener

Constructor Detail

ProcessEngineConfiguration

Method Detail

buildProcessEngine

createProcessEngineConfigurationFromResourceDefault

createProcessEngineConfigurationFromResource

createProcessEngineConfigurationFromResource

createProcessEngineConfigurationFromInputStream

createProcessEngineConfigurationFromInputStream

createStandaloneProcessEngineConfiguration

createStandaloneInMemProcessEngineConfiguration

getProcessEngineName

setProcessEngineName

getIdBlockSize

setIdBlockSize

getHistory

setHistory

getMailServerHost

setMailServerHost

getMailServerUsername

setMailServerUsername

getMailServerPassword

setMailServerPassword

getMailServerPort

setMailServerPort

getMailServerUseSSL

setMailServerUseSSL

getMailServerUseTLS

setMailServerUseTLS

getMailServerDefaultFrom

setMailServerDefaultFrom

getDatabaseType

setDatabaseType

getDatabaseSchemaUpdate

setDatabaseSchemaUpdate