org.jbpm.api
Interface ProcessEngine

public interface ProcessEngine

central starting point for all process engine API interactions. This is a thread safe object so it can be kept in a static member field or in JNDI or something similar from which all threads (requests) will fetch the same ProcessEngine object.

Author:

Tom Baeyens

Method Summary

void	close() clean shutdown of the engine.
<T> T	execute(Command<T> command) perform a user command.
<T> T	get(java.lang.Class<T> type) retrieve and object defined in the process engine by type
java.lang.Object	get(java.lang.String name) retrieve and object defined in the process engine by name
ExecutionService	getExecutionService() the execution service that provides access to the runtime executions repository.
HistoryService	getHistoryService() the history service that provides access to the history executions repository.
IdentityService	getIdentityService() the identity service that exposes the user and group operations management operations.
ManagementService	getManagementService() the management service that exposes the management operations to operators that have to keep the jBPM system up and running.
RepositoryService	getRepositoryService() the repository service that provides access to the process repository.
TaskService	getTaskService() the task service that exposes the runtime human task lists.
ProcessEngine	setAuthenticatedUserId(java.lang.String authenticatedUserId) sets the authenticated user's id for the next invocation of a service method in the same thread.
ProcessEngine	setHibernateSession(java.lang.Object hibernateSession) sets the hibernate session for the next invocation of a service method in the same thread.
ProcessEngine	setJdbcConnection(java.sql.Connection jdbcConnection) sets the hibernate session for the next invocation of a service method in the same thread.

Method Detail

getRepositoryService

RepositoryService getRepositoryService()

the repository service that provides access to the process repository.

getExecutionService

ExecutionService getExecutionService()

the execution service that provides access to the runtime executions repository.

getHistoryService

HistoryService getHistoryService()

the history service that provides access to the history executions repository.

getTaskService

TaskService getTaskService()

the task service that exposes the runtime human task lists.

getIdentityService

IdentityService getIdentityService()

the identity service that exposes the user and group operations management operations.

getManagementService

ManagementService getManagementService()

the management service that exposes the management operations to operators that have to keep the jBPM system up and running.

get

<T> T get(java.lang.Class<T> type)

retrieve and object defined in the process engine by type

get

java.lang.Object get(java.lang.String name)

retrieve and object defined in the process engine by name

setAuthenticatedUserId

ProcessEngine setAuthenticatedUserId(java.lang.String authenticatedUserId)

sets the authenticated user's id for the next invocation of a service method in the same thread. This method returns the process engine for convenient method concatenations.

setHibernateSession

ProcessEngine setHibernateSession(java.lang.Object hibernateSession)

sets the hibernate session for the next invocation of a service method in the same thread. The hibernateSession parameter is of type Object to prevent a dependency of the API on hibernate directly. This method returns the process engine for convenient method concatenations.

setJdbcConnection

ProcessEngine setJdbcConnection(java.sql.Connection jdbcConnection)

sets the hibernate session for the next invocation of a service method in the same thread. This method returns the process engine for convenient method concatenations.

execute

<T> T execute(Command<T> command)

perform a user command. that allows users to span a transaction over their own updates, as well as the jbpm operations.

close

void close()

clean shutdown of the engine.