com.almworks.jira.structure.api.permissions

Class PermissionRule.SetLevel

java.lang.Object

com.almworks.jira.structure.api.permissions.PermissionRule

com.almworks.jira.structure.api.permissions.PermissionRule.SetLevel

All Implemented Interfaces:

Cloneable

Enclosing class:

PermissionRule

public static class PermissionRule.SetLevel
extends PermissionRule

This rule sets the permission level to a specific value in case the user matches PermissionSubject.

See Also:

PermissionSubject

Nested Class Summary

Nested classes/interfaces inherited from class com.almworks.jira.structure.api.permissions.PermissionRule

PermissionRule.ApplyStructure, PermissionRule.SetLevel

Constructor Summary

Constructors

Constructor and Description
SetLevel()
SetLevel(PermissionSubject subject, PermissionLevel level)

Method Summary

Modifier and Type	Method and Description
PermissionLevel	apply(com.atlassian.jira.user.ApplicationUser user, PermissionLevel pass, List<Object> callStack, La<Long,List<PermissionRule>> resolver) Apply permission rule and return the result.
PermissionRule.SetLevel	clone()
boolean	equals(Object o)
PermissionLevel	getLevel()
PermissionSubject	getSubject()
int	hashCode()
void	setLevel(PermissionLevel level)
void	setSubject(PermissionSubject subject)
String	toEncodedString()

Methods inherited from class com.almworks.jira.structure.api.permissions.PermissionRule

decodePermissions, encodePermissions, fromEncodedString, fromEncodedString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SetLevel

public SetLevel()

SetLevel

public SetLevel(PermissionSubject subject,
                PermissionLevel level)

Method Detail

clone

public PermissionRule.SetLevel clone()

Overrides:

clone in class PermissionRule

Returns:

a cloned version of this rule

apply

@NotNull
public PermissionLevel apply(com.atlassian.jira.user.ApplicationUser user,
                                      @NotNull
                                      PermissionLevel pass,
                                      List<Object> callStack,
                                      La<Long,List<PermissionRule>> resolver)

Description copied from class: PermissionRule

Apply permission rule and return the result.

Normally you should not call this method directly - call com.almworks.jira.structure.api.Structure#getEffectivePermission instead.

Specified by:

apply in class PermissionRule

Parameters:

user - the user, null means anonymous

pass - the default value, which is returned in case this rule does not apply

callStack - auxiliary container for objects used to check for recursive rules

resolver - auxiliary function that converts structure ID into associated list of permission rules - used by PermissionRule.ApplyStructure. If null, PermissionRule.ApplyStructure will not be able to apply and return pass value.

Returns:

permission level for the passed user

getSubject

public PermissionSubject getSubject()

setSubject

public void setSubject(PermissionSubject subject)

getLevel

public PermissionLevel getLevel()

setLevel

public void setLevel(PermissionLevel level)

toEncodedString

public String toEncodedString()

Specified by:

toEncodedString in class PermissionRule

Returns:

a string representation of this permission rule

See Also:

PermissionRule.fromEncodedString(java.lang.String)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object