de.dytanic.cloudnet.api.player

Class PermissionProvider

java.lang.Object

de.dytanic.cloudnet.api.player.PermissionProvider

public final class PermissionProvider
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
private static SimpleDateFormat	simpleDateFormat The date format for print statements regarding dates.

Constructor Summary

Constructors

Constructor and Description
PermissionProvider()

Method Summary

Modifier and Type	Method and Description
static void	addPermission(String permissionGroupName, String permission) Adds the given permission to the given permission group.
static void	addPlayerGroup(OfflinePlayer player, String groupName, long time) Adds the given permission group by name to the player.
static void	addPlayerPermission(OfflinePlayer offlinePlayer, String permission) Adds a permission to the given player.
static void	addServerGroupPermission(String permissionGroupName, String permission, String serverGroup) Adds the given permission to the given permission group for the given server group.
static long	calculateDays(int value) Calculates the permission group timeout for the given days in future.
PermissionGroup	createPermissionGroup(String permissionGroupName) Creates the a new permission group with the given name.
static String	getDisplay(OfflinePlayer offlinePlayer) Gets the display for the given player by their highest permission group.
static String	getDisplay(UUID uuid) Gets the display of the player, identified by the given UUID by their highest permission group.
static String	getGroupDisplay(String groupName) Gets the permission group display for the given permission group name.
static Integer	getGroupJoinPower(String groupName) Gets the join power of the specified permission group.
static String	getGroupName(OfflinePlayer offlinePlayer) Gets the name of the highest permission group for the given player.
static String	getGroupName(UUID uuid) Gets the name of the highest permission group for the given player identified by their UUID.
static String	getGroupPrefix(String groupName) Gets the prefix of the given permission group.
static Collection<PermissionGroup>	getGroups() Returns all permission groups.
static String	getGroupSuffix(String groupName) Gets the suffix of the given permission group.
static Collection<String>	getImplementedGroups(String groupName) Gets the implemented permission groups of the specified permission group.
static int	getJoinPower(OfflinePlayer player) Gets the highest join power of the given player.
static PermissionGroup	getPermissionGroup(String groupName) Returns the specified permission group by name.
static long	getPlayerGroupRemainingTime(OfflinePlayer offlinePlayer) Gets the timeout of the player in their highest permission group.
static String	getPlayerGroups(OfflinePlayer offlinePlayer) Gets a string representation of the permission groups of the given player.
static int	getPlayerGroupTagID(OfflinePlayer offlinePlayer) Gets the TagID of the highest permission group of the given player.
static String	getPrefix(OfflinePlayer offlinePlayer) Gets the prefix of the given player by their highest permission group.
static String	getPrefix(UUID uuid) Gets the prefix of the given player identified by their UUID by their highest permission group.
static String	getSuffix(OfflinePlayer offlinePlayer) Gets the suffix of the given player by their highest permission group.
static String	getSuffix(UUID uuid) Gets the suffix of the given player identified by their UUID by their highest permission group.
static boolean	isInGroup(String groupName, OfflinePlayer offlinePlayer) Checks if the player is in the specified permission group.
static void	removePermission(String permissionGroupName, String permission) Removes the given permission from the given permission group.
static void	removePlayerGroup(String groupName, OfflinePlayer offlinePlayer) Removes the given permission group by name from the given player.
static void	removePlayerPermission(OfflinePlayer offlinePlayer, String permission) Removes a permission from the given player.
static void	removeServerGroupPermission(String permissionGroupName, String permission, String serverGroup) Removes the given permission from the given permission group for the given server group.
static void	setDefaultGroup(String groupName) Sets the default permission group.
static void	setDisplay(String groupName, String display) Sets the display for the given group by name.
static void	setJoinPower(String groupName, int joinPower) Sets the join power of the specified permission group by name.
static void	setPlayerGroup(OfflinePlayer offlinePlayer, String groupName, long time) Sets permission group for the given player.
static void	setPrefix(String groupName, String prefix) Sets the prefix for the given group by name.
static void	setSuffix(String groupName, String suffix) Sets the suffix for the given group by name.
static void	setTagID(String groupName, int tagId) Sets the tag id of the given permission group by name.
static void	updatePermissionGroup(PermissionGroup permissionGroup) Updates the permission group in the database.
static void	updatePlayer(OfflinePlayer offlinePlayer) Updates the given player in the player database.

Methods inherited from class java.lang.Object

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

Field Detail

simpleDateFormat

private static final SimpleDateFormat simpleDateFormat

The date format for print statements regarding dates.

Constructor Detail

PermissionProvider

public PermissionProvider()

Method Detail

calculateDays

public static long calculateDays(int value)

Calculates the permission group timeout for the given days in future.

Parameters:

value - the amount of days

Returns:

