org.rvpf.metadata.entity

Class PermissionsEntity

Object

AbstractEntity

PermissionsEntity

All Implemented Interfaces:

Comparable<Entity>, Entity, Permissions

public final class PermissionsEntity
extends AbstractEntity
implements Permissions

Permissions Entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PermissionsEntity.Builder Builder.

Nested classes/interfaces inherited from interface Permissions

Permissions.Action

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT_NAME Permissions element name.
static String	ENTITY_PREFIX Permissions entity prefix.

Fields inherited from interface Entity

UUID_COMPARATOR

Method Summary

Modifier and Type	Method and Description
void	adopt(PermissionsEntity child) Adopts a child.
void	allow(String role, Permissions.Action action) Allows an action for a role.
boolean	check(Permissions.Action action, Optional<Identity> identity) Checks if an action is allowed by at least one role.
PermissionsEntity	copy() Creates a copy of this entity.
void	deny(String role, Permissions.Action action) Denies an action for a role.
boolean	equals(Object other) For two Entity to be equal, they must at least be instances of the same class, have the same UUID and name.
String	getElementName() Gets the entity element name.
Map<String,Set<Permissions.Action>>	getPermissions() Gets the permissions.
String	getPrefix() Gets the class prefix.
String	getReferenceName() Gets the entity reference name.
int	hashCode()
static PermissionsEntity.Builder	newBuilder() Returns a new builder.

Methods inherited from class AbstractEntity

compareTo, getAttributes, getName, getNameInUpperCase, getThisLogger, getUUID, setName, setUUID, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME

Permissions element name.

See Also:

Constant Field Values

ENTITY_PREFIX

public static final String ENTITY_PREFIX

Permissions entity prefix.

See Also:

Constant Field Values

Method Detail

newBuilder

@Nonnull
 @CheckReturnValue
public static PermissionsEntity.Builder newBuilder()

Returns a new builder.

Returns:

The new builder.

adopt

public void adopt(@Nonnull
                  PermissionsEntity child)

Adopts a child.

Parameters:

child - The child.

allow

public void allow(@Nonnull
                  String role,
                  @Nonnull
                  Permissions.Action action)

Allows an action for a role.

Parameters:

role - The role.

action - The action.

check

public boolean check(Permissions.Action action,
                     Optional<Identity> identity)

Checks if an action is allowed by at least one role.

Specified by:

check in interface Permissions

Parameters:

action - The action.

identity - The optional identity.

Returns:

True if the action is allowed.

copy

public PermissionsEntity copy()

Creates a copy of this entity.

Specified by:

copy in interface Entity

Returns:

The copy.

deny

public void deny(@Nonnull
                 String role,
                 @Nonnull
                 Permissions.Action action)

Denies an action for a role.

Parameters:

role - The role.

action - The action.

equals

public boolean equals(Object other)

For two Entity to be equal, they must at least be instances of the same class, have the same UUID and name.

Overrides:

equals in class AbstractEntity

getElementName

public String getElementName()

Gets the entity element name.

The entity element is used to in the generation of the entity URI.

Specified by:

getElementName in interface Entity

Returns:

The entity element name.

getPermissions

@Nonnull
 @CheckReturnValue
public Map<String,Set<Permissions.Action>> getPermissions()

Gets the permissions.

Returns:

The permissions.

getPrefix

public String getPrefix()

Gets the class prefix.

Each concrete entity subclass has its own prefix which will be the same for all its instances. This prefix is used to avoid name collision between different classes in a common registry.

Specified by:

getPrefix in interface Entity

Returns:

The class prefix.

getReferenceName

public String getReferenceName()

Gets the entity reference name.

Specified by:

getReferenceName in interface Entity

Returns:

The entity reference name.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractEntity