diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/authentication')
20 files changed, 152 insertions, 220 deletions
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 b42bd534..222f9a61 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. * <P> - * + * * @version $Revision$, $Date$ */ public class AuthCredentials implements IAuthCredentials { @@ -36,7 +36,7 @@ public class AuthCredentials implements IAuthCredentials { private static final long serialVersionUID = 5862936214648594328L; private Hashtable authCreds = null; private IArgBlock argblk = null; - + /** * Constructor */ @@ -45,9 +45,7 @@ public class AuthCredentials implements IAuthCredentials { } /** - * Sets an authentication credential with credential name and the credential - * object - * + * Sets an authentication credential with credential name and the credential object * @param name credential name * @param cred credential object */ @@ -58,8 +56,7 @@ 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 */ @@ -68,10 +65,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. - * + * 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. * @param name credential name */ public void delete(String name) { @@ -79,29 +75,29 @@ 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. - * + * 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. + * Set 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 006065dd..f98276ec 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). - * + * 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,10 +29,9 @@ 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; @@ -40,8 +39,7 @@ 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() { @@ -50,7 +48,6 @@ 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 18939ed7..f060db5f 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/AuthMgrPlugin.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/AuthMgrPlugin.java @@ -17,10 +17,13 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.authentication; + + + /** * This class represents a registered authentication manager plugin. * <P> - * + * * @version $Revision$, $Date$ */ public class AuthMgrPlugin { @@ -31,24 +34,21 @@ public class AuthMgrPlugin { /** * Constructs a AuthManager plugin. - * * @param id auth manager implementation name * @param classPath class path */ public AuthMgrPlugin(String id, String classPath) { /* - * if (id == null || classPath == null) throw new - * AssertionException("Authentication Manager id or classpath can't be null" - * ); + if (id == null || classPath == null) + throw new AssertionException("Authentication Manager id or classpath can't be null"); */ mId = id; mClassPath = classPath; } - + /** * Returns an auth manager implementation name - * * @return an auth manager implementation name */ public String getId() { @@ -57,25 +57,22 @@ 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 35e81011..138a07eb 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. * <P> - * + * * @deprecated * @version $Revision$, $Date$ */ @@ -30,7 +30,6 @@ 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 80938d90..7d2d5eb9 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/AuthToken.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/AuthToken.java @@ -38,13 +38,13 @@ import com.netscape.certsrv.apps.CMS; 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 manager for more details. + * 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 + * manager for more details. * <p> - * * @version $Revision$, $Date$ */ public class AuthToken implements IAuthToken { @@ -74,45 +74,43 @@ public class AuthToken implements IAuthToken { public static final String TOKEN_CERT_TO_REVOKE = "tokenCertToRevoke"; /** - * Plugin name of the authentication manager that created the AuthToken as a - * string. + * Plugin name of the authentication manager that created the + * AuthToken as a string. */ public static final String TOKEN_AUTHMGR_IMPL_NAME = "authMgrImplName"; /** - * Name of the authentication manager that created the AuthToken as a - * string. + * Name of the authentication manager that created the AuthToken + * as a string. */ 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: <br> - * + * Constructs an instance of a authentication token. + * The token by default contains the following attributes: <br> * <pre> - * "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. * </pre> - * * @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) { @@ -125,7 +123,6 @@ 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) { @@ -134,7 +131,6 @@ public class AuthToken implements IAuthToken { /** * Enumerate all attribute names in the AuthToken. - * * @return Enumeration of all attribute names in this AuthToken. */ public Enumeration getElements() { @@ -355,7 +351,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) { @@ -410,7 +406,6 @@ public class AuthToken implements IAuthToken { /** * Enumerate all attribute values in the AuthToken. - * * @return Enumeration of all attribute names in this AuthToken. */ public Enumeration getVals() { @@ -418,11 +413,10 @@ 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 this - * token. + * 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)); @@ -431,9 +425,8 @@ 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)); @@ -441,10 +434,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 c79c3e9a..b998ae8b 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EAuthException.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EAuthException.java @@ -22,7 +22,6 @@ import com.netscape.certsrv.base.EBaseException; /** * This class represents authentication exceptions. * <P> - * * @version $Revision$, $Date$ */ public class EAuthException extends EBaseException { @@ -39,7 +38,6 @@ public class EAuthException extends EBaseException { /** * Constructs an authentication exception * <P> - * * @param msgFormat exception details */ public EAuthException(String msgFormat) { @@ -47,9 +45,8 @@ public class EAuthException extends EBaseException { } /** - * Constructs an authentication exception with a parameter. + * Constructs an authentication exception with a parameter. * <p> - * * @param msgFormat exception details in message string format * @param param message string parameter */ @@ -60,7 +57,6 @@ public class EAuthException extends EBaseException { /** * Constructs a auth exception with a exception parameter. * <P> - * * @param msgFormat exception details in message string format * @param exception system exception */ @@ -71,7 +67,6 @@ public class EAuthException extends EBaseException { /** * Constructs a auth exception with a list of parameters. * <P> - * * @param msgFormat the message format. * @param params list of message format parameters */ @@ -81,7 +76,6 @@ 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 1b2d848a..fb4ad04b 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EAuthInternalError.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EAuthInternalError.java @@ -28,9 +28,8 @@ public class EAuthInternalError extends EAuthException { private static final long serialVersionUID = -4020816090107820450L; /** - * Constructs an authentication internal error exception with a detailed - * message. - * + * 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 925aaabf..675fbe59 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EAuthMgrNotFound.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EAuthMgrNotFound.java @@ -29,7 +29,6 @@ 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 2ca90e3c..2210de2c 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EAuthMgrPluginNotFound.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EAuthMgrPluginNotFound.java @@ -29,8 +29,7 @@ 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 f816c35e..b3bafd3c 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EAuthUserError.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EAuthUserError.java @@ -29,7 +29,6 @@ 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 84725bb9..edbf13e6 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/ECompSyntaxErr.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/ECompSyntaxErr.java @@ -29,7 +29,6 @@ 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 95282448..b56a1e0a 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EFormSubjectDN.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EFormSubjectDN.java @@ -29,7 +29,6 @@ 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 3e4daaf0..894a07ca 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EInvalidCredentials.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EInvalidCredentials.java @@ -29,7 +29,6 @@ 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 5de73aa0..695dd15c 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/EMissingCredential.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/EMissingCredential.java @@ -29,7 +29,6 @@ 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 8056ae31..eb36f996 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/IAuthCredentials.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/IAuthCredentials.java @@ -21,24 +21,22 @@ import com.netscape.certsrv.base.IArgBlock; import com.netscape.certsrv.base.IAttrSet; /** - * An interface represents authentication credentials: e.g. uid/pwd, uid/pin, - * certificate, etc. + * An interface represents authentication credentials: + * e.g. uid/pwd, uid/pin, certificate, etc. * <P> - * + * * @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 28fcfe41..b2f7d69a 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,7 +41,6 @@ public interface IAuthManager { /** * Get the name of this authentication manager instance. * <p> - * * @return the name of this authentication manager. */ public String getName(); @@ -49,62 +48,58 @@ 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(); 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 efa9dbd7..29657e7a 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 * <P> - * + * * @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,22 +120,19 @@ 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. - * @exception EMissingCredential when missing credential during - * authentication + * @exception EMissingCredential when missing credential during authentication * @exception EInvalidCredentials when the credential is invalid * @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 @@ -144,7 +141,6 @@ public interface IAuthSubsystem extends ISubsystem { /** * Adds (registers) the given authentication manager. - * * @param name The authentication manager name * @param authMgr The authentication manager instance. */ @@ -152,14 +148,12 @@ 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. */ @@ -168,21 +162,18 @@ 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 */ @@ -190,20 +181,17 @@ 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. + * @return configuration parameters for the given authentication manager plugin + * @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 */ @@ -211,31 +199,28 @@ 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 0d9be9a8..a8462108 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,167 +58,151 @@ 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(); /************ - * Helpers for non-string sets and gets. These are needed because AuthToken - * is stored in IRequest (which can only store string values + * Helpers for non-string sets and gets. + * These are needed because AuthToken is stored in IRequest (which can + * only store string values */ /** - * 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 c85e6278..d4bdf7bb 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/ISSLClientCertProvider.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/ISSLClientCertProvider.java @@ -17,15 +17,18 @@ // --- 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 represents an object that captures the + * SSL client certificate in a SSL session. Normally, this + * object is a servlet. * <p> - * - * 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. * <p> * * @version $Revision$, $Date$ @@ -34,7 +37,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 830c8866..eae65d17 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/ISharedToken.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/ISharedToken.java @@ -26,7 +26,6 @@ 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); } |