org.apache.gravitino.dto.authorization

Class PrivilegeDTO

java.lang.Object

org.apache.gravitino.dto.authorization.PrivilegeDTO

All Implemented Interfaces:

Privilege

public class PrivilegeDTO
extends java.lang.Object
implements Privilege

Data transfer object representing a privilege.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrivilegeDTO.Builder Builder for PrivilegeDTO.

Nested classes/interfaces inherited from interface org.apache.gravitino.authorization.Privilege

Privilege.Condition, Privilege.Name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PrivilegeDTO() Default constructor for Jackson deserialization.
protected	PrivilegeDTO(Privilege.Name name, Privilege.Condition condition) Creates a new instance of PrivilegeDTO.

Method Summary

Modifier and Type	Method and Description
static PrivilegeDTO.Builder	builder()
boolean	canBindTo(MetadataObject.Type type) If the privilege can bind to a securable object, then this method will return true, otherwise false.
Privilege.Condition	condition()
Privilege.Name	name()
java.lang.String	simpleString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PrivilegeDTO

protected PrivilegeDTO()

Default constructor for Jackson deserialization.

PrivilegeDTO

protected PrivilegeDTO(Privilege.Name name,
                       Privilege.Condition condition)

Creates a new instance of PrivilegeDTO.

Parameters:

name - The name of the Privilege DTO.

condition - The condition of the Privilege DTO.

Method Detail

name

public Privilege.Name name()

Specified by:

name in interface Privilege

Returns:

The generic name of the privilege.

simpleString

public java.lang.String simpleString()

Specified by:

simpleString in interface Privilege

Returns:

A readable string representation for the privilege.

condition

public Privilege.Condition condition()

Specified by:

condition in interface Privilege

Returns:

The condition of the privilege. `ALLOW` means that you are allowed to use the privilege, `DENY` means that you are denied to use the privilege

canBindTo

public boolean canBindTo(MetadataObject.Type type)

Description copied from interface: Privilege

If the privilege can bind to a securable object, then this method will return true, otherwise false.

Specified by:

canBindTo in interface Privilege

Parameters:

type - The securable object type.

Returns:

It will return true if the privilege can bind to a securable object, otherwise false.

builder

public static PrivilegeDTO.Builder builder()

Returns:

the builder for creating a new instance of PrivilegeDTO.