Package com.atlassian.jira.issue.security

Class IssueSecurityLevelManagerImpl

java.lang.Object

com.atlassian.jira.issue.security.IssueSecurityLevelManagerImpl

All Implemented Interfaces:

InitializingComponent, IssueSecurityLevelManager

public class IssueSecurityLevelManagerImpl
extends Object
implements IssueSecurityLevelManager, InitializingComponent

This class gets a list of all the security that can be part of a issue security scheme

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.log4j.Logger	log

Constructor Summary

Constructors

Constructor

Description

IssueSecurityLevelManagerImpl(IssueSecuritySchemeManager issueSecuritySchemeManager, SecurityTypeManager securityTypeManager, ProjectManager projectManager, PermissionManager permissionManager, EntityEngine entityEngine, com.atlassian.cache.CacheManager cacheManager, QueryDslAccessor queryDslAccessor, ApplicationProperties applicationProperties, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method	Description
void	afterInstantiation()	Called after all the beans are constructed and the ApplicationContext is fully populated.
void	clearProjectLevels(Project project)	Clears the User security Level Map.
void	clearUsersLevels()	Clears the User security Level Map.
IssueSecurityLevel	createIssueSecurityLevel(long schemeId, String name, String description)	Creates an Issue Security Level with the given properties.
IssueSecurityLevel	createIssueSecurityLevel(IssueSecurityLevel level)	Creates an Issue Security Level with the same properties as in provided Issue Security Level.
void	deleteSecurityLevel(Long levelId)	Deletes the given Issue Security Level and any child permissions.
Collection<IssueSecurityLevel>	getAllIssueSecurityLevels()	Get all the different levels of security across all schemes.
Collection<org.ofbiz.core.entity.GenericValue>	getAllSecurityLevels()	Get all the different levels of security across all schemes.
Collection<IssueSecurityLevel>	getAllSecurityLevelsForUser(ApplicationUser user)	Get the different levels of security that the user can see across all projects.
Collection<org.ofbiz.core.entity.GenericValue>	getAllUsersSecurityLevels(ApplicationUser user)	Get the different levels of security that the user can see across all projects.
Long	getDefaultSecurityLevel(Project project)	Returns the default Security Level as defined in the Issue Security Level scheme for the given project.
Long	getIssueCount(Long issueSecurityLevelId, Long projectId)	Get the count of issues at the given security level for a project.
org.ofbiz.core.entity.GenericValue	getIssueSecurity(Long id)	Returns the IssueSecurityLevel with the given ID.
String	getIssueSecurityDescription(Long id)
org.ofbiz.core.entity.GenericValue	getIssueSecurityLevel(Long id)	Returns the IssueSecurityLevel with the given ID.
List<IssueSecurityLevel>	getIssueSecurityLevels(long schemeId)	Returns the list of Security Levels for the given Issue Security Level Scheme.
Collection<IssueSecurityLevel>	getIssueSecurityLevelsByName(String securityLevelName)	Get the different levels of security that have the specified name.
String	getIssueSecurityName(Long id)	Get the name of the issue security
Long	getSchemeDefaultSecurityLevel(org.ofbiz.core.entity.GenericValue project)	Returns the default Security Level as defined in the Issue Security Level scheme for the given project.
List<org.ofbiz.core.entity.GenericValue>	getSchemeIssueSecurityLevels(Long schemeId)	Returns the list of Security Levels for the given Issue Security Level Scheme.
IssueSecurityLevel	getSecurityLevel(long id)	Returns the IssueSecurityLevel with the given ID.
IssueSecurityLevel	getSecurityLevelByNameAndSchema(String securityLevelName, Long schemaId)	Get the level with specified name and schemaId.
Collection<org.ofbiz.core.entity.GenericValue>	getSecurityLevelsByName(String securityLevelName)	Get the different levels of security that have the specified name.
Collection<IssueSecurityLevel>	getSecurityLevelsForUserByName(ApplicationUser user, String securityLevelName)	Get the different levels of security that a user can see that have the specified name.
List<IssueSecurityLevel>	getUsersSecurityLevels(Issue issue, ApplicationUser user)	Get the different levels of security that can be set for this issue.
List<IssueSecurityLevel>	getUsersSecurityLevels(Project project, ApplicationUser user)	Get the different levels of security that can be set for an issue created in this project.
List<org.ofbiz.core.entity.GenericValue>	getUsersSecurityLevels(org.ofbiz.core.entity.GenericValue entity, ApplicationUser user)	Get the different levels of security that can be set for this issue.
Collection<org.ofbiz.core.entity.GenericValue>	getUsersSecurityLevelsByName(ApplicationUser user, String securityLevelName)	Get the different levels of security that a user can see that have the specified name.
void	onClearCache(ClearCacheEvent event)
void	onEvent(IssueSecuritySchemeDeletedEvent event)
boolean	schemeIssueSecurityExists(Long id)	Checks to see if the issue security exists
IssueSecurityLevel	updateIssueSecurityLevel(IssueSecurityLevel issueSecurityLevel)	Updates the name and/or description of security level.

Methods inherited from class java.lang.Object

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

Field Details

log

protected final org.apache.log4j.Logger log

Constructor Details

IssueSecurityLevelManagerImpl

public IssueSecurityLevelManagerImpl(IssueSecuritySchemeManager issueSecuritySchemeManager,
 SecurityTypeManager securityTypeManager,
 ProjectManager projectManager,
 PermissionManager permissionManager,
 EntityEngine entityEngine,
 com.atlassian.cache.CacheManager cacheManager,
 QueryDslAccessor queryDslAccessor,
 ApplicationProperties applicationProperties,
 com.atlassian.event.api.EventPublisher eventPublisher)

Method Details

afterInstantiation

public void afterInstantiation()
                        throws Exception

Description copied from interface: InitializingComponent

Called after all the beans are constructed and the ApplicationContext is fully populated. Order of execution is order of bean creation, driven by InitializingComponentProcessor.

Specified by:

afterInstantiation in interface InitializingComponent

Throws:

Exception

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)

