com.martinambrus.adminAnything

Class AA_API

java.lang.Object

com.martinambrus.adminAnything.AA_API

public final class AA_API
extends java.lang.Object

API for AdminAnything used by AA's own procedures but also publicly available to other plugins.

Constructor Summary

Constructors

Constructor and Description
AA_API(AdminAnything aa) Constructor, stores an instance of AdminAnything, so this API can work with it.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	__(java.lang.String identifier, java.lang.Object... params) Returns translation for the given identifier, and optionally a set of parameters.
static boolean	checkGroupPerm(org.bukkit.command.CommandSender sender, java.lang.String perm) Checks whether the given CommandSender's primary group has the requested permission assigned.
static boolean	checkGroupPerm(java.lang.String worldName, java.lang.String groupName, java.lang.String perm) Checks whether the given group in the given world has the requested permission assigned.
static boolean	checkPerms(org.bukkit.command.CommandSender sender, java.lang.String permsQuery, boolean showResultToSender) Uses a query parsing algorithm to check for one or many permission nodes given via the permsQuery parameter.
static boolean	classMapContainsKey(java.lang.String key) Checks for existence of a command location key in the class map.
static boolean	commandMapContainsKey(java.lang.String key) Checks whether the command map contains the given key.
static boolean	configContainsKey(java.lang.String key) Checks whether the given key is present in the plugin configuration.
static void	generateConsoleWarning(java.lang.String warningText) Generates a console warning.
static java.lang.String	getAaDataDir() Returns the data folder for AdminAnything. This is used in various warning messages in console to inform Admins where to search for files they need to update (for example to turn off statistics etc.) Example:
static java.lang.String	getAaName() Returns name of the AdminAnything plugin.
static java.lang.String	getAaVersion() Gets the plugin version Example:
static java.util.Map<java.lang.String,org.bukkit.command.Command>	getAugmentedCommandMap() Augments and returns a temporary copy of a commandMap with manually-crafter commands from permdescriptions.yml file, or rather mostly sub-commands of a single command (/plugman help, /plugman info...), so these can be shown in /aa_playercommands and /aa_listcommands.
static java.lang.String	getAvailableNewVersion() Returns the newVersionAvailable value, be it null or a real new version string.
static java.util.Collection<java.lang.String>	getBanIpCommandsList() Loads list of IP ban commands from the config file, since different MC versions tend to use different ban-ip commands and the server could even have its own flavor of ban-ip from a plugin.
static java.util.Collection<java.lang.String>	getBuiltInCommands() Get list of built-in commands for a Spigot server.
static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getChatJoinActionsMap() Gets map of actions to be added to the chat next to player's username when they join the server, if enabled.
static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getChatLeaveActionsMap() Gets map of actions to be added to the chat next to player's username when they leave the server, if enabled.
static java.lang.String	getClassMapKey(java.lang.String key) Retrieves a key from the class map cache.
static java.lang.String	getCleanPluginName(java.lang.String pluginWithCommand, boolean returnRealPluginName) Returns a clear name of the plugin from a string which may contain the plugin along with a command (essentials:ban) or along with a core alias (Core -> minecraft:ban).
static java.lang.String[]	getClearCommand(java.lang.String cmd) Returns a clear command name from the command given.
static java.util.List<java.lang.String>	getCommandContainingPlugins(java.lang.String command, boolean... extendCorePluginNames) Returns a list of plugin names that contain the given command.
static java.util.Map<java.lang.String,org.bukkit.command.Command>	getCommandMapCopy() Returns a copy of the entry set for the command map.
static org.bukkit.command.Command	getCommandMapKey(java.lang.String key) Retrieves an actual command from the command map according to the given command name.
static java.util.Set<java.lang.String>	getCommandsConfigurationKeys(java.lang.String which, boolean deep) Retrieves a list of keys from the configuration of the commands to be redirected, muted, overridden etc.
static java.lang.String	getCommandsConfigurationValue(java.lang.String which, java.lang.String key) Retrieves a value to be used in place of the original command which was ignored, muted, overridden etc.
static java.util.Map<java.lang.String,java.lang.Object>	getCommandsConfigurationValues(java.lang.String which) Retrieves a list of values from the configuration of the commands to be redirected, muted, overridden etc.
static java.lang.Iterable<java.lang.String>	getCommandsKeySet() Retrieves a set of all commands for AdminAnything.
static java.util.List<java.lang.String>	getCommandsList(java.lang.String which) Gets an unmodifiable list of the requested type of commands (i.e.
static boolean	getConfigBoolean(java.lang.String key) Returns a boolean value from AA's configuration.
static java.lang.Iterable<java.lang.String>	getConfigSectionKeys(java.lang.String key) Returns keys of a configuration section from AA's configuration.
static java.lang.String	getConfigString(java.lang.String key) Returns a string value from AA's configuration.
static java.lang.String	getConfigString(java.lang.String key, java.lang.String def) Returns a string value from AA's configuration.
static boolean	getDebug() Gets this plugin's debug state.
static org.bukkit.configuration.file.FileConfiguration	getManualPermDescriptionsConfig() Returns current configuration of manual permissions and commands for plugins that don't provide these in their plugin.yml file.
static double	getMaxRecordsPerPage() Gets the maximum records (lines) per page displayable in various AdminAnything listings, such as list of commands, permissions or conflicts.
static java.util.Map<java.lang.String,java.lang.Boolean>	getMutesMap() Gets an unmodifiable map of muted commands.
static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getNickClickActionsMap() Gets map of actions to be added to the chat next to player's username when a chat message is sent, if enabled.
static java.util.List<java.lang.String>	getPlayerAvailableCommands(org.bukkit.entity.Player p) Gets all commands available to a single player in their current world.
static java.lang.String[]	getPlayerPermGroups(org.bukkit.entity.Player p) Returns all permission groups in which a player is present.
static java.lang.String	getPlayerPrimaryPermGroup(org.bukkit.entity.Player p) Retrieves player's primary group name.
static java.lang.Iterable<java.lang.String>	getPluginCommands(java.lang.String plugin) Retrieves a list of all commands for the given plugin.
static java.lang.String	getPluginForCommand(java.lang.String key, org.bukkit.command.Command value) Returns name of the plugin to which the given command belongs.
static org.bukkit.plugin.Plugin	getPluginIgnoreCase(java.lang.String pluginName) Returns plugin name from the cache of lowercased plugins as opposed to the Bukkit.getPluginManager().getPlugin() case-sensitive getting.
static java.lang.Iterable<java.lang.String>	getServerCommands() Retrieves a list of all commands on the server.
static java.lang.Iterable<java.lang.String>	getServerPlugins() Retrieves a set of all plugin names on the server.
static java.lang.Iterable<java.lang.String>	getServerPlugins(java.lang.String... prependBy) Retrieves a set of all plugin names on the server, prepended by the given string prefix.
static boolean	getVirtualPermsCaseSensitive() Check whether virtual permissions should consider letter case when checking them against player's permissions.
static java.lang.String	guessPluginFromClass(java.lang.Class<?> clazz) Returns the plugin name from the given class, which should be one of the command is was just being executed.
static boolean	isAaCoreCommand(java.lang.String[] cmd) Checks whether the given command is AdminAnything's internal command.
static boolean	isFeatureEnabled(java.lang.String featureConfigKey) Checks whether a feature in AdminAnything is enabled via config.
static boolean	isListenerRegistered(java.lang.String listenerName) Checks whether a named listener is already registered with AdminAnything.
static boolean	isPlayerInPermGroup(org.bukkit.entity.Player p, java.lang.String group) Checks whether a player is in the given permission group.
static boolean	isVaultEnabled() Checks whether Vault is enabled on the server.
static boolean	isWarmingUp() Returns TRUE if the initial warmup of AdminAnything is not yet passed, FALSE otherwise.
static void	loadCommandsListFromConfig(java.lang.String which) Loads the requested commands list which will then be used in various parts of this plugin.
static void	loadJoinLeaveClickLinks() Loads join and click event links that will be displayed in chat next to player username's if enabled in config.
static void	loadNickClickLinks() Loads nick click links that will be displayed in chat next to player username's if enabled in config.
static java.lang.String	parsePluginJARLocation(java.lang.Class<?> commandClass) Attempts to retrieve a location of the plugin's class file within the currently loaded JAR archives structure.
static boolean	pluginHasFullApiAccess(java.lang.String pluginName) Checks whether the given plugin has full access to AdminAnything's API, including all data adjusting event calls (i.e.
static void	startRequiredListener(java.lang.String listenerName) Registers a listener if that listener was not registered already.
static void	startRequiredListener(java.lang.String listenerName, org.bukkit.event.Listener listenerClassInstance) Registers a listener if that listener was not registered already.

Methods inherited from class java.lang.Object

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

Constructor Detail

AA_API

public AA_API(AdminAnything aa)

Constructor, stores an instance of AdminAnything, so this API can work with it. Not publicly available and only ever called from the main AdminAnything class' constructor.

Parameters:

aa - Instance of AdminAnything.

Method Detail

getAaName

public static java.lang.String getAaName()

Returns name of the AdminAnything plugin. If it ever changes, we don't have to string-replace all AdminAnything names in all files where console is used to log exceptions.

Example:

 Bukkit.getLogger().warning("[" + AA_API.getAaName() + "] Something's gone wrong :-P");
 

Returns:

Returns the string value from AA's configuration.

getConfigBoolean

public static boolean getConfigBoolean(java.lang.String key)

Returns a boolean value from AA's configuration.

Example:

 boolean chatNickClicksFeature = AA_API.getConfigBoolean("features.chatnicklinks.enabled");
 

Parameters:

key - The config key we want to return a boolean value for.

Returns:

Returns the boolean value from AA's configuration.

getConfigString

public static java.lang.String getConfigString(java.lang.String key)

Returns a string value from AA's configuration.

Example:

 String chatNickClicksColor = AA_API.getConfigString("chatNickClickActions." + key + ".color");
 

Parameters:

key - The config key we want to return a string value for.

Returns:

Returns the string value from AA's configuration.

getConfigString

public static java.lang.String getConfigString(java.lang.String key,
                                               java.lang.String def)

Returns a string value from AA's configuration.

Example:

 String listCommandsSeparator = AA_API.getConfigString("listCommandsSeparator", " ");
 

Parameters:

key - The config key we want to return a string value for.

def - Default value if string is not found in the configuration.

Returns:

Returns the string value from AA's configuration.

getConfigSectionKeys

public static java.lang.Iterable<java.lang.String> getConfigSectionKeys(java.lang.String key)

Returns keys of a configuration section from AA's configuration.

Example:

 
 for (final String key : AA_API.getConfigSectionKeys("chatNickClickActions")) {
     // do something with the configuration key name ("key" variable) here
 }
 
 

Parameters:

key - The configuration section the keys for we want to return.

Returns:

Returns keys for the requested configuration section.

getAaDataDir

public static java.lang.String getAaDataDir()

Returns the data folder for AdminAnything.
This is used in various warning messages in console to inform Admins where to search for files they need to update (for example to turn off statistics etc.)

Example:

 virtualPermissionsList.save(new File(AA_API.getAaDataDir(), "perms.yml"));
 

Returns:

Returns the full data folder path for AdminAnything.

getAaVersion

public static java.lang.String getAaVersion()

Gets the plugin version

Example:

 Bukkit.getLogger().log("info", "You are running AdminAnything, version " + AA_API.getAaVersion());
 

Returns:

Returns version of AdminAnything.

isFeatureEnabled

public static boolean isFeatureEnabled(java.lang.String featureConfigKey)

Checks whether a feature in AdminAnything is enabled via config.

Example:

 
 if (AA_API.isFeatureEnabled("listcommands")) {
     Bukkit.getLogger().log("info", "Listing of commands is enabled in AdminAnything.");
 }
 
 

Parameters:

featureConfigKey - The feature name in the config file (for example "addperm" to check the "features.addperm.enabled" key).

Returns:

Returns true if the requested feature is enabled, false otherwise.

getMaxRecordsPerPage

public static double getMaxRecordsPerPage()

Gets the maximum records (lines) per page displayable in various AdminAnything listings, such as list of commands, permissions or conflicts.

Example:

 
 if (recordsNumber > AA_API.getMaxRecordsPerPage()) {
     Bukkit.getLogger().log("info", "Pagination should be enabled here, as we've requested more records than we allow per one page.");
 }
 
 

Returns:

Returns the maximum number of records (lines) per one page to be returned to the client.

getDebug

public static boolean getDebug()

Gets this plugin's debug state.

Example:

 
 if (AA_API.getDebug()) {
     Bukkit.getLogger().log("debug", "AdminAnything debug information line.");
 }
 
 

Returns:

Returns true if debug is turned ON, false otherwise.

getBuiltInCommands

public static java.util.Collection<java.lang.String> getBuiltInCommands()

Get list of built-in commands for a Spigot server.

Example:

 
 if (AA_API.getBuiltInCommands().contains("ban")) {
     Bukkit.getLogger().log("info", "/ban is a Minecraft built-in server command.");
 }
 
 

Returns:

Returns a hard-coded list of core commands from the CommandMap of Spigot as of version 1.12. There are commands from all - Minecraft, CraftBukkit and Spigot.

getCommandsKeySet

public static java.lang.Iterable<java.lang.String> getCommandsKeySet()

Retrieves a set of all commands for AdminAnything. This is used when registering command executors, tab completers, as well as in class transformations due to enabled commands muting.

Example:

 
 for (final String cmd : AA_API.getCommandsKeySet()) {
   // register tab listener for the command in question
   // note: exception handling omitted for brevity
   final Class<?> cl = Class.forName("com.martinambrus.adminAnything.tabcomplete." + cmd.substring(0, 1).toUpperCase() + cmd.substring(1));

   TabCompleter tc = (TabCompleter) cl.getConstructor().newInstance();
   ((JavaPlugin) plugin).getCommand(cmd).setTabCompleter(tc);
 }
 
 

Returns:

Returns a set of names for all commands of AdminAnything.

configContainsKey

public static boolean configContainsKey(java.lang.String key)

Checks whether the given key is present in the plugin configuration.

Example:

 
 if (AA_API.configContainsKey("listcommandsDefaults.showdescriptions")) {
   // config contains a default setting for showing/hiding command descriptions
   // when using /aa_listcommands
 }
 
 

Returns:

Returns true if the key is present in configuration, false otherwise.

pluginHasFullApiAccess

public static boolean pluginHasFullApiAccess(java.lang.String pluginName)

Checks whether the given plugin has full access to AdminAnything's API, including all data adjusting event calls (i.e. to add/remove records to/from lists of fixed, muted, disabled... commands etc.).

Parameters:

pluginName - Name of the plugin to check for. Letter case is ignored.

Returns:

Returns true if the given plugin has full access to AA's API, false otherwise.

getBanIpCommandsList

public static java.util.Collection<java.lang.String> getBanIpCommandsList()

Loads list of IP ban commands from the config file, since different MC versions tend to use different ban-ip commands and the server could even have its own flavor of ban-ip from a plugin.

Returns:

Returns list of all commands AdminAnything should consider as IP-ban ones.

loadJoinLeaveClickLinks

public static void loadJoinLeaveClickLinks()

Loads join and click event links that will be displayed in chat next to player username's if enabled in config.

loadNickClickLinks

public static void loadNickClickLinks()

Loads nick click links that will be displayed in chat next to player username's if enabled in config.

getChatJoinActionsMap

public static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getChatJoinActionsMap()

Gets map of actions to be added to the chat next to player's username when they join the server, if enabled.

Returns:

Returns the map of actions to be added to player's username when they join the server.

getChatLeaveActionsMap

public static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getChatLeaveActionsMap()

Gets map of actions to be added to the chat next to player's username when they leave the server, if enabled.

Returns:

Returns the map of actions to be added to player's username when they leave the server.

getNickClickActionsMap

public static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getNickClickActionsMap()

Gets map of actions to be added to the chat next to player's username when a chat message is sent, if enabled.

Returns:

Returns the map of actions to be added to player's username when a chat message is sent.

isListenerRegistered

public static boolean isListenerRegistered(java.lang.String listenerName)

Checks whether a named listener is already registered with AdminAnything. This method is used to prevent the same event listener being registered more than once.

Example:

 
 if (!AA_API.isListenerRegistered("chatJoinLeaveClicks")) {
   // register an event listener to display join and leave click links next to nicknames
   // in chat
 }
 
 

Parameters:

listenerName - Name of the listener to check for.

Returns:

Returns true if the given listener name is already registered, false otherwise.

startRequiredListener

public static void startRequiredListener(java.lang.String listenerName)

Registers a listener if that listener was not registered already. Can be used to lazy-register listeners from various listener classes.

Example:

 // register an event listener to display join and leave click links next to nicknames in chat
 AA_API.startRequiredListener("chatJoinLeaveClicks");
 

Parameters:

listenerName - ClassName of the listener to register. This class will then be loaded from com.martinambrus.adminAnything.listeners.[[ listenerName ]]

startRequiredListener

public static void startRequiredListener(java.lang.String listenerName,
                                         org.bukkit.event.Listener listenerClassInstance)

Registers a listener if that listener was not registered already. Can be used to lazy-register listeners from various listener classes.

Example:

 AA_API.startRequiredListener("yourListenerName", yourListenerClassInstance);
 

Parameters:

listenerName - An arbitrary name of the listener to register. AA uses its feature names to register event listeners this way.

listenerClassInstance - The actual instance of the listener class we'd like to register.

generateConsoleWarning

public static void generateConsoleWarning(java.lang.String warningText)

Generates a console warning. In AdminAnything, this method is used when AA is starting or reloading to show any and all error messages that a server Admin should be aware of.

Example:

 AA_API.generateConsoleWarning("You shouldn't eat yellow snow!");
 

Parameters:

warningText - The actual text to display in console.

checkPerms

public static boolean checkPerms(org.bukkit.command.CommandSender sender,
                                 java.lang.String permsQuery,
                                 boolean showResultToSender)

Uses a query parsing algorithm to check for one or many permission nodes given via the permsQuery parameter.

Example:

 
 if (aa_plugin_instance.getPluginUtils().checkPerms(sender, "my_permission", true) {
  // do your stuff
  // ... if the commandSender (sender) OR their permission groups do not have the relevant permission,
  //     an error message will be displayed to the sender
 }
 
 

Example:

 
 if (aa_plugin_instance.getPluginUtils().checkPerms(sender, "my_permission", true, true) {
 // do your stuff
 // ... if the commandSender (sender) themselves does not have the relevant permission,
 //     an error message will be displayed to them
 }
 
 

Example:

 
 if (aa_plugin_instance.getPluginUtils().checkPerms(sender, "(perm1 OR perm2) AND perm3", false) {
  // do your stuff
  // ... in this case, no error message is displayed to the command sender (last parameter is false)
  //     and you can handle this case with your own logic
 }
 
 

Parameters:

sender - The org.bukkit.command.CommandSender CommandSender who we're checking the permission(s) for.

permsQuery - An SQL-like query containing all the parameters that we need to check for.
The syntax is the same as used in SQL queries with AND / OR sections. Parenthesis are important, as is remembering the general rule of operator priority, which says that AND has a higher priority over OR.
That means that any AND statements will be evaluated first.

Example: perm1 AND perm2
» will check for both, perm1 and perm2 permissions

Example: perm1 OR perm2
» will check for either perm1 or perm2 permission

Example: perm1 AND perm2 OR perm3
» will check for either perm1 + perm2, or the perm3 permission

Example: perm1 AND (perm2 OR perm3)
» the use of parenthesis now changes the previous example, so perm1 + EITHER ONE of perm2 or perm3 permissions will be checked

showResultToSender - If TRUE, a message will be sent out to the player / console for who we're checking these permissions.

Returns:

Returns true if the sender has the requested permission(s), false otherwise.

checkGroupPerm

public static boolean checkGroupPerm(org.bukkit.command.CommandSender sender,
                                     java.lang.String perm)

Checks whether the given CommandSender's primary group has the requested permission assigned.

Example:

 
 if (AA_API.checkGroupPerm(sender, "my_permission") {
  // do your stuff
 }
 

Parameters:

sender - The org.bukkit.command.CommandSender CommandSender whose group we're checking the permission(s) for.

perm - The actual permission we're checking for.

Returns:

Returns true if the sender's primary group has the requested permission, false otherwise (or if Vault is not enabled).

checkGroupPerm

public static boolean checkGroupPerm(java.lang.String worldName,
                                     java.lang.String groupName,
                                     java.lang.String perm)

Checks whether the given group in the given world has the requested permission assigned.

Example:

 
 if (AA_API.checkGroupPerm("world", "default", "my_permission") {
  // do your stuff
 }
 

Parameters:

worldName - Name of the world for the perm group check.

groupName - Name of the group we're performing the check for.

perm - The actual permission we're checking.

Returns:

Returns true if the sender's primary group has the requested permission, false otherwise (or if Vault is not enabled).

isVaultEnabled

public static boolean isVaultEnabled()

Checks whether Vault is enabled on the server.

Example:

 
 if (AA_API.isVaultEnabled()) {
   // Vault is enabled, we should hook in to check player permissions
 }
 
 

Returns:

Returns true if Vault is enabled, false otherwise.

isPlayerInPermGroup

public static boolean isPlayerInPermGroup(org.bukkit.entity.Player p,
                                          java.lang.String group)

Checks whether a player is in the given permission group. This check is done via Vault's API and if Vault is not present or enabled, it will return TRUE in case the group name provided was either "global" or "default", FALSE otherwise.

Example:

  
  if (AA_API.isPlayerInPermGroup( playerInstance, "owners" )) {
    // player is in the "Owners" group, let's roll...
  }
  
  

Parameters:

p - Player for which we want to check presence in the permision group.

group - The actual permission group name to check if the player is in.

Returns:

Returns TRUE if the player is present in the group, or if Vault is disabled, then returns TRUE if the player is in either group named "global" or "default". Returns FALSE otherwise.

getPlayerPermGroups

public static java.lang.String[] getPlayerPermGroups(org.bukkit.entity.Player p)

Returns all permission groups in which a player is present. If Vault is disabled, an empty array is returned.

Parameters:

p - The player to check groups for.

Returns:

Returns all permission groups in which a player is present. If Vault is disabled, an empty array is returned.

getPlayerPrimaryPermGroup

public static java.lang.String getPlayerPrimaryPermGroup(org.bukkit.entity.Player p)

Retrieves player's primary group name.

Parameters:

p - Player to retrieve primary group info for.

Returns:

Returns name of player's primary group or "" (empty string) if Vault is disabled.

commandMapContainsKey

public static boolean commandMapContainsKey(java.lang.String key)
                                     throws java.rmi.AccessException,
                                            java.lang.IllegalAccessException,
                                            java.lang.NoSuchMethodException,
                                            java.lang.SecurityException,
                                            java.lang.reflect.InvocationTargetException

Checks whether the command map contains the given key. The key will be a full command name, such as "essentials:ban".

Example:

 
 if (AA_API.commandMapContainsKey("essentials:ban")) {
   // essentials:ban found to be a real command from the command map
   // and we can immediately execute it
 }
 
 

Parameters:

key - The actual command name we want to look up in the command map.

Returns:

Returns true if the command map contains the given command, false otherwise.

Throws:

java.lang.IllegalAccessException - When access is denied to org.bukkit.command.CommandMap or org.bukkit.command.SimpleCommandMap.knownCommands field.

java.lang.NoSuchMethodException - When there is a get() method missing from the org.bukkit.command.SimpleCommandMap.knownCommands field.

java.lang.SecurityException - When private fields cannot be accessed due to a security restriction.

java.lang.reflect.InvocationTargetException - When we try to invoke get() on org.bukkit.command.SimpleCommandMap.knownCommands with invalid org.bukkit.command.CommandMap parameter.

java.rmi.AccessException - When we don't have the permission to access the org.bukkit.command.SimpleCommandMap.knownCommands field of commandMap.

getCommandMapKey

public static org.bukkit.command.Command getCommandMapKey(java.lang.String key)
                                                   throws java.rmi.AccessException,
                                                          java.lang.IllegalAccessException,
                                                          java.lang.NoSuchMethodException,
                                                          java.lang.SecurityException,
                                                          java.lang.reflect.InvocationTargetException

Retrieves an actual command from the command map according to the given command name.

Example:

 // ban ZathrusWriter using essentials' ban command
 AA_API.getCommandMapKey("essentials:ban").execute(Bukkit.getConsoleSender(), "ban", "ZathrusWriter");
 

Parameters:

key - The command name we want to retrieve the actual command for.

Returns:

Returns the actual command retrieved from the command map according to the given command name.

Throws:

java.lang.IllegalAccessException - When access is denied to the org.bukkit.command.CommandMap or org.bukkit.command.SimpleCommandMap.knownCommands field.

java.lang.NoSuchMethodException - When there is a get() method missing from the org.bukkit.command.SimpleCommandMap.knownCommands field.

java.lang.SecurityException - When private fields cannot be accessed due to a security restriction.

java.lang.reflect.InvocationTargetException - When we try to invoke get() on org.bukkit.command.SimpleCommandMap.knownCommands with invalid org.bukkit.command.CommandMap parameter.

java.rmi.AccessException - When we don't have the permission to access the org.bukkit.command.SimpleCommandMap.knownCommands field of org.bukkit.command.CommandMap.

getCommandMapCopy

public static java.util.Map<java.lang.String,org.bukkit.command.Command> getCommandMapCopy()
                                                                                    throws java.rmi.AccessException,
                                                                                           java.lang.IllegalAccessException,
                                                                                           java.lang.NoSuchMethodException,
                                                                                           java.lang.SecurityException,
                                                                                           java.lang.reflect.InvocationTargetException

Returns a copy of the entry set for the command map. This is used in the runnable part of /aa_checkcommandconflicts and is coded this way, so we don't give write access to the actual command map.

Example:

 
 for (final Entry<String, Command> pair : AA_API.getCommandMapCopy().entrySet()) {
   // pair.getKey() will contain the command name of each command registered via CommandMap on the server
   // pair.getValue() will contain the actual command registered via CommandMap
 }
 

Returns:

Returns a clone of the server's command map.

Throws:

java.lang.IllegalAccessException - When access is denied to the org.bukkit.command.CommandMap or org.bukkit.command.SimpleCommandMap.knownCommands field.

java.lang.NoSuchMethodException - When there is a get() method missing from the org.bukkit.command.SimpleCommandMap.knownCommands field.

java.lang.SecurityException - When private fields cannot be accessed due to a security restriction.

java.lang.reflect.InvocationTargetException - When we try to invoke get() on org.bukkit.command.SimpleCommandMap.knownCommands with invalid org.bukkit.command.CommandMap parameter.

java.rmi.AccessException - When we don't have the permission to access the org.bukkit.command.SimpleCommandMap.knownCommands field of org.bukkit.command.CommandMap.

getAugmentedCommandMap

public static java.util.Map<java.lang.String,org.bukkit.command.Command> getAugmentedCommandMap()
                                                                                         throws java.lang.reflect.InvocationTargetException,
                                                                                                java.lang.NoSuchMethodException,
                                                                                                java.rmi.AccessException,
                                                                                                java.lang.IllegalAccessException

Augments and returns a temporary copy of a commandMap with manually-crafter commands from permdescriptions.yml file, or rather mostly sub-commands of a single command (/plugman help, /plugman info...), so these can be shown in /aa_playercommands and /aa_listcommands.

Returns:

Returns a copy of server's commandMap, augmented with extra commands from the from permdescriptions.yml file.

Throws:

java.lang.IllegalAccessException - When access is denied to the commandMap or knownCommands field.

java.lang.NoSuchMethodException - When there is a get() method missing from the knownCommands field.

java.lang.reflect.InvocationTargetException - When we try to invoke get() on knownCommands with invalid commandMap parameter.

java.rmi.AccessException - When we don't have the permission to access the knownCommands field of commandMap.

getClearCommand

public static java.lang.String[] getClearCommand(java.lang.String cmd)

Returns a clear command name from the command given. Used when a command is prefixed (i.e. minecraft:ban or essentials:ban).

Example:

 // will hold "ban"
 String clearBan = AA_API.getClearCommand("minecraft:ban")[0];
 

Parameters:

cmd - The actual command to return stripped of dots and colons.

Returns:

Returns a command that's stripped-down version of the original commands, i.e. without any dots or colons.

getPluginForCommand

public static java.lang.String getPluginForCommand(java.lang.String key,
                                                   org.bukkit.command.Command value)
                                            throws java.io.InvalidClassException

Returns name of the plugin to which the given command belongs.

Example:

 
 for (final Entry<String, Command> pair : AA_API.getCommandMapCopy().entrySet()) {
     Bukkit.getLogger().log("info", "Command '" + pair.getKey() + "' is from the plugin '" + AA_API.getPluginForCommand(pair.getKey(), pair.getValue()) + "'");
 }
 
 

Parameters:

key - The commands name to lookup a plugin name for.

value - The actual command we're trying to lookup a plugin for. Used for a short-circuited version of plugin checking when org.bukkit.command.Command Command} is actually an instance of org.bukkit.command.PluginCommand PluginCommand}, from which the plugin name retrieval is trivial.

Returns:

Returns name of the plugin to which the given command belongs.

Throws:

java.io.InvalidClassException - When this plugin's class file is not found in the current classLoader.

getCommandContainingPlugins

public static java.util.List<java.lang.String> getCommandContainingPlugins(java.lang.String command,
                                                                           boolean... extendCorePluginNames)
                                                                    throws java.rmi.AccessException,
                                                                           java.lang.IllegalAccessException,
                                                                           java.io.InvalidClassException,
                                                                           java.lang.NoSuchMethodException,
                                                                           java.lang.SecurityException,
                                                                           java.lang.reflect.InvocationTargetException

Returns a list of plugin names that contain the given command.

Example:

 
 for (final String pluginName : AA_API.getCommandContainingPlugins("ban")) {
     Bukkit.getLogger().log("info", "Command 'ban' found in plugin '" + pluginName);
 }
 

Parameters:

command - The actual command we need to check all plugins for.

extendCorePluginNames - If true, an extended name with a "Core -> " prefix is returned in the listing, otherwise only the clear command name will be returned.

Returns:

Returns a list of plugins that contain the command in question.

Throws:

java.rmi.AccessException - AccessException When we don't have the permission to access the org.bukkit.command.SimpleCommandMap.knownCommands field of org.bukkit.command.CommandMap.

java.lang.IllegalAccessException - When access is denied to the org.bukkit.command.CommandMap or org.bukkit.command.SimpleCommandMap.knownCommands field.

java.io.InvalidClassException - When a class for any of the server plugins cannot be found within the current classLoader.

java.lang.reflect.InvocationTargetException - When we try to invoke get() on org.bukkit.command.SimpleCommandMap.knownCommands with invalid org.bukkit.command.CommandMap parameter.

java.lang.SecurityException - When private fields cannot be accessed due to a security restriction.

java.lang.NoSuchMethodException - When there is a get() method missing from the org.bukkit.command.SimpleCommandMap.knownCommands field.

isAaCoreCommand

public static boolean isAaCoreCommand(java.lang.String[] cmd)

Checks whether the given command is AdminAnything's internal command. Used to prevent disabling or otherwise messing with our commands, so admins can undo things when they make a mistake (which they wouldn't be able to if they disabled certain combination of commands of AdminAnything without stopping the server, editing config.yml and re-starting).

Example:

 
 if (AA_API.isAaCoreCommand("aa_reload")) {
     Bukkit.getLogger().log("info", "Command /aa_reload() is indeed an AdminAnything core command :)");
 }
 
 

Parameters:

cmd - The command to check.

Returns:

Returns true if the command in question comes from AdminAnything, false otherwise.

guessPluginFromClass

public static java.lang.String guessPluginFromClass(java.lang.Class<?> clazz)
                                             throws java.io.InvalidClassException

Returns the plugin name from the given class, which should be one of the command is was just being executed.

Example:

 Bukkit.getLogger().log("info", "Requested class originates from plugin '" + AA_API.guessPluginFromClass(somePluginCommandClass) + "'");
 

Parameters:

clazz - Class of the command being executed.

Returns:

Returns the name of plugin containing the command currently called.

Throws:

java.io.InvalidClassException - When this plugin's class file is not found in the current classLoader.

getServerCommands

public static java.lang.Iterable<java.lang.String> getServerCommands()
                                                              throws java.rmi.AccessException,
                                                                     java.lang.IllegalAccessException,
                                                                     java.lang.NoSuchMethodException,
                                                                     java.lang.reflect.InvocationTargetException

Retrieves a list of all commands on the server.

Returns:

Returns a list of all registered command names on the server.

Throws:

java.lang.IllegalAccessException - When access is denied to the org.bukkit.command.CommandMap or org.bukkit.command.SimpleCommandMap.knownCommands field.

java.lang.NoSuchMethodException - When there is a get() method missing from the org.bukkit.command.SimpleCommandMap.knownCommands field.

java.lang.reflect.InvocationTargetException - When we try to invoke get() on org.bukkit.command.SimpleCommandMap.knownCommands with invalid org.bukkit.command.CommandMap parameter.

java.rmi.AccessException - When we don't have the permission to access the org.bukkit.command.SimpleCommandMap.knownCommands field of org.bukkit.command.CommandMap.

getPluginCommands

public static java.lang.Iterable<java.lang.String> getPluginCommands(java.lang.String plugin)
                                                              throws java.rmi.AccessException,
                                                                     java.lang.IllegalAccessException,
                                                                     java.lang.NoSuchMethodException,
                                                                     java.lang.reflect.InvocationTargetException,
                                                                     java.io.InvalidClassException

Retrieves a list of all commands for the given plugin.

Parameters:

plugin - The plugin name for which to retrieve commands.

Returns:

Returns a list of commands for the given plugin or null if none are found.

Throws:

java.lang.IllegalAccessException - When access is denied to the org.bukkit.command.CommandMap or org.bukkit.command.SimpleCommandMap.knownCommands field.

java.lang.NoSuchMethodException - When there is a get() method missing from the org.bukkit.command.SimpleCommandMap.knownCommands field.

java.lang.reflect.InvocationTargetException - When we try to invoke get() on org.bukkit.command.SimpleCommandMap.knownCommands with invalid org.bukkit.command.CommandMap parameter.

java.rmi.AccessException - When we don't have the permission to access the org.bukkit.command.SimpleCommandMap.knownCommands field of org.bukkit.command.CommandMap.

java.io.InvalidClassException - When this plugin's class file is not found in the current classLoader.

loadCommandsListFromConfig

public static void loadCommandsListFromConfig(java.lang.String which)
                                       throws java.security.InvalidParameterException

Loads the requested commands list which will then be used in various parts of this plugin.

Example:

 // loads the list of all disabled commands
 AA_API.loadCommandsListFromConfig("removals");
 

Parameters:

which - Says which list (for which feature) we want to load.
Valid values are:

• ignores
• overrides
• virtualperms
• removals
• mutes
• redirects
• helpDisables

Throws:

java.security.InvalidParameterException - When the given which parameter does not conform to any known list of commands.

getCommandsList

public static java.util.List<java.lang.String> getCommandsList(java.lang.String which)
                                                        throws java.security.InvalidParameterException

Gets an unmodifiable list of the requested type of commands (i.e. ignores, fixes etc.)

Example:

 Bukkit.getLogger().log("info", "Commands currently disabled via AdminAnything: " + Utils.flatten(AA_API.getCommandsList("removals"), true));
 

Parameters:

which - Says which list (for which feature) we want to return.
Valid values are:

• ignores
• overrides
• virtualperms
• removals
• mutes
• redirects
• helpDisables

Returns:

Returns an unmodifiable list of the requested type of commands (i.e. ignores, fixes etc.)

Throws:

java.security.InvalidParameterException - When the given which parameter does not conform to any known list of commands.

getCommandsConfigurationValues

public static java.util.Map<java.lang.String,java.lang.Object> getCommandsConfigurationValues(java.lang.String which)
                                                                                       throws java.security.InvalidParameterException

Retrieves a list of values from the configuration of the commands to be redirected, muted, overridden etc.

Example:

 
 if (AA_API.getCommandsConfigurationValues("virtualperms").containsKey("customban")) {
     Bukkit.getLogger().log("info", "The 'customban' virtual permission was successfully located on this server.");
 }
 
 

Parameters:

which - The actual configuration file to return the value set for.
Valid values are:

• ignores
• overrides
• virtualperms
• removals
• mutes
• redirects
• helpDisables

Returns:

Returns a list of values from the requested commands configuration.

Throws:

java.security.InvalidParameterException - When the given which parameter does not conform to any known list of commands.

getCommandsConfigurationKeys

public static java.util.Set<java.lang.String> getCommandsConfigurationKeys(java.lang.String which,
                                                                           boolean deep)
                                                                    throws java.security.InvalidParameterException

Retrieves a list of keys from the configuration of the commands to be redirected, muted, overridden etc.

Example:

 
 // as used in /aa_delredirect
 final Set<String> redirects = AA_API.getCommandsConfigurationKeys("redirects", false);
 if (redirects.size() == 0) {
     sender.sendMessage(ChatColor.GREEN + "No commands are currently being redirected via " + AA_API.getAaName() + ".");
 }
 
 

Parameters:

which - The actual configuration file to return the keys set for.
Valid values are:

• ignores
• overrides
• virtualperms
• removals
• mutes
• redirects
• helpDisables

deep - When set to TRUE, configuration keys including heir subkeys will be returned. When set to FALSE, only first-level keys will be returned.

Returns:

Returns a list of keys from the requested commands configuration.

Throws:

java.security.InvalidParameterException - When the given which parameter does not conform to any known list of commands.

getCommandsConfigurationValue

public static java.lang.String getCommandsConfigurationValue(java.lang.String which,
                                                             java.lang.String key)
                                                      throws java.security.InvalidParameterException

Retrieves a value to be used in place of the original command which was ignored, muted, overridden etc.

Example:

 
 if (!AA_API.getCommandsConfigurationValue("removals", "ban").equals("")) {
     sender.sendMessage(ChatColor.GREEN + "The command 'ban' is currently disabled.");
 }
 
 

Parameters:

which - The actual configuration file to look in for the value.
Valid values are:

• ignores
• overrides
• virtualperms
• removals
• mutes
• redirects
• helpDisables

key - The configuration key (i.e. our command) we want to return a replacement for.

Returns:

Returns the replacement command value we asked for from the loaded configuration.

Throws:

java.security.InvalidParameterException - When the given which parameter does not conform to any known list of commands.

getVirtualPermsCaseSensitive

public static boolean getVirtualPermsCaseSensitive()

Check whether virtual permissions should consider letter case when checking them against player's permissions.

Returns:

Returns true if we should consider custom permissions letter case, false otherwise.

getMutesMap

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

Gets an unmodifiable map of muted commands.

Returns:

Returns an unmodifiable map of muted commands.

getPluginIgnoreCase

public static org.bukkit.plugin.Plugin getPluginIgnoreCase(java.lang.String pluginName)

Returns plugin name from the cache of lowercased plugins as opposed to the Bukkit.getPluginManager().getPlugin() case-sensitive getting.

Example:

 // realPluginName will be set to "AdminAnything" for this one
 String realPluginName = AA_API.getPluginIgnoreCase("ADminAnyThINg");
 

Parameters:

pluginName - Name of the plugin (in any text case, i.e. plugin / Plugin / PLuGIn) we wish to retrieve the original name for.

Returns:

Returns the original name of the given plugin as it's known on the server.

parsePluginJARLocation

public static java.lang.String parsePluginJARLocation(java.lang.Class<?> commandClass)
                                               throws java.io.InvalidClassException

Attempts to retrieve a location of the plugin's class file within the currently loaded JAR archives structure. This method is used if we can't determine which plugin fired up a command directly. Usually this means that the plugin uses a different classLoader to make its magic work on multiple platforms, such as Spigot, Sponge and others.

Example:

 // usage in Commands class
 Command value = [value_from_a_method_call];
 String commandLocationParsed = this.plugin.getPluginUtils().parsePluginJARLocation(value.getClass());

 // then we can actually get a plugin name from this command's class location
 String pluginName = this.plugin.getPluginUtils().getPluginNameViaClassPathsMap(commandLocationParsed);
 

Parameters:

commandClass - The actual command class that has executed the command.

Returns:

Returns the JAR location of the given command class, and thus the plugin itself.

Throws:

java.io.InvalidClassException - When this command's class cannot be found within the current class loader.

classMapContainsKey

public static boolean classMapContainsKey(java.lang.String key)

Checks for existence of a command location key in the class map. Since we don't want to expose the whole map, as it would be writable by anyone, we just expose this method directly here.

Example:

 
 if (AA_API.classMapContainsKey(someRandomAdminAnythingCommandClassMapLocation)) {
     pluginName = AA_API.getClassMapKey(someRandomAdminAnythingCommandClassMapLocation);
 }
 

Parameters:

key - The key we want to check for in the class map.

Returns:

Returns true if the given key exists within the class map, false otherwise.

getClassMapKey

public static java.lang.String getClassMapKey(java.lang.String key)

Retrieves a key from the class map cache. Since we don't want to expose the whole map, as it would be writable by anyone, we just expose this method directly here.

Example:

 
 if (AA_API.classMapContainsKey(someRandomAdminAnythingCommandClassMapLocation)) {
     pluginName = AA_API.getClassMapKey(someRandomAdminAnythingCommandClassMapLocation);
 }
 
 

Parameters:

key - The key we want to get from the class map.

Returns:

Returns the requested key from the class map.

getCleanPluginName

public static java.lang.String getCleanPluginName(java.lang.String pluginWithCommand,
                                                  boolean returnRealPluginName)

Returns a clear name of the plugin from a string which may contain the plugin along with a command (essentials:ban) or along with a core alias (Core -> minecraft:ban).

Example:

 // essentials will be set to "essentials"
 String essentials = AA_API.getCleanPluginName("essentials:ban");

 // ban will be set to "ban"
 String ban = aa_plugin_instance.getPluginUtils().getCleanPluginName("Core -> ban");
 

Parameters:

pluginWithCommand - The actual command with a colon or the AA_API.__("general.core") + " ->" prefix.

Returns:

Returns a clear name of the plugin from a string which may contain colon or a AA_API.__("general.core") + " ->" prefix.

getServerPlugins

public static java.lang.Iterable<java.lang.String> getServerPlugins()

Retrieves a set of all plugin names on the server.

Returns:

Returns a set with names of all the plugins on the server.

getServerPlugins

public static java.lang.Iterable<java.lang.String> getServerPlugins(java.lang.String... prependBy)

Retrieves a set of all plugin names on the server, prepended by the given string prefix.

Parameters:

prependBy - A single-dimensional array with a string to prepend to each plugin name. Used when tab-completing plugin names from the /aa_listcommands command, where we need to prefix plugin names with pl:, plug: or plugin:

Returns:

Returns a set with names of all the plugins on the server.

getAvailableNewVersion

public static java.lang.String getAvailableNewVersion()

Returns the newVersionAvailable value, be it null or a real new version string.

Example:

 
 String newVersion = AA_API.getAvailableNewVersion();
 if (newVersion != null) {
     Bukkit.getLogger().log("info", "New AdminAnything version (" + newVersion + ") was released. Download your copy today!");
 }
 
 

Returns:

Returns the value of newVersionAvailable. It will be null if no new version is available, a real version number string otherwise.

getManualPermDescriptionsConfig

public static org.bukkit.configuration.file.FileConfiguration getManualPermDescriptionsConfig()

Returns current configuration of manual permissions and commands for plugins that don't provide these in their plugin.yml file.

Returns:

Returns current configuration of manual permissions and commands for plugins that don't provide these in their plugin.yml file.

isWarmingUp

public static boolean isWarmingUp()

Returns TRUE if the initial warmup of AdminAnything is not yet passed, FALSE otherwise. This is because we need to wait for all plugins before we can adjust their listener priorities and tab-completers.

Returns:

Returns TRUE if the initial warmup of AdminAnything is not yet passed, FALSE otherwise.

getPlayerAvailableCommands

public static java.util.List<java.lang.String> getPlayerAvailableCommands(org.bukkit.entity.Player p)

Gets all commands available to a single player in their current world.

Parameters:

p - The player to retrieve commands for.

Returns:

Returns a list of all commands currently available to the given player on this server in player's current world.

__

public static java.lang.String __(java.lang.String identifier,
                                  java.lang.Object... params)

Returns translation for the given identifier, and optionally a set of parameters. If this identifier is not found, the same identifier is used instead of the translation and returned with any given parameters replaced.

Parameters:

identifier - The actual identifier from the .properties file to work with.

params - Optional parameters used to format translations with placeholders.

Returns:

Returns a the requested translation with all optional placeholders correctly substituted.