com.atlassian.jira.issue.security

Class IssueSecuritySchemeManagerImpl

java.lang.Object

com.atlassian.jira.scheme.AbstractSchemeManager

com.atlassian.jira.issue.security.IssueSecuritySchemeManagerImpl

All Implemented Interfaces:

GroupConfigurable, Startable, IssueSecuritySchemeManager, SchemeManager

public class IssueSecuritySchemeManagerImpl
extends AbstractSchemeManager
implements IssueSecuritySchemeManager, Startable, GroupConfigurable

Field Summary

Fields inherited from class com.atlassian.jira.scheme.AbstractSchemeManager

eventPublisher, groupManager, schemeFactory, securityTypeManager

Fields inherited from interface com.atlassian.jira.scheme.SchemeManager

PROJECT_ASSOCIATION

Constructor Summary

Constructors

Constructor and Description

IssueSecuritySchemeManagerImpl(ProjectManager projectManager, SecurityTypeManager securityTypeManager, PermissionContextFactory permissionContextFactory, SchemeFactory schemeFactory, com.atlassian.event.api.EventPublisher eventPublisher, OfBizDelegator ofBizDelegator, GroupManager groupManager, NodeAssociationStore nodeAssociationStore, com.atlassian.cache.CacheManager cacheManager, IssueIndexingService issueIndexingService, IssueManager issueManager, TaskManager taskManager, QueryDslAccessor queryDslAccessor, I18nHelper i18nHelper)

Method Summary

Modifier and Type	Method and Description
String	assignSchemeToProject(Project project, Long newSchemeId, Map<Long,Long> oldToNewSecurityLevelMappings) Set the issue security level scheme to be used by the given Project and map any old security levels to new ones.
org.ofbiz.core.entity.GenericValue	copyScheme(org.ofbiz.core.entity.GenericValue oldScheme) This method overrides the AbstractSchemeManager because within Issue Security schemes there is an extra level, which is the table that holds the Security Levels for that Scheme.
org.ofbiz.core.entity.GenericValue	createScheme(String name, String description) Creates a new scheme
protected AbstractSchemeAddedToProjectEvent	createSchemeAddedToProjectEvent(Scheme scheme, Project project)
protected AbstractSchemeCopiedEvent	createSchemeCopiedEvent(Scheme oldScheme, Scheme newScheme)
protected AbstractSchemeEvent	createSchemeCreatedEvent(Scheme scheme)
org.ofbiz.core.entity.GenericValue	createSchemeEntity(org.ofbiz.core.entity.GenericValue scheme, SchemeEntity schemeEntity)
protected Object	createSchemeEntityDeletedEvent(org.ofbiz.core.entity.GenericValue entity)
protected org.ofbiz.core.entity.GenericValue	createSchemeEntityNoEvent(org.ofbiz.core.entity.GenericValue scheme, SchemeEntity schemeEntity)
protected AbstractSchemeRemovedFromProjectEvent	createSchemeRemovedFromProjectEvent(Scheme scheme, Project project)
protected AbstractSchemeUpdatedEvent	createSchemeUpdatedEvent(Scheme scheme, Scheme originalScheme)
void	deleteEntities(Iterable<Long> ids) Deletes a collection of entities from the database.
void	deleteEntity(Long id) Deletes an entity with the given id from the database.
void	deleteScheme(Long id) Deletes a scheme from the database
protected void	flushProjectSchemes()
String	getDefaultDescriptionKey()
String	getDefaultNameKey()
List<org.ofbiz.core.entity.GenericValue>	getEntities(org.ofbiz.core.entity.GenericValue scheme) Get all Scheme entity records for a particular scheme
List<org.ofbiz.core.entity.GenericValue>	getEntities(org.ofbiz.core.entity.GenericValue scheme, Long securityLevelId) Inherited from SchemeManager.
List<org.ofbiz.core.entity.GenericValue>	getEntities(org.ofbiz.core.entity.GenericValue scheme, Long schemeTypeId, String parameter) Get all Generic Value permission records for a particular scheme and permission Id
List<org.ofbiz.core.entity.GenericValue>	getEntities(org.ofbiz.core.entity.GenericValue scheme, String entityTypeId) Inherited from SchemeManager.
List<org.ofbiz.core.entity.GenericValue>	getEntities(org.ofbiz.core.entity.GenericValue scheme, String type, Long schemeTypeId) Get all Generic Value issue security records for a particular scheme, type and Id
List<org.ofbiz.core.entity.GenericValue>	getEntitiesBySecurityLevel(Long securityLevelId) Returns the configured permissions for the given Security Level.
String	getEntityName()
IssueSecurityLevelScheme	getIssueSecurityLevelScheme(Long issueSecuritySchemeId) Returns the IssueSecurityLevelScheme for the given ID.
Collection<IssueSecurityLevelScheme>	getIssueSecurityLevelSchemes() Returns a list containing all defined IssueSecuritySchemes
List<IssueSecurityLevelPermission>	getPermissionsBySecurityLevel(Long securityLevelId) Returns the configured permissions for the given Security Level.
List<Project>	getProjectsUsingScheme(long schemeId) Returns all projects that use the given Issue Security Level Scheme.
String	getSchemeDesc()
String	getSchemeEntityName()
Collection<org.ofbiz.core.entity.GenericValue>	getSchemesContainingEntity(String type, String parameter) This is a method that is meant to quickly get you all the schemes that contain an entity of the specified type and parameter.
boolean	hasSecurityLevelAccess(Issue issue, ApplicationUser user) Checks if the given user has permission to see the Issue Security Level of the given issue.
boolean	isGroupUsed(com.atlassian.crowd.embedded.api.Group group) Determine whether configuration exists for the specified Group.
protected SchemeEntity	makeSchemeEntity(org.ofbiz.core.entity.GenericValue entity)
void	onClearCache(ClearCacheEvent event)
boolean	removeEntities(org.ofbiz.core.entity.GenericValue scheme, Long entityTypeId) Retrieves all the entites for this permission and then removes them.
boolean	removeEntities(String type, String parameter) This method overrides the super implemntation in order to clear cache.
void	setSchemeForProject(Project project, Long schemeId) Set the issue security level scheme to be used by the given Project.
void	start() This method will be called after the plugin system is fully initialised and all components added to the dependency injection framework.

