Package eu.cloudnetservice.driver.permission

Class AbstractPermissible

java.lang.Object

eu.cloudnetservice.driver.permission.AbstractPermissible

All Implemented Interfaces:

eu.cloudnetservice.common.document.property.DefaultedDocPropertyHolder<eu.cloudnetservice.common.document.gson.JsonDocument,Permissible>, eu.cloudnetservice.common.document.property.DocPropertyHolder<eu.cloudnetservice.common.document.gson.JsonDocument,Permissible>, eu.cloudnetservice.common.Nameable, Permissible, Comparable<Permissible>

Direct Known Subclasses:

PermissionGroup, PermissionUser

public abstract class AbstractPermissible
extends Object
implements eu.cloudnetservice.common.document.property.DefaultedDocPropertyHolder<eu.cloudnetservice.common.document.gson.JsonDocument,Permissible>, Permissible

An abstract implementation of a permissible for shared usage.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
protected final long	createdTime
protected final Map<String,Set<Permission>>	groupPermissions
protected final String	name
protected final Set<Permission>	permissions
protected final int	potency
protected final eu.cloudnetservice.common.document.gson.JsonDocument	properties

Constructor Summary

Constructors

Constructor	Description
AbstractPermissible(@NonNull String name, int potency, long createdTime, @NonNull Set<Permission> permissions, @NonNull Map<String,Set<Permission>> groupPermissions, @NonNull eu.cloudnetservice.common.document.gson.JsonDocument properties)	Constructs a new abstract permissible instance.

Method Summary

Modifier and Type	Method	Description
void	addPermission(@NonNull Permission permission)	Adds the given permission to this permissible.
void	addPermission(@NonNull String group, @NonNull Permission permission)	Adds the given permission to this permissible for the specified target group.
private void	addPermission(@NonNull Set<Permission> permissions, @NonNull Permission permission)	Adds the given permission into the set of permissions.
long	creationTime()	Gets the creation time as unix timestamp of this permissible.
@NonNull Map<String,Set<Permission>>	groupPermissions()	Gets all group specific permissions.
@NonNull String	name()
@NonNull Collection<Permission>	permissions()	Gets all global permissions of this permissible.
int	potency()	Gets the potency of this permissible.
@NonNull eu.cloudnetservice.common.document.gson.JsonDocument	propertyHolder()
boolean	removePermission(@NonNull String permission)	Removes the given permission from this permissible.
boolean	removePermission(@NonNull String permission, @NonNull String group)	Removes the given permission from this permissible and the given target group.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.cloudnetservice.common.document.property.DefaultedDocPropertyHolder

propertyAbsent, propertyPresent, readProperty, readPropertyOrDefault, readPropertyOrGet, readPropertyOrThrow, readPropertyOrThrow, removeProperty, writeProperty, writePropertyIfAbsent, writePropertyIfAbsent, writePropertyIfPresent, writePropertyIfPresent

Methods inherited from interface eu.cloudnetservice.driver.permission.Permissible

addPermission, addPermission, compareTo, findMatchingPermission, groupNames, hasPermission, hasPermission, hasPermission, hasPermission, isPermissionSet, permission, permissionNames

Field Details

name

protected final String name

potency

protected final int potency

createdTime

protected final long createdTime

permissions

protected final Set<Permission> permissions

groupPermissions

protected final Map<String,Set<Permission>> groupPermissions

properties

protected final eu.cloudnetservice.common.document.gson.JsonDocument properties

Constructor Details

AbstractPermissible

public AbstractPermissible(@NonNull
 @NonNull String name,
 int potency,
 long createdTime,
 @NonNull
 @NonNull Set<Permission> permissions,
 @NonNull
 @NonNull Map<String,Set<Permission>> groupPermissions,
 @NonNull
 @NonNull eu.cloudnetservice.common.document.gson.JsonDocument properties)

Constructs a new abstract permissible instance.

Parameters:

name - the name of the permissible.

potency - the potency of the permissible.

createdTime - the creation time as unix timestamp.

permissions - all permissions of the permissible.

groupPermissions - all permissions of the permissible that are per (service) group.

properties - extra properties for the permissible.

Throws:

NullPointerException - if the given name, permissions, groupPermissions or properties is null.

Method Details

addPermission

private void addPermission(@NonNull
 @NonNull Set<Permission> permissions,
 @NonNull
 @NonNull Permission permission)

Adds the given permission into the set of permissions. If the collection contains a permission with the same name it is removed before adding the new permission.

Parameters:

permissions - the set of permissions to add the given permission to.

permission - the permission to add to the other permissions.

Throws:

NullPointerException - if the given permissions or the permission is null.

addPermission

public void addPermission(@NonNull
 @NonNull Permission permission)

Adds the given permission to this permissible. If a permission with the same name already exists the permission is replaced with the given one.

After adding the permission an update is required.

Specified by:

addPermission in interface Permissible

Parameters:

permission - the permission to add.

addPermission

public void addPermission(@NonNull
 @NonNull String group,
 @NonNull
 @NonNull Permission permission)

Adds the given permission to this permissible for the specified target group. If a permission with the same name already exists the permission is replaced with the given one.

After adding the permission an update is required.

Specified by:

addPermission in interface Permissible

Parameters:

group - the group to add the permission for.

permission - the permission to add.

removePermission

public boolean removePermission(@NonNull
 @NonNull String permission)

Removes the given permission from this permissible. This only removes global permissions, not group specific ones.

After removing the permission an update is required.

Specified by:

removePermission in interface Permissible

Parameters:

permission - the permission to remove.

Returns:

true if any permission was removed, false otherwise.

removePermission

public boolean removePermission(@NonNull
 @NonNull String permission,
 @NonNull
 @NonNull String group)

Removes the given permission from this permissible and the given target group. This only removes group specific permissions, not global ones.

After removing the permission an update is required.

Specified by:

removePermission in interface Permissible

Parameters:

permission - the permission to remove.

group - the target group to remove the permission from.

Returns:

true if any permission was removed, false otherwise.

creationTime

public long creationTime()

Gets the creation time as unix timestamp of this permissible.

Specified by:

creationTime in interface Permissible

Returns:

the creation time of this permissible.

name

@NonNull
public @NonNull String name()

Specified by:

name in interface eu.cloudnetservice.common.Nameable

potency

public int potency()

Gets the potency of this permissible. The potency is used for comparison of permissibles. A higher potency results in higher significance.

Specified by:

potency in interface Permissible

Returns:

the potency of this permissible.

See Also:

• Permissible.compareTo(Permissible)

permissions

@NonNull
public @NonNull Collection<Permission> permissions()

Gets all global permissions of this permissible. Specific group permissions are not included.

Specified by:

permissions in interface Permissible

Returns:

all global permissions.

groupPermissions

@NonNull
public @NonNull Map<String,Set<Permission>> groupPermissions()

Gets all group specific permissions. Global permissions are not included.

Specified by:

groupPermissions in interface Permissible

Returns:

all group specific permissions.

propertyHolder

@NonNull
public @NonNull eu.cloudnetservice.common.document.gson.JsonDocument propertyHolder()

Specified by:

propertyHolder in interface eu.cloudnetservice.common.document.property.DocPropertyHolder<eu.cloudnetservice.common.document.gson.JsonDocument,Permissible>