com.datastrato.gravitino.authorization

Interface Role

All Superinterfaces:

Auditable

All Known Implementing Classes:

RoleDTO

@Evolving
public interface Role
extends Auditable

The interface of a role. The role is the entity which has kinds of privileges. One role can have multiple privileges of one securable object. Gravitino chooses to bind one securable object to one role to avoid granting too many privileges to one role.

Method Summary

Modifier and Type	Method and Description
java.lang.String	name() The name of the role.
java.util.List<Privilege>	privileges() The privileges of the role.
java.util.Map<java.lang.String,java.lang.String>	properties() The properties of the role.
SecurableObject	securableObject() The securable object represents a special kind of entity with a unique identifier.

Methods inherited from interface com.datastrato.gravitino.Auditable

auditInfo

Method Detail

name

java.lang.String name()

The name of the role.

Returns:

The name of the role.

properties

java.util.Map<java.lang.String,java.lang.String> properties()

The properties of the role. Note, this method will return null if the properties are not set.

Returns:

The properties of the role.

privileges

java.util.List<Privilege> privileges()

The privileges of the role. All privileges belong to one securable object. For example: If the securable object is a table, the privileges could be `READ TABLE`, `WRITE TABLE`, etc. If a schema has the privilege of `LOAD TABLE`. It means the role can all tables of the schema.

Returns:

The privileges of the role.

securableObject

SecurableObject securableObject()

The securable object represents a special kind of entity with a unique identifier. All securable objects are organized by tree structure. For example: If the securable object is a table, the identifier may be `catalog1.schema1.table1`.

Returns:

The securable object of the role.