Package org.bonitasoft.engine.actor.mapping.impl

Class ActorMappingServiceImpl

java.lang.Object

org.bonitasoft.engine.actor.mapping.impl.ActorMappingServiceImpl

All Implemented Interfaces:

ActorMappingService

public class ActorMappingServiceImpl
extends java.lang.Object
implements ActorMappingService

Author:

Matthieu Chaffotte, Elias Ricken de Medeiros, Celine Souchet

Field Summary

Fields inherited from interface org.bonitasoft.engine.actor.mapping.ActorMappingService

ACTOR, ACTOR_MEMBER

Constructor Summary

Constructors

Constructor	Description
ActorMappingServiceImpl(ReadPersistenceService persistenceService, Recorder recorder, EventService eventService, QueriableLoggerService queriableLoggerService, IdentityService identityService)

Method Summary

Modifier and Type	Method	Description
SActor	addActor(SActor actor)	Create an actor by given actor
java.util.Set<SActor>	addActors(java.util.Set<SActor> actors)	Create actors by given actors
SActorMember	addGroupToActor(long actorId, long groupId)	Add the groupId specified group to the actorId specified actor
SActorMember	addRoleAndGroupToActor(long actorId, long roleId, long groupId)	Add the roleId and groupId specified relationship to the actorId specified actor
SActorMember	addRoleToActor(long actorId, long roleId)	Add the roleId specified role to the actorId specified actor
SActorMember	addUserToActor(long actorId, long userId)	Add the userId specified user to the actorId specified actor
boolean	canUserStartProcessDefinition(long userId, long processDefinitionId)	Is a specified user allowed to start a process?
SActorMember	deleteActorMember(long actorMemberId)	Remove actorMember for the give actorMemberId
void	deleteActorMember(SActorMember sActorMember)	Remove an actor member
void	deleteActors(long scopeId)	Delete actors in the id specified scope
void	deleteAllActorMembers()	Delete all actor members for the connected tenant
SActor	getActor(long actorId)	Get actor by actor id If the actor by a given actorId is not found, it will throw SActorNotFoundException
SActor	getActor(java.lang.String actorName, long scopeId)	Get actor by actor name and scope id If the actor by a given actorName and scopeId is not found, it will throw SActorNotFoundException
SActorMember	getActorMember(long actorId, long userId, long groupId, long roleId)	Get the actor member
java.util.List<SActorMember>	getActorMembers(long actorId, int fromIndex, int numberOfActorMembers)	Get list of SActorMember objects by pagination
java.util.List<SActorMember>	getActorMembersOfGroup(long groupId, int fromIndex, int numberOfActorMembers)	Get a list of SActorMember objects for given groupId
java.util.List<SActorMember>	getActorMembersOfRole(long roleId, int fromIndex, int numberOfActorMembers)	Get a list of SActorMember objects for given roleId
java.util.List<SActorMember>	getActorMembersOfUser(long userId, int fromIndex, int numberOfActorMembers)	Get a list of SActorMember objects for given userId
java.util.List<SActor>	getActors(long processDefinitionId, QueryOptions queryOptions)	Get paginated actors
java.util.List<SActor>	getActors(java.util.List<java.lang.Long> actorIds)	Get a list of actors by the given list of actor ids
java.util.List<SActor>	getActors(java.util.Set<java.lang.Long> scopeIds, java.lang.Long userId)	Get a list of all actors for the id specified user in certain scopes specified by scopeIds
long	getNumberOfActorMembers(long actorId)	Get number of ActorMembers for give actorId
long	getNumberOfGroupsOfActor(long actorId)	Get the number of groups corresponding to an actor
long	getNumberOfMembershipsOfActor(long actorId)	Get the number of memberships (role and group) of an actor
long	getNumberOfRolesOfActor(long actorId)	Get the number of roles of an actor
long	getNumberOfUsersOfActor(long actorId)	Return the number of users corresponding to an actor
java.util.List<java.lang.Long>	getPossibleUserIdsOfActorId(long actorId, int startIndex, int maxResults)
SActor	updateActor(long actorId, EntityUpdateDescriptor descriptor)	Update actor by its id If the actor by a given actorId is not found, it will throw processDefinitionNotFountExcetion

Methods inherited from class java.lang.Object

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

Constructor Detail

ActorMappingServiceImpl

