com.atlassian.jira.issue.security

Interface IssueSecurityLevelManager

All Known Implementing Classes:

IssueSecurityLevelManagerImpl

@PublicApi
public interface IssueSecurityLevelManager

Method Summary

Modifier and Type	Method and Description
void	clearProjectLevels(Project project)
void	clearUsersLevels()
IssueSecurityLevel	createIssueSecurityLevel(long schemeId, String name, String description) Creates an Issue Security Level with the given properties.
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() Deprecated. Use getAllIssueSecurityLevels() instead. Since v5.0.
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) Deprecated. Use #getAllSecurityLevelsForUser(com.atlassian.crowd.embedded.api.User) instead. Since v5.0.
Long	getDefaultSecurityLevel(Project project) Returns the default Security Level as defined in the Issue Security Level scheme for the given project.
org.ofbiz.core.entity.GenericValue	getIssueSecurity(Long id) Deprecated. Use getSecurityLevel(long) instead. Since v5.0.
String	getIssueSecurityDescription(Long id)
org.ofbiz.core.entity.GenericValue	getIssueSecurityLevel(Long id) Deprecated. Use getSecurityLevel(long) instead. Since v5.0.
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)
Long	getSchemeDefaultSecurityLevel(org.ofbiz.core.entity.GenericValue project) Deprecated. Use getDefaultSecurityLevel(com.atlassian.jira.project.Project) instead. Since v5.0.
List<org.ofbiz.core.entity.GenericValue>	getSchemeIssueSecurityLevels(Long schemeId) Deprecated. Use getIssueSecurityLevels(long) instead. Since v5.0.
IssueSecurityLevel	getSecurityLevel(long id) Returns the IssueSecurityLevel with the given ID.
Collection<org.ofbiz.core.entity.GenericValue>	getSecurityLevelsByName(String securityLevelName) Deprecated. Use getIssueSecurityLevelsByName(String) instead. Since v5.0.
Collection<IssueSecurityLevel>	getSecurityLevelsForUserByName(ApplicationUser user, String securityLevelName) Get the different levels of security that a user can see that have the specified name.
List<org.ofbiz.core.entity.GenericValue>	getUsersSecurityLevels(org.ofbiz.core.entity.GenericValue entity, ApplicationUser user) Deprecated. Use #getUsersSecurityLevels(Issue, User) or#getUsersSecurityLevels(Project, User) instead. Since v5.0.
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.
Collection<org.ofbiz.core.entity.GenericValue>	getUsersSecurityLevelsByName(ApplicationUser user, String securityLevelName) Deprecated. Use #getSecurityLevelsForUserByName(com.atlassian.crowd.embedded.api.User, String) instead. Since v5.0.
boolean	schemeIssueSecurityExists(Long id) Deprecated. Use getSecurityLevel(long) != null instead. Since v5.0.

Method Detail

getSchemeIssueSecurityLevels

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

Deprecated. Use getIssueSecurityLevels(long) instead. Since v5.0.

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

Parameters:

schemeId - ID of the Issue Security Level Scheme.

Returns:

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

getIssueSecurityLevels

List<IssueSecurityLevel> getIssueSecurityLevels(long schemeId)

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

Parameters:

schemeId - ID of the Issue Security Level Scheme.

Returns:

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

Since:

v5.0

schemeIssueSecurityExists

boolean schemeIssueSecurityExists(Long id)

Deprecated. Use getSecurityLevel(long) != null instead. Since v5.0.

Parameters:

id - IssueSecurityLevel ID

Returns:

true if exists

getIssueSecurityName

String getIssueSecurityName(Long id)

getIssueSecurityDescription

String getIssueSecurityDescription(Long id)

getIssueSecurity

org.ofbiz.core.entity.GenericValue getIssueSecurity(Long id)

Deprecated. Use getSecurityLevel(long) instead. Since v5.0.

Returns the IssueSecurityLevel with the given ID.

