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 TaskanaEngineConfiguration	taskanaEngineConfiguration
protected org.apache.ibatis.transaction.TransactionFactory	transactionFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TaskanaEngineImpl(TaskanaEngineConfiguration taskanaEngineConfiguration)

Method Summary

Modifier and Type	Method	Description
void	checkRoleMembership(TaskanaRole... roles)	Checks whether current user is member of any of the specified roles.
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(TaskanaEngineConfiguration taskanaEngineConfiguration)
ClassificationService	getClassificationService()	The ClassificationService can be used for operations on all Categories.
TaskanaEngineConfiguration	getConfiguration()	The Taskana configuration.
pro.taskana.common.api.security.CurrentUserContext	getCurrentUserContext()	Returns the CurrentUserContext class.
JobService	getJobService()	The JobService can be user for all job operations.
MonitorService	getMonitorService()	The MonitorService can be used for monitoring Tasks.
TaskService	getTaskService()	The TaskService can be used for operations on all Tasks.
WorkbasketService	getWorkbasketService()	The WorkbasketService can be used for operations on all Workbaskets.
WorkingDaysToDaysConverter	getWorkingDaysToDaysConverter()	The WorkingDaysToDaysConverter used to compute holidays.
boolean	isHistoryEnabled()	Checks if the history plugin is enabled.
boolean	isUserInRole(TaskanaRole... roles)	check whether the current user is member of one of the roles specified.
<T> T	runAsAdmin(Supplier<T> supplier)	This method is supposed to skip further permission checks if we are already in a secured environment.
void	setConnection(Connection connection)	Set the connection to be used by taskana in mode CONNECTION_MANAGED_EXTERNALLY.
void	setConnectionManagementMode(TaskanaEngine.ConnectionManagementMode mode)	sets the connection management mode.

Methods inherited from class java.lang.Object

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

Field Detail

taskanaEngineConfiguration

protected TaskanaEngineConfiguration taskanaEngineConfiguration

transactionFactory

protected org.apache.ibatis.transaction.TransactionFactory transactionFactory

sessionManager

protected org.apache.ibatis.session.SqlSessionManager sessionManager

mode

protected TaskanaEngine.ConnectionManagementMode mode

connection

protected Connection connection

Constructor Detail

TaskanaEngineImpl

protected TaskanaEngineImpl(TaskanaEngineConfiguration taskanaEngineConfiguration)
                     throws SQLException

Throws:

SQLException

Method Detail

createTaskanaEngine

public static TaskanaEngine createTaskanaEngine(TaskanaEngineConfiguration taskanaEngineConfiguration)
                                         throws SQLException

Throws:

SQLException

getTaskService

public TaskService getTaskService()

Description copied from interface: TaskanaEngine

The TaskService can be used for operations on all Tasks.

Specified by:

getTaskService in interface TaskanaEngine

Returns:

the TaskService

getMonitorService

public MonitorService getMonitorService()

Description copied from interface: TaskanaEngine

The MonitorService can be used for monitoring Tasks.

Specified by:

getMonitorService in interface TaskanaEngine

Returns:

the MonitorService

getWorkbasketService

public WorkbasketService getWorkbasketService()

Description copied from interface: TaskanaEngine

The WorkbasketService can be used for operations on all Workbaskets.

Specified by:

getWorkbasketService in interface TaskanaEngine

Returns:

the WorbasketService

getClassificationService

public ClassificationService getClassificationService()

Description copied from interface: TaskanaEngine

The ClassificationService can be used for operations on all Categories.

Specified by:

getClassificationService in interface TaskanaEngine

Returns:

the ClassificationService

getJobService

public JobService getJobService()

Description copied from interface: TaskanaEngine

The JobService can be user for all job operations.

Specified by:

getJobService in interface TaskanaEngine

Returns:

the JobService

getConfiguration

public TaskanaEngineConfiguration getConfiguration()

Description copied from interface: TaskanaEngine

The Taskana configuration.

Specified by:

getConfiguration in interface TaskanaEngine

Returns:

the TaskanaConfiguration

getWorkingDaysToDaysConverter

public WorkingDaysToDaysConverter getWorkingDaysToDaysConverter()

Description copied from interface: TaskanaEngine

The WorkingDaysToDaysConverter used to compute holidays.

Specified by:

getWorkingDaysToDaysConverter in interface TaskanaEngine

Returns:

the converter

isHistoryEnabled

public boolean isHistoryEnabled()

Description copied from interface: TaskanaEngine

Checks if the history plugin is enabled.

Specified by:

isHistoryEnabled in interface TaskanaEngine

Returns:

true if the history is enabled. Otherwise false.

setConnectionManagementMode

public void setConnectionManagementMode(TaskanaEngine.ConnectionManagementMode mode)

Description copied from interface: TaskanaEngine

sets the connection management mode.

Specified by:

setConnectionManagementMode in interface TaskanaEngine

Parameters:

mode - the connection management mode Valid values 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

setConnection

public void setConnection(Connection connection)
                   throws SQLException

Description copied from interface: TaskanaEngine

Set the connection to be used by taskana in mode CONNECTION_MANAGED_EXTERNALLY. 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

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 roles specified.

Specified by:

isUserInRole in interface TaskanaEngine

Parameters:

roles - The roles 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 groups

checkRoleMembership

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

Description copied from interface: TaskanaEngine

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

Specified by:

checkRoleMembership in interface TaskanaEngine

Parameters:

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

Throws:

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

getCurrentUserContext

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

Description copied from interface: TaskanaEngine

Returns the CurrentUserContext class.

Specified by:

getCurrentUserContext in interface TaskanaEngine

Returns:

the CurrentUserContext

runAsAdmin

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

Description copied from interface: TaskanaEngine

This method is supposed to skip further permission checks if we are already in a secured environment. With great power comes great responsibility.

Specified by:

runAsAdmin in interface TaskanaEngine

Type Parameters:

T - defined with the supplier return value

Parameters:

supplier - will be executed with admin privileges

Returns:

output from supplier

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.