summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/authentication/IAuthManager.java
diff options
context:
space:
mode:
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/authentication/IAuthManager.java')
-rw-r--r--pki/base/common/src/com/netscape/certsrv/authentication/IAuthManager.java33
1 files changed, 19 insertions, 14 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/IAuthManager.java b/pki/base/common/src/com/netscape/certsrv/authentication/IAuthManager.java
index b2f7d69a..28fcfe41 100644
--- a/pki/base/common/src/com/netscape/certsrv/authentication/IAuthManager.java
+++ b/pki/base/common/src/com/netscape/certsrv/authentication/IAuthManager.java
@@ -23,7 +23,7 @@ import com.netscape.certsrv.base.IConfigStore;
/**
* Authentication Manager interface.
* <P>
- *
+ *
* @version $Revision$, $Date$
*/
public interface IAuthManager {
@@ -41,6 +41,7 @@ public interface IAuthManager {
/**
* Get the name of this authentication manager instance.
* <p>
+ *
* @return the name of this authentication manager.
*/
public String getName();
@@ -48,58 +49,62 @@ public interface IAuthManager {
/**
* Get name of authentication manager plugin.
* <p>
+ *
* @return the name of the authentication manager plugin.
- */
+ */
public String getImplName();
/**
* Authenticate the given credentials.
+ *
* @param authCred The authentication credentials
* @return authentication token
- * @exception EMissingCredential If a required credential for this
- * authentication manager is missing.
+ * @exception EMissingCredential If a required credential for this
+ * authentication manager is missing.
* @exception EInvalidCredentials If credentials cannot be authenticated.
* @exception EBaseException If an internal error occurred.
*/
public IAuthToken authenticate(IAuthCredentials authCred)
- throws EMissingCredential, EInvalidCredentials, EBaseException;
+ throws EMissingCredential, EInvalidCredentials, EBaseException;
/**
* Initialize this authentication manager.
+ *
* @param name The name of this authentication manager instance.
* @param implName The name of the authentication manager plugin.
* @param config The configuration store for this authentication manager.
* @exception EBaseException If an initialization error occurred.
*/
public void init(String name, String implName, IConfigStore config)
- throws EBaseException;
+ throws EBaseException;
/**
- * Prepare this authentication manager for a shutdown.
- * Called when the server is exiting for any cleanup needed.
+ * Prepare this authentication manager for a shutdown. Called when the
+ * server is exiting for any cleanup needed.
*/
public void shutdown();
/**
* Gets a list of the required credentials for this authentication manager.
+ *
* @return The required credential attributes.
*/
public String[] getRequiredCreds();
/**
- * Get configuration parameters for this implementation.
- * The configuration parameters returned is passed to the
- * configuration console so configuration for instances of this
- * implementation can be made through the console.
+ * Get configuration parameters for this implementation. The configuration
+ * parameters returned is passed to the configuration console so
+ * configuration for instances of this implementation can be made through
+ * the console.
*
* @return a list of configuration parameters.
* @exception EBaseException If an internal error occurred
*/
- public String[] getConfigParams()
- throws EBaseException;
+ public String[] getConfigParams() throws EBaseException;
/**
* Get the configuration store for this authentication manager.
+ *
* @return The configuration store of this authentication manager.
*/
public IConfigStore getConfigStore();