Package com.bonitasoft.engine.api

The Bonita project has a clear separation between the API the users should be interacting with and the actual implementation classes.

See: Description

Interface Summary

Interface	Description
APIAccessor	Gives access to Subscription edition specific APIs.
IdentityAPI	This API does not contain anymore anything Subscription-specific.
LogAPI	When some actions are performed in Bonita Execution Engine, some business logs are stored. The LogAPI allows to get / search those logs.
LoginAPI
MonitoringAPI
NodeAPI	Handle nodes A node is a JVM that allows the engine to run on a platform
PlatformAPI
PlatformMonitoringAPI	The PlatformMonitoringAPI allows to monitor certains indicator at platform level.
ProcessAPI
ProcessManagementAPI	* ProcessManagementAPI extends ProcessManagementAPI and adds capabilities on Parameters, activity replay, connector implementation hot-replace.
ProcessRuntimeAPI	ProcessRuntimeAPI extends ProcessRuntimeAPI and adds capabilities on Manual tasks, connector execution (directly available at API level), search index updating.
ProfileAPI	Profiles are a notion used in Bonita Portal to give and control access to some specific features of the Bonita suite.
ReportingAPI	This API gives access to all reporting features.
TenantAdministrationAPI	Subscription-specific implementation of tenant administration API.
ThemeAPI	Manage mobile and portal theme

Class Summary

Class	Description
APIClient	Bonita Subscription Edition API's client. Be aware that if you use APIClient instead, you will have only access to Community Edition APIs, which give access to less features.
PlatformAPIAccessor	Accessor class that retrieve Platform APIs
TenantAPIAccessor	Accessor class that retrieve APIs in Bonita Subscription Edition. Be aware that if you use TenantAPIAccessor instead, you will have only access to Community Edition APIs, which give access to less features.

Exception Summary

Exception	Description
TenantIsPausedException	Deprecated use TenantStatusException instead
TenantStatusException	Deprecated from version 7.0.0 on, use TenantStatusException instead.

Package com.bonitasoft.engine.api Description

The Bonita project has a clear separation between the API the users should be interacting with and the actual implementation classes.
The public API exposes most of the features we believe "normal" users can safely use and should remain rather stable across releases.
Expert users can still access internal classes but should be aware that they should know what they are doing and that the internal API might still change in the future.