onEvent

@EventListener
public void onEvent(IssueSecuritySchemeDeletedEvent event)

getSchemeIssueSecurityLevels

public List<org.ofbiz.core.entity.GenericValue> getSchemeIssueSecurityLevels(Long schemeId)

Description copied from interface: IssueSecurityLevelManager

Returns the list of Security Levels for the given Issue Security Level Scheme.

Specified by:

getSchemeIssueSecurityLevels in interface IssueSecurityLevelManager

Parameters:

schemeId - ID of the Issue Security Level Scheme.

Returns:

the list of Security Levels for the given Issue Security Level Scheme.

getIssueSecurityLevels

public List<IssueSecurityLevel> getIssueSecurityLevels(long schemeId)

Description copied from interface: IssueSecurityLevelManager

Returns the list of Security Levels for the given Issue Security Level Scheme. The elements are ordered by name.

Specified by:

getIssueSecurityLevels in interface IssueSecurityLevelManager

Parameters:

schemeId - ID of the Issue Security Level Scheme.

Returns:

the list of Security Levels for the given Issue Security Level Scheme.

getIssueSecurity

@Nullable
public org.ofbiz.core.entity.GenericValue getIssueSecurity(@Nonnull
 Long id)

Description copied from interface: IssueSecurityLevelManager

Returns the IssueSecurityLevel with the given ID.

Specified by:

getIssueSecurity in interface IssueSecurityLevelManager

Parameters:

id - the ID

Returns:

the IssueSecurityLevel with the given ID. May be null if you pass an invalid id.

getSecurityLevel

public IssueSecurityLevel getSecurityLevel(long id)

Description copied from interface: IssueSecurityLevelManager