Methods inherited from class com.atlassian.jira.scheme.AbstractSchemeManager

addDefaultSchemeToProject, addDefaultSchemeToProject, addSchemeToProject, addSchemeToProject, copyScheme, createDefaultScheme, createSchemeAndEntities, createSchemeGenericValue, createSchemeNoEvent, createSchemeObject, getApplicationI18n, getAssociatedSchemes, getAssociationType, getDefaultScheme, getDefaultSchemeObject, getEntities, getEntitiesByIds, getEntity, getGroups, getGroups, getNameForCopy, getProjects, getScheme, getScheme, getSchemeFor, getSchemeIdFor, getSchemeObject, getSchemeObject, getSchemeObjects, getSchemes, getSchemes, getUnassociatedSchemes, getUsers, getUsers, getUsers, getUsers, removeSchemesFromProject, removeSchemesFromProject, schemeExists, swapParameterForEntitiesOfType, updateScheme, updateScheme

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.issue.security.IssueSecuritySchemeManager

getSchemeObject

Methods inherited from interface com.atlassian.jira.scheme.SchemeManager

addDefaultSchemeToProject, addDefaultSchemeToProject, addSchemeToProject, addSchemeToProject, copyScheme, createDefaultScheme, createSchemeAndEntities, createSchemeObject, getAssociatedSchemes, getDefaultScheme, getDefaultSchemeObject, getEntities, getEntitiesByIds, getEntity, getGroups, getGroups, getProjects, getScheme, getScheme, getSchemeFor, getSchemeIdFor, getSchemeObject, getSchemeObjects, getSchemes, getSchemes, getUnassociatedSchemes, getUsers, getUsers, getUsers, getUsers, removeSchemesFromProject, removeSchemesFromProject, schemeExists, swapParameterForEntitiesOfType, updateScheme, updateScheme

Methods inherited from interface com.atlassian.jira.config.group.GroupConfigurable

isGroupUsed

Constructor Detail

IssueSecuritySchemeManagerImpl

public IssueSecuritySchemeManagerImpl(ProjectManager projectManager,
                                      SecurityTypeManager securityTypeManager,
                                      PermissionContextFactory permissionContextFactory,
                                      SchemeFactory schemeFactory,
                                      com.atlassian.event.api.EventPublisher eventPublisher,
                                      OfBizDelegator ofBizDelegator,
                                      GroupManager groupManager,
                                      NodeAssociationStore nodeAssociationStore,
                                      com.atlassian.cache.CacheManager cacheManager,
                                      IssueIndexingService issueIndexingService,
                                      IssueManager issueManager,
                                      TaskManager taskManager,
                                      QueryDslAccessor queryDslAccessor,
                                      I18nHelper i18nHelper)

