com.palmergames.bukkit.towny.permissions

Class TownyPerms

java.lang.Object

com.palmergames.bukkit.towny.permissions.TownyPerms

public class TownyPerms
extends java.lang.Object

Author:

ElgarL

Constructor Summary

Constructors

Constructor and Description
TownyPerms()

Method Summary

Methods

Modifier and Type	Method and Description
static void	assignPermissions(Resident resident, org.bukkit.entity.Player player) Register a specific residents permissions with Bukkit.
static void	collectPermissions() Update the list of permissions registered with bukkit
static java.util.Map<java.lang.String,java.lang.Boolean>	getAllChildren(java.lang.String node, java.util.Set<java.lang.String> playerPermArray) Returns a map of ALL child permissions registered with bukkit null is empty
java.util.List<java.lang.String>	getAllRegisteredPermissions(boolean includeChildren) Fetch all permissions which are registered with superperms.
static java.util.Map<java.lang.String,java.lang.Boolean>	getChildren(java.lang.String node) Returns a map of the child permissions (1 node deep) as registered with Bukkit.
static java.util.List<java.lang.String>	getDefault() Default permissions everyone gets
static java.util.List<java.lang.String>	getNationDefault() Default permissions everyone in a nation gets
static java.util.List<java.lang.String>	getNationKing() A nations kings permissions
static java.util.List<java.lang.String>	getNationRank(java.lang.String rank) Get a specific ranks permissions
static java.util.List<java.lang.String>	getNationRanks() Fetch a list of all available nation ranks
static java.util.LinkedHashMap<java.lang.String,java.lang.Boolean>	getResidentPerms(Resident resident) Returns a sorted map of this residents current permissions.
static java.util.List<java.lang.String>	getTownDefault() Default permissions everyone in a town gets
static java.util.List<java.lang.String>	getTownMayor() A town mayors permissions
static java.util.List<java.lang.String>	getTownRank(java.lang.String rank) Get a specific ranks permissions
static java.util.List<java.lang.String>	getTownRanks() Fetch a list of all available town ranks
static void	initialize(Towny plugin)
static void	loadPerms(java.lang.String filepath, java.lang.String defaultRes) Load the townyperms.yml file.
static void	registerPermissionNodes()
static void	removeAttachment(java.lang.String name) Should only be called when a player leaves the server.
static void	updateNationPerms(Nation nation) Update the permissions for all residents of a nation (if online)
static void	updateOnlinePerms() Update the permissions for all online residents
static void	updateTownPerms(Town town) Update the permissions for all residents of a town (if online)

Methods inherited from class java.lang.Object

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

Constructor Detail

TownyPerms

public TownyPerms()

Method Detail

initialize

public static void initialize(Towny plugin)

loadPerms

public static void loadPerms(java.lang.String filepath,
             java.lang.String defaultRes)
                      throws java.io.IOException

Load the townyperms.yml file. If it doesn't exist create it from the resource file in the jar.

Parameters:

filepath -

defaultRes -

Throws:

java.io.IOException

assignPermissions

public static void assignPermissions(Resident resident,
                     org.bukkit.entity.Player player)

Register a specific residents permissions with Bukkit.

Parameters:

resident -

removeAttachment

public static void removeAttachment(java.lang.String name)

Should only be called when a player leaves the server.

Parameters:

name -

updateOnlinePerms

public static void updateOnlinePerms()

Update the permissions for all online residents

updateTownPerms

public static void updateTownPerms(Town town)

Update the permissions for all residents of a town (if online)

Parameters:

town -

updateNationPerms

public static void updateNationPerms(Nation nation)

Update the permissions for all residents of a nation (if online)

Parameters:

nation -

getResidentPerms

public static java.util.LinkedHashMap<java.lang.String,java.lang.Boolean> getResidentPerms(Resident resident)

Returns a sorted map of this residents current permissions.

Parameters:

resident -

Returns:

a sorted Map of permission nodes

registerPermissionNodes

public static void registerPermissionNodes()

getDefault

public static java.util.List<java.lang.String> getDefault()

Default permissions everyone gets

Returns:

a List of permissions

getTownRanks

public static java.util.List<java.lang.String> getTownRanks()

Fetch a list of all available town ranks

Returns:

a list of rank names.

getTownDefault

public static java.util.List<java.lang.String> getTownDefault()

Default permissions everyone in a town gets

Returns:

a list of permissions

getTownMayor

public static java.util.List<java.lang.String> getTownMayor()

A town mayors permissions

Returns:

a list of permissions

getTownRank

public static java.util.List<java.lang.String> getTownRank(java.lang.String rank)

Get a specific ranks permissions

Parameters:

rank -

Returns:

a List of permissions

getNationRanks

public static java.util.List<java.lang.String> getNationRanks()

Fetch a list of all available nation ranks

Returns:

a list of rank names.

getNationDefault

public static java.util.List<java.lang.String> getNationDefault()

Default permissions everyone in a nation gets

Returns:

a List of permissions

getNationKing

public static java.util.List<java.lang.String> getNationKing()

A nations kings permissions

Returns:

a List of permissions

getNationRank

public static java.util.List<java.lang.String> getNationRank(java.lang.String rank)

Get a specific ranks permissions

Parameters:

rank -

Returns:

a List of Permissions

collectPermissions

public static void collectPermissions()

Update the list of permissions registered with bukkit

getAllRegisteredPermissions

public java.util.List<java.lang.String> getAllRegisteredPermissions(boolean includeChildren)

Fetch all permissions which are registered with superperms. {can include child nodes)

Parameters:

includeChildren -

Returns:

List of all permission nodes

getAllChildren

public static java.util.Map<java.lang.String,java.lang.Boolean> getAllChildren(java.lang.String node,
                                                               java.util.Set<java.lang.String> playerPermArray)

Returns a map of ALL child permissions registered with bukkit null is empty

Parameters:

node -

playerPermArray - current list of perms to check against for negations

Returns:

Map of child permissions

getChildren

public static java.util.Map<java.lang.String,java.lang.Boolean> getChildren(java.lang.String node)

Returns a map of the child permissions (1 node deep) as registered with Bukkit. null is empty

Parameters:

node -

Returns:

Map of child permissions