com.netscape.certsrv.authentication

Interface IAuthToken

All Known Implementing Classes:

AuthToken

public interface IAuthToken

AuthToken interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GROUPS
static java.lang.String	UID
static java.lang.String	USER_ID Constant for userid.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	get(java.lang.String name) Gets an attribute value.
java.util.Enumeration<java.lang.String>	getElements() Returns an enumeration of the names of the attributes existing within this AttrSet.
java.math.BigInteger[]	getInBigIntegerArray(java.lang.String name) Retrieves the BigInteger array value for name.
byte[]	getInByteArray(java.lang.String name) Retrieves the byte array value for name.
byte[][]	getInByteArrayArray(java.lang.String name) Retrieves the byte[][] value for name.
netscape.security.x509.X509CertImpl	getInCert(java.lang.String name) Retrieves the X509CertImpl value for name.
netscape.security.x509.CertificateExtensions	getInCertExts(java.lang.String name) Retrieves the CertificateExtensions value for name.
Certificates	getInCertificates(java.lang.String name) Retrieves the Certificates value for name.
java.util.Date	getInDate(java.lang.String name) Retrieves the Date value for name.
java.lang.Integer	getInInteger(java.lang.String name) Retrieves the Integer value for name.
java.lang.String	getInString(java.lang.String name) Gets an attribute value.
java.lang.String[]	getInStringArray(java.lang.String name) Retrieves the String array value for name.
boolean	set(java.lang.String name, java.math.BigInteger[] value) Stores the BigInteger array with the associated key.
boolean	set(java.lang.String name, byte[] value) Stores the byte array with the associated key.
boolean	set(java.lang.String name, byte[][] value) Stores the byte[][] with the associated key.
boolean	set(java.lang.String name, netscape.security.x509.CertificateExtensions value) Stores the CertificateExtensions with the associated key.
boolean	set(java.lang.String name, Certificates value) Stores the Certificates with the associated key.
boolean	set(java.lang.String name, java.util.Date value) Stores the Date with the associated key.
boolean	set(java.lang.String name, java.lang.Integer value) Stores the Integer with the associated key.
boolean	set(java.lang.String name, java.lang.String value) Sets an attribute value within this AttrSet.
boolean	set(java.lang.String name, java.lang.String[] value) Stores the String array with the associated key.
boolean	set(java.lang.String name, netscape.security.x509.X509CertImpl value) Stores the X509CertImpl with the associated key.

Field Detail

USER_ID

static final java.lang.String USER_ID

Constant for userid.

See Also:

Constant Field Values

UID

static final java.lang.String UID

See Also:

Constant Field Values

GROUPS

static final java.lang.String GROUPS

See Also:

Constant Field Values

Method Detail

set

boolean set(java.lang.String name,
            java.lang.String value)

Sets an attribute value within this AttrSet.

Parameters:

name - the name of the attribute

value - the attribute object.

Returns:

false on an error

get

java.lang.Object get(java.lang.String name)

Gets an attribute value.

Parameters:

name - the name of the attribute to return.

Returns:

the attribute value

Throws:

EBaseException - on attribute handling errors.

getInString

java.lang.String getInString(java.lang.String name)

Gets an attribute value.

Parameters:

name - the name of the attribute to return.

Returns:

the attribute value

Throws:

EBaseException - on attribute handling errors.

getElements

java.util.Enumeration<java.lang.String> getElements()

Returns an enumeration of the names of the attributes existing within this AttrSet.

Returns:

an enumeration of the attribute names.

getInByteArray

byte[] getInByteArray(java.lang.String name)

Retrieves the byte array value for name. The value should have been previously stored as a byte array (it will be CMS.AtoB decoded).

Parameters:

name - The attribute name.

Returns:

The byte array or null on error.

set

boolean set(java.lang.String name,
            byte[] value)

Stores the byte array with the associated key.

Parameters:

name - The attribute name.

value - The value to store

Returns:

false on an error

getInInteger

java.lang.Integer getInInteger(java.lang.String name)

Retrieves the Integer value for name.

Parameters:

name - The attribute name.

Returns:

The Integer or null on error.

set

boolean set(java.lang.String name,
            java.lang.Integer value)

Stores the Integer with the associated key.

Parameters:

name - The attribute name.

value - The value to store

Returns:

false on an error

getInBigIntegerArray

java.math.BigInteger[] getInBigIntegerArray(java.lang.String name)

Retrieves the BigInteger array value for name.

Parameters:

name - The attribute name.

Returns:

The value or null on error.

set

boolean set(java.lang.String name,
            java.math.BigInteger[] value)

Stores the BigInteger array with the associated key.

Parameters:

name - The attribute name.

value - The value to store

Returns:

false on an error

getInDate

java.util.Date getInDate(java.lang.String name)

Retrieves the Date value for name.

Parameters:

name - The attribute name.

Returns:

The value or null on error.

set

boolean set(java.lang.String name,
            java.util.Date value)

Stores the Date with the associated key.

Parameters:

name - The attribute name.

value - The value to store

Returns:

false on an error

getInStringArray

java.lang.String[] getInStringArray(java.lang.String name)

Retrieves the String array value for name.

Parameters:

name - The attribute name.

Returns:

The value or null on error.

set

boolean set(java.lang.String name,
            java.lang.String[] value)

Stores the String array with the associated key.

Parameters:

name - The attribute name.

value - The value to store

Returns:

False on error.

getInCert

netscape.security.x509.X509CertImpl getInCert(java.lang.String name)

Retrieves the X509CertImpl value for name.

Parameters:

name - The attribute name.

Returns:

The value or null on error.

set

boolean set(java.lang.String name,
            netscape.security.x509.X509CertImpl value)

Stores the X509CertImpl with the associated key.

Parameters:

name - The attribute name.

value - The value to store

Returns:

false on error

getInCertExts

netscape.security.x509.CertificateExtensions getInCertExts(java.lang.String name)
                                                    throws java.io.IOException

Retrieves the CertificateExtensions value for name.

Parameters:

name - The attribute name.

Returns:

The value.

Throws:

java.io.IOException

set

boolean set(java.lang.String name,
            netscape.security.x509.CertificateExtensions value)

Stores the CertificateExtensions with the associated key.

Parameters:

name - The attribute name.

value - The value to store

Returns:

false on error

getInCertificates

Certificates getInCertificates(java.lang.String name)
                        throws java.io.IOException,
                               java.security.cert.CertificateException

Retrieves the Certificates value for name.

Parameters:

name - The attribute name.

Returns:

The value.

Throws:

java.io.IOException

java.security.cert.CertificateException

set

boolean set(java.lang.String name,
            Certificates value)

Stores the Certificates with the associated key.

Parameters:

name - The attribute name.

value - The value to store

Returns:

false on error

getInByteArrayArray

byte[][] getInByteArrayArray(java.lang.String name)
                      throws java.io.IOException

Retrieves the byte[][] value for name.

Parameters:

name - The attribute name.

Returns:

The value.

Throws:

java.io.IOException

set

boolean set(java.lang.String name,
            byte[][] value)

Stores the byte[][] with the associated key.

Parameters:

name - The attribute name.

value - The value to store

Returns:

false on error