Method Detail

start

public void start()
           throws Exception

Description copied from interface: Startable

This method will be called after the plugin system is fully initialised and all components added to the dependency injection framework.

Specified by:

start in interface Startable

Throws:

Exception - Allows implementations to throw an Exception.

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)

Overrides:

onClearCache in class AbstractSchemeManager

getSchemeEntityName

public String getSchemeEntityName()

Specified by:

getSchemeEntityName in class AbstractSchemeManager

getEntityName

public String getEntityName()

Specified by:

getEntityName in class AbstractSchemeManager

getSchemeDesc

public String getSchemeDesc()

Specified by:

getSchemeDesc in class AbstractSchemeManager

getDefaultNameKey

public String getDefaultNameKey()

Specified by:

getDefaultNameKey in class AbstractSchemeManager

getDefaultDescriptionKey

public String getDefaultDescriptionKey()

Specified by:

getDefaultDescriptionKey in class AbstractSchemeManager

getEntities

public List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme)

Description copied from interface: SchemeManager

Get all Scheme entity records for a particular scheme

Specified by:

getEntities in interface IssueSecuritySchemeManager

Specified by:

getEntities in interface SchemeManager

Overrides:

getEntities in class AbstractSchemeManager

Parameters:

scheme - The scheme that the entities belong to

Returns:

List of (GenericValue) entities

getEntities

public List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme,
                                                            Long securityLevelId)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Description copied from interface: IssueSecuritySchemeManager

Inherited from SchemeManager.

Specified by:

getEntities in interface IssueSecuritySchemeManager

Specified by:

getEntities in interface SchemeManager

Throws:

org.ofbiz.core.entity.GenericEntityException

getIssueSecurityLevelScheme

public IssueSecurityLevelScheme getIssueSecurityLevelScheme(Long issueSecuritySchemeId)

Description copied from interface: IssueSecuritySchemeManager

Returns the IssueSecurityLevelScheme for the given ID.

Specified by:

getIssueSecurityLevelScheme in interface IssueSecuritySchemeManager

Parameters:

issueSecuritySchemeId - Scheme ID

Returns:

the IssueSecurityLevelScheme for the given ID.

getIssueSecurityLevelSchemes

public Collection<IssueSecurityLevelScheme> getIssueSecurityLevelSchemes()

Description copied from interface: IssueSecuritySchemeManager

Returns a list containing all defined IssueSecuritySchemes

Specified by:

getIssueSecurityLevelSchemes in interface IssueSecuritySchemeManager

Returns:

a list of IssueSecuritySchemes

getEntitiesBySecurityLevel

public List<org.ofbiz.core.entity.GenericValue> getEntitiesBySecurityLevel(Long securityLevelId)

Description copied from interface: IssueSecuritySchemeManager

Returns the configured permissions for the given Security Level.

Specified by:

getEntitiesBySecurityLevel in interface IssueSecuritySchemeManager

Parameters:

securityLevelId - the Security Level

Returns:

the configured permissions for the given Security Level.

getPermissionsBySecurityLevel

public List<IssueSecurityLevelPermission> getPermissionsBySecurityLevel(Long securityLevelId)

Description copied from interface: IssueSecuritySchemeManager

Returns the configured permissions for the given Security Level.

Specified by:

getPermissionsBySecurityLevel in interface IssueSecuritySchemeManager

Parameters:

securityLevelId - the Security Level

Returns:

the configured permissions for the given Security Level.

getSchemesContainingEntity

public Collection<org.ofbiz.core.entity.GenericValue> getSchemesContainingEntity(String type,
                                                                                 String parameter)

Description copied from interface: IssueSecuritySchemeManager

This is a method that is meant to quickly get you all the schemes that contain an entity of the specified type and parameter.

Specified by:

getSchemesContainingEntity in interface IssueSecuritySchemeManager

Parameters:

type - is the entity type

parameter - is the scheme entries parameter value

Returns:

Collection of GenericValues that represents a scheme

setSchemeForProject

public void setSchemeForProject(Project project,
                                Long schemeId)

Description copied from interface: IssueSecuritySchemeManager

Set the issue security level scheme to be used by the given Project.

Specified by:

setSchemeForProject in interface IssueSecuritySchemeManager

Parameters:

project - The Project

schemeId - The desired new security level scheme to use - null indicates "no issue security levels".

assignSchemeToProject

public String assignSchemeToProject(@Nonnull
                                    Project project,
                                    Long newSchemeId,
                                    Map<Long,Long> oldToNewSecurityLevelMappings)

