diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/authentication/IAuthToken.java')
| -rw-r--r-- | pki/base/common/src/com/netscape/certsrv/authentication/IAuthToken.java | 112 |
1 files changed, 64 insertions, 48 deletions
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 a8462108..0d9be9a8 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,151 +58,167 @@ 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); } - |