Parameters:

id - the ID

Returns:

the IssueSecurityLevel with the given ID.

getSecurityLevel

IssueSecurityLevel getSecurityLevel(long id)

Returns the IssueSecurityLevel with the given ID.

Parameters:

id - the ID

Returns:

the IssueSecurityLevel with the given ID.

Since:

v5.0

createIssueSecurityLevel

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

Creates an Issue Security Level with the given properties.

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

getUsersSecurityLevels

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

Deprecated. Use #getUsersSecurityLevels(Issue, User) or#getUsersSecurityLevels(Project, User) instead. Since v5.0.

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

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:

list containing the security levels, can be null

Throws:

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

getUsersSecurityLevels

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

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

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

Since:

v5.0

See Also:

#getUsersSecurityLevels(com.atlassian.jira.project.Project, com.atlassian.crowd.embedded.api.User)

getUsersSecurityLevels

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

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 #getUsersSecurityLevels(Issue, User).

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

Since:

v5.0

See Also:

#getUsersSecurityLevels(com.atlassian.jira.issue.Issue, com.atlassian.crowd.embedded.api.User)

getAllUsersSecurityLevels

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

Deprecated. Use #getAllSecurityLevelsForUser(com.atlassian.crowd.embedded.api.User) instead. Since v5.0.

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

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.

Since:

v4.0

getAllSecurityLevelsForUser

@Nonnull
Collection<IssueSecurityLevel> getAllSecurityLevelsForUser(ApplicationUser user)

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

Parameters:

user - The user used for the security check

Returns:

list containing the security levels

Since:

v5.0

getAllSecurityLevels

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

Deprecated. Use getAllIssueSecurityLevels() instead. Since v5.0.

Get all the different levels of security across all schemes.

Returns:

list containing the security levels, can be null

Throws:

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

Since:

v4.0

getAllIssueSecurityLevels

Collection<IssueSecurityLevel> getAllIssueSecurityLevels()

Get all the different levels of security across all schemes.

Returns:

list containing the security levels, can be null

Since:

v5.0

getUsersSecurityLevelsByName

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

Deprecated. Use #getSecurityLevelsForUserByName(com.atlassian.crowd.embedded.api.User, String) instead. Since v5.0.

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

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.

Since:

v4.0

getSecurityLevelsForUserByName

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

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

Parameters:

user - the user

securityLevelName - the name of the security level.

Returns:

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

Since:

v5.0

getSecurityLevelsByName

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

Deprecated. Use getIssueSecurityLevelsByName(String) instead. Since v5.0.

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

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.

Since:

v4.0

getIssueSecurityLevelsByName

Collection<IssueSecurityLevel> getIssueSecurityLevelsByName(String securityLevelName)

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

Parameters:

securityLevelName - the name of the security level.

Returns:

a collection of the IssueSecurityLevels with the specified name.

Since:

v5.0

getSchemeDefaultSecurityLevel

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

Deprecated. Use getDefaultSecurityLevel(com.atlassian.jira.project.Project) instead. Since v5.0.

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

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

Long getDefaultSecurityLevel(Project project)

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

Parameters:

project - the Project

Returns:

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

Since:

v5.0

getIssueSecurityLevel

org.ofbiz.core.entity.GenericValue getIssueSecurityLevel(Long id)
                                                  throws org.ofbiz.core.entity.GenericEntityException

Deprecated. Use getSecurityLevel(long) instead. Since v5.0.

Returns the IssueSecurityLevel with the given ID.

Parameters:

id - the ID

Returns:

the IssueSecurityLevel with the given ID.

Throws:

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

deleteSecurityLevel

void deleteSecurityLevel(Long levelId)

Deletes the given Issue Security Level and any child permissions.

Parameters:

levelId - Issue Security Level ID

clearUsersLevels

@Internal
void clearUsersLevels()

clearProjectLevels

@Internal
void clearProjectLevels(Project project)