Returns the IssueSecurityLevel with the given ID.

Specified by:

getSecurityLevel in interface IssueSecurityLevelManager

Parameters:

id - the ID

Returns:

the IssueSecurityLevel with the given ID.

createIssueSecurityLevel

public IssueSecurityLevel createIssueSecurityLevel(long schemeId,
 String name,
 String description)

Description copied from interface: IssueSecurityLevelManager

Creates an Issue Security Level with the given properties.

Specified by:

createIssueSecurityLevel in interface IssueSecurityLevelManager

Parameters:

schemeId - The Issue security scheme that this level belongs to.

name - The name of the new level

description - an optional description

Returns:

the newly created Issue Security Level

getSecurityLevelByNameAndSchema

public IssueSecurityLevel getSecurityLevelByNameAndSchema(String securityLevelName,
 Long schemaId)

Description copied from interface: IssueSecurityLevelManager

Get the level with specified name and schemaId.

Specified by:

getSecurityLevelByNameAndSchema in interface IssueSecurityLevelManager

Parameters:

securityLevelName - the name of the security level.

schemaId - the id of security schema.

Returns:

the IssueSecurityLevel with the specified name and security level if was found, null otherwise.

createIssueSecurityLevel

public IssueSecurityLevel createIssueSecurityLevel(IssueSecurityLevel level)

Description copied from interface: IssueSecurityLevelManager

Creates an Issue Security Level with the same properties as in provided Issue Security Level.

Specified by:

createIssueSecurityLevel in interface IssueSecurityLevelManager

Parameters:

level - The Issue security level to be created.

Returns:

the newly created Issue Security Level

updateIssueSecurityLevel

public IssueSecurityLevel updateIssueSecurityLevel(IssueSecurityLevel issueSecurityLevel)

Description copied from interface: IssueSecurityLevelManager

Updates the name and/or description of security level.

Specified by:

updateIssueSecurityLevel in interface IssueSecurityLevelManager

Parameters:

issueSecurityLevel - the level to update

schemeIssueSecurityExists

public boolean schemeIssueSecurityExists(Long id)

Checks to see if the issue security exists

Specified by:

schemeIssueSecurityExists in interface IssueSecurityLevelManager

Parameters:

id - The security Id

Returns:

True / False

getIssueSecurityName

public String getIssueSecurityName(Long id)

Get the name of the issue security

Specified by:

getIssueSecurityName in interface IssueSecurityLevelManager

Parameters:

id - The security Id

Returns:

The name of the security

getIssueSecurityDescription

public String getIssueSecurityDescription(Long id)

Specified by:

getIssueSecurityDescription in interface IssueSecurityLevelManager

getUsersSecurityLevels

public List<org.ofbiz.core.entity.GenericValue> getUsersSecurityLevels(org.ofbiz.core.entity.GenericValue entity,
 @Nullable
 ApplicationUser user)
                                                                throws org.ofbiz.core.entity.GenericEntityException

Get the different levels of security that can be set for this issue.

When editing an Issue, then you would pass in the GenericValue for the Issue. When creating an Issue, the project is passed in.

Specified by:

getUsersSecurityLevels in interface IssueSecurityLevelManager

Parameters:

entity - This is the issue or the project that the security is being checked for

user - The user used for the security check

Returns:

an unmodifiable List containing the security levels

Throws:

org.ofbiz.core.entity.GenericEntityException

getUsersSecurityLevels

public List<IssueSecurityLevel> getUsersSecurityLevels(Issue issue,
 ApplicationUser user)

Description copied from interface: IssueSecurityLevelManager

Get the different levels of security that can be set for this issue. If you are creating a new Issue, then use IssueSecurityLevelManager.getUsersSecurityLevels(com.atlassian.jira.project.Project, ApplicationUser).

Specified by:

getUsersSecurityLevels in interface IssueSecurityLevelManager