Description copied from interface: IssueSecuritySchemeManager

Set the issue security level scheme to be used by the given Project and map any old security levels to new ones.

Specified by:

assignSchemeToProject in interface IssueSecuritySchemeManager

Parameters:

project - The Project

newSchemeId - The desired new security level scheme to use - null indicates "no issue security levels".

oldToNewSecurityLevelMappings - Mappings of old to new security levels. This must not contain null values. '-1' is used to represent the value "none".

Returns:

the URL of the progress page.

getProjectsUsingScheme

public List<Project> getProjectsUsingScheme(long schemeId)

Description copied from interface: IssueSecuritySchemeManager

Returns all projects that use the given Issue Security Level Scheme.

Specified by:

getProjectsUsingScheme in interface IssueSecuritySchemeManager

Parameters:

schemeId - ID of the Issue Security Level Scheme

Returns:

all projects that use the given Issue Security Level Scheme.

getEntities

public List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme,
                                                            Long schemeTypeId,
                                                            String parameter)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Get all Generic Value permission records for a particular scheme and permission Id

Specified by:

getEntities in interface IssueSecuritySchemeManager

Specified by:

getEntities in interface SchemeManager

Parameters:

scheme - The scheme that the permissions belong to

schemeTypeId - The security level Id

parameter - The permission parameter (group name etc)

Returns:

List of (GenericValue) permissions

Throws:

org.ofbiz.core.entity.GenericEntityException

getEntities

public List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme,
                                                            String entityTypeId)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Description copied from interface: IssueSecuritySchemeManager

Inherited from SchemeManager.

Specified by:

getEntities in interface IssueSecuritySchemeManager

Specified by:

getEntities in interface SchemeManager

Throws:

org.ofbiz.core.entity.GenericEntityException

getEntities

public List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme,
                                                            String type,
                                                            Long schemeTypeId)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Get all Generic Value issue security records for a particular scheme, type and Id

Specified by:

getEntities in interface IssueSecuritySchemeManager

Specified by:

getEntities in interface SchemeManager

Parameters:

scheme - The scheme that the permissions belong to

type - The type of the permission(Group, Current Reporter etc)

schemeTypeId - The security level Id

Returns:

List of (GenericValue) permissions

Throws:

org.ofbiz.core.entity.GenericEntityException

createSchemeEntity

public org.ofbiz.core.entity.GenericValue createSchemeEntity(org.ofbiz.core.entity.GenericValue scheme,
                                                             SchemeEntity schemeEntity)
                                                      throws org.ofbiz.core.entity.GenericEntityException

Specified by:

createSchemeEntity in interface SchemeManager

Throws:

org.ofbiz.core.entity.GenericEntityException

createSchemeEntityNoEvent

protected org.ofbiz.core.entity.GenericValue createSchemeEntityNoEvent(org.ofbiz.core.entity.GenericValue scheme,
                                                                       SchemeEntity schemeEntity)
                                                                throws org.ofbiz.core.entity.GenericEntityException

Specified by:

createSchemeEntityNoEvent in class AbstractSchemeManager

Throws:

org.ofbiz.core.entity.GenericEntityException

copyScheme

public org.ofbiz.core.entity.GenericValue copyScheme(org.ofbiz.core.entity.GenericValue oldScheme)
                                              throws org.ofbiz.core.entity.GenericEntityException

This method overrides the AbstractSchemeManager because within Issue Security schemes there is an extra level, which is the table that holds the Security Levels for that Scheme. This is because with Issue Security schemes you can add and delete the different levels of security. With other schemes this is not possible

Specified by:

copyScheme in interface SchemeManager

Overrides:

copyScheme in class AbstractSchemeManager

Parameters:

oldScheme - The permission scheme to be copied

Returns:

The new permission scheme

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

createSchemeCopiedEvent

@Nonnull
protected AbstractSchemeCopiedEvent createSchemeCopiedEvent(@Nonnull
                                                                     Scheme oldScheme,
                                                                     @Nonnull
                                                                     Scheme newScheme)

Specified by:

createSchemeCopiedEvent in class AbstractSchemeManager

hasSecurityLevelAccess

public boolean hasSecurityLevelAccess(@Nonnull
                                      Issue issue,
                                      @Nullable
                                      ApplicationUser user)

Description copied from interface: IssueSecuritySchemeManager

Checks if the given user has permission to see the Issue Security Level of the given issue.

Note that this does not check other permissions.

Specified by:

hasSecurityLevelAccess in interface IssueSecuritySchemeManager

