org.bonitasoft.engine.api

Interface OrganizationAPI

All Known Subinterfaces:

IdentityAPI

public interface OrganizationAPI

Manages the Organization, that is the users, groups, roles, memberships, through import / export methods.

Author:

Yanyan Liu, Matthieu Chaffotte, Emmanuel Duchastenier

Method Summary

Modifier and Type	Method and Description
void	deleteOrganization() Deletes the organization.
String	exportOrganization() Exports the organization.
void	importOrganization(String organizationContent) Imports the organization using the ImportPolicy.MERGE_DUPLICATES policy.
void	importOrganization(String organizationContent, ImportPolicy policy) Deprecated. since 7.5.2, use importOrganizationWithWarnings(String, ImportPolicy) instead.
List<String>	importOrganizationWithWarnings(String organizationContent, ImportPolicy policy) Imports the organization.

Method Detail

deleteOrganization

void deleteOrganization()
                 throws DeletionException

Deletes the organization.

It deletes all user memberships, roles, groups, users and custom user info.

Use this method with caution: some artifacts like Applications and DesignProcessDefinitions may present display problems in the Bonita BPM Portal if the referenced user was deleted. Note that you can disable a user instead of deleting it. To do so, use the method UserAPI.updateUser(long, UserUpdater) to set the attribute 'enabled' to false

.

Throws:

DeletionException - If an exception occurs during the organization deletion

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0.0

See Also:

UserAPI.updateUser(long, UserUpdater), Application, DesignProcessDefinition

importOrganization

void importOrganization(String organizationContent)
                 throws OrganizationImportException

Imports the organization using the ImportPolicy.MERGE_DUPLICATES policy.

An organization is composed by users, roles, groups and user memberships.

Parameters:

organizationContent - the XML content of the organization

Throws:

OrganizationImportException - If an exception occurs during the organization import

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0.0

importOrganization

@Deprecated
void importOrganization(String organizationContent,
                                    ImportPolicy policy)
                             throws OrganizationImportException

Deprecated. since 7.5.2, use importOrganizationWithWarnings(String, ImportPolicy) instead.

Imports the organization.

An organization is composed by users, roles, groups and user memberships.

Parameters:

organizationContent - the XML content of the organization

policy - the import policy

Throws:

OrganizationImportException - If an exception occurs during the organization import

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0.0

importOrganizationWithWarnings

List<String> importOrganizationWithWarnings(String organizationContent,
                                            ImportPolicy policy)
                                     throws OrganizationImportException

Imports the organization. Returns the error/info messages about what occured during the process. Functionally the same thing that importOrganization(String, ImportPolicy) but allows to inform the end-user of particular non-critical events that occured during the import.

Ex: If a group in the organization contains an illegal character in their name, the method will import all the other groups in the organization, and return a List with one String : "The group name (...) contains the illegal character (...). The group has not been imported"

An organization is composed by users, roles, groups and user memberships.

Parameters:

organizationContent - the XML content of the organization

policy - the import policy

Returns:

List of warning messages

Throws:

OrganizationImportException - If an exception occurs during the organization import

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

7.5.2 Replaces importOrganizationWithWarnings(String, ImportPolicy)

exportOrganization

String exportOrganization()
                   throws OrganizationExportException

Exports the organization.

An organization is composed by users, roles, groups and user memberships.

Returns:

the organization contented in an XML format

Throws:

OrganizationExportException - If an exception occurs during the organization export

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0.0