Update javadocs

stephen-crawford · stephen-crawford · commit 6cd03531a7ab · 2023-05-08T10:58:58.000-04:00
Signed-off-by: Stephen Crawford &lt;steecraw@amazon.com&gt;
diff --git a/server/src/main/java/org/opensearch/identity/noop/NoopTokenManager.java b/server/src/main/java/org/opensearch/identity/noop/NoopTokenManager.java
@@ -12,12 +12,25 @@
 import org.opensearch.identity.tokens.NoopToken;
 import org.opensearch.identity.tokens.TokenManager;
 
+/**
+ * This class represents a Noop Token Manager
+ */
 public class NoopTokenManager implements TokenManager {
+
+    /**
+     * Generate a new Noop Token
+     * @return a new Noop Token
+     */
     @Override
     public AuthToken generateToken() {
         return new NoopToken();
     }
 
+    /**
+     * Validate a token
+     * @param token The token to be validated
+     * @return If the token is a Noop Token, then pass with True; otherwise fail with False.
+     */
     @Override
     public boolean validateToken(AuthToken token) {
         if (token instanceof NoopToken){
@@ -26,16 +39,32 @@ public boolean validateToken(AuthToken token) {
         return false;
     }
 
+    /**
+     * Get token info, there should not be any token info so just return whether the token is a NoopToken
+     * @param token The auth token to be parsed
+     * @return A String stating the token is a NoopToken or is not a NopToken
+     */
     @Override
     public String getTokenInfo(AuthToken token) {
-        return "Token is NoopToken";
+        if (token instanceof NoopToken){
+            return "Token is NoopToken";
+        }
+        return "Token is not a NoopToken";
     }
 
+    /**
+     * Revoking a Noop Token should not do anything
+     * @param token The Auth Token to be revoked
+     */
     @Override
     public void revokeToken(AuthToken token) {
 
     }
 
+    /**
+     * Refreshing a NoopToken also not do anything
+     * @param token The token to be refreshed
+     */
     @Override
     public void refreshToken(AuthToken token) {
 
diff --git a/server/src/main/java/org/opensearch/identity/tokens/NoopToken.java b/server/src/main/java/org/opensearch/identity/tokens/NoopToken.java
@@ -8,9 +8,16 @@
 
 package org.opensearch.identity.tokens;
 
+/**
+ * A NoopToken is a pass-through AuthToken
+ */
 public class NoopToken implements AuthToken {
     public final static String TOKEN_IDENTIFIER = "Noop";
 
+    /**
+     * Returns the TokenIdentifier of Noop
+     * @return The token identifier "Noop"
+     */
     public String getTokenIdentifier() {
         return TOKEN_IDENTIFIER;
     }
diff --git a/server/src/main/java/org/opensearch/identity/tokens/TokenManager.java b/server/src/main/java/org/opensearch/identity/tokens/TokenManager.java
@@ -8,15 +8,40 @@
 
 package org.opensearch.identity.tokens;
 
+/**
+ * This interface defines the expected methods of a token manager
+ */
 public interface TokenManager {
 
+    /**
+     * Create a new auth token
+     * @return A new auth token
+     */
     public AuthToken generateToken();
 
+    /**
+     * Validate an auth token based on the rules associated with its format
+     * @param token The token to validate
+     * @return True if the token is valid; False if the token is not valid
+     */
     public boolean validateToken(AuthToken token);
 
+    /**
+     * Fetch the info from a token
+     * @param token The auth token to be parsed
+     * @return A String representing the info associated with the token
+     */
     public String getTokenInfo(AuthToken token);
 
+    /**
+     * Revoke a token that should no longer be treated as valid
+     * @param token The Auth Token to be revoked
+     */
     public void revokeToken(AuthToken token);
 
+    /**
+     * Updates a token to be valid for a greater period of time or to have different attributes.
+     * @param token The token to be refreshed
+     */
     public void refreshToken(AuthToken token);
 }
