com.bonitasoft.engine.api

Interface MonitoringAPI

public interface MonitoringAPI

Author:

Zhao Na, Elias Ricken de Medeiros, Matthieu Chaffotte

Method Summary

Methods

Modifier and Type	Method and Description
long	getNumberOfActiveTransactions() Get the number of all active transactions If no active transactions there, return 0
long	getNumberOfExecutingProcesses() Deprecated. since 6.3.0, use ProcessRuntimeAPI.getNumberOfProcessInstances()
long	getNumberOfUsers() Get the number of users in the organization of the current tenant.

Method Detail

getNumberOfActiveTransactions

long getNumberOfActiveTransactions()
                                   throws MonitoringException

Get the number of all active transactions If no active transactions there, return 0

Returns:

the total number of active transaction

Throws:

MonitoringException - occurs when an exception is thrown during monitoring

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

getNumberOfExecutingProcesses

@Deprecated
long getNumberOfExecutingProcesses()
                                   throws MonitoringException

Deprecated. since 6.3.0, use ProcessRuntimeAPI.getNumberOfProcessInstances()

Get the number of all executing processes If no executing processes there, return 0

Returns:

The total number of executing process

Throws:

MonitoringException - occurs when an exception is thrown during monitoring

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

getNumberOfUsers

long getNumberOfUsers()
                      throws MonitoringException

Get the number of users in the organization of the current tenant. If there are no users return 0

Returns:

The number of users

Throws:

MonitoringException - occurs when an exception is thrown during monitoring

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.