com.atlassian.jira.security.roles

Class CachingProjectRoleAndActorStore

java.lang.Object

com.atlassian.jira.security.roles.CachingProjectRoleAndActorStore

All Implemented Interfaces:

ProjectRoleAndActorStore

public class CachingProjectRoleAndActorStore
extends Object
implements ProjectRoleAndActorStore

A caching implementation of the ProjectRoleAndActorStore that delegates to another ProjectRoleAndActorStore.

This class maintains two separate unrelated caches, one for ProjectRoles and another for the actors associated with a Project/ProjectRole combination. These use separate approaches to maintain correctness under concurrent usage.

The caching of the ProjectRoleActors maintains its correctness under concurrent updates/miss population by using ConcurrentMap.putIfAbsent(Object, Object) to store the result of a retrieval operation from the database (non-mutative), but Map.put(Object, Object) to store the result of an update.

Constructor Summary

Constructors

Constructor and Description
CachingProjectRoleAndActorStore(ProjectRoleAndActorStore delegate, RoleActorFactory roleActorFactory, com.atlassian.cache.CacheManager cacheManager, ProjectRoleActorsCacheSettings projectRoleActorsCacheSettings)

Method Summary

Modifier and Type	Method and Description
ProjectRole	addProjectRole(ProjectRole projectRole)
void	applyDefaultsRolesToProject(Project project)
void	clearCaches()
void	deleteProjectRole(ProjectRole projectRole)
Collection<ProjectRole>	getAllProjectRoles()
DefaultRoleActors	getDefaultRoleActors(Long projectRoleId) Get the default ProjectRoleActors for a given project role ID.
Collection<Long>	getProjectIdsContainingRoleActorByKeyAndType(String key, String type)
Map<Long,List<String>>	getProjectIdsForUserInGroupsBecauseOfRole(List<Long> projectsToLimitBy, ProjectRole projectRole, String projectRoleType, String userKey)
ProjectRole	getProjectRole(Long id)
ProjectRoleActors	getProjectRoleActors(Long projectRoleId, Long projectId) Get the ProjectRoleActors for a given project role ID and project ID.
Collection<ProjectRoleActors>	getProjectRoleActorsByRoleId(Long projectRoleId) Get all of the ProjectRoleActors that have a given project role ID, including the default ones (null project).
ProjectRole	getProjectRoleByName(String name)
boolean	isGroupUsed(String group)
Map<Optional<Long>,ProjectRoleActors>	loadRolesFromDelegate(Long key)
void	onClearCache(ClearCacheEvent event)
void	removeAllRoleActorsByKeyAndType(String key, String type)
void	removeAllRoleActorsByProject(Project project)
List<Long>	roleActorOfTypeExistsForProjects(List<Long> projectsToLimitBy, ProjectRole projectRole, String projectRoleType, String projectRoleParameter)
protected com.atlassian.jira.security.roles.CachingProjectRoleAndActorStore.CachedRoleActors	toCachedRoleActor(DefaultRoleActors defaultRoleActors)
void	updateDefaultRoleActors(DefaultRoleActors defaultRoleActors)
void	updateProjectRole(ProjectRole projectRole)
void	updateProjectRoleActors(ProjectRoleActors projectRoleActors)

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingProjectRoleAndActorStore

public CachingProjectRoleAndActorStore(ProjectRoleAndActorStore delegate,
                                       RoleActorFactory roleActorFactory,
                                       com.atlassian.cache.CacheManager cacheManager,
                                       ProjectRoleActorsCacheSettings projectRoleActorsCacheSettings)

Method Detail

getAllProjectRoles

public Collection<ProjectRole> getAllProjectRoles()

Specified by:

getAllProjectRoles in interface ProjectRoleAndActorStore

getProjectRole

public ProjectRole getProjectRole(Long id)

Specified by:

getProjectRole in interface ProjectRoleAndActorStore

getProjectRoleByName

public ProjectRole getProjectRoleByName(String name)

Specified by:

getProjectRoleByName in interface ProjectRoleAndActorStore

addProjectRole

public ProjectRole addProjectRole(ProjectRole projectRole)

Specified by:

addProjectRole in interface ProjectRoleAndActorStore

updateProjectRole

public void updateProjectRole(ProjectRole projectRole)

Specified by:

updateProjectRole in interface ProjectRoleAndActorStore

deleteProjectRole