timeout value for use with PermissionGroup

getDisplay

public static String getDisplay(OfflinePlayer offlinePlayer)

Gets the display for the given player by their highest permission group.

Parameters:

offlinePlayer - the player to get the display for

Returns:

the display for the given player

See Also:

PermissionGroup, getDisplay(UUID)

getDisplay

public static String getDisplay(UUID uuid)

Gets the display of the player, identified by the given UUID by their highest permission group.

Parameters:

uuid - the UUID of the player

Returns:

the display for the given player

See Also:

PermissionGroup, getDisplay(OfflinePlayer)

getSuffix

public static String getSuffix(OfflinePlayer offlinePlayer)

Gets the suffix of the given player by their highest permission group.

Parameters:

offlinePlayer - the player to get the suffix for

Returns:

the suffix for the given player

See Also:

PermissionGroup, getSuffix(UUID)

getSuffix

public static String getSuffix(UUID uuid)

Gets the suffix of the given player identified by their UUID by their highest permission group.

Parameters:

uuid - the UUID of the player

Returns:

the suffix for the given player

See Also:

PermissionGroup, getSuffix(OfflinePlayer)

getPrefix

public static String getPrefix(OfflinePlayer offlinePlayer)

Gets the prefix of the given player by their highest permission group.

Parameters:

offlinePlayer - the player to get the prefix for

Returns:

the prefix for the given player

See Also:

PermissionGroup, getPrefix(UUID)

getPrefix

public static String getPrefix(UUID uuid)

Gets the prefix of the given player identified by their UUID by their highest permission group.

Parameters:

uuid - the UUID of the player

Returns:

the prefix for the given player

See Also:

PermissionGroup, getPrefix(OfflinePlayer)

getGroupName

public static String getGroupName(UUID uuid)

Gets the name of the highest permission group for the given player identified by their UUID.

Parameters:

uuid - the UUID of the player

Returns:

the name of the highest permission group of the given player

See Also:

getGroupName(OfflinePlayer), PermissionGroup, PermissionEntity

getGroupPrefix

public static String getGroupPrefix(String groupName)

Gets the prefix of the given permission group.

Parameters:

groupName - the name of the permission group

Returns:

the group prefix of the given group or null, if the group doesn't exist.

See Also:

PermissionGroup, PermissionPool

getGroupSuffix

public static String getGroupSuffix(String groupName)

Gets the suffix of the given permission group.

Parameters:

groupName - the name of the group

Returns:

the group suffix of the given group or null, if the group doesn't exist.

See Also:

PermissionGroup, PermissionPool

isInGroup

public static boolean isInGroup(String groupName,
                                OfflinePlayer offlinePlayer)

Checks if the player is in the specified permission group.

Parameters:

groupName - the name of the group

offlinePlayer - the player to check for group membership

Returns:

whether or not the player is in the requested group

See Also:

PermissionEntity

getGroupDisplay

public static String getGroupDisplay(String groupName)

Gets the permission group display for the given permission group name.

Parameters:

groupName - the name of the group

Returns:

the group display of the given group or null if the group doesn't exist

See Also:

PermissionGroup

getImplementedGroups

public static Collection<String> getImplementedGroups(String groupName)

Gets the implemented permission groups of the specified permission group.

Parameters:

groupName - the permission group

Returns:

Collection of implemented permission groups of the given permission group or null, if the group doesn't exist.

See Also:

PermissionGroup

getJoinPower

public static int getJoinPower(OfflinePlayer player)

Gets the highest join power of the given player.

Parameters:

player - the player

Returns:

the highest join power

See Also:

PermissionGroup

getGroupJoinPower

public static Integer getGroupJoinPower(String groupName)

Gets the join power of the specified permission group.

Parameters:

groupName - the name of the group

Returns:

the group join power of the given permission group or null, if the group doesn't exist.

getPlayerGroupTagID

public static int getPlayerGroupTagID(OfflinePlayer offlinePlayer)

Gets the TagID of the highest permission group of the given player.

Parameters:

offlinePlayer - the player

Returns:

The permission group's TagID of the highest permission group of the given player

See Also:

PermissionGroup

getPlayerGroupRemainingTime

public static long getPlayerGroupRemainingTime(OfflinePlayer offlinePlayer)

Gets the timeout of the player in their highest permission group.

Parameters:

offlinePlayer - the player to get the timeout for

Returns:

The timeout of the player in their highest permission group or -1 if it´s lifetime.

See Also:

GroupEntityData

getGroupName

public static String getGroupName(OfflinePlayer offlinePlayer)

Gets the name of the highest permission group for the given player.

Parameters:

offlinePlayer - the player to get the name of their highest permission group for.

Returns:

the name of the highest permission group of the given player

See Also:

