com.atlassian.jira.jql.permission

Class CustomFieldClausePermissionChecker

java.lang.Object

com.atlassian.jira.jql.permission.CustomFieldClausePermissionChecker

All Implemented Interfaces:

ClausePermissionChecker

@NonInjectableComponent
public class CustomFieldClausePermissionChecker
extends Object
implements ClausePermissionChecker

A clause permission checker for custom fields that will check the users permission to see the field and also that the user has permission to see at least one context on the custom field.

Since:

v4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomFieldClausePermissionChecker.DefaultFactory This is a factory so that we don't have a circular dependency on the Field manager.
static interface	CustomFieldClausePermissionChecker.Factory

Constructor Summary

Constructors

Constructor and Description
CustomFieldClausePermissionChecker(CustomField field, FieldManager fieldManager, FieldConfigSchemeClauseContextUtil clauseContextUtil)

Method Summary

Modifier and Type	Method and Description
boolean	hasPermissionToUseClause(ApplicationUser user) Checks to see that the provided user is able to use the clause.
boolean	hasPermissionToUseClause(ApplicationUser user, Set<FieldLayout> fieldLayouts) Checks to see that the provided user is able to use the clause.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFieldClausePermissionChecker

public CustomFieldClausePermissionChecker(CustomField field,
                                          FieldManager fieldManager,
                                          FieldConfigSchemeClauseContextUtil clauseContextUtil)

Method Detail

hasPermissionToUseClause

public boolean hasPermissionToUseClause(ApplicationUser user)

Description copied from interface: ClausePermissionChecker

Checks to see that the provided user is able to use the clause. This may be as simple as determining if the user has permission to see the field that the clause represents.

Specified by:

hasPermissionToUseClause in interface ClausePermissionChecker

Parameters:

user - to check permissions against.

Returns:

true if the user can use this clause, false otherwise.

hasPermissionToUseClause

public boolean hasPermissionToUseClause(ApplicationUser user,
                                        Set<FieldLayout> fieldLayouts)

Description copied from interface: ClausePermissionChecker

Checks to see that the provided user is able to use the clause. This method provides all the FieldLayouts visible to the given user as a shortcut otherwise individual checkers can end up looking this up dozens or even hundreds of times with causes slow downs in our search (see JRADEV-15665).

Specified by:

hasPermissionToUseClause in interface ClausePermissionChecker

Parameters:

user - to check permissions against.

fieldLayouts - The field Layouts available to the given user (value of com.atlassian.jira.issue.fields.FieldManager#getVisibleFieldLayouts(User).

Returns:

true if the user can use this clause, false otherwise.