public ActorMappingServiceImpl(ReadPersistenceService persistenceService,
                               Recorder recorder,
                               EventService eventService,
                               QueriableLoggerService queriableLoggerService,
                               IdentityService identityService)

Method Detail

addActors

public java.util.Set<SActor> addActors(java.util.Set<SActor> actors)
                                throws SActorCreationException

Description copied from interface: ActorMappingService

Create actors by given actors

Specified by:

addActors in interface ActorMappingService

Parameters:

actors - The given actors without IDs

Returns:

The set of the new created actors

Throws:

SActorCreationException

addActor

public SActor addActor(SActor actor)
                throws SActorCreationException

Description copied from interface: ActorMappingService

Create an actor by given actor

Specified by:

addActor in interface ActorMappingService

Parameters:

actor - The given actor without id

Returns:

the new created actor with id

Throws:

SActorCreationException

getActor

public SActor getActor(long actorId)
                throws SActorNotFoundException,
                       SBonitaReadException

Description copied from interface: ActorMappingService

Get actor by actor id If the actor by a given actorId is not found, it will throw SActorNotFoundException

Specified by:

getActor in interface ActorMappingService

Parameters:

actorId - Id of actor

Returns:

SActor object response to the given actorId

Throws:

SActorNotFoundException

SBonitaReadException

getNumberOfUsersOfActor

public long getNumberOfUsersOfActor(long actorId)

Description copied from interface: ActorMappingService

Return the number of users corresponding to an actor

Specified by:

getNumberOfUsersOfActor in interface ActorMappingService

Parameters:

actorId - the id of the actor to retrieve the users from

Returns:

Number of users mapped to actor

getNumberOfRolesOfActor

public long getNumberOfRolesOfActor(long actorId)

Description copied from interface: ActorMappingService

Get the number of roles of an actor

Specified by:

getNumberOfRolesOfActor in interface ActorMappingService

Parameters:

actorId - the id corresponding to an actor

Returns:

Number of roles mapped to actor

getNumberOfGroupsOfActor

public long getNumberOfGroupsOfActor(long actorId)

Description copied from interface: ActorMappingService

Get the number of groups corresponding to an actor

Specified by:

getNumberOfGroupsOfActor in interface ActorMappingService

Parameters:

actorId - the id of the actor to retrieve the groups from

Returns:

Number of groups mapped to actor

getNumberOfMembershipsOfActor

public long getNumberOfMembershipsOfActor(long actorId)

Description copied from interface: ActorMappingService

Get the number of memberships (role and group) of an actor

Specified by:

getNumberOfMembershipsOfActor in interface ActorMappingService

Parameters:

actorId - the id of the actor to retrieve the memberships from

Returns:

Number of memberships mapped to actor

getActors

public java.util.List<SActor> getActors(java.util.List<java.lang.Long> actorIds)
                                 throws SBonitaReadException

Description copied from interface: ActorMappingService

Get a list of actors by the given list of actor ids

Specified by:

getActors in interface ActorMappingService

Parameters:

actorIds - the list of actor ids to retrieve

Returns:

a list of actors

Throws:

SBonitaReadException

getActor

public SActor getActor(java.lang.String actorName,
                       long scopeId)
                throws SActorNotFoundException

Description copied from interface: ActorMappingService

Get actor by actor name and scope id If the actor by a given actorName and scopeId is not found, it will throw SActorNotFoundException

Specified by:

getActor in interface ActorMappingService

Parameters:

actorName - Name of actor

scopeId - Id of scope, it can be processDefinitionId

Returns:

SActor object corresponding to the given actorName and scopeId

Throws:

SActorNotFoundException - Error thrown if no actor have an id corresponding to the parameter.

updateActor

public SActor updateActor(long actorId,
                          EntityUpdateDescriptor descriptor)
                   throws SActorNotFoundException,
                          SActorUpdateException,
                          SBonitaReadException

Description copied from interface: ActorMappingService

Update actor by its id If the actor by a given actorId is not found, it will throw processDefinitionNotFountExcetion

Specified by:

updateActor in interface ActorMappingService

Parameters:

actorId - Id of actor

descriptor - Update description

Returns:

the updated actor

Throws:

SActorNotFoundException - Error thrown if no actor have an id corresponding to the parameter actorId.

SActorUpdateException - Error thrown if has exceptions while try to update an actor

SBonitaReadException

