[DOC] Документация к AuthProvider/AuthHandler

LaunchServer/src/main/java/pro/gravit/launchserver/auth/handler/AuthHandler.java

@@ -33,14 +33,38 @@ public static void registerHandlers() {
 
 	protected transient LaunchServer srv;
 
+    /**
+     * Returns the UUID associated with the account
+     * @param authResult {@link pro.gravit.launchserver.auth.provider.AuthProvider} result
+     * @return User UUID
+     * @throws IOException
+     * Internal Script Error
+     */
     public abstract UUID auth(AuthProviderResult authResult) throws IOException;
 
+    /**
+     * Validates serverID
+     * @param username user name
+     * @param serverID serverID to check
+     * @return user UUID
+     * @throws IOException
+     * Internal Script Error
+     */
     public abstract UUID checkServer(String username, String serverID) throws IOException;
 
     @Override
     public abstract void close() throws IOException;
 
 
+    /**
+     * Checks assessToken for validity and saves serverID if successful
+     * @param username user name
+     * @param accessToken assessToken to check
+     * @param serverID serverID to save
+     * @return true - allow, false - deny
+     * @throws IOException
+     * Internal Script Error
+     */
     public abstract boolean joinServer(String username, String accessToken, String serverID) throws IOException;
 
 

LaunchServer/src/main/java/pro/gravit/launchserver/auth/provider/AuthProvider.java

@@ -29,6 +29,16 @@ public static void registerProviders() {
     }
 
 
+    /**
+     * Verifies the username and password
+     * @param login user login
+     * @param password user password
+     * @param ip user ip
+     * @return player privileges, effective username and authorization token
+     * @throws Exception
+     * Throws an exception {@link AuthException} {@link pro.gravit.utils.HookException} if the verification script returned a meaningful error
+     * In other cases, throwing an exception indicates a serious error
+     */
     public abstract AuthProviderResult auth(String login, String password, String ip) throws Exception;
 
     public void preAuth(String login, String password, String customText, String ip) {