com.bonitasoft.engine.api

Interface ProfileAPI

All Superinterfaces:

ProfileAPI

public interface ProfileAPI
extends ProfileAPI

Profiles are a notion used in Bonita BPM Portal to give and control access to some specific features of the Bonita BPM suite. Profiles are associated to Bonita Identity / Organization notions: users, groups, roles, memberships. ProfileAPI gives FULL access on profile administration: creation / update / removal of profiles, adding / removing members to / from a profile, retrieving / searching for profiles.
Import / export of all profiles is also part of this API.
ProfileAPI also gives access to ProfileEntry management, which are a way to map profiles to features / pages in Bonita BPM Portal *

Author:

Celine Souchet, Matthieu Chaffotte

See Also:

ProfileEntry

Method Summary

Modifier and Type	Method and Description
Profile	createProfile(ProfileCreator creator) Create a new custom profile
Profile	createProfile(String name, String description) Create a new custom profile
Profile	createProfile(String name, String description, String iconPath) Deprecated. use createProfile(String name, String description)
ProfileEntry	createProfileEntry(ProfileEntryCreator creator) Create a new profile entry
ProfileEntry	createProfileEntry(String name, String description, long profileId, String type) Deprecated. since 7.4 use createProfileEntry(ProfileEntryCreator) or createProfileFolderEntry(String, String, long)
ProfileEntry	createProfileEntry(String name, String description, long profileId, String type, String page) Deprecated. since 7.4 use createProfileEntry(ProfileEntryCreator) or createProfileLinkEntry(String, String, long, String, boolean)
ProfileEntry	createProfileFolderEntry(String name, String description, long profileId) Create a new profile entry of type folder (group of menu link)
ProfileEntry	createProfileLinkEntry(String name, String description, long profileId, String page, boolean isCustom) Create a new profile entry of type link (link to a page in the menu)
void	deleteProfile(long id) Delete a specific custom profile
void	deleteProfileEntry(long id) Delete a specific profile entry
byte[]	exportAllProfiles() Export all profiles from DataBase to XML file
byte[]	exportProfilesWithIdsSpecified(long[] profileIds) Export specific profiles from DataBase to XML file
List<ImportStatus>	importProfiles(byte[] xmlContent, ImportPolicy policy) Import profiles from XML file.
List<String>	importProfilesUsingSpecifiedPolicy(byte[] xmlContent, ImportPolicy policy) Deprecated. use importProfiles(byte[], ImportPolicy)
Profile	updateProfile(long id, ProfileUpdater updater) Update a custom profile.
ProfileEntry	updateProfileEntry(long id, ProfileEntryUpdater updater) Update a profile entry.

Methods inherited from interface org.bonitasoft.engine.api.ProfileAPI

createProfileMember, createProfileMember, deleteProfileMember, getNumberOfProfileMembers, getProfile, getProfileEntry, getProfilesForUser, getProfilesForUser, searchProfileEntries, searchProfileMembers, searchProfiles

Method Detail

createProfile

@Deprecated
Profile createProfile(String name,
                                  String description,
                                  String iconPath)
                           throws AlreadyExistsException,
                                  CreationException

Deprecated. use createProfile(String name, String description)

Create a new custom profile

Parameters:

name - the profile name

description - the profile description

iconPath - the profile icon path

Returns:

The new created custom profile

Throws:

CreationException - If can't create the new profile

AlreadyExistsException - If the profile already exists

Since:

6.0

createProfile

Profile createProfile(String name,
                      String description)
               throws AlreadyExistsException,
                      CreationException

Create a new custom profile

Parameters:

name - the profile name

description - the profile description

Returns:

The new created custom profile

Throws:

CreationException - If can't create the new profile

AlreadyExistsException - If the profile already exists

Since:

6.3.1

createProfile

Profile createProfile(ProfileCreator creator)
               throws AlreadyExistsException,
                      CreationException

Create a new custom profile

Parameters:

creator - the attributes to initialize

Returns:

The new created custom profile

Throws:

CreationException - If can't create the new profile

AlreadyExistsException - If the profile already exists

Since:

6.0

deleteProfile

void deleteProfile(long id)
            throws DeletionException

Delete a specific custom profile

Parameters:

id - the identifier of the profile to delete

Throws:

DeletionException - If can't delete the profile

Since:

6.0

exportAllProfiles

byte[] exportAllProfiles()
                  throws ExecutionException

Export all profiles from DataBase to XML file

Returns:

The content of the xml file containing all profiles

Throws:

ExecutionException - If can't export profiles

Since:

6.0

exportProfilesWithIdsSpecified

byte[] exportProfilesWithIdsSpecified(long[] profileIds)
                               throws ExecutionException

Export specific profiles from DataBase to XML file

Parameters:

profileIds - profile identifiers to export

Returns:

the content of the xml file containing profiles to export

Throws:

ExecutionException - If can't export profiles

Since:

6.0