getGroupName(UUID), PermissionGroup, PermissionEntity

addPlayerPermission

public static void addPlayerPermission(OfflinePlayer offlinePlayer,
                                       String permission)

Adds a permission to the given player.

Parameters:

offlinePlayer - the player to add the permission to

permission - the permission to add

updatePlayer

public static void updatePlayer(OfflinePlayer offlinePlayer)

Updates the given player in the player database.

Parameters:

offlinePlayer - the player to update

removePlayerPermission

public static void removePlayerPermission(OfflinePlayer offlinePlayer,
                                          String permission)

Removes a permission from the given player.

Parameters:

offlinePlayer - the player to remove the permission from

permission - the permission to remove

addPermission

public static void addPermission(String permissionGroupName,
                                 String permission)

Adds the given permission to the given permission group.

Parameters:

permissionGroupName - the name of the permission group to add the permission to.

permission - the permission to add

updatePermissionGroup

public static void updatePermissionGroup(PermissionGroup permissionGroup)

Updates the permission group in the database.

Parameters:

permissionGroup - the permission group to update

removePermission

public static void removePermission(String permissionGroupName,
                                    String permission)

Removes the given permission from the given permission group.

Parameters:

permissionGroupName - the name of the permission group to remove the permission from.

permission - the permission to remove.

addServerGroupPermission

public static void addServerGroupPermission(String permissionGroupName,
                                            String permission,
                                            String serverGroup)

Adds the given permission to the given permission group for the given server group.

Parameters:

permissionGroupName - the name of the permission group to add the permission to.

permission - the permission to add

serverGroup - the server group to restrict the permission to

removeServerGroupPermission

public static void removeServerGroupPermission(String permissionGroupName,
                                               String permission,
                                               String serverGroup)

Removes the given permission from the given permission group for the given server group.

Parameters:

permissionGroupName - the name of the permission group to remove the permission from.

permission - the permission to remove

serverGroup - the server group to remove the permission from

setPlayerGroup

public static void setPlayerGroup(OfflinePlayer offlinePlayer,
                                  String groupName,
                                  long time)

Sets permission group for the given player.

Parameters:

offlinePlayer - the player to set the permission groups for

groupName - the group name of the group to add

time - the time after which the group will be removed

See Also:

GroupEntityData

addPlayerGroup

public static void addPlayerGroup(OfflinePlayer player,
                                  String groupName,
                                  long time)

Adds the given permission group by name to the player.

Parameters:

player - the player to add the permission group to.

groupName - the group to add to the player

time - the time after which the group will be removed

See Also:

GroupEntityData

removePlayerGroup

public static void removePlayerGroup(String groupName,
                                     OfflinePlayer offlinePlayer)

Removes the given permission group by name from the given player.

Parameters:

groupName - the name of the permission group to remove

offlinePlayer - the player to remove the permission group from

See Also:

PermissionGroup

getPlayerGroups

public static String getPlayerGroups(OfflinePlayer offlinePlayer)

Gets a string representation of the permission groups of the given player.

Parameters:

offlinePlayer - the player to get the groups as a string for

Returns:

Player Groups of the given player as String or null if the player doesn't exists

getGroups

public static Collection<PermissionGroup> getGroups()

Returns all permission groups.

Returns:

All permission groups

getPermissionGroup

public static PermissionGroup getPermissionGroup(String groupName)

Returns the specified permission group by name.

Parameters:

groupName - the name of the group to get

Returns:

the specified permission group or null if the group doesn't exist

setDisplay

public static void setDisplay(String groupName,
                              String display)

Sets the display for the given group by name.

Parameters:

groupName - the name of the group

display - the display to set

setPrefix

public static void setPrefix(String groupName,
                             String prefix)

Sets the prefix for the given group by name.

Parameters:

groupName - the name of the group

prefix - the prefix to set

setSuffix

public static void setSuffix(String groupName,
                             String suffix)

Sets the suffix for the given group by name.

Parameters:

groupName - the name of the group

suffix - the suffix to set

setDefaultGroup

public static void setDefaultGroup(String groupName)

Sets the default permission group.

Parameters:

groupName - the name of the group to set as default

setJoinPower

public static void setJoinPower(String groupName,
                                int joinPower)

Sets the join power of the specified permission group by name.

Parameters:

groupName - the name of the group

joinPower - the new join power of the group

setTagID

public static void setTagID(String groupName,
                            int tagId)

Sets the tag id of the given permission group by name.

Parameters:

groupName - the name of the group

tagId - the new tag id.

createPermissionGroup

public PermissionGroup createPermissionGroup(String permissionGroupName)

Creates the a new permission group with the given name.

Parameters:

permissionGroupName - the name of the new permission group

Returns:

the new permission group or null, if the group already exists.