pro.taskana.common.internal

Interface InternalTaskanaEngine

public interface InternalTaskanaEngine

FOR INTERNAL USE ONLY.

Contains all actions which are necessary within taskana.

Method Summary

Modifier and Type	Method and Description
boolean	domainExists(String domain) Returns true if the given domain does exist in the configuration.
TaskanaEngine	getEngine() Retrieve TaskanaEngine.
HistoryEventProducer	getHistoryEventProducer() Retrieve HistoryEventProducer.
org.apache.ibatis.session.SqlSession	getSqlSession() retrieve the SqlSession used by taskana.
TaskRoutingManager	getTaskRoutingManager() Retrieve TaskRoutingProducer.
void	initSqlSession() Initializes the SqlSessionManager.
<T> T	openAndReturnConnection(Supplier<T> supplier) Executes the supplier after openConnection is called and then returns the connection.
void	openConnection() Opens the connection to the database.
void	returnConnection() Returns the database connection into the pool.
<T> T	runAsAdmin(Supplier<T> supplier) This method is supposed to skip further permission checks if we are already in a secured environment.

Method Detail

openConnection

void openConnection()

Opens the connection to the database. Has to be called at the begin of each Api call that accesses the database

returnConnection

void returnConnection()

Returns the database connection into the pool. In the case of nested calls, simply pops the latest session from the session stack. Closes the connection if the session stack is empty. In mode AUTOCOMMIT commits before the connection is closed. To be called at the end of each Api call that accesses the database

openAndReturnConnection

<T> T openAndReturnConnection(Supplier<T> supplier)

Executes the supplier after openConnection is called and then returns the connection.

Type Parameters:

T - any type

Parameters:

supplier - a function that returns something of type T

Returns:

the result of the supplier

initSqlSession

void initSqlSession()

Initializes the SqlSessionManager.

domainExists

boolean domainExists(String domain)

Returns true if the given domain does exist in the configuration.

Parameters:

domain - the domain specified in the configuration

Returns:

true if the domain exists

getSqlSession

org.apache.ibatis.session.SqlSession getSqlSession()

retrieve the SqlSession used by taskana.

Returns:

the myBatis SqlSession object used by taskana

getEngine

TaskanaEngine getEngine()

Retrieve TaskanaEngine.

Returns:

The nested TaskanaEngine.

getHistoryEventProducer

HistoryEventProducer getHistoryEventProducer()

Retrieve HistoryEventProducer.

Returns:

the HistoryEventProducer instance.

getTaskRoutingManager

TaskRoutingManager getTaskRoutingManager()

Retrieve TaskRoutingProducer.

Returns:

the TaskRoutingProducer instance.

runAsAdmin

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

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

Type Parameters:

T - defined with the supplier return value

Parameters:

supplier - will be executed with admin privileges

Returns:

output from supplier