com.netscape.certsrv.dbs.keydb

Interface IKeyRecord

public interface IKeyRecord

An interface contains constants for key record.

Version:

$Revision$, $Date$

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_ALGORITHM
static java.lang.String	ATTR_ARCHIVED_BY
static java.lang.String	ATTR_CLIENT_ID
static java.lang.String	ATTR_CREATE_TIME
static java.lang.String	ATTR_DATA_TYPE
static java.lang.String	ATTR_DATE_OF_RECOVERY
static java.lang.String	ATTR_ID
static java.lang.String	ATTR_KEY_SIZE
static java.lang.String	ATTR_META_INFO
static java.lang.String	ATTR_MODIFY_TIME
static java.lang.String	ATTR_OWNER_NAME
static java.lang.String	ATTR_PRIVATE_KEY_DATA
static java.lang.String	ATTR_PUBLIC_KEY_DATA
static java.lang.String	ATTR_REALM
static java.lang.String	ATTR_STATE
static java.lang.String	ATTR_STATUS
static java.lang.String	STATUS_ANY
static java.lang.String	STATUS_INVALID
static java.lang.String	STATUS_VALID

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlgorithm() Retrieves key algorithm.
java.lang.String	getArchivedBy() Retrieves archiver identifier.
java.lang.String	getClientId() Retrieves client ID.
java.util.Date	getCreateTime() Retrieves creation time.
java.lang.String	getDataType() Retrieves key data type.
java.util.Date[]	getDateOfRevocation() Retrieves dates of recovery.
java.lang.Integer	getKeySize() Retrieves key length.
java.lang.String	getKeyStatus() Retrieves key status.
MetaInfo	getMetaInfo() Retrieves meta info.
java.util.Date	getModifyTime() Retrieves last modification time.
java.lang.String	getOwnerName() Retrieves key owner name.
byte[]	getPublicKeyData() Retrieves public key data.
java.lang.String	getRealm() Retrieves authorization realm.
java.math.BigInteger	getSerialNumber() Retrieves key identifier.
KeyState	getState() Retrieves the state of the key.

Field Detail

ATTR_ID

static final java.lang.String ATTR_ID

See Also:

Constant Field Values

ATTR_STATE

static final java.lang.String ATTR_STATE

See Also:

Constant Field Values

ATTR_ALGORITHM

static final java.lang.String ATTR_ALGORITHM

See Also:

Constant Field Values

ATTR_KEY_SIZE

static final java.lang.String ATTR_KEY_SIZE

See Also:

Constant Field Values

ATTR_OWNER_NAME

static final java.lang.String ATTR_OWNER_NAME

See Also:

Constant Field Values

ATTR_PRIVATE_KEY_DATA

static final java.lang.String ATTR_PRIVATE_KEY_DATA

See Also:

Constant Field Values

ATTR_PUBLIC_KEY_DATA

static final java.lang.String ATTR_PUBLIC_KEY_DATA

See Also:

Constant Field Values

ATTR_DATE_OF_RECOVERY

static final java.lang.String ATTR_DATE_OF_RECOVERY

See Also:

Constant Field Values

ATTR_CREATE_TIME

static final java.lang.String ATTR_CREATE_TIME

See Also:

Constant Field Values

ATTR_MODIFY_TIME

static final java.lang.String ATTR_MODIFY_TIME

See Also:

Constant Field Values

ATTR_META_INFO

static final java.lang.String ATTR_META_INFO

See Also:

Constant Field Values

ATTR_ARCHIVED_BY

static final java.lang.String ATTR_ARCHIVED_BY

See Also:

Constant Field Values

ATTR_CLIENT_ID

static final java.lang.String ATTR_CLIENT_ID

See Also:

Constant Field Values

ATTR_DATA_TYPE

static final java.lang.String ATTR_DATA_TYPE

See Also:

Constant Field Values

ATTR_STATUS

static final java.lang.String ATTR_STATUS

See Also:

Constant Field Values

ATTR_REALM

static final java.lang.String ATTR_REALM

See Also:

Constant Field Values

STATUS_ANY

static final java.lang.String STATUS_ANY

See Also:

Constant Field Values

STATUS_VALID

static final java.lang.String STATUS_VALID

See Also:

Constant Field Values

STATUS_INVALID

static final java.lang.String STATUS_INVALID

See Also:

Constant Field Values

Method Detail

getState

KeyState getState()
           throws EBaseException

Retrieves the state of the key.

Returns:

key state

Throws:

EBaseException - failed to retrieve state of the key

getSerialNumber

java.math.BigInteger getSerialNumber()
                              throws EBaseException

Retrieves key identifier.

Returns:

key id

Throws:

EBaseException - failed to retrieve key id

getOwnerName

java.lang.String getOwnerName()
                       throws EBaseException

Retrieves key owner name.

Returns:

key owner name

Throws:

EBaseException - failed to retrieve key owner name

getAlgorithm

java.lang.String getAlgorithm()

Retrieves key algorithm.

Returns:

key algorithm

getKeySize

java.lang.Integer getKeySize()
                      throws EBaseException

Retrieves key length.

Returns:

key length

Throws:

EBaseException - failed to retrieve key length

getMetaInfo

MetaInfo getMetaInfo()

Retrieves meta info.

Returns:

MetaInfo

getClientId

java.lang.String getClientId()
                      throws EBaseException

Retrieves client ID.

Returns:

client id

Throws:

EBaseException - failed to retrieve client id

getDataType

java.lang.String getDataType()
                      throws EBaseException

Retrieves key data type.

Returns:

data type

Throws:

EBaseException - failed to retrieve data type

getKeyStatus

java.lang.String getKeyStatus()
                       throws EBaseException

Retrieves key status.

Returns:

key status

Throws:

EBaseException - failed to retrieve key status

getArchivedBy

java.lang.String getArchivedBy()

Retrieves archiver identifier.

Returns:

archiver uid

getCreateTime

java.util.Date getCreateTime()

Retrieves creation time.

Returns:

creation time

getModifyTime

java.util.Date getModifyTime()

Retrieves last modification time.

Returns:

modification time

getDateOfRevocation

java.util.Date[] getDateOfRevocation()
                              throws EBaseException

Retrieves dates of recovery.

Returns:

recovery history

Throws:

EBaseException - failed to retrieve recovery history

getPublicKeyData

byte[] getPublicKeyData()
                 throws EBaseException

Retrieves public key data.

Returns:

public key data

Throws:

EBaseException - failed to retrieve public key data

getRealm

java.lang.String getRealm()
                   throws EBaseException

Retrieves authorization realm.

Returns:

authorization realm

Throws:

EBaseException - failed to retrieve authorization realm