Class AuthToken

java.lang.Object
org.dogtagpki.server.authentication.AuthToken
All Implemented Interfaces:
IAuthToken
public class AuthToken extends Object implements IAuthToken
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.

Version:
$Revision$, $Date$

  • Field Details

  • Constructor Details

    • AuthToken

      public AuthToken(AuthManager authMgr)
      Constructs an instance of a authentication token. The token by default contains the following attributes: 
              "authMgrInstName" - The authentication manager instance name.
        "authTime" - The - The time of authentication.
      Parameters:
      authMgr - The authentication manager that created this Token.

  • Method Details

    • get

      public Object get(String attrName)
      Description copied from interface: IAuthToken
      Gets an attribute value.
      Specified by:
      get in interface IAuthToken
      Parameters:
      attrName - the name of the attribute to return.
      Returns:
      the attribute value

    • getInString

      public String getInString(String attrName)
      Description copied from interface: IAuthToken
      Gets an attribute value.
      Specified by:
      getInString in interface IAuthToken
      Parameters:
      attrName - the name of the attribute to return.
      Returns:
      the attribute value

    • set

      public boolean set(String attrName, String value)
      Description copied from interface: IAuthToken
      Sets an attribute value within this AttrSet.
      Specified by:
      set in interface IAuthToken
      Parameters:
      attrName - the name of the attribute
      value - the attribute object.
      Returns:
      false on an error

    • delete

      public void delete(String attrName)
      Removes an attribute in the AuthToken
      Parameters:
      attrName - The name of the attribute to remove.

    • getElements

      public Enumeration<String> getElements()
      Enumerate all attribute names in the AuthToken.
      Specified by:
      getElements in interface IAuthToken
      Returns:
      Enumeration of all attribute names in this AuthToken.

    • getInByteArray

      public byte[] getInByteArray(String name)
      Description copied from interface: IAuthToken
      Retrieves the byte array value for name. The value should have been previously stored as a byte array (it will be CMS.AtoB decoded).
      Specified by:
      getInByteArray in interface IAuthToken
      Parameters:
      name - The attribute name.
      Returns:
      The byte array or null on error.

    • set

      public boolean set(String name, byte[] value)
      Description copied from interface: IAuthToken
      Stores the byte array with the associated key.
      Specified by:
      set in interface IAuthToken
      Parameters:
      name - The attribute name.
      value - The value to store
      Returns:
      false on an error

    • getInInteger

      public Integer getInInteger(String name)
      Description copied from interface: IAuthToken
      Retrieves the Integer value for name.
      Specified by:
      getInInteger in interface IAuthToken
      Parameters:
      name - The attribute name.
      Returns:
      The Integer or null on error.

    • set

      public boolean set(String name, Integer value)
      Description copied from interface: IAuthToken
      Stores the Integer with the associated key.
      Specified by:
      set in interface IAuthToken
      Parameters:
      name - The attribute name.
      value - The value to store
      Returns:
      false on an error

    • getInBigIntegerArray

      public BigInteger[] getInBigIntegerArray(String name)
      Description copied from interface: IAuthToken
      Retrieves the BigInteger array value for name.
      Specified by:
      getInBigIntegerArray in interface IAuthToken
      Parameters:
      name - The attribute name.
      Returns:
      The value or null on error.

    • set

      public boolean set(String name, BigInteger[] value)
      Description copied from interface: IAuthToken
      Stores the BigInteger array with the associated key.
      Specified by:
      set in interface IAuthToken
      Parameters:
      name - The attribute name.
      value - The value to store
      Returns:
      false on an error

    • getInDate

      public Date getInDate(String name)
      Description copied from interface: IAuthToken
      Retrieves the Date value for name.
      Specified by:
      getInDate in interface IAuthToken
      Parameters:
      name - The attribute name.
      Returns:
      The value or null on error.

    • set

      public boolean set(String name, Date value)
      Description copied from interface: IAuthToken
      Stores the Date with the associated key.
      Specified by:
      set in interface IAuthToken
      Parameters:
      name - The attribute name.
      value - The value to store
      Returns:
      false on an error

    • getInStringArray

      public String[] getInStringArray(String name)
      Description copied from interface: IAuthToken
      Retrieves the String array value for name.
      Specified by:
      getInStringArray in interface IAuthToken
      Parameters:
      name - The attribute name.
      Returns:
      The value or null on error.

    • set

      public boolean set(String name, String[] value)
      Description copied from interface: IAuthToken
      Stores the String array with the associated key.
      Specified by:
      set in interface IAuthToken
      Parameters:
      name - The attribute name.
      value - The value to store
      Returns:
      False on error.

    • getInCert

      public org.mozilla.jss.netscape.security.x509.X509CertImpl getInCert(String name)
      Description copied from interface: IAuthToken
      Retrieves the X509CertImpl value for name.
      Specified by:
      getInCert in interface IAuthToken
      Parameters:
      name - The attribute name.
      Returns:
      The value or null on error.

    • set

      public boolean set(String name, org.mozilla.jss.netscape.security.x509.X509CertImpl value)
      Description copied from interface: IAuthToken
      Stores the X509CertImpl with the associated key.
      Specified by:
      set in interface IAuthToken
      Parameters:
      name - The attribute name.
      value - The value to store
      Returns:
      false on error

    • getInCertExts

      public org.mozilla.jss.netscape.security.x509.CertificateExtensions getInCertExts(String name) throws IOException
      Description copied from interface: IAuthToken
      Retrieves the CertificateExtensions value for name.
      Specified by:
      getInCertExts in interface IAuthToken
      Parameters:
      name - The attribute name.
      Returns:
      The value.
      Throws:
      IOException

    • set

      public boolean set(String name, org.mozilla.jss.netscape.security.x509.CertificateExtensions value)
      Description copied from interface: IAuthToken
      Stores the CertificateExtensions with the associated key.
      Specified by:
      set in interface IAuthToken
      Parameters:
      name - The attribute name.
      value - The value to store
      Returns:
      false on error

    • getInCertificates

      public Certificates getInCertificates(String name) throws IOException, CertificateException
      Description copied from interface: IAuthToken
      Retrieves the Certificates value for name.
      Specified by:
      getInCertificates in interface IAuthToken
      Parameters:
      name - The attribute name.
      Returns:
      The value.
      Throws:
      IOException
      CertificateException

    • set

      public boolean set(String name, Certificates value)
      Description copied from interface: IAuthToken
      Stores the Certificates with the associated key.
      Specified by:
      set in interface IAuthToken
      Parameters:
      name - The attribute name.
      value - The value to store
      Returns:
      false on error

    • getInByteArrayArray

      public byte[][] getInByteArrayArray(String name) throws IOException
      Description copied from interface: IAuthToken
      Retrieves the byte[][] value for name.
      Specified by:
      getInByteArrayArray in interface IAuthToken
      Parameters:
      name - The attribute name.
      Returns:
      The value.
      Throws:
      IOException

    • set

      public boolean set(String name, byte[][] value)
      Description copied from interface: IAuthToken
      Stores the byte[][] with the associated key.
      Specified by:
      set in interface IAuthToken
      Parameters:
      name - The attribute name.
      value - The value to store
      Returns:
      false on error

    • getVals

      public Enumeration<Object> getVals()
      Enumerate all attribute values in the AuthToken.
      Returns:
      Enumeration of all attribute names in this AuthToken.

    • getAuthManagerInstName

      public String getAuthManagerInstName()
      Gets the name of the authentication manager instance that created this token.
      Returns:
      The name of the authentication manager instance that created this token.

    • getAuthTime

      public Date getAuthTime()
      Gets the time of authentication.
      Returns:
      The time of authentication