org.bonitasoft.engine.profile.impl

Class ProfileServiceImpl

java.lang.Object

org.bonitasoft.engine.profile.impl.ProfileServiceImpl

All Implemented Interfaces:

ProfileService

public class ProfileServiceImpl
extends Object
implements ProfileService

Author:

Matthieu Chaffotte, Elias Ricken de Medeiros

Field Summary

Fields inherited from interface org.bonitasoft.engine.profile.ProfileService

ENTRY_PROFILE, PROFILE, PROFILE_MEMBER

Constructor Summary

Constructors

Constructor and Description
ProfileServiceImpl(org.bonitasoft.engine.services.PersistenceService persistenceService, Recorder recorder, EventService eventService, TechnicalLoggerService logger, QueriableLoggerService queriableLoggerService, ReadSessionAccessor sessionAccessor, SessionService sessionService)

Method Summary

Modifier and Type	Method and Description
SProfileMember	addGroupToProfile(long profileId, long groupId, String groupName, String parentPath) Add a group to exist profile
SProfileMember	addRoleAndGroupToProfile(long profileId, long roleId, long groupId, String roleName, String groupName, String groupParentPath) Add a role and a group to exist profile
SProfileMember	addRoleToProfile(long profileId, long roleId, String roleName) Add a role to exist profile
SProfileMember	addUserToProfile(long profileId, long userId, String firstName, String lastName, String userName) Add a user to exist profile
SProfile	createProfile(SProfile profile) Add a new profile
SProfileEntry	createProfileEntry(SProfileEntry profileEntry) Add new profile entry
void	deleteAllProfileEntriesOfProfile(SProfile profile)
void	deleteAllProfileMembers() Delete all profile members for the connected tenant
void	deleteAllProfileMembersOfProfile(SProfile profile)
void	deleteProfile(long profileId) Delete profile by its id
void	deleteProfile(SProfile profile) Delete profile by given sProfile
void	deleteProfileEntry(long profileEntryId) Delete a profile entry by its id
void	deleteProfileEntry(SProfileEntry profileEntry) Delete a profileEntry by given profileEntry
void	deleteProfileMember(long profileMemberId) Delete a profile member by its id
void	deleteProfileMember(SProfileMember profileMember) Delete a profile member by given sProfile member
List<SProfileEntry>	getEntriesOfProfile(long profileId, int fromIndex, int numberOfProfileEntries, String field, org.bonitasoft.engine.persistence.OrderByType order) Get all profile entries having the given value for the given int index by profileId
List<SProfileEntry>	getEntriesOfProfileByParentId(long profileId, long parentId, int fromIndex, int numberOfProfileEntries, String field, org.bonitasoft.engine.persistence.OrderByType order) Get a list of profileEntries by the given profileId and parentId
long	getNumberOfProfileEntries(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
long	getNumberOfProfileMembers(String querySuffix, org.bonitasoft.engine.persistence.QueryOptions countOptions) Get the total number of profile members
long	getNumberOfProfiles(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
SProfile	getProfile(long profileId) Get profile by its id
SProfile	getProfileByName(String profileName) Get profile by given name
SProfileEntry	getProfileEntry(long profileEntryId) Get profile entry by its id
List<SProfileMember>	getProfileMembers(int fromIndex, int numberOfElements, String field, org.bonitasoft.engine.persistence.OrderByType order)
List<SProfileMember>	getProfileMembers(List<Long> profileIds) Get the total number of sProfileMember by a list contains profileIds
List<SProfileMember>	getProfileMembers(long profileId, org.bonitasoft.engine.persistence.QueryOptions queryOptions) Get a list of profileMembers by the given profileId
List<SProfileMember>	getProfileMembersOfGroup(long groupId, int fromIndex, int numberOfElements, String field, org.bonitasoft.engine.persistence.OrderByType order) Get all sProfileMembers with same group having the given value for the given int index
List<SProfileMember>	getProfileMembersOfRole(long roleId, int fromIndex, int numberOfElements, String field, org.bonitasoft.engine.persistence.OrderByType order) Get all sProfileMembers with same group having the given value for the given int index
List<SProfileMember>	getProfileMembersOfUser(long userId, int fromIndex, int numberOfElements, String field, org.bonitasoft.engine.persistence.OrderByType order) Get all sProfileMembers with same user having the given value for the given int index
SProfileMember	getProfileMemberWithoutDisplayName(long profileMemberId)
List<SProfile>	getProfiles(List<Long> profileIds) Get all profiles by given ids
List<SProfileEntry>	searchProfileEntries(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
List<SProfileMember>	searchProfileMembers(String querySuffix, org.bonitasoft.engine.persistence.QueryOptions queryOptions) Get all sProfileMember by profileId and queryOptions
List<SProfile>	searchProfiles(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
List<SProfile>	searchProfilesOfUser(long userId, int fromIndex, int numberOfElements, String field, org.bonitasoft.engine.persistence.OrderByType order) Get all profiles of the user by userId
List<SProfile>	searchProfilesWithNavigationOfUser(long userId, int fromIndex, int numberOfElements, String field, org.bonitasoft.engine.persistence.OrderByType order) Get all profiles with portal navigation for a user
SProfile	updateProfile(SProfile sProfile, EntityUpdateDescriptor descriptor) Update profile by given profile and new content
SProfileEntry	updateProfileEntry(SProfileEntry profileEntry, EntityUpdateDescriptor descriptor) Update a profileEntry by given profileEntry and new content
void	updateProfileMetaData(long profileId) updates profile metaData fields lastUpdateDate and lastUpdatedBy for a given profile

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProfileServiceImpl

public ProfileServiceImpl(org.bonitasoft.engine.services.PersistenceService persistenceService,
                          Recorder recorder,
                          EventService eventService,
                          TechnicalLoggerService logger,
                          QueriableLoggerService queriableLoggerService,
                          ReadSessionAccessor sessionAccessor,
                          SessionService sessionService)

Method Detail

createProfile

public SProfile createProfile(SProfile profile)
                       throws SProfileCreationException

Description copied from interface: ProfileService

Add a new profile

Specified by:

createProfile in interface ProfileService

Returns:

sProfile

Throws:

SProfileCreationException - occurs when an exception is thrown during sProfile creation

getProfile

public SProfile getProfile(long profileId)
                    throws SProfileNotFoundException

Description copied from interface: ProfileService

Get profile by its id

Specified by:

getProfile in interface ProfileService

Returns:

sProfile

Throws:

SProfileNotFoundException - occurs when the identifier does not refer to an existing sProfile

getProfileByName

public SProfile getProfileByName(String profileName)
                          throws SProfileNotFoundException

Description copied from interface: ProfileService

Get profile by given name

Specified by:

getProfileByName in interface ProfileService

Returns:

sProfile

Throws:

SProfileNotFoundException - occurs when the identifier does not refer to an existing sProfile

getProfiles

public List<SProfile> getProfiles(List<Long> profileIds)
                           throws SProfileNotFoundException

Description copied from interface: ProfileService

Get all profiles by given ids

Specified by:

getProfiles in interface ProfileService

Parameters:

profileIds - a list contains many profile id

Returns:

Throws:

SProfileNotFoundException - occurs when the identifier does not refer to an existing sProfile

updateProfile

public SProfile updateProfile(SProfile sProfile,
                              EntityUpdateDescriptor descriptor)
                       throws SProfileUpdateException

Description copied from interface: ProfileService

Update profile by given profile and new content

Specified by:

updateProfile in interface ProfileService

Returns:

The updated profile

Throws:

SProfileUpdateException - occurs when an exception is thrown during sProfile update

deleteProfile

public void deleteProfile(SProfile profile)
                   throws SProfileDeletionException,
                          SProfileEntryDeletionException,
                          SProfileMemberDeletionException

Description copied from interface: ProfileService

Delete profile by given sProfile

Specified by:

deleteProfile in interface ProfileService

Throws:

SProfileDeletionException - occurs when an exception is thrown during sProfile deletion

SProfileEntryDeletionException

SProfileMemberDeletionException

deleteAllProfileMembersOfProfile

public void deleteAllProfileMembersOfProfile(SProfile profile)
                                      throws SProfileMemberDeletionException

Specified by:

deleteAllProfileMembersOfProfile in interface ProfileService

Throws:

SProfileMemberDeletionException

deleteAllProfileEntriesOfProfile

public void deleteAllProfileEntriesOfProfile(SProfile profile)
                                      throws SProfileEntryDeletionException

Specified by:

deleteAllProfileEntriesOfProfile in interface ProfileService

Throws:

SProfileEntryDeletionException

deleteProfile

public void deleteProfile(long profileId)
                   throws SProfileNotFoundException,
                          SProfileDeletionException,
                          SProfileEntryDeletionException,
                          SProfileMemberDeletionException

Description copied from interface: ProfileService

Delete profile by its id

Specified by:

deleteProfile in interface ProfileService

Throws:

SProfileNotFoundException - occurs when the identifier does not refer to an existing sProfile

SProfileDeletionException - occurs when an exception is thrown during sProfile deletion

SProfileEntryDeletionException

SProfileMemberDeletionException

getProfileEntry

public SProfileEntry getProfileEntry(long profileEntryId)
                              throws SProfileEntryNotFoundException

Description copied from interface: ProfileService

Get profile entry by its id

Specified by:

getProfileEntry in interface ProfileService

Returns:

sProfileEntry

Throws:

SProfileEntryNotFoundException - occurs when the identifier does not refer to an existing sProfileEntry

getEntriesOfProfile

public List<SProfileEntry> getEntriesOfProfile(long profileId,
                                               int fromIndex,
                                               int numberOfProfileEntries,
                                               String field,
                                               org.bonitasoft.engine.persistence.OrderByType order)
                                        throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: ProfileService

Get all profile entries having the given value for the given int index by profileId

Specified by:

getEntriesOfProfile in interface ProfileService

fromIndex - first result to be considered(>=0)

numberOfProfileEntries - the max number of profileEntry to be returned (>=0)

Returns:

all profile entries having the given value for the given int index by profileId

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getEntriesOfProfileByParentId

public List<SProfileEntry> getEntriesOfProfileByParentId(long profileId,
                                                         long parentId,
                                                         int fromIndex,
                                                         int numberOfProfileEntries,
                                                         String field,
                                                         org.bonitasoft.engine.persistence.OrderByType order)
                                                  throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: ProfileService

Get a list of profileEntries by the given profileId and parentId

Specified by:

getEntriesOfProfileByParentId in interface ProfileService

Returns:

a list of profileEntries

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

createProfileEntry

public SProfileEntry createProfileEntry(SProfileEntry profileEntry)
                                 throws SProfileEntryCreationException

Description copied from interface: ProfileService

Add new profile entry

Specified by:

createProfileEntry in interface ProfileService

Returns:

the new created sProfileEntry

Throws:

SProfileEntryCreationException - occurs when an exception is thrown during sProfileEntry creation

updateProfileEntry

public SProfileEntry updateProfileEntry(SProfileEntry profileEntry,
                                        EntityUpdateDescriptor descriptor)
                                 throws SProfileEntryUpdateException

Description copied from interface: ProfileService

Update a profileEntry by given profileEntry and new content

Specified by:

updateProfileEntry in interface ProfileService

Returns:

The updated profile entry

Throws:

SProfileEntryUpdateException - occurs when an exception is thrown during sProfileEntry update

deleteProfileEntry

public void deleteProfileEntry(SProfileEntry profileEntry)
                        throws SProfileEntryDeletionException

Description copied from interface: ProfileService

Delete a profileEntry by given profileEntry

Specified by:

deleteProfileEntry in interface ProfileService

Throws:

SProfileEntryDeletionException - occurs when an exception is thrown during sProfileEntry deletion

deleteProfileEntry

public void deleteProfileEntry(long profileEntryId)
                        throws SProfileEntryNotFoundException,
                               SProfileEntryDeletionException

Description copied from interface: ProfileService

Delete a profile entry by its id

Specified by:

deleteProfileEntry in interface ProfileService

Throws:

SProfileEntryNotFoundException - occurs when the identifier does not refer to an existing sProfileEntry

SProfileEntryDeletionException - occurs when an exception is thrown during sProfileEntry deletion

addUserToProfile

public SProfileMember addUserToProfile(long profileId,
                                       long userId,
                                       String firstName,
                                       String lastName,
                                       String userName)
                                throws SProfileMemberCreationException

Description copied from interface: ProfileService

Add a user to exist profile

Specified by:

addUserToProfile in interface ProfileService

Parameters:

profileId - the identifier of profile

userId - the identifier of user

Returns:

sProfileMember

Throws:

SProfileMemberCreationException

addGroupToProfile

public SProfileMember addGroupToProfile(long profileId,
                                        long groupId,
                                        String groupName,
                                        String parentPath)
                                 throws SProfileMemberCreationException

Description copied from interface: ProfileService

Add a group to exist profile

Specified by:

addGroupToProfile in interface ProfileService

Parameters:

profileId - the identifier of profile

groupId - the identifier of group

Returns:

sProfileMember

Throws:

SProfileMemberCreationException - TODO

addRoleToProfile

public SProfileMember addRoleToProfile(long profileId,
                                       long roleId,
                                       String roleName)
                                throws SProfileMemberCreationException

Description copied from interface: ProfileService

Add a role to exist profile

Specified by:

addRoleToProfile in interface ProfileService

Parameters:

profileId - the identifier of profile

roleId - the identifier of role

Returns:

sProfileMember

Throws:

SProfileMemberCreationException - TODO

addRoleAndGroupToProfile

public SProfileMember addRoleAndGroupToProfile(long profileId,
                                               long roleId,
                                               long groupId,
                                               String roleName,
                                               String groupName,
                                               String groupParentPath)
                                        throws SProfileMemberCreationException

Description copied from interface: ProfileService

Add a role and a group to exist profile

Specified by:

addRoleAndGroupToProfile in interface ProfileService

Parameters:

profileId - the identifier of profile

roleId - the identifier of role

groupId - the identifier of group

Returns:

sProfileMember

Throws:

SProfileMemberCreationException - TODO

deleteProfileMember

public void deleteProfileMember(long profileMemberId)
                         throws SProfileMemberDeletionException,
                                SProfileMemberNotFoundException

Description copied from interface: ProfileService

Delete a profile member by its id

Specified by:

deleteProfileMember in interface ProfileService

Throws:

SProfileMemberDeletionException - occurs when an exception is thrown during sProfileMember deletion

SProfileMemberNotFoundException - occurs when the identifier does not refer to an existing sProfileMember

getProfileMemberWithoutDisplayName

public SProfileMember getProfileMemberWithoutDisplayName(long profileMemberId)
                                                  throws SProfileMemberNotFoundException

Specified by:

getProfileMemberWithoutDisplayName in interface ProfileService

Returns:

Throws:

SProfileMemberNotFoundException

deleteProfileMember

public void deleteProfileMember(SProfileMember profileMember)
                         throws SProfileMemberDeletionException

Description copied from interface: ProfileService

Delete a profile member by given sProfile member

Specified by:

deleteProfileMember in interface ProfileService

Throws:

SProfileMemberDeletionException - occurs when an exception is thrown during sProfileMember deletion

getProfileMembersOfUser

public List<SProfileMember> getProfileMembersOfUser(long userId,
                                                    int fromIndex,
                                                    int numberOfElements,
                                                    String field,
                                                    org.bonitasoft.engine.persistence.OrderByType order)
                                             throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: ProfileService

Get all sProfileMembers with same user having the given value for the given int index

Specified by:

getProfileMembersOfUser in interface ProfileService

Parameters:

userId - the identifier of user

fromIndex - first result to be considered(>=0)

Returns:

sProfileMember

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException - occurs when an exception is thrown during sProfileMember creation

getProfileMembersOfGroup

public List<SProfileMember> getProfileMembersOfGroup(long groupId,
                                                     int fromIndex,
                                                     int numberOfElements,
                                                     String field,
                                                     org.bonitasoft.engine.persistence.OrderByType order)
                                              throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: ProfileService

Get all sProfileMembers with same group having the given value for the given int index

Specified by:

getProfileMembersOfGroup in interface ProfileService

Parameters:

groupId - the identifier of group

fromIndex - first result to be considered(>=0)

Returns:

sProfileMember

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException - occurs when an exception is thrown during sProfileMember creation

getProfileMembersOfRole

public List<SProfileMember> getProfileMembersOfRole(long roleId,
                                                    int fromIndex,
                                                    int numberOfElements,
                                                    String field,
                                                    org.bonitasoft.engine.persistence.OrderByType order)
                                             throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: ProfileService

Get all sProfileMembers with same group having the given value for the given int index

Specified by:

getProfileMembersOfRole in interface ProfileService

Parameters:

roleId - the identifier of role

fromIndex - first result to be considered(>=0)

Returns:

sProfileMember

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException - occurs when an exception is thrown during sProfileMember creation

searchProfilesOfUser

public List<SProfile> searchProfilesOfUser(long userId,
                                           int fromIndex,
                                           int numberOfElements,
                                           String field,
                                           org.bonitasoft.engine.persistence.OrderByType order)
                                    throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: ProfileService

Get all profiles of the user by userId

Specified by:

searchProfilesOfUser in interface ProfileService

fromIndex - first result to be considered(>=0)

Returns:

A list of sProfile

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

searchProfilesWithNavigationOfUser

public List<SProfile> searchProfilesWithNavigationOfUser(long userId,
                                                         int fromIndex,
                                                         int numberOfElements,
                                                         String field,
                                                         org.bonitasoft.engine.persistence.OrderByType order)
                                                  throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: ProfileService

Get all profiles with portal navigation for a user

Specified by:

searchProfilesWithNavigationOfUser in interface ProfileService

fromIndex - first result to be considered(>=0)

Returns:

A list of sProfile

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getProfileMembers

public List<SProfileMember> getProfileMembers(long profileId,
                                              org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                       throws SProfileMemberNotFoundException

Description copied from interface: ProfileService

Get a list of profileMembers by the given profileId

Specified by:

getProfileMembers in interface ProfileService

Returns:

a list of profileMembers

Throws:

SProfileMemberNotFoundException

searchProfileMembers

public List<SProfileMember> searchProfileMembers(String querySuffix,
                                                 org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                          throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: ProfileService

Get all sProfileMember by profileId and queryOptions

Specified by:

searchProfileMembers in interface ProfileService

Parameters:

querySuffix - the suffix of query string

Returns:

all sProfileMember by profileId and queryOptions

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getNumberOfProfileMembers

public long getNumberOfProfileMembers(String querySuffix,
                                      org.bonitasoft.engine.persistence.QueryOptions countOptions)
                               throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: ProfileService

Get the total number of profile members

Specified by:

getNumberOfProfileMembers in interface ProfileService

Parameters:

querySuffix - the suffix of query string

countOptions - The criterion used to search profileMembers

Returns:

the total number of profile members

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getProfileMembers

public List<SProfileMember> getProfileMembers(List<Long> profileIds)
                                       throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: ProfileService

Get the total number of sProfileMember by a list contains profileIds

Specified by:

getProfileMembers in interface ProfileService

Returns:

A list of

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

deleteAllProfileMembers

public void deleteAllProfileMembers()
                             throws SProfileMemberDeletionException

Description copied from interface: ProfileService

Delete all profile members for the connected tenant

Specified by:

deleteAllProfileMembers in interface ProfileService

Throws:

SProfileMemberDeletionException

getNumberOfProfiles

public long getNumberOfProfiles(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                         throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

getNumberOfProfiles in interface ProfileService

Returns:

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

searchProfiles

public List<SProfile> searchProfiles(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                              throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

searchProfiles in interface ProfileService

Returns:

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getProfileMembers

public List<SProfileMember> getProfileMembers(int fromIndex,
                                              int numberOfElements,
                                              String field,
                                              org.bonitasoft.engine.persistence.OrderByType order)
                                       throws org.bonitasoft.engine.persistence.SBonitaReadException

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getNumberOfProfileEntries

public long getNumberOfProfileEntries(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                               throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

getNumberOfProfileEntries in interface ProfileService

Returns:

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

searchProfileEntries

public List<SProfileEntry> searchProfileEntries(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                         throws org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

searchProfileEntries in interface ProfileService

Returns:

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

updateProfileMetaData

public void updateProfileMetaData(long profileId)
                           throws SProfileUpdateException

Description copied from interface: ProfileService

updates profile metaData fields lastUpdateDate and lastUpdatedBy for a given profile

Specified by:

updateProfileMetaData in interface ProfileService

Throws:

SProfileUpdateException - when given profileId is not found