Parameters:

issue - This is the issue that the security is being checked for

user - The user used for the security check

Returns:

list containing the security levels, can be null

See Also:

• IssueSecurityLevelManager.getUsersSecurityLevels(com.atlassian.jira.project.Project, ApplicationUser)

getUsersSecurityLevels

public List<IssueSecurityLevel> getUsersSecurityLevels(Project project,
 ApplicationUser user)

Description copied from interface: IssueSecurityLevelManager

Get the different levels of security that can be set for an issue created in this project. If you are editing an existing Issue, then use IssueSecurityLevelManager.getUsersSecurityLevels(Issue, ApplicationUser).

Specified by:

getUsersSecurityLevels in interface IssueSecurityLevelManager

Parameters:

project - the project that the security is being checked for

user - The user used for the security check

Returns:

list containing the security levels, can be null

See Also:

• IssueSecurityLevelManager.getUsersSecurityLevels(com.atlassian.jira.issue.Issue, ApplicationUser)

getAllUsersSecurityLevels

public Collection<org.ofbiz.core.entity.GenericValue> getAllUsersSecurityLevels(ApplicationUser user)
                                                                         throws org.ofbiz.core.entity.GenericEntityException

Description copied from interface: IssueSecurityLevelManager

Get the different levels of security that the user can see across all projects.

Specified by:

getAllUsersSecurityLevels in interface IssueSecurityLevelManager

Parameters:

user - The user used for the security check

Returns:

list containing the security levels, can be null

Throws:

org.ofbiz.core.entity.GenericEntityException - Exception in the OFBiz persistence layer.

getAllSecurityLevelsForUser

@Nonnull
public Collection<IssueSecurityLevel> getAllSecurityLevelsForUser(ApplicationUser user)

Description copied from interface: IssueSecurityLevelManager

Get the different levels of security that the user can see across all projects.

Specified by:

getAllSecurityLevelsForUser in interface IssueSecurityLevelManager

Parameters:

user - The user used for the security check

Returns:

list containing the security levels

getAllSecurityLevels

public Collection<org.ofbiz.core.entity.GenericValue> getAllSecurityLevels()
                                                                    throws org.ofbiz.core.entity.GenericEntityException

Description copied from interface: IssueSecurityLevelManager

Get all the different levels of security across all schemes.

Specified by:

getAllSecurityLevels in interface IssueSecurityLevelManager

Returns:

list containing the security levels, can be null

Throws:

org.ofbiz.core.entity.GenericEntityException - Exception in the OFBiz persistence layer.

getAllIssueSecurityLevels

public Collection<IssueSecurityLevel> getAllIssueSecurityLevels()

Description copied from interface: IssueSecurityLevelManager

Get all the different levels of security across all schemes.

Specified by:

getAllIssueSecurityLevels in interface IssueSecurityLevelManager

Returns:

list containing the security levels, can be null

getUsersSecurityLevelsByName

public Collection<org.ofbiz.core.entity.GenericValue> getUsersSecurityLevelsByName(ApplicationUser user,
 String securityLevelName)
                                                                            throws org.ofbiz.core.entity.GenericEntityException

Description copied from interface: IssueSecurityLevelManager

Get the different levels of security that a user can see that have the specified name.

Specified by:

getUsersSecurityLevelsByName in interface IssueSecurityLevelManager

Parameters:

user - the user

securityLevelName - the name of the security level.

Returns:

a collection of the GenericValues representing each level they can see with the specified name.

Throws:

org.ofbiz.core.entity.GenericEntityException - Exception in the OFBiz persistence layer.

getSecurityLevelsForUserByName

public Collection<IssueSecurityLevel> getSecurityLevelsForUserByName(ApplicationUser user,
 String securityLevelName)

Description copied from interface: IssueSecurityLevelManager

Get the different levels of security that a user can see that have the specified name.

Specified by:

