Package pro.taskana.common.internal

Class TaskanaEngineImpl

java.lang.Object

pro.taskana.common.internal.TaskanaEngineImpl

All Implemented Interfaces:

TaskanaEngine

public class TaskanaEngineImpl
extends Object
implements TaskanaEngine

This is the implementation of TaskanaEngine.

Nested Class Summary

Nested classes/interfaces inherited from interface pro.taskana.common.api.TaskanaEngine

TaskanaEngine.ConnectionManagementMode

Field Summary

Fields

Modifier and Type	Field	Description
protected Connection	connection
protected TaskanaEngine.ConnectionManagementMode	mode
protected org.apache.ibatis.session.SqlSessionManager	sessionManager
protected final TaskanaConfiguration	taskanaConfiguration
protected org.apache.ibatis.transaction.TransactionFactory	transactionFactory

Fields inherited from interface pro.taskana.common.api.TaskanaEngine

MINIMAL_TASKANA_SCHEMA_VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TaskanaEngineImpl(TaskanaConfiguration taskanaConfiguration, TaskanaEngine.ConnectionManagementMode connectionManagementMode, org.apache.ibatis.transaction.TransactionFactory transactionFactory)

Method Summary

Modifier and Type	Method	Description
void	checkRoleMembership(TaskanaRole... roles)	Checks whether current user is member of any of the specified TaskanaRoles.
void	clearSqlSessionCache()	Clears the cache of the underlying local SQL session.
void	closeConnection()	Closes the client's connection, sets it to null and switches to mode PARTICIPATE.
protected org.apache.ibatis.session.SqlSessionManager	createSqlSessionManager()	This method creates the sqlSessionManager of myBatis.
static TaskanaEngine	createTaskanaEngine(TaskanaConfiguration taskanaConfiguration, TaskanaEngine.ConnectionManagementMode connectionManagementMode, org.apache.ibatis.transaction.TransactionFactory transactionFactory)
ClassificationService	getClassificationService()	Returns a ClassificationService initialized with the current TaskanaEngine.
TaskanaConfiguration	getConfiguration()	Returns the configuration of the TaskanaEngine.
ConfigurationService	getConfigurationService()	Returns a ConfigurationService initialized with the current TaskanaEngine.
Connection	getConnection()
TaskanaEngine.ConnectionManagementMode	getConnectionManagementMode()	Returns the ConnectionManagementMode of the TaskanaEngine.
pro.taskana.common.api.security.CurrentUserContext	getCurrentUserContext()	Returns the CurrentUserContext of the TaskanaEngine.
JobScheduler	getJobScheduler()
JobService	getJobService()	Returns a JobService initialized with the current TaskanaEngine.
MonitorService	getMonitorService()	Returns a MonitorService initialized with the current TaskanaEngine.
PriorityServiceManager	getPriorityServiceManager()
TaskService	getTaskService()	Returns a TaskService initialized with the current TaskanaEngine.
UserService	getUserService()	Returns a UserService initialized with the current TaskanaEngine.
WorkbasketService	getWorkbasketService()	Returns a WorkbasketService initialized with the current TaskanaEngine.
WorkingTimeCalculator	getWorkingTimeCalculator()	Returns the WorkingTimeCalculator of the TaskanaEngine.
boolean	isHistoryEnabled()	Checks if the TaskanaHistory plugin is enabled.
boolean	isUserInRole(TaskanaRole... roles)	Check whether the current user is member of one of the TaskanaRoles specified.
<T> T	runAsAdmin(Supplier<T> supplier)	Executes a given Supplier with admin privileges and thus skips further permission checks.
void	setConnection(Connection connection)	Set the Connection to be used by TASKANA in mode EXPLICIT.
void	setConnectionManagementMode(TaskanaEngine.ConnectionManagementMode mode)	Sets ConnectionManagementMode of the TaskanaEngine.

Methods inherited from class java.lang.Object

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

Methods inherited from interface pro.taskana.common.api.TaskanaEngine

runAsAdmin

Field Details

taskanaConfiguration

protected final TaskanaConfiguration taskanaConfiguration