importProfilesUsingSpecifiedPolicy

@Deprecated
List<String> importProfilesUsingSpecifiedPolicy(byte[] xmlContent,
                                                            ImportPolicy policy)
                                                     throws ExecutionException

Deprecated. use importProfiles(byte[], ImportPolicy)

Import profiles from XML file.

Parameters:

xmlContent - xml content to import

policy - import policy to define different way how to import xml content in different case

Returns:

A List<String> is a warning message list in case of non-existing User, Group or Role to map the profile to.

Throws:

ExecutionException - If can't import profiles

Since:

6.0

updateProfile

Profile updateProfile(long id,
                      ProfileUpdater updater)
               throws ProfileNotFoundException,
                      UpdateException,
                      AlreadyExistsException

Update a custom profile.

Parameters:

id - the identifier of the profile to update

updater - the attributes to update

Returns:

The updated custom Profile.

Throws:

UpdateException - If can't update profiles

ProfileNotFoundException - If the profile to update cannot be found with the given id

AlreadyExistsException - If a profile with the new name already exists

Since:

6.1

createProfileEntry

ProfileEntry createProfileEntry(ProfileEntryCreator creator)
                         throws CreationException

Create a new profile entry

Parameters:

creator - the attributes to initialize. The type value must be "folder" or "link". If type = "link", the page is also mandatory. Index must be an odd long value if the profile is not inserted at last position To insert at first position, the value of index must be -1

Returns:

The created profile entry

Throws:

CreationException - If can't create the new profile entry

Since:

6.0

createProfileEntry

@Deprecated
ProfileEntry createProfileEntry(String name,
                                            String description,
                                            long profileId,
                                            String type)
                                     throws CreationException

Deprecated. since 7.4 use createProfileEntry(ProfileEntryCreator) or createProfileFolderEntry(String, String, long)

Create a new profile entry

Parameters:

name - the profile entry name

description - the profile entry description

profileId - the linked profile identifier

type - the value must be "folder" or "link". If type = "link", the page parameter.

Returns:

The created profile entry

Throws:

CreationException - If can't create the new profile entry

Since:

6.0

createProfileEntry

@Deprecated
ProfileEntry createProfileEntry(String name,
                                            String description,
                                            long profileId,
                                            String type,
                                            String page)
                                     throws CreationException

Deprecated. since 7.4 use createProfileEntry(ProfileEntryCreator) or createProfileLinkEntry(String, String, long, String, boolean)

Create a new profile entry (only works for regular portal pages, not custom pages)

Parameters:

name - the profile entry name

description - the profile entry description

profileId - the linked profile id

type - the value must be "folder" or "link". If type = "link", the page parameter.

page - token of the linked page

Returns:

The created profile entry

Throws:

CreationException - If can't create the new profile entry

Since:

6.0

createProfileFolderEntry

ProfileEntry createProfileFolderEntry(String name,
                                      String description,
                                      long profileId)
                               throws CreationException

Create a new profile entry of type folder (group of menu link)

Parameters:

name - the profile entry name

description - the profile entry description

profileId - the linked profile identifier

Returns:

The created profile entry

Throws:

CreationException - If can't create the new profile entry

Since:

7.4

createProfileLinkEntry

ProfileEntry createProfileLinkEntry(String name,
                                    String description,
                                    long profileId,
                                    String page,
                                    boolean isCustom)
                             throws CreationException

Create a new profile entry of type link (link to a page in the menu)

Parameters:

name - the profile entry name

description - the profile entry description

profileId - the linked profile id

page - token of the linked page

isCustom - indicates if the page is a custom page or not (provided profile page)

Returns:

The created profile entry

Throws:

CreationException - If can't create the new profile entry

Since:

7.4

deleteProfileEntry

void deleteProfileEntry(long id)
                 throws DeletionException

Delete a specific profile entry

Parameters:

id - the identifier of the profile entry to delete

Throws:

DeletionException - If can't delete the profile entry

Since:

6.0

updateProfileEntry

ProfileEntry updateProfileEntry(long id,
                                ProfileEntryUpdater updater)
                         throws ProfileEntryNotFoundException,
                                UpdateException

Update a profile entry.

Parameters:

id - the identifier of the profile entry to update

updater - the attributes to update

Returns:

the updated profile entry

Throws:

ProfileEntryNotFoundException - if no ProfileEntry can be found with the provided ID.

UpdateException - If can't update the profile entry Index must be an odd long value if index is updated To put at first position, the value of index must be -1

Since:

6.0

importProfiles

List<ImportStatus> importProfiles(byte[] xmlContent,
                                  ImportPolicy policy)
                           throws ExecutionException

Import profiles from XML file.

Parameters:

xmlContent - xml content to import

policy - import policy to define different ways of how to import xml content in different case

Returns:

A list that is the result of the import, there is one element for each profile

Throws:

ExecutionException - If there is an unexpected error during the imports

Since:

6.3.1