Package de.dytanic.cloudnet.driver.permission

Class AbstractPermissible

java.lang.Object

de.dytanic.cloudnet.common.document.gson.BasicJsonDocPropertyable

de.dytanic.cloudnet.driver.permission.AbstractPermissible

All Implemented Interfaces:

de.dytanic.cloudnet.common.document.gson.IJsonDocPropertyable, de.dytanic.cloudnet.common.INameable, IPermissible, java.lang.Comparable<IPermissible>

Direct Known Subclasses:

PermissionGroup, PermissionUser

public abstract class AbstractPermissible
extends de.dytanic.cloudnet.common.document.gson.BasicJsonDocPropertyable
implements IPermissible

Field Summary

Fields

Modifier and Type	Field	Description
protected long	createdTime
protected java.util.Map<java.lang.String,java.util.Collection<Permission>>	groupPermissions
protected java.lang.String	name
protected java.util.List<Permission>	permissions
protected int	potency

Fields inherited from class de.dytanic.cloudnet.common.document.gson.BasicJsonDocPropertyable

properties

Constructor Summary

Constructors

Constructor	Description
AbstractPermissible()

Method Summary

Modifier and Type	Method	Description
boolean	addPermission(@NotNull Permission permission)	Adds a new permission to this permissible and updates it if a permission with that name already exists.
boolean	addPermission(@NotNull java.lang.String group, @NotNull Permission permission)	Adds a new permission to this permissible and updates it if a permission with that name already exists.
long	getCreatedTime()
java.util.Map<java.lang.String,java.util.Collection<Permission>>	getGroupPermissions()	Gets all effective permissions on a specific group.
java.lang.String	getName()
java.util.List<Permission>	getPermissions()	Gets all effective global permissions.
int	getPotency()	Gets the potency of this permissible.
boolean	removePermission(@NotNull java.lang.String permission)	Removes a permission out of this permissible.
boolean	removePermission(@NotNull java.lang.String group, @NotNull java.lang.String permission)	Removes a permission for a specific group out of this permissible.
void	setName(@NotNull java.lang.String name)	Sets the name of this permissible.
void	setPermissions(java.util.List<Permission> permissions)
void	setPotency(int potency)	Sets the potency of this permissible.

Methods inherited from class de.dytanic.cloudnet.common.document.gson.BasicJsonDocPropertyable

getProperties, getProperty, hasProperty, removeProperty, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.dytanic.cloudnet.common.document.gson.IJsonDocPropertyable

getProperties, getProperty, hasProperty, removeProperty, setProperty

Methods inherited from interface de.dytanic.cloudnet.driver.permission.IPermissible

addPermission, addPermission, addPermission, addPermission, addPermission, addPermission, compareTo, getPermission, getPermissionNames, hasPermission, hasPermission, hasPermission, hasPermission, isPermissionSet

Field Detail

createdTime

protected final long createdTime

name

protected java.lang.String name

potency

protected int potency

permissions

protected java.util.List<Permission> permissions

groupPermissions

protected java.util.Map<java.lang.String,java.util.Collection<Permission>> groupPermissions

Constructor Detail

AbstractPermissible

public AbstractPermissible()

Method Detail

addPermission

public boolean addPermission(@NotNull
                             @NotNull Permission permission)

Description copied from interface: IPermissible

Adds a new permission to this permissible and updates it if a permission with that name already exists.

An update via IPermissionManagement.updateGroup(IPermissionGroup) or IPermissionManagement.updateGroup(IPermissionGroup) is required.

Specified by:

addPermission in interface IPermissible

Parameters:

permission - the permission

Returns:

true if the permission has been added successfully or false if the given permission was null

addPermission

public boolean addPermission(@NotNull
                             @NotNull java.lang.String group,
                             @NotNull
                             @NotNull Permission permission)

Description copied from interface: IPermissible

Adds a new permission to this permissible and updates it if a permission with that name already exists. This permission will be only effective on servers which have the specified group.

An update via IPermissionManagement.updateGroup(IPermissionGroup) or IPermissionManagement.updateGroup(IPermissionGroup) is required.

Specified by:

addPermission in interface IPermissible

Parameters:

group - the group where this permission should be effective

permission - the permission

Returns:

true if the permission has been added successfully or false if the given permission was null

removePermission

public boolean removePermission(@NotNull
                                @NotNull java.lang.String permission)

Description copied from interface: IPermissible

Removes a permission out of this permissible.

An update via IPermissionManagement.updateGroup(IPermissionGroup) or IPermissionManagement.updateGroup(IPermissionGroup) is required.

Specified by:

removePermission in interface IPermissible

Parameters:

permission - the permission

Returns:

true if the permission has been removed successfully or false if the given permission doesn't exist

removePermission

public boolean removePermission(@NotNull
                                @NotNull java.lang.String group,
                                @NotNull
                                @NotNull java.lang.String permission)

Description copied from interface: IPermissible

Removes a permission for a specific group out of this permissible.

An update via IPermissionManagement.updateGroup(IPermissionGroup) or IPermissionManagement.updateGroup(IPermissionGroup) is required.

Specified by:

removePermission in interface IPermissible

Parameters:

group - the group where this permission is effective

permission - the permission

Returns:

true if the permission has been removed successfully or false if the given permission doesn't exist

getCreatedTime

public long getCreatedTime()

getName

public java.lang.String getName()

Specified by:

getName in interface de.dytanic.cloudnet.common.INameable

setName

public void setName(@NotNull
                    @NotNull java.lang.String name)

Description copied from interface: IPermissible

Sets the name of this permissible.

An update via IPermissionManagement.updateGroup(IPermissionGroup) or IPermissionManagement.updateGroup(IPermissionGroup) is required.

Specified by:

setName in interface IPermissible

Parameters:

name - the new name

getPotency

public int getPotency()

Description copied from interface: IPermissible

Gets the potency of this permissible. If this permissible is an IPermissionGroup, IPermissionManagement.getHighestPermissionGroup(IPermissionUser) is sorted by the potency. If this permissible is an IPermissionUser, in CloudNet it has no specific meaning, but of course you can use it for whatever you want.

Specified by:

getPotency in interface IPermissible

Returns:

the potency of this permissible

setPotency

public void setPotency(int potency)

Description copied from interface: IPermissible

Sets the potency of this permissible.

An update via IPermissionManagement.updateGroup(IPermissionGroup) or IPermissionManagement.updateGroup(IPermissionGroup) is required.

Specified by:

setPotency in interface IPermissible

Parameters:

potency - the new potency

getPermissions

public java.util.List<Permission> getPermissions()

Description copied from interface: IPermissible

Gets all effective global permissions. Permissions which are only effective on specific groups are not included.

Specified by:

getPermissions in interface IPermissible

Returns:

a mutable list of all permissions

setPermissions

public void setPermissions(java.util.List<Permission> permissions)

getGroupPermissions

public java.util.Map<java.lang.String,java.util.Collection<Permission>> getGroupPermissions()

Description copied from interface: IPermissible

Gets all effective permissions on a specific group. Global permissions are not included.

Specified by:

getGroupPermissions in interface IPermissible

Returns:

a mutable map containing mutable lists of permissions