getSecurityLevelsForUserByName in interface IssueSecurityLevelManager

Parameters:

user - the user

securityLevelName - the name of the security level.

Returns:

a collection of each IssueSecurityLevel they can see with the specified name.

getSecurityLevelsByName

public Collection<org.ofbiz.core.entity.GenericValue> getSecurityLevelsByName(String securityLevelName)
                                                                       throws org.ofbiz.core.entity.GenericEntityException

Description copied from interface: IssueSecurityLevelManager

Get the different levels of security that have the specified name.

Specified by:

getSecurityLevelsByName in interface IssueSecurityLevelManager

Parameters:

securityLevelName - the name of the security level.

Returns:

a collection of the GenericValues representing each level with the specified name.

Throws:

org.ofbiz.core.entity.GenericEntityException - Exception in the OFBiz persistence layer.

getIssueSecurityLevelsByName

public Collection<IssueSecurityLevel> getIssueSecurityLevelsByName(String securityLevelName)

Description copied from interface: IssueSecurityLevelManager

Get the different levels of security that have the specified name.

Specified by:

getIssueSecurityLevelsByName in interface IssueSecurityLevelManager

Parameters:

securityLevelName - the name of the security level.

Returns:

a collection of the IssueSecurityLevels with the specified name.

getSchemeDefaultSecurityLevel

public Long getSchemeDefaultSecurityLevel(org.ofbiz.core.entity.GenericValue project)
                                   throws org.ofbiz.core.entity.GenericEntityException

Description copied from interface: IssueSecurityLevelManager

Returns the default Security Level as defined in the Issue Security Level scheme for the given project.

Specified by:

getSchemeDefaultSecurityLevel in interface IssueSecurityLevelManager

Parameters:

project - the Project

Returns:

the default Security Level as defined in the Issue Security Level scheme for the given project. Can be null.

Throws:

org.ofbiz.core.entity.GenericEntityException - Exception in the OFBiz persistence layer.

getDefaultSecurityLevel

public Long getDefaultSecurityLevel(Project project)

Description copied from interface: IssueSecurityLevelManager

Returns the default Security Level as defined in the Issue Security Level scheme for the given project.

Specified by:

getDefaultSecurityLevel in interface IssueSecurityLevelManager

Parameters:

project - the Project

Returns:

the default Security Level as defined in the Issue Security Level scheme for the given project. Can be null.

getIssueSecurityLevel

public org.ofbiz.core.entity.GenericValue getIssueSecurityLevel(Long id)

Description copied from interface: IssueSecurityLevelManager

Returns the IssueSecurityLevel with the given ID.

Specified by:

getIssueSecurityLevel in interface IssueSecurityLevelManager

Parameters:

id - the ID

Returns:

the IssueSecurityLevel with the given ID.

deleteSecurityLevel

public void deleteSecurityLevel(Long levelId)

Description copied from interface: IssueSecurityLevelManager

Deletes the given Issue Security Level and any child permissions.

Specified by:

deleteSecurityLevel in interface IssueSecurityLevelManager

Parameters:

levelId - Issue Security Level ID

clearUsersLevels

public void clearUsersLevels()

Clears the User security Level Map. This is done when security records are added or deleted

Specified by:

clearUsersLevels in interface IssueSecurityLevelManager

clearProjectLevels

public void clearProjectLevels(Project project)

Clears the User security Level Map. This is done when security records are added or deleted

Specified by:

clearProjectLevels in interface IssueSecurityLevelManager

getIssueCount

public Long getIssueCount(@Nullable
 Long issueSecurityLevelId,
 @Nonnull
 Long projectId)

Description copied from interface: IssueSecurityLevelManager

Get the count of issues at the given security level for a project.

Specified by:

getIssueCount in interface IssueSecurityLevelManager

Parameters:

issueSecurityLevelId - Issue Security Level

projectId - Project

Returns:

count of issues at the given security level for a project.