Package pro.taskana.common.api

Interface TaskanaEngine

All Known Implementing Classes:

TaskanaEngineImpl

public interface TaskanaEngine

The TaskanaEngine represents an overall set of all needed services.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	TaskanaEngine.ConnectionManagementMode	Connection management mode.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MINIMAL_TASKANA_SCHEMA_VERSION

Method Summary

Modifier and Type	Method	Description
static TaskanaEngine	buildTaskanaEngine(TaskanaConfiguration configuration)	This method creates the TaskanaEngine with TaskanaEngine.ConnectionManagementMode.PARTICIPATE.
static TaskanaEngine	buildTaskanaEngine(TaskanaConfiguration configuration, TaskanaEngine.ConnectionManagementMode connectionManagementMode)	Builds an TaskanaEngine based on TaskanaConfiguration and SqlConnectionMode.
static TaskanaEngine	buildTaskanaEngine(TaskanaConfiguration configuration, TaskanaEngine.ConnectionManagementMode connectionManagementMode, org.apache.ibatis.transaction.TransactionFactory transactionFactory)	Builds an TaskanaEngine based on TaskanaConfiguration, SqlConnectionMode and TransactionFactory.
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.
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.
TaskanaEngine.ConnectionManagementMode	getConnectionManagementMode()	Returns the ConnectionManagementMode of the TaskanaEngine.
pro.taskana.common.api.security.CurrentUserContext	getCurrentUserContext()	Returns the CurrentUserContext of the TaskanaEngine.
JobService	getJobService()	Returns a JobService initialized with the current TaskanaEngine.
MonitorService	getMonitorService()	Returns a MonitorService initialized with the current TaskanaEngine.
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.
default void	runAsAdmin(Runnable runnable)	Executes a given Runnable with admin privileges and thus skips further permission checks.
<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.

Field Details

MINIMAL_TASKANA_SCHEMA_VERSION

static final String MINIMAL_TASKANA_SCHEMA_VERSION

See Also:

• Constant Field Values

Method Details

getTaskService

TaskService getTaskService()

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

Returns:

an instance of TaskService

getMonitorService

MonitorService getMonitorService()

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

Returns:

an instance of MonitorService

getWorkbasketService

WorkbasketService getWorkbasketService()

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

Returns:

an instance of WorkbasketService

getClassificationService

ClassificationService getClassificationService()

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

Returns:

an instance of ClassificationService

getJobService

JobService getJobService()

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

Returns:

an instance of JobService

getUserService

UserService getUserService()

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

Returns:

an instance of UserService

getConfigurationService

ConfigurationService getConfigurationService()

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

Returns:

an instance of ConfigurationService

getConfiguration

TaskanaConfiguration getConfiguration()

Returns the configuration of the TaskanaEngine.

Returns:

configuration

buildTaskanaEngine

static TaskanaEngine buildTaskanaEngine(TaskanaConfiguration configuration)
                                 throws SQLException

This method creates the TaskanaEngine with TaskanaEngine.ConnectionManagementMode.PARTICIPATE.

Throws:

SQLException

See Also:

• buildTaskanaEngine(TaskanaConfiguration, ConnectionManagementMode)

buildTaskanaEngine

static TaskanaEngine buildTaskanaEngine(TaskanaConfiguration configuration,
 TaskanaEngine.ConnectionManagementMode connectionManagementMode)
                                 throws SQLException

Builds an TaskanaEngine based on TaskanaConfiguration and SqlConnectionMode.

Parameters:

configuration - complete taskanaConfig to build the engine

connectionManagementMode - connectionMode for the SqlSession

Returns:

a TaskanaEngineImpl

Throws:

SQLException - when the db schema could not be initialized

buildTaskanaEngine

static TaskanaEngine buildTaskanaEngine(TaskanaConfiguration configuration,
 TaskanaEngine.ConnectionManagementMode connectionManagementMode,
 org.apache.ibatis.transaction.TransactionFactory transactionFactory)
                                 throws SQLException

Builds an TaskanaEngine based on TaskanaConfiguration, SqlConnectionMode and TransactionFactory.

Parameters:

configuration - complete taskanaConfig to build the engine

connectionManagementMode - connectionMode for the SqlSession

transactionFactory - the TransactionFactory

Returns:

a TaskanaEngineImpl

Throws:

SQLException - when the db schema could not be initialized

getWorkingTimeCalculator

WorkingTimeCalculator getWorkingTimeCalculator()

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.

Returns:

WorkingTimeCalculatorImpl

isHistoryEnabled

boolean isHistoryEnabled()

Checks if the TaskanaHistory plugin is enabled.

Returns:

true if the history is enabled; otherwise false

getConnectionManagementMode

TaskanaEngine.ConnectionManagementMode getConnectionManagementMode()

Returns the ConnectionManagementMode of the TaskanaEngine.

Returns:

ConnectionManagementMode

setConnectionManagementMode

void setConnectionManagementMode(TaskanaEngine.ConnectionManagementMode mode)

Sets ConnectionManagementMode of the 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

setConnection

void setConnection(Connection connection)
            throws SQLException

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.

Parameters:

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

Throws:

SQLException - if a database access error occurs

closeConnection

void closeConnection()

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

isUserInRole

boolean isUserInRole(TaskanaRole... roles)

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

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

void checkRoleMembership(TaskanaRole... roles)
                  throws NotAuthorizedException

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

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

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

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

Type Parameters:

T - defined with the return value of the Supplier

Parameters:

supplier - will be executed with admin privileges

Returns:

output from Supplier

runAsAdmin

default void runAsAdmin(Runnable runnable)

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

See Also:

• runAsAdmin(Supplier)

getCurrentUserContext

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

Returns the CurrentUserContext of the TaskanaEngine.

Returns:

CurrentUserContext

clearSqlSessionCache

void clearSqlSessionCache()

Clears the cache of the underlying local SQL session.