public void deleteProjectRole(ProjectRole projectRole)

Specified by:

deleteProjectRole in interface ProjectRoleAndActorStore

getDefaultRoleActors

public DefaultRoleActors getDefaultRoleActors(Long projectRoleId)

Description copied from interface: ProjectRoleAndActorStore

Get the default ProjectRoleActors for a given project role ID.

Specified by:

getDefaultRoleActors in interface ProjectRoleAndActorStore

Parameters:

projectRoleId - the ID of the project role.

Returns:

A ProjectRoleActors object containing the default role actors for the given project. If none are found, a ProjectRoleActors object with an empty set will be returned.

getProjectRoleActors

public ProjectRoleActors getProjectRoleActors(@Nonnull
                                              Long projectRoleId,
                                              Long projectId)

Description copied from interface: ProjectRoleAndActorStore

Get the ProjectRoleActors for a given project role ID and project ID.

Specified by:

getProjectRoleActors in interface ProjectRoleAndActorStore

Parameters:

projectRoleId - the ID of the project role.

projectId - the ID of the project.

Returns:

A ProjectRoleActors object containing the role actors for the given project with the given project role id. If none are found, a ProjectRoleActors object with an empty set will be returned.

getProjectRoleActorsByRoleId

public Collection<ProjectRoleActors> getProjectRoleActorsByRoleId(@Nonnull
                                                                  Long projectRoleId)

Description copied from interface: ProjectRoleAndActorStore

Get all of the ProjectRoleActors that have a given project role ID, including the default ones (null project).

Specified by:

getProjectRoleActorsByRoleId in interface ProjectRoleAndActorStore

Parameters:

projectRoleId - the ID of the project role.

Returns:

A set of project role actors for the given project role ID. If there are no ProjectRoleActors for that ID, it will return an empty set.

updateProjectRoleActors

public void updateProjectRoleActors(ProjectRoleActors projectRoleActors)

Specified by:

updateProjectRoleActors in interface ProjectRoleAndActorStore

updateDefaultRoleActors

public void updateDefaultRoleActors(DefaultRoleActors defaultRoleActors)

Specified by:

updateDefaultRoleActors in interface ProjectRoleAndActorStore

applyDefaultsRolesToProject

public void applyDefaultsRolesToProject(Project project)

Specified by:

applyDefaultsRolesToProject in interface ProjectRoleAndActorStore

removeAllRoleActorsByKeyAndType

public void removeAllRoleActorsByKeyAndType(String key,
                                            String type)

Specified by:

removeAllRoleActorsByKeyAndType in interface ProjectRoleAndActorStore

removeAllRoleActorsByProject

public void removeAllRoleActorsByProject(Project project)

Specified by:

removeAllRoleActorsByProject in interface ProjectRoleAndActorStore

getProjectIdsContainingRoleActorByKeyAndType

public Collection<Long> getProjectIdsContainingRoleActorByKeyAndType(String key,
                                                                     String type)

Specified by:

getProjectIdsContainingRoleActorByKeyAndType in interface ProjectRoleAndActorStore

roleActorOfTypeExistsForProjects

public List<Long> roleActorOfTypeExistsForProjects(List<Long> projectsToLimitBy,
                                                   ProjectRole projectRole,
                                                   String projectRoleType,
                                                   String projectRoleParameter)

Specified by:

roleActorOfTypeExistsForProjects in interface ProjectRoleAndActorStore

getProjectIdsForUserInGroupsBecauseOfRole

public Map<Long,List<String>> getProjectIdsForUserInGroupsBecauseOfRole(List<Long> projectsToLimitBy,
                                                                        ProjectRole projectRole,
                                                                        String projectRoleType,
                                                                        String userKey)

Specified by:

getProjectIdsForUserInGroupsBecauseOfRole in interface ProjectRoleAndActorStore

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)

clearCaches

public void clearCaches()

toCachedRoleActor

protected com.atlassian.jira.security.roles.CachingProjectRoleAndActorStore.CachedRoleActors toCachedRoleActor(@Nonnull
                                                                                                               DefaultRoleActors defaultRoleActors)

isGroupUsed

public boolean isGroupUsed(@Nonnull
                           String group)

Specified by:

isGroupUsed in interface ProjectRoleAndActorStore

loadRolesFromDelegate

public Map<Optional<Long>,ProjectRoleActors> loadRolesFromDelegate(@Nonnull
                                                                   Long key)