deleteActors

public void deleteActors(long scopeId)
                  throws SActorDeletionException

Description copied from interface: ActorMappingService

Delete actors in the id specified scope

Specified by:

deleteActors in interface ActorMappingService

Parameters:

scopeId - Id of scope, it can be processDefinitionId

Throws:

SActorDeletionException - Error thrown if has exceptions while try to delete actors

getActors

public java.util.List<SActor> getActors(java.util.Set<java.lang.Long> scopeIds,
                                        java.lang.Long userId)
                                 throws SBonitaReadException

Description copied from interface: ActorMappingService

Get a list of all actors for the id specified user in certain scopes specified by scopeIds

Specified by:

getActors in interface ActorMappingService

Parameters:

scopeIds - Ids of scope, it can be processDefinitionId

userId - Id of user which is added to actor

Returns:

The list of SActor Objects

Throws:

SBonitaReadException

addUserToActor

public SActorMember addUserToActor(long actorId,
                                   long userId)
                            throws SActorMemberCreationException

Description copied from interface: ActorMappingService

Add the userId specified user to the actorId specified actor

Specified by:

addUserToActor in interface ActorMappingService

Parameters:

actorId - Id of actor

userId - Id of user

Returns:

SActorMember object

Throws:

SActorMemberCreationException - Error thrown if has exceptions while try to create the SActorMember object

addGroupToActor

public SActorMember addGroupToActor(long actorId,
                                    long groupId)
                             throws SActorNotFoundException,
                                    SActorMemberCreationException

Description copied from interface: ActorMappingService

Add the groupId specified group to the actorId specified actor

Specified by:

addGroupToActor in interface ActorMappingService

Parameters:

actorId - Id of actor

groupId - Id of group

Returns:

SActorMember object

Throws:

SActorNotFoundException - Error thrown if no actor have an id corresponding to the parameter actorId.

SActorMemberCreationException - Error thrown if has exceptions while try to create the SActorMember object

addRoleToActor

public SActorMember addRoleToActor(long actorId,
                                   long roleId)
                            throws SActorMemberCreationException

Description copied from interface: ActorMappingService

Add the roleId specified role to the actorId specified actor

Specified by:

addRoleToActor in interface ActorMappingService

Parameters:

actorId - Id of actor

roleId - Id of role

Returns:

SActorMember object

Throws:

SActorMemberCreationException - Error thrown if has exceptions while try to create the SActorMember object

addRoleAndGroupToActor

public SActorMember addRoleAndGroupToActor(long actorId,
                                           long roleId,
                                           long groupId)
                                    throws SActorNotFoundException,
                                           SActorMemberCreationException

Description copied from interface: ActorMappingService

Add the roleId and groupId specified relationship to the actorId specified actor

Specified by:

addRoleAndGroupToActor in interface ActorMappingService

Parameters:

actorId - Id of actor

roleId - Id of role

groupId - Id of group

Returns:

SActorMember object

Throws:

SActorNotFoundException - Error thrown if no actor have an id corresponding to the parameter actorId.

SActorMemberCreationException - Error thrown if has exceptions while try to create the SActorMember object

deleteActorMember

public SActorMember deleteActorMember(long actorMemberId)
                               throws SActorMemberNotFoundException,
                                      SActorMemberDeletionException

Description copied from interface: ActorMappingService

Remove actorMember for the give actorMemberId

Specified by:

deleteActorMember in interface ActorMappingService

Parameters:

actorMemberId - Id of actorMember

Throws:

SActorMemberNotFoundException - Error thrown if no actorMember have an id corresponding to the parameter actorMemberId.

SActorMemberDeletionException - Error thrown if has exceptions while try to remove the SActorMember object

deleteActorMember

public void deleteActorMember(SActorMember sActorMember)
                       throws SActorMemberDeletionException

Description copied from interface: ActorMappingService

Remove an actor member

Specified by:

deleteActorMember in interface ActorMappingService

Parameters:

sActorMember - the actorMember to remove

Throws:

SActorMemberDeletionException - Error thrown if has exceptions while try to remove the SActorMember object

getActorMember

public SActorMember getActorMember(long actorId,
                                   long userId,
                                   long groupId,
                                   long roleId)
                            throws SBonitaReadException

Description copied from interface: ActorMappingService

Get the actor member

Specified by:

getActorMember in interface ActorMappingService

