Summary: Methods | [Expand All]
@PublicSpi public interface

RoleActorFactory

com.atlassian.jira.security.roles.RoleActorFactory
Known Indirect Subclasses

@PublicSpi

This interface is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

Create RoleActor instances.

Summary

Public Methods
ProjectRoleActor createRoleActor(Long id, Long projectRoleId, Long projectId, String type, String parameter)
Create instance of the ProjectRoleActor representing a role actor stored in the database.
@Nonnull Set<ProjectRoleActor> getAllRoleActorsForUser(ApplicationUser user)
Find and return all role actors for the given user.
Set<RoleActor> optimizeRoleActorSet(Set<RoleActor> roleActors)
if RoleActors can be aggregated and queried in a more optimised way, then optimize the set to reduce its size so we reduce the number of iterations across the set.

Public Methods

public ProjectRoleActor createRoleActor (Long id, Long projectRoleId, Long projectId, String type, String parameter)

Create instance of the ProjectRoleActor representing a role actor stored in the database. In order to add a new role actor please pass a null id.

Parameters
id of the ProjectRoleActor
projectRoleId of the ProjectRole associated with the actor.
projectId of the Project associated with the actor.
type of the actor which determines the implementation.
parameter saying with which exact entity is actor associated ie. group name, user name.
Returns
  • implementation representing ProjectRoleActor.
Throws
RoleActorDoesNotExistException

@Nonnull public Set<ProjectRoleActor> getAllRoleActorsForUser (ApplicationUser user)

Find and return all role actors for the given user.

Parameters
user for which actors will be obtained
Returns
  • a set of actors being associated with the given user or empty set if none found.

public Set<RoleActor> optimizeRoleActorSet (Set<RoleActor> roleActors)

if RoleActors can be aggregated and queried in a more optimised way, then optimize the set to reduce its size so we reduce the number of iterations across the set.

Parameters
roleActors a Set of RoleActor instances
Returns
  • the optimized Set perhaps containing aggregations that can be queried more efficiently.