ru.tehkode.permissions.backends
Class FileBackend

java.lang.Object
  ru.tehkode.permissions.PermissionBackend
      ru.tehkode.permissions.backends.FileBackend

public class FileBackend
extends PermissionBackend

Author:

code

Field Summary

Configuration

permissions

Fields inherited from class ru.tehkode.permissions.PermissionBackend

config, createUserRecords, defaultBackend, manager, registedAliases

Constructor Summary

FileBackend(PermissionManager manager, org.bukkit.util.config.Configuration config)

Method Summary

static Map<String,String>	collectOptions(Map<String,Object> root)
protected static Map<String,String>	collectOptions(Map<String,Object> root, String baseKey, Map<String,String> collector)
void	dumpData(OutputStreamWriter writer) Dump data to native backend format
PermissionGroup	getDefaultGroup(String worldName) Returns default group, a group that is assigned to a user without a group set
PermissionGroup	getGroup(String groupName) Returns new PermissionGroup object for specified group name
PermissionGroup[]	getGroups() Return all registered groups
PermissionUser[]	getRegisteredUsers() Return all registered users
PermissionUser	getUser(String userName) Returns new PermissionUser object for specified player name
String[]	getWorldInheritance(String world) Returns an array of world names of specified world name
void	initialize() Backend initialization should be done here
void	reload() Reload backend (reread permissions file, reconnect to database, etc)
void	setDefaultGroup(PermissionGroup group, String worldName) Set group as default group
void	setWorldInheritance(String world, String[] parentWorlds) Set world inheritance parents for specified world

Methods inherited from class ru.tehkode.permissions.PermissionBackend

createGroup, getBackend, getBackend, getBackend, getBackendAlias, getBackendClass, getBackendClassName, getGroups, getGroups, getGroups, getGroups, getUsers, getUsers, getUsers, getUsers, getUsers, isCreateUserRecords, registerBackendAlias, removeGroup

Methods inherited from class java.lang.Object

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

Field Detail

permissions

public Configuration permissions

Constructor Detail

FileBackend

public FileBackend(PermissionManager manager,
                   org.bukkit.util.config.Configuration config)

Method Detail

initialize

public void initialize()

Description copied from class: PermissionBackend

Backend initialization should be done here

Specified by:

initialize in class PermissionBackend

getWorldInheritance

public String[] getWorldInheritance(String world)

Description copied from class: PermissionBackend

Returns an array of world names of specified world name

Specified by:

getWorldInheritance in class PermissionBackend

Parameters:

world - world name

Returns:

Array of parent worlds. If there is no parent world return empty array

setWorldInheritance

public void setWorldInheritance(String world,
                                String[] parentWorlds)

Description copied from class: PermissionBackend

Set world inheritance parents for specified world

Specified by:

setWorldInheritance in class PermissionBackend

Parameters:

world - world name which inheritance should be set

parentWorlds - array of parent world names

getUser

public PermissionUser getUser(String userName)

Description copied from class: PermissionBackend

Returns new PermissionUser object for specified player name

Specified by:

getUser in class PermissionBackend

Parameters:

userName - Player name

Returns:

PermissionUser for specified player, or null on error.

getGroup

public PermissionGroup getGroup(String groupName)

Description copied from class: PermissionBackend

Returns new PermissionGroup object for specified group name

Specified by:

getGroup in class PermissionBackend

Parameters:

groupName - Group name

Returns:

PermissionGroup object, or null on error

getDefaultGroup

public PermissionGroup getDefaultGroup(String worldName)

Description copied from class: PermissionBackend

Returns default group, a group that is assigned to a user without a group set

Specified by:

getDefaultGroup in class PermissionBackend

Returns:

Default group instance

setDefaultGroup

public void setDefaultGroup(PermissionGroup group,
                            String worldName)

Description copied from class: PermissionBackend

Set group as default group

Specified by:

setDefaultGroup in class PermissionBackend

getGroups

public PermissionGroup[] getGroups()

Description copied from class: PermissionBackend

Return all registered groups

Specified by:

getGroups in class PermissionBackend

Returns:

getRegisteredUsers

public PermissionUser[] getRegisteredUsers()

Description copied from class: PermissionBackend

Return all registered users

Specified by:

getRegisteredUsers in class PermissionBackend

Returns:

reload

public void reload()

Description copied from class: PermissionBackend

Reload backend (reread permissions file, reconnect to database, etc)

Specified by:

reload in class PermissionBackend

collectOptions

public static Map<String,String> collectOptions(Map<String,Object> root)

collectOptions

protected static Map<String,String> collectOptions(Map<String,Object> root,
                                                   String baseKey,
                                                   Map<String,String> collector)

dumpData

public void dumpData(OutputStreamWriter writer)
              throws IOException

Description copied from class: PermissionBackend

Dump data to native backend format

Specified by:

dumpData in class PermissionBackend

Parameters:

writer - Writer where dumped data should be written to

Throws:

IOException