pro.taskana

Class TaskanaEngineConfiguration

java.lang.Object

pro.taskana.TaskanaEngineConfiguration

public class TaskanaEngineConfiguration
extends Object

This central class creates the TaskanaEngine and holds all the information about DB and Security.
Security is enabled by default.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,List<String>>	classificationCategoriesByTypeMap
protected List<String>	classificationTypes
protected DataSource	dataSource
protected DbSchemaCreator	dbSchemaCreator
protected List<String>	domains
protected String	propertiesFileName
protected String	propertiesSeparator
protected Map<TaskanaRole,Set<String>>	roleMap
protected String	schemaName
protected boolean	securityEnabled
protected SecurityVerifier	securityVerifier
protected boolean	useManagedTransactions

Constructor Summary

Constructors

Constructor and Description
TaskanaEngineConfiguration(DataSource dataSource, boolean useManagedTransactions, boolean securityEnabled, String schemaName)
TaskanaEngineConfiguration(DataSource dataSource, boolean useManagedTransactions, boolean securityEnabled, String propertiesFileName, String propertySeparator, String schemaName)
TaskanaEngineConfiguration(DataSource dataSource, boolean useManagedTransactions, String schemaName)

Method Summary

Modifier and Type	Method and Description
void	addCustomHolidays(List<CustomHoliday> customHolidays)
TaskanaEngine	buildTaskanaEngine() This method creates the TaskanaEngine without an sqlSessionFactory.
static DataSource	createDatasource(String driver, String jdbcUrl, String username, String password) This method creates a PooledDataSource, if the needed properties are provided.
static DataSource	createDefaultDataSource()
List<String>	getAllClassificationCategories()
List<String>	getClassificationCategoriesByType(String type)
Map<String,List<String>>	getClassificationCategoriesByTypeMap()
List<String>	getClassificationTypes()
Instant	getCleanupJobFirstRun()
Duration	getCleanupJobMinimumAge()
Duration	getCleanupJobRunEvery()
List<CustomHoliday>	getCustomHolidays()
DataSource	getDatasource()
List<String>	getDomains()
int	getMaxNumberOfJobRetries()
int	getMaxNumberOfUpdatesPerTransaction()
Map<TaskanaRole,Set<String>>	getRoleMap()
String	getSchemaName()
boolean	getUseManagedTransactions()
void	initTaskanaProperties(String propertiesFile, String separator)
boolean	isCorpusChristiEnabled()
boolean	isDeleteHistoryOnTaskDeletionEnabled()
boolean	isGermanPublicHolidaysEnabled()
boolean	isSecurityEnabled()
boolean	isTaskCleanupJobAllCompletedSameParentBusiness()
void	setClassificationCategoriesByType(Map<String,List<String>> classificationCategoriesByType)
void	setClassificationTypes(List<String> classificationTypes)
void	setCleanupJobFirstRun(Instant cleanupJobFirstRun)
void	setCleanupJobMinimumAge(Duration cleanupJobMinimumAge)
void	setCleanupJobRunEvery(Duration cleanupJobRunEvery)
void	setCorpusChristiEnabled(boolean corpusChristiEnabled)
void	setDeleteHistoryOnTaskDeletionEnabled(boolean deleteHistoryOnTaskDeletionEnabled)
void	setDomains(List<String> domains)
void	setGermanPublicHolidaysEnabled(boolean germanPublicHolidaysEnabled)
void	setMaxNumberOfJobRetries(int maxNumberOfJobRetries)
void	setMaxNumberOfUpdatesPerTransaction(int jobBatchSize)
void	setRoleMap(Map<TaskanaRole,Set<String>> roleMap)
void	setSchemaName(String schemaName)
void	setTaskCleanupJobAllCompletedSameParentBusiness(boolean taskCleanupJobAllCompletedSameParentBusiness)
static boolean	shouldUseLowerCaseForAccessIds() Helper method to determine whether all access ids (user Id and group ids) should be used in lower case.

Methods inherited from class java.lang.Object

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

Field Detail

propertiesFileName

protected String propertiesFileName

dataSource

protected DataSource dataSource

dbSchemaCreator

protected DbSchemaCreator dbSchemaCreator

schemaName

protected String schemaName

propertiesSeparator

protected String propertiesSeparator

roleMap

protected Map<TaskanaRole,Set<String>> roleMap

securityEnabled

protected boolean securityEnabled

securityVerifier

protected SecurityVerifier securityVerifier

useManagedTransactions

protected boolean useManagedTransactions

domains

protected List<String> domains

classificationTypes

protected List<String> classificationTypes

classificationCategoriesByTypeMap

protected Map<String,List<String>> classificationCategoriesByTypeMap

Constructor Detail

TaskanaEngineConfiguration

public TaskanaEngineConfiguration(DataSource dataSource,
                                  boolean useManagedTransactions,
                                  String schemaName)
                           throws SQLException

Throws:

SQLException

TaskanaEngineConfiguration

public TaskanaEngineConfiguration(DataSource dataSource,
                                  boolean useManagedTransactions,
                                  boolean securityEnabled,
                                  String schemaName)
                           throws SQLException

Throws:

SQLException

TaskanaEngineConfiguration

public TaskanaEngineConfiguration(DataSource dataSource,
                                  boolean useManagedTransactions,
                                  boolean securityEnabled,
                                  String propertiesFileName,
                                  String propertySeparator,
                                  String schemaName)
                           throws SQLException

Throws:

SQLException

Method Detail

initTaskanaProperties

public void initTaskanaProperties(String propertiesFile,
                                  String separator)

createDefaultDataSource

public static DataSource createDefaultDataSource()

buildTaskanaEngine

public TaskanaEngine buildTaskanaEngine()

This method creates the TaskanaEngine without an sqlSessionFactory.

Returns:

the TaskanaEngine

createDatasource

public static DataSource createDatasource(String driver,
                                          String jdbcUrl,
                                          String username,
                                          String password)

This method creates a PooledDataSource, if the needed properties are provided.

Parameters:

driver - the name of the jdbc driver

jdbcUrl - the url to which the jdbc driver connects

username - the user name for database access

password - the password for database access

Returns:

DataSource

isSecurityEnabled

public boolean isSecurityEnabled()

getDatasource

public DataSource getDatasource()

getUseManagedTransactions

public boolean getUseManagedTransactions()

getMaxNumberOfUpdatesPerTransaction

public int getMaxNumberOfUpdatesPerTransaction()

setMaxNumberOfUpdatesPerTransaction

public void setMaxNumberOfUpdatesPerTransaction(int jobBatchSize)

getMaxNumberOfJobRetries

public int getMaxNumberOfJobRetries()

setMaxNumberOfJobRetries

public void setMaxNumberOfJobRetries(int maxNumberOfJobRetries)

isCorpusChristiEnabled

public boolean isCorpusChristiEnabled()

setCorpusChristiEnabled

public void setCorpusChristiEnabled(boolean corpusChristiEnabled)

isGermanPublicHolidaysEnabled

public boolean isGermanPublicHolidaysEnabled()

setGermanPublicHolidaysEnabled

public void setGermanPublicHolidaysEnabled(boolean germanPublicHolidaysEnabled)

isDeleteHistoryOnTaskDeletionEnabled

public boolean isDeleteHistoryOnTaskDeletionEnabled()

setDeleteHistoryOnTaskDeletionEnabled

public void setDeleteHistoryOnTaskDeletionEnabled(boolean deleteHistoryOnTaskDeletionEnabled)

getCustomHolidays

public List<CustomHoliday> getCustomHolidays()

addCustomHolidays

public void addCustomHolidays(List<CustomHoliday> customHolidays)

getRoleMap

public Map<TaskanaRole,Set<String>> getRoleMap()

setRoleMap

public void setRoleMap(Map<TaskanaRole,Set<String>> roleMap)

getDomains

public List<String> getDomains()

setDomains

public void setDomains(List<String> domains)

getClassificationTypes

public List<String> getClassificationTypes()

setClassificationTypes

public void setClassificationTypes(List<String> classificationTypes)

getAllClassificationCategories

public List<String> getAllClassificationCategories()

getClassificationCategoriesByTypeMap

public Map<String,List<String>> getClassificationCategoriesByTypeMap()

getClassificationCategoriesByType

public List<String> getClassificationCategoriesByType(String type)

setClassificationCategoriesByType

public void setClassificationCategoriesByType(Map<String,List<String>> classificationCategoriesByType)

getCleanupJobFirstRun

public Instant getCleanupJobFirstRun()

setCleanupJobFirstRun

public void setCleanupJobFirstRun(Instant cleanupJobFirstRun)

getCleanupJobRunEvery

public Duration getCleanupJobRunEvery()

setCleanupJobRunEvery

public void setCleanupJobRunEvery(Duration cleanupJobRunEvery)

getCleanupJobMinimumAge

public Duration getCleanupJobMinimumAge()

setCleanupJobMinimumAge

public void setCleanupJobMinimumAge(Duration cleanupJobMinimumAge)

isTaskCleanupJobAllCompletedSameParentBusiness

public boolean isTaskCleanupJobAllCompletedSameParentBusiness()

setTaskCleanupJobAllCompletedSameParentBusiness

public void setTaskCleanupJobAllCompletedSameParentBusiness(boolean taskCleanupJobAllCompletedSameParentBusiness)

getSchemaName

public String getSchemaName()

setSchemaName

public void setSchemaName(String schemaName)

shouldUseLowerCaseForAccessIds

public static boolean shouldUseLowerCaseForAccessIds()

Helper method to determine whether all access ids (user Id and group ids) should be used in lower case.

Returns:

true if all access ids should be used in lower case, false otherwise