me.lucko.luckperms.api

Interface PermissionHolder

All Known Subinterfaces:

Group, User

public interface PermissionHolder

An object which holds permissions.

Any changes made to permission holding objects will be lost unless the instance is saved back to the Storage.

Method Summary

Modifier and Type	Method and Description
void	auditTemporaryPermissions() Removes temporary permissions that have expired
void	clearMatching(Predicate<Node> test) Clears any nodes from the holder which pass the predicate
void	clearMatchingTransient(Predicate<Node> test) Clears any transient nodes from the holder which pass the predicate
void	clearMeta() Clears all meta held by the object
void	clearMeta(ContextSet contextSet) Clears all meta held by the object in a specific context
void	clearNodes() Clears all nodes held by the object
void	clearNodes(ContextSet contextSet) Clears all nodes held by the object in a specific context
void	clearParents() Clears all parent groups
void	clearParents(ContextSet contextSet) Clears all parent groups in a specific context
void	clearTransientNodes() Clears all transient permissions the holder has.
Map<String,Boolean>	exportNodes(Contexts contexts, boolean lowerCase) Converts the output of getAllNodesFiltered(Contexts), and expands shorthand permissions.
SortedSet<LocalizedNode>	getAllNodes() Gets a mutable sorted set of the nodes that this object has and inherits.
SortedSet<LocalizedNode>	getAllNodes(Contexts contexts) Gets a mutable sorted set of the nodes that this object has and inherits, filtered by context
Set<LocalizedNode>	getAllNodesFiltered(Contexts contexts) Gets a mutable set of the nodes that this object has and inherits, filtered by context.
CachedData	getCachedData() Gets the holders CachedData cache.
Set<? extends Node>	getEnduringPermissions() Similar to getPermissions(), except without transient permissions.
String	getFriendlyName() Gets a friendly name for this holder, to be displayed in command output, etc.
ImmutableSetMultimap<ImmutableContextSet,Node>	getNodes() Gets the backing multimap containing every permission this holder has.
String	getObjectName() Gets the objects name.
List<Node>	getOwnNodes() Gets a flattened/squashed view of the holders permissions.
Set<Node>	getPermanentPermissionNodes() Processes the nodes and returns the non-temporary ones.
SortedSet<? extends Node>	getPermissions() Gets a sorted set of all held permissions.
Set<Node>	getTemporaryPermissionNodes() Processes the nodes and returns the temporary ones.
ImmutableSetMultimap<ImmutableContextSet,Node>	getTransientNodes() Gets the backing multimap containing every transient permission this holder has.
Set<? extends Node>	getTransientPermissions() Similar to getPermissions(), except without enduring permissions.
Tristate	hasPermission(Node node) Checks to see if the object has a certain permission
Tristate	hasPermission(Node node, NodeEqualityPredicate equalityPredicate) Checks to see if the object has a certain permission
Tristate	hasTransientPermission(Node node) Checks to see if the object has a certain permission
Tristate	hasTransientPermission(Node node, NodeEqualityPredicate equalityPredicate) Checks to see if the object has a certain permission
boolean	inheritsGroup(Group group) Check to see if this holder inherits another group directly
boolean	inheritsGroup(Group group, ContextSet contextSet) Check to see if this holder inherits another group directly
Tristate	inheritsPermission(Node node) Checks to see if the object inherits a certain permission
Tristate	inheritsPermission(Node node, NodeEqualityPredicate equalityPredicate) Checks to see if the object inherits a certain permission
CompletableFuture<Void>	refreshCachedData() Refreshes and applies any changes to the cached holder data.
List<LocalizedNode>	resolveInheritances() Recursively resolves this holders permissions.
List<LocalizedNode>	resolveInheritances(Contexts contexts) Recursively resolves this holders permissions.
DataMutateResult	setPermission(Node node) Sets a permission for the object
default DataMutateResult	setPermissionUnchecked(Node node) Deprecated. now forwards to setPermission(Node).
DataMutateResult	setTransientPermission(Node node) Sets a transient permission for the object
default DataMutateResult	setTransientPermissionUnchecked(Node node) Deprecated. now forwards to setTransientPermission(Node)
DataMutateResult	unsetPermission(Node node) Unsets a permission for the object
default DataMutateResult	unsetPermissionUnchecked(Node node) Deprecated. now forwards to unsetPermission(Node)
DataMutateResult	unsetTransientPermission(Node node) Unsets a transient permission for the object
default DataMutateResult	unsetTransientPermissionUnchecked(Node node) Deprecated. now forwards to unsetTransientPermission(Node)