mode

protected TaskanaEngine.ConnectionManagementMode mode

transactionFactory

protected org.apache.ibatis.transaction.TransactionFactory transactionFactory

sessionManager

protected org.apache.ibatis.session.SqlSessionManager sessionManager

connection

protected Connection connection

Constructor Details

TaskanaEngineImpl

protected TaskanaEngineImpl(TaskanaConfiguration taskanaConfiguration,
 TaskanaEngine.ConnectionManagementMode connectionManagementMode,
 org.apache.ibatis.transaction.TransactionFactory transactionFactory)
                     throws SQLException

Throws:

SQLException

Method Details

createTaskanaEngine

public static TaskanaEngine createTaskanaEngine(TaskanaConfiguration taskanaConfiguration,
 TaskanaEngine.ConnectionManagementMode connectionManagementMode,
 org.apache.ibatis.transaction.TransactionFactory transactionFactory)
                                         throws SQLException

Throws:

SQLException

getConfigurationService

public ConfigurationService getConfigurationService()

Description copied from interface: TaskanaEngine

Returns a ConfigurationService initialized with the current TaskanaEngine. The ConfigurationService can be used to manage custom configuration options.

Specified by:

getConfigurationService in interface TaskanaEngine

Returns:

an instance of ConfigurationService

getTaskService

public TaskService getTaskService()

Description copied from interface: TaskanaEngine

Returns a TaskService initialized with the current TaskanaEngine. TaskService can be used for operations on all Tasks.

Specified by:

getTaskService in interface TaskanaEngine

Returns:

an instance of TaskService

getMonitorService

public MonitorService getMonitorService()

Description copied from interface: TaskanaEngine

Returns a MonitorService initialized with the current TaskanaEngine. MonitorService can be used for monitoring Tasks.

Specified by:

getMonitorService in interface TaskanaEngine

Returns:

an instance of MonitorService

getWorkbasketService

public WorkbasketService getWorkbasketService()

Description copied from interface: TaskanaEngine

Returns a WorkbasketService initialized with the current TaskanaEngine. The WorkbasketService can be used for operations on all Workbaskets.

Specified by:

getWorkbasketService in interface TaskanaEngine

Returns:

an instance of WorkbasketService

getClassificationService

public ClassificationService getClassificationService()

Description copied from interface: TaskanaEngine

Returns a ClassificationService initialized with the current TaskanaEngine. The ClassificationService can be used for operations on all Classifications.

Specified by:

getClassificationService in interface TaskanaEngine

Returns:

an instance of ClassificationService

getConnection

public Connection getConnection()

setConnection

public void setConnection(Connection connection)
                   throws SQLException

Description copied from interface: TaskanaEngine

Set the Connection to be used by TASKANA in mode EXPLICIT. If this API is called, TASKANA uses the Connection passed by the client for all subsequent API calls until the client resets this Connection. Control over commit and rollback of the Connection is the responsibility of the client. In order to close the Connection, closeConnection() or setConnection(null) has to be called.

Specified by:

setConnection in interface TaskanaEngine

Parameters:

connection - - The java.sql.Connection that is controlled by the client

Throws:

SQLException - if a database access error occurs

getPriorityServiceManager

public PriorityServiceManager getPriorityServiceManager()

getJobService

public JobService getJobService()

Description copied from interface: TaskanaEngine

Returns a JobService initialized with the current TaskanaEngine. The JobService can be used for all operations on TaskanaJobs.

Specified by:

getJobService in interface TaskanaEngine

Returns:

an instance of JobService

getUserService

public UserService getUserService()

Description copied from interface: TaskanaEngine

Returns a UserService initialized with the current TaskanaEngine. The UserService can be used for all operations on Users.

Specified by:

getUserService in interface TaskanaEngine

Returns:

an instance of UserService

getJobScheduler

public JobScheduler getJobScheduler()

getConfiguration

public TaskanaConfiguration getConfiguration()

Description copied from interface: TaskanaEngine

Returns the configuration of the TaskanaEngine.

Specified by:

getConfiguration in interface TaskanaEngine

