Package org.apache.polaris.persistence.nosql.authz.api

Interface PrivilegeSet

All Superinterfaces:

Collection<Privilege>, Iterable<Privilege>, Set<Privilege>

public interface PrivilegeSet
extends Set<Privilege>

Represents a set of individual privileges.

External representations, for example, when serialized as JSON, prefer composite privileges over individual ones. This means that if a privilege set contains all privileges included in a composite privilege, only the name of the composite privilege is serialized. If multiple composite privileges match, all matching ones are serialized.

This set of privileges natively represents only individual privileges. To "collapse" those into composite privileges, use collapseComposites(Privileges).

Composite privileges can however be used as arguments to all contains() functions and to the add()/remove() builder methods.

Do not use a PrivilegeSet when the special meaning of composite privileges needs to be retained, especially during access checks.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PrivilegeSet.PrivilegeSetBuilder

Method Summary

Modifier and Type	Method	Description
default Set<Privilege>	collapseComposites(Privileges privileges)
boolean	contains(Object o)	Checks whether the given Privilege is fully contained in this privilege set.
boolean	contains(Privilege privilege)
boolean	containsAll(Collection<?> c)	Checks whether all of given privileges is contained in this privilege set.
boolean	containsAny(Iterable<? extends Privilege> privilege)	Checks whether any of given privileges is contained in this privilege set.
static PrivilegeSet	emptyPrivilegeSet()
boolean	isEmpty()
Iterator<Privilege>	iterator(Privileges privileges)
byte[]	toByteArray()

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

add, addAll, clear, equals, hashCode, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Method Details

emptyPrivilegeSet

static PrivilegeSet emptyPrivilegeSet()

contains

boolean contains(Privilege privilege)

iterator

Iterator<Privilege> iterator(Privileges privileges)

isEmpty

boolean isEmpty()

Specified by:

isEmpty in interface Collection<Privilege>

Specified by:

isEmpty in interface Set<Privilege>

toByteArray

byte[] toByteArray()

collapseComposites

default Set<Privilege> collapseComposites(Privileges privileges)

contains

boolean contains(Object o)

Checks whether the given Privilege is fully contained in this privilege set.

For composite privileges, returns true if and only if all the individual privileges of a composite privilege are contained in this set.

Specified by:

contains in interface Collection<Privilege>

Specified by:

contains in interface Set<Privilege>

containsAll

boolean containsAll(@Nonnull
 Collection<?> c)

Checks whether all of given privileges is contained in this privilege set.

For composite privileges, returns true if and only if all the individual privileges of a composite privilege are contained in this set.

Specified by:

containsAll in interface Collection<Privilege>

Specified by:

containsAll in interface Set<Privilege>

containsAny

boolean containsAny(Iterable<? extends Privilege> privilege)

Checks whether any of given privileges is contained in this privilege set.

For composite privileges, returns true if and only if all the individual privileges of a composite privilege are contained in this set.