Method Detail

getObjectName

@Nonnull
String getObjectName()

Gets the objects name.

User.getUuid(), User.getName() or Group.getName() should normally be used instead of this method.

Returns:

the identifier for this object. Either a uuid string or name.

getFriendlyName

@Nonnull
String getFriendlyName()

Gets a friendly name for this holder, to be displayed in command output, etc.

This will always return a value, eventually falling back to getObjectName() if no other "friendlier" identifiers are present.

Returns:

a friendly identifier for this holder

Since:

3.2

getCachedData

@Nonnull
CachedData getCachedData()

Gets the holders CachedData cache.

Returns:

the holders cached data.

Since:

3.2

refreshCachedData

@Nonnull
CompletableFuture<Void> refreshCachedData()

Refreshes and applies any changes to the cached holder data.

Calling this method is unnecessary in most cases. Cache updates are handled behind the scenes by the implementation.

Returns:

the task future

Since:

4.0

getNodes

@Nonnull
ImmutableSetMultimap<ImmutableContextSet,Node> getNodes()

Gets the backing multimap containing every permission this holder has.

This method does not resolve inheritance rules, and returns a view of what's 'in the file'.

Returns:

the holders own permissions

Since:

3.3

getTransientNodes

@Nonnull
ImmutableSetMultimap<ImmutableContextSet,Node> getTransientNodes()

Gets the backing multimap containing every transient permission this holder has.

This method does not resolve inheritance rules.

Transient permissions only exist for the duration of the session.

Returns:

the holders own permissions

Since:

3.3

getOwnNodes

@Nonnull
List<Node> getOwnNodes()

Gets a flattened/squashed view of the holders permissions.

This list is constructed using the Multimap.values() method of both the transient and enduring backing multimaps.

This means that it may contain duplicate entries.

Use getPermissions() for a view without duplicates.

Returns:

a list of the holders own nodes.

Since:

3.3

getPermissions

@Nonnull
SortedSet<? extends Node> getPermissions()

Gets a sorted set of all held permissions.

Returns:

an immutable set of permissions in priority order

Since:

2.6

getEnduringPermissions

@Nonnull
Set<? extends Node> getEnduringPermissions()

Similar to getPermissions(), except without transient permissions.

Unlike transient permissions, enduring permissions will be saved to storage, and exist after the session.

Returns:

a set of nodes

Since:

2.6

getTransientPermissions

@Nonnull
Set<? extends Node> getTransientPermissions()

Similar to getPermissions(), except without enduring permissions.

Transient permissions only exist for the duration of the session.

Returns:

a set of nodes

Since:

2.6

getPermanentPermissionNodes

@Nonnull
Set<Node> getPermanentPermissionNodes()

Processes the nodes and returns the non-temporary ones.

Returns:

a set of permanent nodes

Since:

2.6

getTemporaryPermissionNodes

@Nonnull
Set<Node> getTemporaryPermissionNodes()

Processes the nodes and returns the temporary ones.

Returns:

a set of temporary nodes

Since:

2.6

resolveInheritances

@Nonnull
List<LocalizedNode> resolveInheritances(Contexts contexts)

Recursively resolves this holders permissions.

The returned list will contain every inherited node the holder has, in the order that they were inherited in.

This means the list will contain duplicates.

Parameters:

contexts - the contexts for the lookup

Returns:

a list of nodes

Since:

3.3

resolveInheritances

@Nonnull
List<LocalizedNode> resolveInheritances()

Recursively resolves this holders permissions.

The returned list will contain every inherited node the holder has, in the order that they were inherited in.

This means the list will contain duplicates.

Unlike resolveInheritances(Contexts), this method does not filter by context, at all.

Returns:

a list of nodes

Since:

3.3

getAllNodes

@Nonnull
SortedSet<LocalizedNode> getAllNodes(@Nonnull
                                               Contexts contexts)

Gets a mutable sorted set of the nodes that this object has and inherits, filtered by context

Unlike getAllNodesFiltered(Contexts), this method will not filter individual nodes. The context is only used to determine which groups should apply.

Nodes are sorted into priority order.

Parameters:

contexts - the context for the lookup

Returns:

a mutable sorted set of permissions

Throws:

NullPointerException - if the context is null

Since:

2.11

getAllNodes

@Nonnull
SortedSet<LocalizedNode> getAllNodes()

Gets a mutable sorted set of the nodes that this object has and inherits.

Unlike getAllNodes(Contexts), this method does not filter by context, at all.

Nodes are sorted into priority order.

Returns:

a mutable sorted set of permissions

Throws:

NullPointerException - if the context is null

Since:

3.3

getAllNodesFiltered

@Nonnull
Set<LocalizedNode> getAllNodesFiltered(@Nonnull
                                                 Contexts contexts)

Gets a mutable set of the nodes that this object has and inherits, filtered by context.

Unlike getAllNodes(Contexts), this method WILL filter individual nodes, and only return ones that fully meet the context provided.

Parameters:

contexts - the context for the lookup

Returns:

a mutable set of permissions

Throws:

NullPointerException - if the context is null

Since:

2.11

exportNodes

@Nonnull
Map<String,Boolean> exportNodes(@Nonnull
                                          Contexts contexts,
                                          boolean lowerCase)

Converts the output of getAllNodesFiltered(Contexts), and expands shorthand permissions.

Parameters:

contexts - the context for the lookup

lowerCase - if the keys should be made lowercase whilst being exported

Returns:

a mutable map of permissions

auditTemporaryPermissions

void auditTemporaryPermissions()

Removes temporary permissions that have expired

hasPermission

@Nonnull
Tristate hasPermission(@Nonnull
                                 Node node,
                                 @Nonnull
                                 NodeEqualityPredicate equalityPredicate)

Checks to see if the object has a certain permission

Parameters:

node - the node to check for

equalityPredicate - how to determine if a node matches

Returns:

a Tristate for the holders permission status for the node

Throws:

NullPointerException - if the node is null

Since:

4.1

hasTransientPermission

@Nonnull
Tristate hasTransientPermission(@Nonnull
                                          Node node,
                                          @Nonnull
                                          NodeEqualityPredicate equalityPredicate)

Checks to see if the object has a certain permission

Parameters:

node - the node to check for

equalityPredicate - how to determine if a node matches

Returns:

a Tristate for the holders permission status for the node

Throws:

NullPointerException - if the node is null

Since:

4.1

inheritsPermission

@Nonnull
Tristate inheritsPermission(@Nonnull
                                      Node node,
                                      @Nonnull
                                      NodeEqualityPredicate equalityPredicate)

Checks to see if the object inherits a certain permission

Parameters:

node - the node to check for

equalityPredicate - how to determine if a node matches

Returns:

a Tristate for the holders inheritance status for the node

Throws:

NullPointerException - if the node is null

Since:

4.1

hasPermission

@Nonnull
Tristate hasPermission(@Nonnull
                                 Node node)

Checks to see if the object has a certain permission

Parameters:

node - the node to check for

Returns:

a Tristate for the holders permission status for the node

Throws:

NullPointerException - if the node is null

Since:

2.6

hasTransientPermission

@Nonnull
Tristate hasTransientPermission(@Nonnull
                                          Node node)

Checks to see if the object has a certain permission

Parameters:

node - the node to check for

Returns:

a Tristate for the holders permission status for the node

Throws:

NullPointerException - if the node is null

Since:

2.6

inheritsPermission

@Nonnull
Tristate inheritsPermission(@Nonnull
                                      Node node)

Checks to see if the object inherits a certain permission

Parameters:

node - the node to check for

Returns:

a Tristate for the holders inheritance status for the node

Throws:

NullPointerException - if the node is null

Since:

2.6

inheritsGroup

boolean inheritsGroup(@Nonnull
                      Group group)

Check to see if this holder inherits another group directly

Parameters:

group - The group to check membership of

Returns:

true if the group inherits the other group

Throws:

NullPointerException - if the group is null

IllegalStateException - if the group instance was not obtained from LuckPerms.

Since:

4.0

inheritsGroup

boolean inheritsGroup(@Nonnull
                      Group group,
                      @Nonnull
                      ContextSet contextSet)

Check to see if this holder inherits another group directly

Parameters:

group - The group to check membership of

contextSet - the context set to filter by

Returns:

true if the group inherits the other group

Throws:

NullPointerException - if the group is null

IllegalStateException - if the group instance was not obtained from LuckPerms.

