Initial creation of VaultAPI

.gitignore

@@ -0,0 +1,2 @@
+/target
+/dependency-reduced-pom.xml

README.md

@@ -0,0 +1,224 @@
+# Vault - Abstraction Library for Bukkit Plugin
+
+## Installing
+Installing Vault is as simple as copying the provided "Vault.jar" to your
+"<bukkit-install-dir>/plugins" directory and the rest is automatic!  If you
+wish to perform configuration changes, this can be done via a configuration
+file but should not be necessary in most cases.  See the "Advanced
+Configuration" section for more information.
+
+
+## Why Vault?
+I have no preference which library suits your plugin and development efforts
+best.  Really, I thought a central suite (rather...Vault) of solutions was the
+the proper avenue than focusing on a single category of plugin.  That's where
+the idea for Vault came into play.
+
+So, what features do I _think_ you'll like the most?
+
+ * No need to include my source code in your plugin
+   All of Vault is run in its own plugin, so all you need to do is obtain an
+   instance of it!  This simplifies issues with multiple plugins using the same
+   namespaces.  Just simply add Vault.jar to your download zip file!
+ * Broad range of supported plugins
+   I wanted an abstraction layer not only for Economic plugins but also
+   Permission plugins as well.  The future will likely add more, but what
+   types, I have yet to decide, let me know!
+ * Choice!
+   That's half the fun of Bukkit, we get to choose what to use!  More choice
+   has never hurt developers so here's to choice!
+
+
+## Permissions
+ * vault.admin
+   - Determines if a player should recieve the update notices
+
+## License
+Copyright (C) 2011 Morgan Humes <[email protected]>
+
+Vault is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Vault is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with Vault.  If not, see <http://www.gnu.org/licenses/>.
+
+## Building
+Vault comes with all libraries needed to build from the current branch and
+also comes with an Apache Ant build file (build.xml).
+
+
+## Dependencies
+Because Vault provides a bridge to other plugins, their binaries will be
+required to build from.  To ease this, they have been included in the lib
+folder and will be updated from time to time.  For plugin developers, it
+is not necessary to use these libraries when implementing Vault.  You will
+only need to compile against Vault.
+
+
+## Supported Plugins
+Vault provides abstraction for the following categories and plugins.  If you
+have your own plugin that you believe should be supported, fork Vault or create
+a patch with the necessary changes.  Additionally you can create an issue on
+Github and we'll get to it at our convenience.
+
+* Economy
+   - 3co (http://forums.bukkit.org/threads/22461/)
+   - AEco
+   - BOSEconomy 6 (http://forums.bukkit.org/threads/19025/)
+   - BOSEconomy 7
+   - CommandsEX Economy (http://dev.bukkit.org/server-mods/commandsex/)
+   - CraftConomy2 (http://dev.bukkit.org/server-mods/craftconomy/)
+   - CraftConomy3 (http://dev.bukkit.org/server-mods/craftconomy/)
+   - CurrencyCore (http://dev.bukkit.org/server-mods/currency/)
+   - Dosh
+   - EconXP (http://dev.bukkit.org/server-mods/econxp/)
+   - Essentials Economy (http://forums.bukkit.org/threads/15312/)
+   - eWallet (http://dev.bukkit.org/server-mods/ewallet/)
+   - GoldIsMoney
+   - GoldIsMoney2
+   - Gringotts
+   - iConomy 4 (http://forums.bukkit.org/threads/40/)
+   - iConomy 5 (http://forums.bukkit.org/threads/40/)
+   - iConomy 6 (http://forums.bukkit.org/threads/40/)
+   - McMoney
+   - Miconomy
+   - MineConomy (http://dev.bukkit.org/server-mods/mineconomy/)
+   - MineFaconomy2
+   - MultiCurrency
+   - SDFEconomy
+   - TAEcon
+   - XPBank
+
+* Permissions
+   - bPermissions
+   - bPermissions 2 (http://dev.bukkit.org/server-mods/bpermissions/)
+   - DroxPerms
+   - Group Manager (Essentials) (http://forums.bukkit.org/threads/15312/)
+   - Permissions 3 (http://forums.bukkit.org/threads/18430/)
+   - PermissionsBukkit
+   - Permissions Ex (http://forums.bukkit.org/threads/18140/)
+   - Privileges
+   - rscPermissions
+   - SimplyPerms
+   - SuperPerms (Bukkit's default)
+   - TotalPermissions (http://dev.bukkit.org/bukkit-mods/totalpermissions)
+   - XPerms
+   - zPermissions
+
+* Chat
+   - bPermissions
+   - Group Manager (Essentials)
+   - iChat
+   - mChat
+   - mChatSuite
+   - Permissions3
+   - PEX
+   - rscPermissions
+   - TotalPermissions
+   - zPermissions
+
+## Implementing Vault
+Implementing Vault is quite simple. It requires getting the Economy, Permission, or Chat service from the Bukkit ServiceManager. See the example below:
+
+```java
+package com.example.plugin;
+
+import java.util.logging.Logger;
+
+import net.milkbowl.vault.chat.Chat;
+import net.milkbowl.vault.economy.Economy;
+import net.milkbowl.vault.economy.EconomyResponse;
+import net.milkbowl.vault.permission.Permission;
+
+import org.bukkit.command.Command;
+import org.bukkit.command.CommandSender;
+import org.bukkit.entity.Player;
+import org.bukkit.plugin.RegisteredServiceProvider;
+import org.bukkit.plugin.java.JavaPlugin;
+
+public class ExamplePlugin extends JavaPlugin {
+
+    private static final Logger log = Logger.getLogger("Minecraft");
+    public static Economy econ = null;
+    public static Permission perms = null;
+    public static Chat chat = null;
+
+    @Override
+    public void onDisable() {
+        log.info(String.format("[%s] Disabled Version %s", getDescription().getName(), getDescription().getVersion()));
+    }
+
+    @Override
+    public void onEnable() {
+        if (!setupEconomy() ) {
+            log.severe(String.format("[%s] - Disabled due to no Vault dependency found!", getDescription().getName()));
+            getServer().getPluginManager().disablePlugin(this);
+            return;
+        }
+        setupPermissions();
+        setupChat();
+    }
+
+    private boolean setupEconomy() {
+        if (getServer().getPluginManager().getPlugin("Vault") == null) {
+            return false;
+        }
+        RegisteredServiceProvider<Economy> rsp = getServer().getServicesManager().getRegistration(Economy.class);
+        if (rsp == null) {
+            return false;
+        }
+        econ = rsp.getProvider();
+        return econ != null;
+    }
+
+    private boolean setupChat() {
+        RegisteredServiceProvider<Chat> rsp = getServer().getServicesManager().getRegistration(Chat.class);
+        chat = rsp.getProvider();
+        return chat != null;
+    }
+
+    private boolean setupPermissions() {
+        RegisteredServiceProvider<Permission> rsp = getServer().getServicesManager().getRegistration(Permission.class);
+        perms = rsp.getProvider();
+        return perms != null;
+    }
+
+    public boolean onCommand(CommandSender sender, Command command, String commandLabel, String[] args) {
+        if(!(sender instanceof Player)) {
+            log.info("Only players are supported for this Example Plugin, but you should not do this!!!");
+            return true;
+        }
+
+        Player player = (Player) sender;
+
+        if(command.getLabel().equals("test-economy")) {
+            // Lets give the player 1.05 currency (note that SOME economic plugins require rounding!)
+            sender.sendMessage(String.format("You have %s", econ.format(econ.getBalance(player.getName()))));
+            EconomyResponse r = econ.depositPlayer(player.getName(), 1.05);
+            if(r.transactionSuccess()) {
+                sender.sendMessage(String.format("You were given %s and now have %s", econ.format(r.amount), econ.format(r.balance)));
+            } else {
+                sender.sendMessage(String.format("An error occured: %s", r.errorMessage));
+            }
+            return true;
+        } else if(command.getLabel().equals("test-permission")) {
+            // Lets test if user has the node "example.plugin.awesome" to determine if they are awesome or just suck
+            if(perms.has(player, "example.plugin.awesome")) {
+                sender.sendMessage("You are awesome!");
+            } else {
+                sender.sendMessage("You suck!");
+            }
+            return true;
+        } else {
+            return false;
+        }
+    }
+}
+```

license.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.