Package com.almworks.jira.structure.api.permissions

Class PermissionRule

Object

PermissionRule

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

PermissionRule.ApplyStructure, PermissionRule.SetLevel

public abstract class PermissionRule
extends Object
implements Cloneable

A list of PermissionRules is used to define a PermissionLevel for a given user. All possible sub-classes of PermissionRule are listed here as the inner classes.

Author:

Igor Sereda

See Also:

• PermissionRule.SetLevel
• PermissionRule.ApplyStructure
• Structure Permissions (Structure Documentation)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PermissionRule.ApplyStructure	This rules applies a list of rules taken from a Structure, identified by the structure ID.
static class	PermissionRule.SetLevel	This rule sets the permission level to a specific value in case the user matches PermissionSubject.

Constructor Summary

Constructors

Constructor	Description
PermissionRule()

Method Summary

Modifier and Type	Method	Description
abstract PermissionLevel	apply(ApplicationUser user, PermissionLevel pass, List<Object> callStack, La<Long,List<PermissionRule>> resolver)	Apply permission rule and return the result.
PermissionRule	clone()
static List<PermissionRule>	decodePermissions(String s)	Deprecated. Please avoid using this method.
static String	encodePermissions(List<PermissionRule> permissions)	Deprecated. Please avoid using this method.
static PermissionRule	fromEncodedString(String s)	Restores permission rule from its encoded String form.
static PermissionRule	fromEncodedString(String s, boolean usersAsUserNames)	Restores permission rule from its encoded String form.
abstract String	toEncodedString()
String	toString()

Methods inherited from class Object

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

Constructor Details

PermissionRule

public PermissionRule()

Method Details

toEncodedString

public abstract String toEncodedString()

Returns:

a string representation of this permission rule

See Also:

• fromEncodedString(java.lang.String)

apply

@NotNull
public abstract PermissionLevel apply(@Nullable
 ApplicationUser user,
 @NotNull
 PermissionLevel pass,
 @Nullable
 List<Object> callStack,
 @Nullable
 La<Long,List<PermissionRule>> resolver)

Apply permission rule and return the result.

Normally you should not call this method directly - call Structure.getEffectivePermission() instead.

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

fromEncodedString

@Nullable
public static PermissionRule fromEncodedString(@Nullable
 String s)
                                        throws ParseException

Restores permission rule from its encoded String form. In case the string is null or empty, returns null. Use this method only if user keys were used to encode user permissions.

Parameters:

s - encoded string

Returns:

the encoded rule, or null if the string is null or empty

Throws:

ParseException - if the string is not empty, but cannot be translated back to a rule

See Also:

• fromEncodedString(String, boolean)

fromEncodedString

@Nullable
public static PermissionRule fromEncodedString(@Nullable
 String s,
 boolean usersAsUserNames)
                                        throws ParseException

Restores permission rule from its encoded String form. In case the string is null or empty, returns null.

Parameters:

s - encoded string

usersAsUserNames - true if user names were used to encode user permissions (Structure version was less than 2.3), false if user keys were used instead.

Returns:

the encoded rule, or null if the string is null or empty

Throws:

ParseException - if the string is not empty, but cannot be translated back to a rule

encodePermissions

@NotNull
@Deprecated
public static String encodePermissions(@Nullable
 List<PermissionRule> permissions)

Deprecated.

Please avoid using this method. The resulting String can't be decoded if any provided PermissionRule contains "," in its encoded form. Consider using other formats for encoding: JSON or XML.

Utility method to encode a list of PermissionRules.

Parameters:

permissions - a list of permissions

Returns:

a string with encoded permissions, separated by comma

See Also:

• toEncodedString()

decodePermissions

@NotNull
@Deprecated
public static List<PermissionRule> decodePermissions(@Nullable
 String s)
                                              throws ParseException

Deprecated.

Please avoid using this method. It can't decode permission rules if any rule contains "," it its encoded form. Consider using other formats for encoding: JSON or XML.

Utility method to decode a list of PermissionRules.

Parameters:

s - encoded list of permissions, delimited by comma

Returns:

a restored list of rules

Throws:

ParseException - in case any of the parts used to encode a permission rule failed to decode

See Also:

• fromEncodedString(String)

clone

public PermissionRule clone()

Overrides:

clone in class Object

Returns:

a cloned version of this rule

toString

public String toString()

Overrides:

toString in class Object