Returns:

configuration

getWorkingTimeCalculator

public WorkingTimeCalculator getWorkingTimeCalculator()

Description copied from interface: TaskanaEngine

Returns the WorkingTimeCalculator of the TaskanaEngine. The WorkingTimeCalculator is used to add or subtract working time from Instants according to a working time schedule or to calculate the working time between Instants.

Specified by:

getWorkingTimeCalculator in interface TaskanaEngine

Returns:

WorkingTimeCalculatorImpl

isHistoryEnabled

public boolean isHistoryEnabled()

Description copied from interface: TaskanaEngine

Checks if the TaskanaHistory plugin is enabled.

Specified by:

isHistoryEnabled in interface TaskanaEngine

Returns:

true if the history is enabled; otherwise false

getConnectionManagementMode

public TaskanaEngine.ConnectionManagementMode getConnectionManagementMode()

Description copied from interface: TaskanaEngine

Returns the ConnectionManagementMode of the TaskanaEngine.

Specified by:

getConnectionManagementMode in interface TaskanaEngine

Returns:

ConnectionManagementMode

setConnectionManagementMode

public void setConnectionManagementMode(TaskanaEngine.ConnectionManagementMode mode)

Description copied from interface: TaskanaEngine

Sets ConnectionManagementMode of the TaskanaEngine.

Specified by:

setConnectionManagementMode in interface TaskanaEngine

Parameters:

mode - the valid values for the TaskanaEngine.ConnectionManagementMode are:

• PARTICIPATE - taskana participates in global transaction; this is the default mode
• AUTOCOMMIT - taskana commits each API call separately
• EXPLICIT - commit processing is managed explicitly by the client

closeConnection

public void closeConnection()

Description copied from interface: TaskanaEngine

Closes the client's connection, sets it to null and switches to mode PARTICIPATE. Only applicable in mode EXPLICIT. Has the same effect as setConnection(null).

Specified by:

closeConnection in interface TaskanaEngine

isUserInRole

public boolean isUserInRole(TaskanaRole... roles)

Description copied from interface: TaskanaEngine

Check whether the current user is member of one of the TaskanaRoles specified.

Specified by:

isUserInRole in interface TaskanaEngine

Parameters:

roles - The TaskanaRoles that are checked for membership of the current user

Returns:

true if the current user is a member of at least one of the specified TaskanaRole

checkRoleMembership

public void checkRoleMembership(TaskanaRole... roles)
                         throws NotAuthorizedException

Description copied from interface: TaskanaEngine

Checks whether current user is member of any of the specified TaskanaRoles.

Specified by:

checkRoleMembership in interface TaskanaEngine

Parameters:

roles - The TaskanaRoles that are checked for membership of the current user

Throws:

NotAuthorizedException - If the current user is not member of any specified TaskanaRole

runAsAdmin

public <T> T runAsAdmin(Supplier<T> supplier)

Description copied from interface: TaskanaEngine

Executes a given Supplier with admin privileges and thus skips further permission checks. With great power comes great responsibility.

Specified by:

runAsAdmin in interface TaskanaEngine

Type Parameters:

T - defined with the return value of the Supplier

Parameters:

supplier - will be executed with admin privileges

Returns:

output from Supplier

getCurrentUserContext

public pro.taskana.common.api.security.CurrentUserContext getCurrentUserContext()

Description copied from interface: TaskanaEngine

Returns the CurrentUserContext of the TaskanaEngine.

Specified by:

getCurrentUserContext in interface TaskanaEngine

Returns:

CurrentUserContext

clearSqlSessionCache

public void clearSqlSessionCache()

Description copied from interface: TaskanaEngine

Clears the cache of the underlying local SQL session.

Specified by:

clearSqlSessionCache in interface TaskanaEngine

createSqlSessionManager

protected org.apache.ibatis.session.SqlSessionManager createSqlSessionManager()

This method creates the sqlSessionManager of myBatis. It integrates all the SQL mappers and sets the databaseId attribute.

Returns:

a SqlSessionFactory

Throws:

SystemException - when a connection to the database could not be opened.