com.datastrato.gravitino.dto.authorization

Class RoleDTO

java.lang.Object

com.datastrato.gravitino.dto.authorization.RoleDTO

All Implemented Interfaces:

Auditable, Role

public class RoleDTO
extends java.lang.Object
implements Role

Represents a Role Data Transfer Object (DTO).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RoleDTO.Builder<S extends RoleDTO.Builder> Builder class for constructing a RoleDTO instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RoleDTO() Default constructor for Jackson deserialization.
protected	RoleDTO(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> properties, java.util.List<java.lang.String> privileges, SecurableObjectDTO securableObject, AuditDTO audit) Creates a new instance of RoleDTO.

Method Summary

Modifier and Type	Method and Description
Audit	auditInfo()
static RoleDTO.Builder	builder() Creates a new Builder for constructing a Role DTO.
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 resource represents a special kind of entity with a unique identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleDTO

protected RoleDTO()

Default constructor for Jackson deserialization.

RoleDTO

protected RoleDTO(java.lang.String name,
                  java.util.Map<java.lang.String,java.lang.String> properties,
                  java.util.List<java.lang.String> privileges,
                  SecurableObjectDTO securableObject,
                  AuditDTO audit)

Creates a new instance of RoleDTO.

Parameters:

name - The name of the Role DTO.

properties - The properties of the Role DTO.

privileges - The privileges of the Role DTO.

securableObject - The securable object of the Role DTO.

audit - The audit information of the Role DTO.

Method Detail

name

public java.lang.String name()

Description copied from interface: Role

The name of the role.

Specified by:

name in interface Role

Returns:

The name of the Role DTO.

properties

public 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.

Specified by:

properties in interface Role

Returns:

The properties of the role.

privileges

public java.util.List<Privilege> privileges()

The privileges of the role. All privileges belong to one resource. For example: If the resource 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.

Specified by:

privileges in interface Role

Returns:

The privileges of the role.

securableObject

public SecurableObject securableObject()

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

Specified by:

securableObject in interface Role

Returns:

The securable object of the role.

auditInfo

public Audit auditInfo()

Specified by:

auditInfo in interface Auditable

Returns:

The audit information of the Role DTO.

builder

public static RoleDTO.Builder builder()

Creates a new Builder for constructing a Role DTO.

Returns:

A new Builder instance.