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 DataSource	dataSource
protected DbSchemaCreator	dbScriptRunner
protected String	propertiesFileName
protected String	propertiesSeparator
protected boolean	securityEnabled
protected boolean	useManagedTransactions

Constructor Summary

Constructors

Constructor and Description
TaskanaEngineConfiguration(boolean enableSecurity)
TaskanaEngineConfiguration(DataSource dataSource, boolean useManagedTransactions)
TaskanaEngineConfiguration(DataSource dataSource, boolean useManagedTransactions, boolean securityEnabled)
TaskanaEngineConfiguration(DataSource dataSource, boolean useManagedTransactions, boolean securityEnabled, String propertiesFileName, String propertiesSeparator)

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<java.time.LocalDate>	getCustomHolidays()
DataSource	getDatasource()
String	getPropertiesFileName()
String	getPropertiesSeparator()
boolean	getUseManagedTransactions()
boolean	isGermanPublicHolidaysEnabled()
boolean	isSecurityEnabled()
void	setCustomHolidays(List<java.time.LocalDate> customHolidays)
void	setGermanPublicHolidaysEnabled(boolean germanPublicHolidaysEnabled)
void	setPropertiesFileName(String propertiesFileName)
void	setPropertiesSeparator(String propertiesSeparator)
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

dataSource

protected DataSource dataSource

dbScriptRunner

protected DbSchemaCreator dbScriptRunner

propertiesFileName

protected String propertiesFileName

propertiesSeparator

protected String propertiesSeparator

securityEnabled

protected boolean securityEnabled

useManagedTransactions

protected boolean useManagedTransactions

Constructor Detail

TaskanaEngineConfiguration

public TaskanaEngineConfiguration(boolean enableSecurity)

TaskanaEngineConfiguration

public TaskanaEngineConfiguration(DataSource dataSource,
                                  boolean useManagedTransactions)
                           throws SQLException

Throws:

SQLException

TaskanaEngineConfiguration

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

Throws:

SQLException

TaskanaEngineConfiguration

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

Throws:

SQLException

Method Detail

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

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)

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