pro.taskana.configuration

Class TaskanaEngineConfiguration

java.lang.Object

pro.taskana.configuration.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 Map<TaskanaRole,Set<String>>	roleMap
protected String	rolesSeparator
protected String	schemaName
protected boolean	securityEnabled
protected static String	TASKANA_SCHEMA_VERSION
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 rolesSeparator, String schemaName)
TaskanaEngineConfiguration(DataSource dataSource, boolean useManagedTransactions, String schemaName)

Method Summary

Modifier and Type	Method and Description
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)
List<String>	getClassificationTypes()
java.time.Instant	getCleanupJobFirstRun()
java.time.Duration	getCleanupJobMinimumAge()
java.time.Duration	getCleanupJobRunEvery()
List<java.time.LocalDate>	getCustomHolidays()
DataSource	getDatasource()
List<String>	getDomains()
int	getMaxNumberOfJobRetries()
int	getMaxNumberOfUpdatesPerTransaction()
String	getPropertiesFileName()
String	getPropertiesSeparator()
Map<TaskanaRole,Set<String>>	getRoleMap()
String	getSchemaName()
boolean	getUseManagedTransactions()
void	initTaskanaProperties(String propertiesFile, String rolesSeparator)
boolean	isGermanPublicHolidaysEnabled()
boolean	isSecurityEnabled()
boolean	isTaskCleanupJobAllCompletedSameParentBusiness()
void	setClassificationCategoriesByType(Map<String,List<String>> classificationCategoriesByType)
void	setClassificationTypes(List<String> classificationTypes)
void	setCustomHolidays(List<java.time.LocalDate> customHolidays)
void	setDomains(List<String> domains)
void	setGermanPublicHolidaysEnabled(boolean germanPublicHolidaysEnabled)
void	setPropertiesFileName(String propertiesFileName)
void	setPropertiesSeparator(String propertiesSeparator)
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

TASKANA_SCHEMA_VERSION

protected static final String TASKANA_SCHEMA_VERSION

See Also:

Constant Field Values

propertiesFileName

protected String propertiesFileName

dataSource

protected DataSource dataSource

dbSchemaCreator

protected DbSchemaCreator dbSchemaCreator

schemaName

protected String schemaName

rolesSeparator

protected String rolesSeparator

roleMap

protected Map<TaskanaRole,Set<String>> roleMap

securityEnabled

protected boolean securityEnabled

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 rolesSeparator,
                                  String schemaName)
                           throws SQLException

Throws:

SQLException

Method Detail

initTaskanaProperties

public void initTaskanaProperties(String propertiesFile,
                                  String rolesSeparator)

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()

getPropertiesFileName

public String getPropertiesFileName()

getMaxNumberOfUpdatesPerTransaction

public int getMaxNumberOfUpdatesPerTransaction()

getMaxNumberOfJobRetries

public int getMaxNumberOfJobRetries()

setPropertiesFileName

public void setPropertiesFileName(String propertiesFileName)

getPropertiesSeparator

public String getPropertiesSeparator()

setPropertiesSeparator

public void setPropertiesSeparator(String propertiesSeparator)

isGermanPublicHolidaysEnabled

public boolean isGermanPublicHolidaysEnabled()

setGermanPublicHolidaysEnabled

public void setGermanPublicHolidaysEnabled(boolean germanPublicHolidaysEnabled)

getCustomHolidays

public List<java.time.LocalDate> getCustomHolidays()

setCustomHolidays

public void setCustomHolidays(List<java.time.LocalDate> 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()

getClassificationCategoriesByType

public List<String> getClassificationCategoriesByType(String type)

setClassificationCategoriesByType

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

getCleanupJobFirstRun

public java.time.Instant getCleanupJobFirstRun()

getCleanupJobRunEvery

public java.time.Duration getCleanupJobRunEvery()

getCleanupJobMinimumAge

public java.time.Duration getCleanupJobMinimumAge()

setTaskCleanupJobAllCompletedSameParentBusiness

public void setTaskCleanupJobAllCompletedSameParentBusiness(boolean taskCleanupJobAllCompletedSameParentBusiness)

isTaskCleanupJobAllCompletedSameParentBusiness

public boolean isTaskCleanupJobAllCompletedSameParentBusiness()

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