|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectru.tehkode.permissions.PermissionBackend
public abstract class PermissionBackend
Field Summary | |
---|---|
protected org.bukkit.util.config.Configuration |
config
|
protected boolean |
createUserRecords
|
protected static String |
defaultBackend
|
protected PermissionManager |
manager
|
protected static Map<String,Class<? extends PermissionBackend>> |
registedAliases
Array of backend aliases |
Constructor Summary | |
---|---|
protected |
PermissionBackend(PermissionManager manager,
org.bukkit.util.config.Configuration config)
|
Method Summary | |
---|---|
PermissionGroup |
createGroup(String name)
|
abstract void |
dumpData(OutputStreamWriter writer)
Dump data to native backend format |
static PermissionBackend |
getBackend(String backendName,
org.bukkit.util.config.Configuration config)
Returns new backend class instance for specified backendName |
static PermissionBackend |
getBackend(String backendName,
PermissionManager manager,
org.bukkit.util.config.Configuration config)
Returns new Backend class instance for specified backendName |
static PermissionBackend |
getBackend(String backendName,
PermissionManager manager,
org.bukkit.util.config.Configuration config,
String fallBackBackend)
Returns new Backend class instance for specified backendName |
static String |
getBackendAlias(Class<? extends PermissionBackend> backendClass)
Return alias for specified backend class If there is no such class registered the fullname of this class would be returned using backendClass.getName(); |
static Class<? extends PermissionBackend> |
getBackendClass(String alias)
Returns Class object for specified alias, if there is no alias registered then try to find it using Class.forName(alias) |
static String |
getBackendClassName(String alias)
Return class name for alias |
abstract PermissionGroup |
getDefaultGroup(String worldName)
Returns default group, a group that is assigned to a user without a group set |
abstract PermissionGroup |
getGroup(String name)
Returns new PermissionGroup object for specified group name |
abstract PermissionGroup[] |
getGroups()
Return all registered groups |
PermissionGroup[] |
getGroups(String groupName)
Return child groups of specified group |
PermissionGroup[] |
getGroups(String groupName,
boolean inheritance)
Return child groups of specified group. |
PermissionGroup[] |
getGroups(String groupName,
String worldName)
|
PermissionGroup[] |
getGroups(String groupName,
String worldName,
boolean inheritance)
|
abstract PermissionUser[] |
getRegisteredUsers()
Return all registered users |
abstract PermissionUser |
getUser(String name)
Returns new PermissionUser object for specified player name |
PermissionUser[] |
getUsers()
Return all registered and online users |
PermissionUser[] |
getUsers(String groupName)
Return users of specified group. |
PermissionUser[] |
getUsers(String groupName,
boolean inheritance)
Return users of specified group (and child groups) |
PermissionUser[] |
getUsers(String groupName,
String worldName)
|
PermissionUser[] |
getUsers(String groupName,
String worldName,
boolean inheritance)
|
abstract String[] |
getWorldInheritance(String world)
Returns an array of world names of specified world name |
abstract void |
initialize()
Backend initialization should be done here |
boolean |
isCreateUserRecords()
|
static void |
registerBackendAlias(String alias,
Class<? extends PermissionBackend> backendClass)
Register new alias for specified backend class |
abstract void |
reload()
Reload backend (reread permissions file, reconnect to database, etc) |
boolean |
removeGroup(String groupName)
Removes the specified group |
abstract void |
setDefaultGroup(PermissionGroup group,
String worldName)
Set group as default group |
abstract void |
setWorldInheritance(String world,
String[] parentWorlds)
Set world inheritance parents for specified world |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final String defaultBackend
protected PermissionManager manager
protected org.bukkit.util.config.Configuration config
protected boolean createUserRecords
protected static Map<String,Class<? extends PermissionBackend>> registedAliases
Constructor Detail |
---|
protected PermissionBackend(PermissionManager manager, org.bukkit.util.config.Configuration config)
Method Detail |
---|
public abstract void initialize()
public abstract PermissionUser getUser(String name)
name
- Player name
public abstract PermissionGroup getGroup(String name)
name
- Group name
public PermissionGroup createGroup(String name)
public boolean removeGroup(String groupName)
groupName
- Name of the group which should be removed
public abstract PermissionGroup getDefaultGroup(String worldName)
public abstract void setDefaultGroup(PermissionGroup group, String worldName)
group
- public abstract String[] getWorldInheritance(String world)
world
- world name
public abstract void setWorldInheritance(String world, String[] parentWorlds)
world
- world name which inheritance should be setparentWorlds
- array of parent world namespublic abstract PermissionGroup[] getGroups()
public PermissionGroup[] getGroups(String groupName)
groupName
-
public PermissionGroup[] getGroups(String groupName, String worldName)
public PermissionGroup[] getGroups(String groupName, boolean inheritance)
groupName
- inheritance
- - If true a full list of descendants will be returned
public PermissionGroup[] getGroups(String groupName, String worldName, boolean inheritance)
public PermissionUser[] getUsers()
public abstract PermissionUser[] getRegisteredUsers()
public PermissionUser[] getUsers(String groupName)
groupName
-
public PermissionUser[] getUsers(String groupName, String worldName)
public PermissionUser[] getUsers(String groupName, boolean inheritance)
groupName
- inheritance
- - If true return users list of descendant groups too
public PermissionUser[] getUsers(String groupName, String worldName, boolean inheritance)
public abstract void reload()
public abstract void dumpData(OutputStreamWriter writer) throws IOException
writer
- Writer where dumped data should be written to
IOException
public static String getBackendClassName(String alias)
alias
-
public static Class<? extends PermissionBackend> getBackendClass(String alias) throws ClassNotFoundException
alias
-
ClassNotFoundException
public static void registerBackendAlias(String alias, Class<? extends PermissionBackend> backendClass)
alias
- backendClass
- public static String getBackendAlias(Class<? extends PermissionBackend> backendClass)
backendClass
-
public static PermissionBackend getBackend(String backendName, org.bukkit.util.config.Configuration config)
backendName
- Class name or alias of backendconfig
- Configuration object to access backend settings
public static PermissionBackend getBackend(String backendName, PermissionManager manager, org.bukkit.util.config.Configuration config)
backendName
- Class name or alias of backendmanager
- PermissionManager objectconfig
- Configuration object to access backend settings
public static PermissionBackend getBackend(String backendName, PermissionManager manager, org.bukkit.util.config.Configuration config, String fallBackBackend)
backendName
- Class name or alias of backendmanager
- PermissionManager objectconfig
- Configuration object to access backend settingsfallBackBackend
- name of backend that should be used if specified backend was not found or failed to initialize
public boolean isCreateUserRecords()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |