From 10cfe7756e967ac91c66d33b392aeab9cf3780fb Mon Sep 17 00:00:00 2001 From: Ade Lee Date: Wed, 11 Jan 2012 12:57:53 -0500 Subject: Formatting (no line wrap in comments or code) --- .../certsrv/authentication/AuthCredentials.java | 26 ++--- .../certsrv/authentication/AuthManagerProxy.java | 9 +- .../certsrv/authentication/AuthMgrPlugin.java | 16 +-- .../certsrv/authentication/AuthResources.java | 3 +- .../netscape/certsrv/authentication/AuthToken.java | 40 +++++--- .../certsrv/authentication/EAuthException.java | 8 +- .../certsrv/authentication/EAuthInternalError.java | 1 + .../certsrv/authentication/EAuthMgrNotFound.java | 1 + .../authentication/EAuthMgrPluginNotFound.java | 3 +- .../certsrv/authentication/EAuthUserError.java | 1 + .../certsrv/authentication/ECompSyntaxErr.java | 1 + .../certsrv/authentication/EFormSubjectDN.java | 1 + .../authentication/EInvalidCredentials.java | 1 + .../certsrv/authentication/EMissingCredential.java | 1 + .../certsrv/authentication/IAuthCredentials.java | 6 +- .../certsrv/authentication/IAuthManager.java | 24 +++-- .../certsrv/authentication/IAuthSubsystem.java | 35 ++++--- .../certsrv/authentication/IAuthToken.java | 107 ++++++++++++--------- .../authentication/ISSLClientCertProvider.java | 9 +- .../certsrv/authentication/ISharedToken.java | 5 +- 20 files changed, 183 insertions(+), 115 deletions(-) (limited to 'pki/base/common/src/com/netscape/certsrv/authentication') diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/AuthCredentials.java b/pki/base/common/src/com/netscape/certsrv/authentication/AuthCredentials.java index de124a38c..1475683eb 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/AuthCredentials.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/AuthCredentials.java @@ -23,10 +23,10 @@ import java.util.Hashtable; import com.netscape.certsrv.base.IArgBlock; /** - * Authentication Credentials as input to the authMgr. It contains all the + * Authentication Credentials as input to the authMgr. It contains all the * information required for authentication in the authMgr. *

- * + * * @version $Revision$, $Date$ */ public class AuthCredentials implements IAuthCredentials { @@ -34,7 +34,7 @@ public class AuthCredentials implements IAuthCredentials { private static final long serialVersionUID = 5862936214648594328L; private Hashtable authCreds = null; private IArgBlock argblk = null; - + /** * Constructor */ @@ -44,6 +44,7 @@ public class AuthCredentials implements IAuthCredentials { /** * Sets an authentication credential with credential name and the credential object + * * @param name credential name * @param cred credential object */ @@ -54,7 +55,8 @@ public class AuthCredentials implements IAuthCredentials { /** * Returns the credential to which the specified name is mapped in this - * credential set + * credential set + * * @param name credential name * @return the authentication credential for the given name */ @@ -64,8 +66,9 @@ public class AuthCredentials implements IAuthCredentials { /** * Removes the name and its corresponding credential from this - * credential set. This method does nothing if the named - * credential is not in the credential set. + * credential set. This method does nothing if the named + * credential is not in the credential set. + * * @param name credential name */ public void delete(String name) { @@ -76,26 +79,27 @@ public class AuthCredentials implements IAuthCredentials { * Returns an enumeration of the credentials in this credential * set. Use the Enumeration methods on the returned object to * fetch the elements sequentially. + * * @return an enumeration of the values in this credential set */ public Enumeration getElements() { return (authCreds.elements()); } - + /** * Set the given argblock -i * @param blk the given argblock. + * i * @param blk the given argblock. */ public void setArgBlock(IArgBlock blk) { argblk = blk; - } + } /** * Returns the argblock. + * * @return the argblock. */ public IArgBlock getArgBlock() { return argblk; - } + } } - diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/AuthManagerProxy.java b/pki/base/common/src/com/netscape/certsrv/authentication/AuthManagerProxy.java index f98276ec5..76161e803 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/AuthManagerProxy.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/AuthManagerProxy.java @@ -17,10 +17,10 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.authentication; - /** * A class represents an authentication manager. It contains an * authentication manager instance and its state (enable or not). + * * @version $Revision$, $Date$ */ public class AuthManagerProxy { @@ -29,9 +29,10 @@ public class AuthManagerProxy { /** * Constructor + * * @param enable true if the authMgr is enabled; false otherwise * @param mgr authentication manager instance - */ + */ public AuthManagerProxy(boolean enable, IAuthManager mgr) { mEnable = enable; mMgr = mgr; @@ -39,7 +40,8 @@ public class AuthManagerProxy { /** * Returns the state of the authentication manager instance - * @return true if the state of the authentication manager instance is + * + * @return true if the state of the authentication manager instance is * enabled; false otherwise. */ public boolean isEnable() { @@ -48,6 +50,7 @@ public class AuthManagerProxy { /** * Returns an authentication manager instance. + * * @return an authentication manager instance */ public IAuthManager getAuthManager() { diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/AuthMgrPlugin.java b/pki/base/common/src/com/netscape/certsrv/authentication/AuthMgrPlugin.java index bdb2fe002..4226fd83c 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/AuthMgrPlugin.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/AuthMgrPlugin.java @@ -17,13 +17,10 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.authentication; - - - /** * This class represents a registered authentication manager plugin. *

- * + * * @version $Revision$, $Date$ */ public class AuthMgrPlugin { @@ -33,6 +30,7 @@ public class AuthMgrPlugin { /** * Constructs a AuthManager plugin. + * * @param id auth manager implementation name * @param classPath class path */ @@ -45,9 +43,10 @@ public class AuthMgrPlugin { mId = id; mClassPath = classPath; } - + /** * Returns an auth manager implementation name + * * @return an auth manager implementation name */ public String getId() { @@ -56,22 +55,25 @@ public class AuthMgrPlugin { /** * Returns a classpath of a AuthManager plugin + * * @return a classpath of a AuthManager plugin */ public String getClassPath() { return mClassPath; } - /** + /** * Returns a visibility of the plugin + * * @return a visibility of the plugin */ public boolean isVisible() { return mVisible; } - /** + /** * Sets visibility of the plugin + * * @param visibility visibility of the plugin */ public void setVisible(boolean visibility) { diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/AuthResources.java b/pki/base/common/src/com/netscape/certsrv/authentication/AuthResources.java index 138a07ebb..35e810112 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/AuthResources.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/AuthResources.java @@ -22,7 +22,7 @@ import java.util.ListResourceBundle; /** * A class represents a resource bundle for the authentication component. *

- * + * * @deprecated * @version $Revision$, $Date$ */ @@ -30,6 +30,7 @@ public class AuthResources extends ListResourceBundle { /** * Returns the content of this resource. + * * @return the contents of this resource */ public Object[][] getContents() { diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/AuthToken.java b/pki/base/common/src/com/netscape/certsrv/authentication/AuthToken.java index eae282c02..0a2b1f0a2 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/AuthToken.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/AuthToken.java @@ -41,10 +41,11 @@ import com.netscape.certsrv.usrgrp.Certificates; * Authentication token returned by Authentication Managers. * Upon return, it contains authentication/identification information * as well as information retrieved from the database where the - * authentication was done against. Each authentication manager has - * its own list of such information. See individual authenticaiton + * authentication was done against. Each authentication manager has + * its own list of such information. See individual authenticaiton * manager for more details. *

+ * * @version $Revision$, $Date$ */ public class AuthToken implements IAuthToken { @@ -74,7 +75,7 @@ public class AuthToken implements IAuthToken { public static final String TOKEN_CERT_TO_REVOKE = "tokenCertToRevoke"; /** - * Plugin name of the authentication manager that created the + * Plugin name of the authentication manager that created the * AuthToken as a string. */ public static final String TOKEN_AUTHMGR_IMPL_NAME = "authMgrImplName"; @@ -86,31 +87,33 @@ public class AuthToken implements IAuthToken { public static final String TOKEN_AUTHMGR_INST_NAME = "authMgrInstName"; /** - * Time of authentication as a java.util.Date + * Time of authentication as a java.util.Date */ public static final String TOKEN_AUTHTIME = "authTime"; /** * Constructs an instance of a authentication token. * The token by default contains the following attributes:
+ * * 

-     *		"authMgrInstName" - The authentication manager instance name.
-     *		"authMgrImplName" - The authentication manager plugin name.
-     *		"authTime" - The - The time of authentication.
+     * 	"authMgrInstName" - The authentication manager instance name.
+     * 	"authMgrImplName" - The authentication manager plugin name.
+     * 	"authTime" - The - The time of authentication.
      *
+ * * @param authMgr The authentication manager that created this Token. */ public AuthToken(IAuthManager authMgr) { mAttrs = new Hashtable(); if (authMgr != null) { - set(TOKEN_AUTHMGR_INST_NAME, authMgr.getName()); - set(TOKEN_AUTHMGR_IMPL_NAME, authMgr.getImplName()); + set(TOKEN_AUTHMGR_INST_NAME, authMgr.getName()); + set(TOKEN_AUTHMGR_IMPL_NAME, authMgr.getImplName()); } set(TOKEN_AUTHTIME, new Date()); } public String getInString(String attrName) { - return (String)mAttrs.get(attrName); + return (String) mAttrs.get(attrName); } public boolean set(String attrName, String value) { @@ -123,6 +126,7 @@ public class AuthToken implements IAuthToken { /** * Removes an attribute in the AuthToken + * * @param attrName The name of the attribute to remove. */ public void delete(String attrName) { @@ -131,6 +135,7 @@ public class AuthToken implements IAuthToken { /** * Enumerate all attribute names in the AuthToken. + * * @return Enumeration of all attribute names in this AuthToken. */ public Enumeration getElements() { @@ -351,7 +356,7 @@ public class AuthToken implements IAuthToken { for (int i = 0; i < certArray.length; i++) { ByteArrayOutputStream byteStream = new ByteArrayOutputStream(); try { - X509CertImpl certImpl = (X509CertImpl)certArray[i]; + X509CertImpl certImpl = (X509CertImpl) certArray[i]; certImpl.encode(byteStream); derValues[i] = new DerValue(byteStream.toByteArray()); } catch (CertificateEncodingException e) { @@ -406,6 +411,7 @@ public class AuthToken implements IAuthToken { /** * Enumerate all attribute values in the AuthToken. + * * @return Enumeration of all attribute names in this AuthToken. */ public Enumeration getVals() { @@ -413,10 +419,11 @@ public class AuthToken implements IAuthToken { } /** - * Gets the name of the authentication manager instance that created - * this token. - * @return The name of the authentication manager instance that created + * Gets the name of the authentication manager instance that created * this token. + * + * @return The name of the authentication manager instance that created + * this token. */ public String getAuthManagerInstName() { return ((String) mAttrs.get(TOKEN_AUTHMGR_INST_NAME)); @@ -425,8 +432,9 @@ public class AuthToken implements IAuthToken { /** * Gets the plugin name of the authentication manager that created this * token. + * * @return The plugin name of the authentication manager that created this - * token. + * token. */ public String getAuthManagerImplName() { return ((String) mAttrs.get(TOKEN_AUTHMGR_IMPL_NAME)); @@ -434,10 +442,10 @@ public class AuthToken implements IAuthToken { /** * Gets the time of authentication. + * * @return The time of authentication */ public Date getAuthTime() { return ((Date) mAttrs.get(TOKEN_AUTHTIME)); } } - diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/EAuthException.java b/pki/base/common/src/com/netscape/certsrv/authentication/EAuthException.java index b998ae8b0..c79c3e9a7 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EAuthException.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EAuthException.java @@ -22,6 +22,7 @@ import com.netscape.certsrv.base.EBaseException; /** * This class represents authentication exceptions. *

+ * * @version $Revision$, $Date$ */ public class EAuthException extends EBaseException { @@ -38,6 +39,7 @@ public class EAuthException extends EBaseException { /** * Constructs an authentication exception *

+ * * @param msgFormat exception details */ public EAuthException(String msgFormat) { @@ -45,8 +47,9 @@ public class EAuthException extends EBaseException { } /** - * Constructs an authentication exception with a parameter. + * Constructs an authentication exception with a parameter. *

+ * * @param msgFormat exception details in message string format * @param param message string parameter */ @@ -57,6 +60,7 @@ public class EAuthException extends EBaseException { /** * Constructs a auth exception with a exception parameter. *

+ * * @param msgFormat exception details in message string format * @param exception system exception */ @@ -67,6 +71,7 @@ public class EAuthException extends EBaseException { /** * Constructs a auth exception with a list of parameters. *

+ * * @param msgFormat the message format. * @param params list of message format parameters */ @@ -76,6 +81,7 @@ public class EAuthException extends EBaseException { /** * Returns the resource bundle name + * * @return resource bundle name. */ protected String getBundleName() { diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/EAuthInternalError.java b/pki/base/common/src/com/netscape/certsrv/authentication/EAuthInternalError.java index fb4ad04bb..52688f922 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EAuthInternalError.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EAuthInternalError.java @@ -30,6 +30,7 @@ public class EAuthInternalError extends EAuthException { /** * Constructs an authentication internal error exception * with a detailed message. + * * @param errorString Detailed error message. */ public EAuthInternalError(String errorString) { diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/EAuthMgrNotFound.java b/pki/base/common/src/com/netscape/certsrv/authentication/EAuthMgrNotFound.java index 675fbe59a..925aaabf0 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EAuthMgrNotFound.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EAuthMgrNotFound.java @@ -29,6 +29,7 @@ public class EAuthMgrNotFound extends EAuthException { /** * Constructs a exception for a missing authentication manager + * * @param errorString error string for missing authentication manager */ public EAuthMgrNotFound(String errorString) { diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/EAuthMgrPluginNotFound.java b/pki/base/common/src/com/netscape/certsrv/authentication/EAuthMgrPluginNotFound.java index 2210de2ca..2ca90e3c8 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EAuthMgrPluginNotFound.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EAuthMgrPluginNotFound.java @@ -29,7 +29,8 @@ public class EAuthMgrPluginNotFound extends EAuthException { /** * Constructs a exception for a missing authentication manager plugin - * @param errorString error for a missing authentication manager plugin + * + * @param errorString error for a missing authentication manager plugin */ public EAuthMgrPluginNotFound(String errorString) { super(errorString); diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/EAuthUserError.java b/pki/base/common/src/com/netscape/certsrv/authentication/EAuthUserError.java index b3bafd3cc..f816c35e8 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EAuthUserError.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EAuthUserError.java @@ -29,6 +29,7 @@ public class EAuthUserError extends EAuthException { /** * Constructs a exception for a Invalid attribute value + * * @param errorString Detailed error message. */ public EAuthUserError(String errorString) { diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/ECompSyntaxErr.java b/pki/base/common/src/com/netscape/certsrv/authentication/ECompSyntaxErr.java index edbf13e66..84725bb96 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/ECompSyntaxErr.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/ECompSyntaxErr.java @@ -29,6 +29,7 @@ public class ECompSyntaxErr extends EAuthException { /** * Constructs an component syntax error + * * @param errorString Detailed error message. */ public ECompSyntaxErr(String errorString) { diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/EFormSubjectDN.java b/pki/base/common/src/com/netscape/certsrv/authentication/EFormSubjectDN.java index b56a1e0a0..952824481 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EFormSubjectDN.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EFormSubjectDN.java @@ -29,6 +29,7 @@ public class EFormSubjectDN extends EAuthException { /** * Constructs an Error on formulating the subject dn. + * * @param errorString Detailed error message. */ public EFormSubjectDN(String errorString) { diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/EInvalidCredentials.java b/pki/base/common/src/com/netscape/certsrv/authentication/EInvalidCredentials.java index 894a07ca5..3e4daaf0d 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EInvalidCredentials.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EInvalidCredentials.java @@ -29,6 +29,7 @@ public class EInvalidCredentials extends EAuthException { /** * Constructs an Invalid Credentials exception. + * * @param errorString Detailed error message. */ public EInvalidCredentials(String errorString) { diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/EMissingCredential.java b/pki/base/common/src/com/netscape/certsrv/authentication/EMissingCredential.java index 695dd15cd..5de73aa0d 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EMissingCredential.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EMissingCredential.java @@ -29,6 +29,7 @@ public class EMissingCredential extends EAuthException { /** * Constructs a exception for a missing required authentication credential + * * @param errorString Detailed error message. */ public EMissingCredential(String errorString) { diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/IAuthCredentials.java b/pki/base/common/src/com/netscape/certsrv/authentication/IAuthCredentials.java index eb36f9965..cd8434433 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/IAuthCredentials.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/IAuthCredentials.java @@ -24,19 +24,21 @@ import com.netscape.certsrv.base.IAttrSet; * An interface represents authentication credentials: * e.g. uid/pwd, uid/pin, certificate, etc. *

- * + * * @version $Revision$, $Date$ */ public interface IAuthCredentials extends IAttrSet { - /** + /** * Set argblock. + * * @param blk argblock */ public void setArgBlock(IArgBlock blk); /** * Returns argblock. + * * @return Argblock. */ public IArgBlock getArgBlock(); 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 b2f7d69ad..1ff46af7d 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. *

- * + * * @version $Revision$, $Date$ */ public interface IAuthManager { @@ -41,6 +41,7 @@ public interface IAuthManager { /** * Get the name of this authentication manager instance. *

+ * * @return the name of this authentication manager. */ public String getName(); @@ -48,31 +49,34 @@ public interface IAuthManager { /** * Get name of authentication manager plugin. *

+ * * @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. @@ -82,24 +86,26 @@ public interface IAuthManager { /** * 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 + * 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; + throws EBaseException; /** * Get the configuration store for this authentication manager. + * * @return The configuration store of this authentication manager. */ public IConfigStore getConfigStore(); diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/IAuthSubsystem.java b/pki/base/common/src/com/netscape/certsrv/authentication/IAuthSubsystem.java index 2de8ed266..329b6802e 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/IAuthSubsystem.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/IAuthSubsystem.java @@ -26,7 +26,7 @@ import com.netscape.certsrv.base.ISubsystem; /** * An interface that represents an authentication component *

- * + * * @version $Revision$, $Date$ */ public interface IAuthSubsystem extends ISubsystem { @@ -39,17 +39,17 @@ public interface IAuthSubsystem extends ISubsystem { /** * Constant for class. */ - public static final String PROP_CLASS = "class"; + public static final String PROP_CLASS = "class"; /** * Constant for impl */ - public static final String PROP_IMPL = "impl"; + public static final String PROP_IMPL = "impl"; /** * Constant for pluginName. */ - public static final String PROP_PLUGIN = "pluginName"; + public static final String PROP_PLUGIN = "pluginName"; /** * Constant for instance. @@ -120,6 +120,7 @@ public interface IAuthSubsystem extends ISubsystem { /** * Authenticate the given credentials using the given manager name. + * * @param authCred The authentication credentials * @param authMgrName The authentication manager name * @return a authentication token. @@ -128,11 +129,12 @@ public interface IAuthSubsystem extends ISubsystem { * @exception EBaseException If an error occurs during authentication. */ public IAuthToken authenticate(IAuthCredentials authCred, String authMgrName) - throws EMissingCredential, EInvalidCredentials, EBaseException; + throws EMissingCredential, EInvalidCredentials, EBaseException; /** * Gets the required credential attributes for the given authentication * manager. + * * @param authMgrName The authentication manager name * @return a Vector of required credential attribute names. * @exception EBaseException If the required credential is missing @@ -141,6 +143,7 @@ public interface IAuthSubsystem extends ISubsystem { /** * Adds (registers) the given authentication manager. + * * @param name The authentication manager name * @param authMgr The authentication manager instance. */ @@ -148,12 +151,14 @@ public interface IAuthSubsystem extends ISubsystem { /** * Deletes (deregisters) the given authentication manager. + * * @param name The authentication manager name to delete. */ public void delete(String name); /** * Gets the Authentication manager instance of the specified name. + * * @param name The authentication manager's name. * @exception EBaseException when internal error occurs. */ @@ -162,18 +167,21 @@ public interface IAuthSubsystem extends ISubsystem { /** * Gets an enumeration of authentication managers registered to the * authentication subsystem. + * * @return a list of authentication managers */ public Enumeration getAuthManagers(); /** * Gets an enumeration of authentication manager plugins. + * * @return a list of authentication plugins */ public Enumeration getAuthManagerPlugins(); /** * Gets a single authentication manager plugin implementation + * * @param name given authentication plugin name * @return the given authentication plugin */ @@ -181,17 +189,19 @@ public interface IAuthSubsystem extends ISubsystem { /** * Get configuration parameters for a authentication mgr plugin. + * * @param implName The plugin name. * @return configuration parameters for the given authentication manager plugin - * @exception EAuthMgrPluginNotFound If the authentication manager - * plugin is not found. + * @exception EAuthMgrPluginNotFound If the authentication manager + * plugin is not found. * @exception EBaseException If an internal error occurred. */ - public String[] getConfigParams(String implName) - throws EAuthMgrPluginNotFound, EBaseException; + public String[] getConfigParams(String implName) + throws EAuthMgrPluginNotFound, EBaseException; /** * Log error message. + * * @param level log level * @param msg error message */ @@ -199,28 +209,31 @@ public interface IAuthSubsystem extends ISubsystem { /** * Get a hashtable containing all authentication plugins. + * * @return all authentication plugins. */ public Hashtable getPlugins(); /** * Get a hashtable containing all authentication instances. + * * @return all authentication instances. */ public Hashtable getInstances(); /** * Get an authentication manager interface for the given name. + * * @param name given authentication manager name. * @return an authentication manager for the given manager name. */ public IAuthManager get(String name); /** - * Get an authentication manager plugin impl for the given name. + * Get an authentication manager plugin impl for the given name. + * * @param name given authentication manager name. * @return an authentication manager plugin */ public AuthMgrPlugin getAuthManagerPluginImpl(String name); } - diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/IAuthToken.java b/pki/base/common/src/com/netscape/certsrv/authentication/IAuthToken.java index 942793633..f46ee3ca1 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/IAuthToken.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/IAuthToken.java @@ -32,14 +32,14 @@ import com.netscape.certsrv.usrgrp.Certificates; */ public interface IAuthToken { - /** - * Constant for userid. - */ - public static final String USER_ID = "userid"; + /** + * Constant for userid. + */ + public static final String USER_ID = "userid"; /** * Sets an attribute value within this AttrSet. - * + * * @param name the name of the attribute * @param value the attribute object. * @return false on an error @@ -48,7 +48,7 @@ public interface IAuthToken { /** * Gets an attribute value. - * + * * @param name the name of the attribute to return. * @exception EBaseException on attribute handling errors. * @return the attribute value @@ -58,7 +58,7 @@ public interface IAuthToken { /** * Returns an enumeration of the names of the attributes existing within * this AttrSet. - * + * * @return an enumeration of the attribute names. */ public Enumeration getElements(); @@ -70,139 +70,156 @@ public interface IAuthToken { */ /** - * Retrieves the byte array value for name. The value should have been + * Retrieves the byte array value for name. The value should have been * previously stored as a byte array (it will be CMS.AtoB decoded). - * @param name The attribute name. - * @return The byte array or null on error. + * + * @param name The attribute name. + * @return The byte array or null on error. */ public byte[] getInByteArray(String name); /** * Stores the byte array with the associated key. - * @param name The attribute name. - * @param value The value to store + * + * @param name The attribute name. + * @param value The value to store * @return false on an error */ public boolean set(String name, byte[] value); /** * Retrieves the Integer value for name. - * @param name The attribute name. - * @return The Integer or null on error. + * + * @param name The attribute name. + * @return The Integer or null on error. */ public Integer getInInteger(String name); /** * Stores the Integer with the associated key. - * @param name The attribute name. - * @param value The value to store + * + * @param name The attribute name. + * @param value The value to store * @return false on an error */ public boolean set(String name, Integer value); /** * Retrieves the BigInteger array value for name. - * @param name The attribute name. - * @return The value or null on error. + * + * @param name The attribute name. + * @return The value or null on error. */ public BigInteger[] getInBigIntegerArray(String name); /** * Stores the BigInteger array with the associated key. - * @param name The attribute name. - * @param value The value to store + * + * @param name The attribute name. + * @param value The value to store * @return false on an error */ public boolean set(String name, BigInteger[] value); /** * Retrieves the Date value for name. - * @param name The attribute name. - * @return The value or null on error. + * + * @param name The attribute name. + * @return The value or null on error. */ public Date getInDate(String name); /** * Stores the Date with the associated key. - * @param name The attribute name. - * @param value The value to store + * + * @param name The attribute name. + * @param value The value to store * @return false on an error */ public boolean set(String name, Date value); /** * Retrieves the String array value for name. - * @param name The attribute name. - * @return The value or null on error. + * + * @param name The attribute name. + * @return The value or null on error. */ public String[] getInStringArray(String name); /** * Stores the String array with the associated key. - * @param name The attribute name. - * @param value The value to store + * + * @param name The attribute name. + * @param value The value to store * @return False on error. */ public boolean set(String name, String[] value); /** * Retrieves the X509CertImpl value for name. - * @param name The attribute name. - * @return The value or null on error. + * + * @param name The attribute name. + * @return The value or null on error. */ public X509CertImpl getInCert(String name); /** * Stores the X509CertImpl with the associated key. - * @param name The attribute name. - * @param value The value to store + * + * @param name The attribute name. + * @param value The value to store * @return false on error */ public boolean set(String name, X509CertImpl value); /** * Retrieves the CertificateExtensions value for name. - * @param name The attribute name. - * @return The value or null on error. + * + * @param name The attribute name. + * @return The value or null on error. */ public CertificateExtensions getInCertExts(String name); /** * Stores the CertificateExtensions with the associated key. - * @param name The attribute name. - * @param value The value to store + * + * @param name The attribute name. + * @param value The value to store * @return false on error */ public boolean set(String name, CertificateExtensions value); /** * Retrieves the Certificates value for name. - * @param name The attribute name. - * @return The value or null on error. + * + * @param name The attribute name. + * @return The value or null on error. */ public Certificates getInCertificates(String name); /** * Stores the Certificates with the associated key. - * @param name The attribute name. - * @param value The value to store + * + * @param name The attribute name. + * @param value The value to store * @return false on error */ public boolean set(String name, Certificates value); /** * Retrieves the byte[][] value for name. - * @param name The attribute name. - * @return The value or null on error. + * + * @param name The attribute name. + * @return The value or null on error. */ public byte[][] getInByteArrayArray(String name); /** * Stores the byte[][] with the associated key. - * @param name The attribute name. - * @param value The value to store + * + * @param name The attribute name. + * @param value The value to store * @return false on error */ public boolean set(String name, byte[][] value); } - diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/ISSLClientCertProvider.java b/pki/base/common/src/com/netscape/certsrv/authentication/ISSLClientCertProvider.java index d4bdf7bb1..6932decc0 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/ISSLClientCertProvider.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/ISSLClientCertProvider.java @@ -17,18 +17,15 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.authentication; - import java.security.cert.X509Certificate; - /** * This interface represents an object that captures the * SSL client certificate in a SSL session. Normally, this * object is a servlet. *

- * - * This interface is used to avoid the internal imeplemtnation - * to have servlet (protocol handler) dependency. + * + * This interface is used to avoid the internal imeplemtnation to have servlet (protocol handler) dependency. *

* * @version $Revision$, $Date$ @@ -37,7 +34,7 @@ public interface ISSLClientCertProvider { /** * Retrieves the SSL client certificate chain. - * + * * @return certificate chain */ public X509Certificate[] getClientCertificateChain(); diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/ISharedToken.java b/pki/base/common/src/com/netscape/certsrv/authentication/ISharedToken.java index eae65d176..830c8866e 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/ISharedToken.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/ISharedToken.java @@ -26,6 +26,7 @@ import org.mozilla.jss.pkix.cmc.PKIData; */ public interface ISharedToken { - public String getSharedToken(PKIData cmcData); - public String getSharedToken(BigInteger serialnum); + public String getSharedToken(PKIData cmcData); + + public String getSharedToken(BigInteger serialnum); } -- cgit