Since:

4.0

setPermission

@Nonnull
DataMutateResult setPermission(@Nonnull
                                         Node node)

Sets a permission for the object

Parameters:

node - The node to be set

Returns:

the result of the operation

Throws:

NullPointerException - if the node is null

Since:

4.0

setTransientPermission

@Nonnull
DataMutateResult setTransientPermission(@Nonnull
                                                  Node node)

Sets a transient permission for the object

A transient node is a permission that does not persist. Whenever a user logs out of the server, or the server restarts, this permission will disappear. It is never saved to the datastore, and therefore will not apply on other servers.

This is useful if you want to temporarily set a permission for a user while they're online, but don't want it to persist, and have to worry about removing it when they log out.

For unsetting a transient permission, see unsetTransientPermission(Node)

Parameters:

node - The node to be set

Returns:

the result of the operation

Throws:

NullPointerException - if the node is null

Since:

4.0

unsetPermission

@Nonnull
DataMutateResult unsetPermission(@Nonnull
                                           Node node)

Unsets a permission for the object

Parameters:

node - The node to be unset

Returns:

the result of the operation

Throws:

NullPointerException - if the node is null

Since:

4.0

unsetTransientPermission

@Nonnull
DataMutateResult unsetTransientPermission(@Nonnull
                                                    Node node)

Unsets a transient permission for the object

Parameters:

node - The node to be unset

Returns:

the result of the operation

Throws:

NullPointerException - if the node is null

Since:

4.0

clearMatching

void clearMatching(@Nonnull
                   Predicate<Node> test)

Clears any nodes from the holder which pass the predicate

Parameters:

test - the predicate to test for nodes which should be removed

Since:

3.2

clearMatchingTransient

void clearMatchingTransient(@Nonnull
                            Predicate<Node> test)

Clears any transient nodes from the holder which pass the predicate

Parameters:

test - the predicate to test for nodes which should be removed

Since:

3.2

clearNodes

void clearNodes()

Clears all nodes held by the object

Since:

2.17

clearNodes

void clearNodes(@Nonnull
                ContextSet contextSet)

Clears all nodes held by the object in a specific context

Parameters:

contextSet - the contexts to filter by

Since:

3.2

clearParents

void clearParents()

Clears all parent groups

Since:

2.17

clearParents

void clearParents(@Nonnull
                  ContextSet contextSet)

Clears all parent groups in a specific context

Parameters:

contextSet - the contexts to filter by

Since:

3.2

clearMeta

void clearMeta()

Clears all meta held by the object

Since:

2.17

clearMeta

void clearMeta(@Nonnull
               ContextSet contextSet)

Clears all meta held by the object in a specific context

Parameters:

contextSet - the contexts to filter by

Since:

3.2

clearTransientNodes

void clearTransientNodes()

Clears all transient permissions the holder has.

setPermissionUnchecked

@Nonnull
 @Deprecated
default DataMutateResult setPermissionUnchecked(@Nonnull
                                                                        Node node)

Deprecated. now forwards to setPermission(Node).

Sets a permission for the object

Parameters:

node - The node to be set

Returns:

the result of the operation

Throws:

NullPointerException - if the node is null

Since:

3.1

setTransientPermissionUnchecked

@Nonnull
 @Deprecated
default DataMutateResult setTransientPermissionUnchecked(@Nonnull
                                                                                 Node node)

Deprecated. now forwards to setTransientPermission(Node)

Sets a transient permission for the object

Parameters:

node - The node to be set

Returns:

the result of the operation

Throws:

NullPointerException - if the node is null

Since:

3.1

unsetPermissionUnchecked

@Nonnull
 @Deprecated
default DataMutateResult unsetPermissionUnchecked(@Nonnull
                                                                          Node node)

Deprecated. now forwards to unsetPermission(Node)

Unsets a permission for the object

Parameters:

node - The node to be unset

Returns:

the result of the operation

Throws:

NullPointerException - if the node is null

Since:

3.1

unsetTransientPermissionUnchecked

@Nonnull
 @Deprecated
default DataMutateResult unsetTransientPermissionUnchecked(@Nonnull
                                                                                   Node node)

Deprecated. now forwards to unsetTransientPermission(Node)

Unsets a transient permission for the object

Parameters:

node - The node to be unset

Returns:

the result of the operation

Throws:

NullPointerException - if the node is null

Since:

3.1