Add more stuff to api

api/src/main/java/me/lucko/luckperms/api/LPConfiguration.java

@@ -0,0 +1,50 @@
+package me.lucko.luckperms.api;
+
+import me.lucko.luckperms.api.data.MySQLConfiguration;
+
+/**
+ * A wrapper interface for the internal LuckPerms configuration, providing read only access.
+ */
+public interface LPConfiguration {
+
+    /**
+     * @return the name of this server
+     */
+    String getServer();
+
+    /**
+     * @return how often a sync task will run in minutes
+     */
+    int getSyncTime();
+
+    /**
+     * @return the default group, in a node representation
+     */
+    String getDefaultGroupNode();
+
+    /**
+     * @return the name of the default group
+     */
+    String getDefaultGroupName();
+
+    /**
+     * @return if the users on this server will have their global permissions applied
+     */
+    boolean getIncludeGlobalPerms();
+
+    /**
+     * @return the online mode setting in the config
+     */
+    boolean getOnlineMode();
+
+    /**
+     * @return the database values set in the configuration
+     */
+    MySQLConfiguration getDatabaseValues();
+
+    /**
+     * @return the storage method string from the configuration
+     */
+    String getStorageMethod();
+
+}

api/src/main/java/me/lucko/luckperms/api/LuckPermsApi.java

@@ -1,5 +1,6 @@
 package me.lucko.luckperms.api;
 
+import java.util.Optional;
 import java.util.UUID;
 
 /**
@@ -18,6 +19,12 @@ public interface LuckPermsApi {
      */
     String getVersion();
 
+    /**
+     * Gets a wrapped {@link LPConfiguration} instance, with read only access
+     * @return a configuration instance
+     */
+    LPConfiguration getConfiguration();
+
     /**
      * Gets a wrapped {@link Datastore} instance, with somewhat limited access
      * @return a datastore instance
@@ -30,6 +37,12 @@ public interface LuckPermsApi {
      */
     Logger getLogger();
 
+    /**
+     * Gets a wrapped {@link UuidCache} instance, providing read access to the LuckPerms internal uuid caching system
+     * @return a uuidcache instance
+     */
+    UuidCache getUuidCache();
+
     /**
      * Gets a wrapped user object from the user storage
      * @param uuid the uuid of the user to get
@@ -37,6 +50,13 @@ public interface LuckPermsApi {
      */
     User getUser(UUID uuid);
 
+    /**
+     * Gets a wrapped user object from the user storage. This method does not return null, unlike {@link #getUser(UUID)}
+     * @param uuid the uuid of the user to get
+     * @return an optional {@link User} object
+     */
+    Optional<User> getUserSafe(UUID uuid);
+
     /**
      * Gets a wrapped user object from the user storage
      * @param name the username of the user to get
@@ -44,6 +64,13 @@ public interface LuckPermsApi {
      */
     User getUser(String name);
 
+    /**
+     * Gets a wrapped user object from the user storage. This method does not return null, unlike {@link #getUser(String)}
+     * @param name the username of the user to get
+     * @return an optional {@link User} object
+     */
+    Optional<User> getUserSafe(String name);
+
     /**
      * Check if a user is loaded in memory
      * @param uuid the uuid to check for
@@ -58,6 +85,13 @@ public interface LuckPermsApi {
      */
     Group getGroup(String name);
 
+    /**
+     * Gets a wrapped group object from the group storage. This method does not return null, unlike {@link #getGroup}
+     * @param name the name of the group to get
+     * @return an optional {@link Group} object
+     */
+    Optional<Group> getGroupSafe(String name);
+
     /**
      * Check if a group is loaded in memory
      * @param name the name to check for
@@ -72,6 +106,13 @@ public interface LuckPermsApi {
      */
     Track getTrack(String name);
 
+    /**
+     * Gets a wrapped tracj object from the track storage. This method does not return null, unlike {@link #getTrack}
+     * @param name the name of the track to get
+     * @return an optional {@link Track} object
+     */
+    Optional<Track> getTrackSafe(String name);
+
     /**
      * Check if a track is loaded in memory
      * @param name the name to check for

api/src/main/java/me/lucko/luckperms/api/UuidCache.java

@@ -0,0 +1,32 @@
+package me.lucko.luckperms.api;
+
+import java.util.UUID;
+
+/**
+ * This UuidCache is a means of allowing users to have the same internal UUID across a network of offline mode servers
+ * or mixed offline mode and online mode servers. Platforms running in offline mode generate a random UUID for a user when
+ * they first join the server, but this UUID will then not be consistent across the network. LuckPerms will instead check
+ * the datastore cache, to get a UUID for a user that is consistent across an entire network.
+ *
+ * If you want to get a user object from the datastore using the api on a server in offline mode, you will need to use this cache,
+ * OR use Datastore#getUUID, for users that are not online.
+ *
+ * WARNING: THIS IS ONLY EFFECTIVE FOR ONLINE PLAYERS. USE THE DATASTORE METHODS FOR OFFLINE PLAYERS.
+ */
+public interface UuidCache {
+
+    /**
+     * Gets a users internal "LuckPerms" UUID, from the one given by the server.
+     * @param external the UUID assigned by the server, through Player#getUniqueId or ProxiedPlayer#getUniqueId
+     * @return the corresponding internal UUID
+     */
+    UUID getUUID(UUID external);
+
+    /**
+     * Gets a users external, server assigned or Mojang assigned unique id, from the internal one used within LuckPerms.
+     * @param internal the UUID used within LuckPerms, through User#getUuid
+     * @return the corresponding external UUID
+     */
+    UUID getExternalUUID(UUID internal);
+
+}

api/src/main/java/me/lucko/luckperms/api/data/MySQLConfiguration.java

@@ -0,0 +1,9 @@
+package me.lucko.luckperms.api.data;
+
+public interface MySQLConfiguration {
+
+    String getAddress();
+    String getDatabase();
+    String getUsername();
+    String getPassword();
+}