com.atlassian.jira.security.type

Class ProjectLead

java.lang.Object

com.atlassian.jira.security.type.AbstractSecurityType

com.atlassian.jira.security.type.AbstractProjectsSecurityType

com.atlassian.jira.security.type.ProjectLead

All Implemented Interfaces:

SchemeType, SecurityType

public class ProjectLead
extends AbstractProjectsSecurityType

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESC

Constructor Summary

Constructors

Constructor and Description
ProjectLead(JiraAuthenticationContext jiraAuthenticationContext)

Method Summary

Modifier and Type	Method and Description
void	doValidation(String key, Map parameters, JiraServiceContext jiraServiceContext)
String	getDisplayName()
Set<org.apache.lucene.util.BytesRef>	getPermissionFieldContents(ApplicationUser searcher, Project project, IssueSecurityLevel securityLevel, String parameter) Returns a set of (issue level permission field) contents based on the security level, the project and optionally the parameter (for role-based queries).
String	getType()
Set<ApplicationUser>	getUsers(PermissionContext ctx, String ignored) Returns a list of ApplicationUsers represented by a security type instance.
boolean	hasPermission(Issue issue, String parameter) Determines if this permission type is satisfied for anonymous access.
boolean	hasPermission(Issue issue, String parameter, ApplicationUser user, boolean issueCreation) Determines if this permission type is satisfied.
boolean	hasPermission(Project project, String argument) Determines if this permission type is satisfied for anonymous access.
boolean	hasPermission(Project project, String argument, ApplicationUser user, boolean issueCreation) Determines if this permission type is satisfied.
boolean	isTopLevelIssueSecurityPermission() Returns true if this permission depends only on a issue security level value and not on project or any field value.

Methods inherited from class com.atlassian.jira.security.type.AbstractProjectsSecurityType

getPermissionFieldContents, getPermissionFieldContents, isTopLevelProjectPermission

Methods inherited from class com.atlassian.jira.security.type.AbstractSecurityType

getArgumentDisplay, isValidForPermission

Methods inherited from class java.lang.Object

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

Field Detail

DESC

public static final String DESC

See Also:

Constant Field Values

Constructor Detail

ProjectLead

public ProjectLead(JiraAuthenticationContext jiraAuthenticationContext)

Method Detail

getDisplayName

public String getDisplayName()

getType

public String getType()

hasPermission

public boolean hasPermission(Project project,
                             String argument)

Description copied from interface: SchemeType

Determines if this permission type is satisfied for anonymous access.

Parameters:

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

argument - If this particular SchemeType has been configured with a parameter, then this parameter is passed (eg. Group Name for GroupDropdown)

Returns:

true if anonymous Users have this permission.

hasPermission

public boolean hasPermission(Issue issue,
                             String parameter)

Description copied from interface: SchemeType

Determines if this permission type is satisfied for anonymous access.

Parameters:

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

parameter - If this particular SchemeType has been configured with a parameter, then this parameter is passed (eg. Group Name for GroupDropdown)

Returns:

true if anonymous Users have this permission.

hasPermission

public boolean hasPermission(Project project,
                             String argument,
                             ApplicationUser user,
                             boolean issueCreation)

Description copied from interface: SchemeType

Determines if this permission type is satisfied.

Parameters:

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

argument - If this particular SchemeType has been configured with a parameter, then this parameter is passed (eg. Group Name for GroupDropdown)

user - The user for whom the permission is being checked

issueCreation - Whether this permission is being checked during issue creation

Returns:

true if the given User has this permission.

hasPermission

public boolean hasPermission(Issue issue,
                             String parameter,
                             ApplicationUser user,
                             boolean issueCreation)

Description copied from interface: SchemeType

Determines if this permission type is satisfied.

Parameters:

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

parameter - If this particular SchemeType has been configured with a parameter, then this parameter is passed (eg. Group Name for GroupDropdown)

user - The user for whom the permission is being checked

issueCreation - Whether this permission is being checked during issue creation

Returns:

true if the given User has this permission.

doValidation

public void doValidation(String key,
                         Map parameters,
                         JiraServiceContext jiraServiceContext)

getUsers

public Set<ApplicationUser> getUsers(PermissionContext ctx,
                                     String ignored)

Description copied from interface: SecurityType

Returns a list of ApplicationUsers represented by a security type instance. The collection must not contain any nulls.

Parameters:

ctx - The current issue and project

ignored - Instance value, eg. a group name, user name, custom field id

Returns:

A set of ApplicationUsers.

isTopLevelIssueSecurityPermission

public boolean isTopLevelIssueSecurityPermission()

Description copied from interface: SecurityType

Returns true if this permission depends only on a issue security level value and not on project or any field value. Used for optimisation.

Specified by:

isTopLevelIssueSecurityPermission in interface SecurityType

Overrides:

isTopLevelIssueSecurityPermission in class AbstractProjectsSecurityType

getPermissionFieldContents

public Set<org.apache.lucene.util.BytesRef> getPermissionFieldContents(ApplicationUser searcher,
                                                                       Project project,
                                                                       IssueSecurityLevel securityLevel,
                                                                       String parameter)

Description copied from interface: SecurityType

Returns a set of (issue level permission field) contents based on the security level, the project and optionally the parameter (for role-based queries). This is needed to build issue security level query.

Specified by:

getPermissionFieldContents in interface SecurityType

Overrides:

getPermissionFieldContents in class AbstractProjectsSecurityType

Parameters:

searcher - The searcher conducting the search

project - The project for which we're constructing a query

securityLevel - The security level for which we are constructing the permissions field contents

parameter - Parameter identifying user related field (reporter, assignee, etc)

Returns:

A set of Lucene permissions field tuples

See Also:

SecurityIndexingUtils