Parameters:

issue - the Issue

user - the User (null for anonymous)

Returns:

true if the user hase Security Level permission for the issue.

createSchemeUpdatedEvent

protected AbstractSchemeUpdatedEvent createSchemeUpdatedEvent(Scheme scheme,
                                                              Scheme originalScheme)

Specified by:

createSchemeUpdatedEvent in class AbstractSchemeManager

deleteScheme

public void deleteScheme(Long id)
                  throws org.ofbiz.core.entity.GenericEntityException

Deletes a scheme from the database

Specified by:

deleteScheme in interface SchemeManager

Overrides:

deleteScheme in class AbstractSchemeManager

Parameters:

id - Id of the scheme to be deleted

Throws:

org.ofbiz.core.entity.GenericEntityException

deleteEntity

public void deleteEntity(Long id)
                  throws DataAccessException

Description copied from interface: SchemeManager

Deletes an entity with the given id from the database.

Specified by:

deleteEntity in interface SchemeManager

Overrides:

deleteEntity in class AbstractSchemeManager

Parameters:

id - The id of the entity to be deleted

Throws:

DataAccessException

deleteEntities

public void deleteEntities(Iterable<Long> ids)

Description copied from interface: SchemeManager

Deletes a collection of entities from the database.

Specified by:

deleteEntities in interface SchemeManager

Overrides:

deleteEntities in class AbstractSchemeManager

Parameters:

ids - a collection entity ids to be deleted.

makeSchemeEntity

protected SchemeEntity makeSchemeEntity(org.ofbiz.core.entity.GenericValue entity)

Specified by:

makeSchemeEntity in class AbstractSchemeManager

createSchemeEntityDeletedEvent

protected Object createSchemeEntityDeletedEvent(org.ofbiz.core.entity.GenericValue entity)

Specified by:

createSchemeEntityDeletedEvent in class AbstractSchemeManager

removeEntities

public boolean removeEntities(org.ofbiz.core.entity.GenericValue scheme,
                              Long entityTypeId)
                       throws RemoveException

Description copied from interface: SchemeManager

Retrieves all the entites for this permission and then removes them.

Specified by:

removeEntities in interface SchemeManager

Overrides:

removeEntities in class AbstractSchemeManager

Parameters:

scheme - to remove entites from must NOT be null

entityTypeId - to remove

Returns:

True all the time (legacy)

Throws:

RemoveException - if the delete fails (DB error)

createScheme

public org.ofbiz.core.entity.GenericValue createScheme(String name,
                                                       String description)
                                                throws org.ofbiz.core.entity.GenericEntityException

Description copied from interface: SchemeManager

Creates a new scheme

Specified by:

createScheme in interface SchemeManager

Overrides:

createScheme in class AbstractSchemeManager

Parameters:

name - The name of the new scheme

description - The description of the new scheme

Returns:

The new scheme object

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

createSchemeCreatedEvent

protected AbstractSchemeEvent createSchemeCreatedEvent(Scheme scheme)

Specified by:

createSchemeCreatedEvent in class AbstractSchemeManager

flushProjectSchemes

protected void flushProjectSchemes()

Overrides:

flushProjectSchemes in class AbstractSchemeManager

removeEntities

public boolean removeEntities(String type,
                              String parameter)
                       throws RemoveException

This method overrides the super implemntation in order to clear cache.

Specified by:

removeEntities in interface SchemeManager

Overrides:

removeEntities in class AbstractSchemeManager

Parameters:

type - type

parameter - parameter

Returns:

the original result of the call to super method

Throws:

RemoveException - if super method throws it

createSchemeAddedToProjectEvent

@Nonnull
protected AbstractSchemeAddedToProjectEvent createSchemeAddedToProjectEvent(Scheme scheme,
                                                                                     Project project)

Specified by:

createSchemeAddedToProjectEvent in class AbstractSchemeManager

createSchemeRemovedFromProjectEvent

@Nonnull
protected AbstractSchemeRemovedFromProjectEvent createSchemeRemovedFromProjectEvent(Scheme scheme,
                                                                                             Project project)

Specified by:

createSchemeRemovedFromProjectEvent in class AbstractSchemeManager

isGroupUsed

public boolean isGroupUsed(@Nonnull
                           com.atlassian.crowd.embedded.api.Group group)

Description copied from interface: GroupConfigurable

Determine whether configuration exists for the specified Group.

Specified by:

isGroupUsed in interface GroupConfigurable

Parameters:

group - that may or may not exist.

Returns:

true if the group is used in the components configuration.