Package org.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 some common APIs.
ApplicationAPI	This API allows to list and manage Bonita Living Applications (Application).
BusinessDataAPI	Deprecated As of 7.3, replaced by ProcessRuntimeAPI.getProcessInstanceExecutionContext(long) (ProcessRuntimeAPI.getArchivedProcessInstanceExecutionContext(long) for archived process instances).
CommandAPI	Manipulate tenant commands.
CustomUserInfoAPI	CustomUserInfoAPI forms part of the OrganizationAPI and gives access to all the Administration operations available on CustomUserInfoDefinition and CustomUserInfoValue: creation, deletion and retrieve methods
DocumentAPI	Manipulate documents that are attached to a process instance.
GroupAPI	GroupAPI forms part of the OrganizationAPI and gives access to all the Administration operations available on Groups: creation, deletion, updating, search, etc...
IdentityAPI	The Interface IdentityAPI.
Logger	A logger given to PermissionRule
LoginAPI	The LoginAPI allows to log in (and out) onto the Engine.
MembershipAPI	MembershipAPI forms part of the OrganizationAPI and gives access to all the Administration operations available on UserMemberships: creation, deletion, updating, retrieval, etc...
OrganizationAPI	Manages the Organization, that is the users, groups, roles, memberships, through import / export methods.
PageAPI	This API gives access to all page features.
PermissionAPI	Handle permissions of users
PlatformAPI	Manage the platform.
PlatformCommandAPI	Manipulates a platform command.
PlatformLoginAPI	Manage the login on the platform.
ProcessAPI	Contains all methods that handle processes.
ProcessManagementAPI	This API deals with definition objects such as ProcessDefinition, ProcessDeploymentInfo, Category, ...
ProcessRuntimeAPI	ProcessRuntimeAPI deals with Process runtime notions such as starting a new instance of a process, retrieving and executing tasks, accessing to all types of tasks, assigning a user to a task, retrieving archived versions of a task, accessing / updating data / variable values, adding / retrieving process comments ...
ProfileAPI	Profiles are a notion used in Bonita Portal to give and control access to some specific features of the Bonita suite.
RoleAPI	RoleAPI forms part of the OrganizationAPI and gives access to all the Administration operations available on Roles: creation, deletion, search, etc...
TenantAdministrationAPI	This API gives access to tenant administration tasks.
ThemeAPI	Manage mobile and portal theme.
UserAPI	UserAPI forms part of the OrganizationAPI and gives access to all the Administration operations available on Users: creation, deletion, certain specific getXXX() methods, generic search methods, etc...

Class Summary

Class	Description
APIClient	Bonita Community Edition APIs client. IdentityAPI, ProcessAPI, ThemeAPI CommandAPI, ProfileAPI, TenantAdministrationAPI, PageAPI, ApplicationAPI, PermissionAPI, BusinessDataAPI (deprecated as of 7.3),
BonitaStackTraceElementConverter	Override default stack trace element parser to avoid having big exception when there is parsing issues
EJB3ServerAPI
HTTPServerAPI
ImportError
ImportStatus	This object represents the status of the import of an entity e.g.
PlatformAPIAccessor	Accessor class that retrieve Platform APIs
TcpDestination
TCPServerAPI
TenantAPIAccessor	Accessor class that retrieve APIs in Bonita Community Edition.

Enum Summary

Enum	Description
ApiAccessType
ImportError.Type
ImportStatus.Status

Annotation Types Summary

Annotation Type	Description
Experimental	An experimental API that can be used but might change in any version of Bonita.
Internal	Element annotated with @Internal are for internal usage only and may change without any warning
NoSessionRequired	Indicates that a Bonita API method does not need to have a valid session to be called.

Package org.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.