Parameters:

actorId - The identifier of the actor

userId - The identifier of the user

groupId - The identifier of the group

roleId - The identifier of the role

Returns:

The corresponding actor member

Throws:

SBonitaReadException

getNumberOfActorMembers

public long getNumberOfActorMembers(long actorId)
                             throws SBonitaReadException

Description copied from interface: ActorMappingService

Get number of ActorMembers for give actorId

Specified by:

getNumberOfActorMembers in interface ActorMappingService

Parameters:

actorId - Id of actor

Returns:

the number of ActorMembers

Throws:

SBonitaReadException

getActorMembers

public java.util.List<SActorMember> getActorMembers(long actorId,
                                                    int fromIndex,
                                                    int numberOfActorMembers)
                                             throws SBonitaReadException

Description copied from interface: ActorMappingService

Get list of SActorMember objects by pagination

Specified by:

getActorMembers in interface ActorMappingService

Parameters:

actorId - Id of actor

fromIndex - Index of the record to be retrieved from. First record has pageNumber 0.

numberOfActorMembers - Number of result we want to get. Maximum number of result returned.

Returns:

List of SActorMember objects, ordered by id ascending

Throws:

SBonitaReadException

getActorMembersOfUser

public java.util.List<SActorMember> getActorMembersOfUser(long userId,
                                                          int fromIndex,
                                                          int numberOfActorMembers)
                                                   throws SBonitaReadException

Description copied from interface: ActorMappingService

Get a list of SActorMember objects for given userId

Specified by:

getActorMembersOfUser in interface ActorMappingService

Parameters:

userId - Id of user

fromIndex - Index of the record to be retrieved from. First record has pageNumber 0.

numberOfActorMembers - Number of result we want to get. Maximum number of result returned.

Returns:

List of SActorMember objects, ordered by id ascending

Throws:

SBonitaReadException

getActorMembersOfGroup

public java.util.List<SActorMember> getActorMembersOfGroup(long groupId,
                                                           int fromIndex,
                                                           int numberOfActorMembers)
                                                    throws SBonitaReadException

Description copied from interface: ActorMappingService

Get a list of SActorMember objects for given groupId

Specified by:

getActorMembersOfGroup in interface ActorMappingService

Parameters:

groupId - Id of group

Returns:

a list of SActorMember objects, ordered by id ascending

Throws:

SBonitaReadException

getActorMembersOfRole

public java.util.List<SActorMember> getActorMembersOfRole(long roleId,
                                                          int fromIndex,
                                                          int numberOfActorMembers)
                                                   throws SBonitaReadException

Description copied from interface: ActorMappingService

Get a list of SActorMember objects for given roleId

Specified by:

getActorMembersOfRole in interface ActorMappingService

Parameters:

roleId - Id of role

Returns:

a list of SActorMember objects, ordered by id ascending

Throws:

SBonitaReadException

canUserStartProcessDefinition

public boolean canUserStartProcessDefinition(long userId,
                                             long processDefinitionId)
                                      throws SBonitaReadException

Description copied from interface: ActorMappingService

Is a specified user allowed to start a process?

Specified by:

canUserStartProcessDefinition in interface ActorMappingService

Parameters:

userId - Id of user

processDefinitionId - Id of processDefinition

Returns:

a list of SActor objects

Throws:

SBonitaReadException

getActors

public java.util.List<SActor> getActors(long processDefinitionId,
                                        QueryOptions queryOptions)
                                 throws SBonitaReadException

Description copied from interface: ActorMappingService

Get paginated actors

Specified by:

getActors in interface ActorMappingService

Parameters:

processDefinitionId - identifier of process definition

Returns:

the list of actors

Throws:

SBonitaReadException

deleteAllActorMembers

public void deleteAllActorMembers()
                           throws SActorMemberDeletionException

Description copied from interface: ActorMappingService

Delete all actor members for the connected tenant

Specified by:

deleteAllActorMembers in interface ActorMappingService

Throws:

SActorMemberDeletionException

getPossibleUserIdsOfActorId

public java.util.List<java.lang.Long> getPossibleUserIdsOfActorId(long actorId,
                                                                  int startIndex,
                                                                  int maxResults)
                                                           throws SBonitaReadException

Specified by:

getPossibleUserIdsOfActorId in interface ActorMappingService

Throws:

SBonitaReadException