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

Interface Privileges

public interface Privileges

Container holding all defined privileges.

Implementation is provided as an @ApplicationScoped bean.

Method Summary

Modifier and Type	Method	Description
Collection<Privilege>	all()	Informative function, returns all known privileges.
Set<Integer>	allIds()	Informative function, the IDs provided all known privileges.
Set<String>	allNames()	Informative function, returns the names of all known privileges.
Privilege	byId(int id)	Return the privilege for the given ID.
Privilege	byName(String name)	Return the privilege for the given name (case-sensitive).
Set<Privilege>	collapseComposites(PrivilegeSet value)	Returns the set of privilege from the given privilege set, replacing all individual privileges that fully match the composite privileges.
int	idForName(String name)
int	idForPrivilege(Privilege privilege)
Acl.AclBuilder	newAclBuilder()
AclEntry.AclEntryBuilder	newAclEntryBuilder()
PrivilegeSet.PrivilegeSetBuilder	newPrivilegesSetBuilder()
PrivilegeSet	nonInheritablePrivileges()
PrivilegeCheck	startPrivilegeCheck(boolean anonymous, Set<String> roleIds)

Method Details

byId

Privilege byId(int id)

Return the privilege for the given ID.

Throws:

IllegalArgumentException - if no privilege for the given ID exists.

byName

Privilege byName(@Nonnull
 String name)

Return the privilege for the given name (case-sensitive).

Throws:

IllegalArgumentException - if no privilege for the given name exists.

idForName

int idForName(@Nonnull
 String name)

idForPrivilege

int idForPrivilege(@Nonnull
 Privilege privilege)

nonInheritablePrivileges

PrivilegeSet nonInheritablePrivileges()

collapseComposites

Set<Privilege> collapseComposites(@Nonnull
 PrivilegeSet value)

Returns the set of privilege from the given privilege set, replacing all individual privileges that fully match the composite privileges. If multiple composite privileges match, all of those will be returned.

all

Collection<Privilege> all()

Informative function, returns all known privileges.

allIds

Set<Integer> allIds()

Informative function, the IDs provided all known privileges.

allNames

Set<String> allNames()

Informative function, returns the names of all known privileges.

newPrivilegesSetBuilder

PrivilegeSet.PrivilegeSetBuilder newPrivilegesSetBuilder()

newAclBuilder

Acl.AclBuilder newAclBuilder()

newAclEntryBuilder

AclEntry.AclEntryBuilder newAclEntryBuilder()

startPrivilegeCheck

PrivilegeCheck startPrivilegeCheck(boolean anonymous,
 Set<String> roleIds)