Class KeyRecord

java.lang.Object

com.netscape.cmscore.dbs.DBRecord

com.netscape.cmscore.dbs.KeyRecord

All Implemented Interfaces:

IAttrSet, IDBObj, Serializable

public class KeyRecord
extends DBRecord

A class represents a Key record. It maintains the key life cycle as well as other information about an archived key. Namely, whether a key is inactive because of compromise.

Author:

thomask

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_ALGORITHM
static final String	ATTR_ARCHIVED_BY
static final String	ATTR_CLIENT_ID
static final String	ATTR_CREATE_TIME
static final String	ATTR_DATA_TYPE
static final String	ATTR_DATE_OF_RECOVERY
static final String	ATTR_ID
static final String	ATTR_KEY_SIZE
static final String	ATTR_META_INFO
static final String	ATTR_MODIFY_TIME
static final String	ATTR_OWNER_NAME
static final String	ATTR_PRIVATE_KEY_DATA
static final String	ATTR_PUBLIC_KEY_DATA
static final String	ATTR_REALM
static final String	ATTR_STATE
static final String	ATTR_STATUS
protected static Vector<String>	mNames
static final String	STATUS_ANY
static final String	STATUS_INVALID
static final String	STATUS_VALID

Constructor Summary

Constructors

Constructor	Description
KeyRecord()	Constructs empty key record.
KeyRecord(BigInteger serialNo, byte[] publicData, byte[] privateData, String owner, String algorithm, String agentId)

Method Summary

Modifier and Type	Method	Description
void	delete(String name)	Deletes an attribute.
Object	get(String name)	Retrieves an attribute.
String	getAlgorithm()	Retrieves algorithm of the key pair.
String	getArchivedBy()	Retrieves the uid of person who archived this record.
String	getClientId()	Retrieves the client ID of this record.
Date	getCreateTime()	Retrieves the creation time of this record.
String	getDataType()	Retrieves the key data type of this record.
Date[]	getDateOfRevocation()	Retrieves the date(s) of revocation.
Enumeration<String>	getElements()	Retrieves an enumeration of attributes.
Integer	getKeySize()	Retrieves the key size.
String	getKeyStatus()	Retrieves the key status of this record.
MetaInfo	getMetaInfo()	Retrieves the meta info.
Date	getModifyTime()	Retrieves the last modification time of this record.
String	getOwnerName()	Retrieves owner name.
byte[]	getPrivateKeyData()	Retrieves key.
byte[]	getPublicKeyData()	Retrieves the public key.
String	getRealm()	Retrieves authorization realm.
Enumeration<String>	getSerializableAttrNames()	Retrieves serializable attribute names.
BigInteger	getSerialNumber()	Retrieves serial number of the key record.
KeyState	getState()	Retrieves the key state.
org.mozilla.jss.netscape.security.util.WrappingParams	getWrappingParams(org.mozilla.jss.netscape.security.util.WrappingParams oldParams)
Boolean	isEncrypted()
void	set(String name, Object object)	Sets an attribute.
void	setDateOfRevocation(Date[] dates)	Sets the date of revocation.
void	setKeySize(Integer keySize)	Sets key size.
void	setOwnerName(String name)	Sets owner name.
void	setPrivateKeyData(byte[] keydata)	Sets key data.
void	setPublicKeyData(byte[] key)	Sets the public key.
void	setSerialNumber(BigInteger serialno)	Sets serial number.
void	setState(KeyState state)	Sets key state.
void	setWrappingParams(org.mozilla.jss.netscape.security.util.WrappingParams params, boolean doEncrypt)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ATTR_ID

public static final String ATTR_ID

See Also:

• Constant Field Values

ATTR_STATE

public static final String ATTR_STATE

See Also:

• Constant Field Values

ATTR_ALGORITHM

public static final String ATTR_ALGORITHM

See Also:

• Constant Field Values

ATTR_KEY_SIZE

public static final String ATTR_KEY_SIZE

See Also:

• Constant Field Values

ATTR_OWNER_NAME

public static final String ATTR_OWNER_NAME

See Also:

• Constant Field Values

ATTR_PRIVATE_KEY_DATA

public static final String ATTR_PRIVATE_KEY_DATA

See Also:

• Constant Field Values

ATTR_PUBLIC_KEY_DATA

public static final String ATTR_PUBLIC_KEY_DATA

See Also:

• Constant Field Values

ATTR_DATE_OF_RECOVERY

public static final String ATTR_DATE_OF_RECOVERY

See Also:

• Constant Field Values

ATTR_CREATE_TIME

public static final String ATTR_CREATE_TIME

See Also:

• Constant Field Values

ATTR_MODIFY_TIME

public static final String ATTR_MODIFY_TIME

See Also:

• Constant Field Values

ATTR_META_INFO

public static final String ATTR_META_INFO

See Also:

• Constant Field Values

ATTR_ARCHIVED_BY

public static final String ATTR_ARCHIVED_BY

See Also:

• Constant Field Values

ATTR_CLIENT_ID

public static final String ATTR_CLIENT_ID

See Also:

• Constant Field Values

ATTR_DATA_TYPE

public static final String ATTR_DATA_TYPE

See Also:

• Constant Field Values

ATTR_STATUS

public static final String ATTR_STATUS

See Also:

• Constant Field Values

ATTR_REALM

public static final String ATTR_REALM

See Also:

• Constant Field Values

STATUS_ANY

public static final String STATUS_ANY

See Also:

• Constant Field Values

STATUS_VALID

public static final String STATUS_VALID

See Also:

• Constant Field Values

STATUS_INVALID

public static final String STATUS_INVALID

See Also:

• Constant Field Values

mNames

protected static Vector<String> mNames

Constructor Details

KeyRecord

public KeyRecord()

Constructs empty key record.

KeyRecord

public KeyRecord(BigInteger serialNo,
 byte[] publicData,
 byte[] privateData,
 String owner,
 String algorithm,
 String agentId)
          throws EBaseException

Throws:

EBaseException

Method Details

set

public void set(String name,
 Object object)
         throws EBaseException

Sets an attribute.

Specified by:

set in interface IAttrSet

Overrides:

set in class DBRecord

Parameters:

name - the name of the attribute

object - the attribute object.

Throws:

EBaseException - on attribute handling errors.

get

public Object get(String name)
           throws EBaseException

Retrieves an attribute.

Specified by:

get in interface IAttrSet

Overrides:

get in class DBRecord

Parameters:

name - the name of the attribute to return.

Throws:

EBaseException - on attribute handling errors.

delete

public void delete(String name)
            throws EBaseException

Deletes an attribute.

Specified by:

delete in interface IAttrSet

Overrides:

delete in class DBRecord

Parameters:

name - the name of the attribute to delete.

Throws:

EBaseException - on attribute handling errors.

getElements

public Enumeration<String> getElements()

Retrieves an enumeration of attributes.

Specified by:

getElements in interface IAttrSet

Overrides:

getElements in class DBRecord

Returns:

an enumeration of the attribute names.

getSerializableAttrNames

public Enumeration<String> getSerializableAttrNames()

Retrieves serializable attribute names.

Specified by:

getSerializableAttrNames in interface IDBObj

Overrides:

getSerializableAttrNames in class DBRecord

Returns:

a list of serializable attribute names

getSerialNumber

public BigInteger getSerialNumber()
                           throws EBaseException

Retrieves serial number of the key record. Each key record is uniquely identified by serial number.

Returns:

serial number of this key record

Throws:

EBaseException - failed to retrieve key serial number

setSerialNumber

public void setSerialNumber(BigInteger serialno)
                     throws EBaseException

Sets serial number.

Throws:

EBaseException

getState

public KeyState getState()
                  throws EBaseException

Retrieves the key state. This gives key life cycle information.

Returns:

key state

Throws:

EBaseException - failed to retrieve state of the key

setState

public void setState(KeyState state)
              throws EBaseException

Sets key state.

Throws:

EBaseException

getArchivedBy

public String getArchivedBy()

Retrieves the uid of person who archived this record.

Returns:

archiver uid

getPrivateKeyData

public byte[] getPrivateKeyData()
                         throws EBaseException

Retrieves key.

Returns:

archived key

Throws:

EBaseException

setPrivateKeyData

public void setPrivateKeyData(byte[] keydata)
                       throws EBaseException

Sets key data.

Throws:

EBaseException

getKeySize

public Integer getKeySize()
                   throws EBaseException

Retrieves the key size.

Returns:

key size

Throws:

EBaseException - failed to retrieve key size

getMetaInfo

public MetaInfo getMetaInfo()

Retrieves the meta info.

Returns:

meta info

setKeySize

public void setKeySize(Integer keySize)
                throws EBaseException

Sets key size.

Throws:

EBaseException

getOwnerName

public String getOwnerName()
                    throws EBaseException

Retrieves owner name.

Returns:

key owner name

Throws:

EBaseException - failed to retrieve key owner name

setOwnerName

public void setOwnerName(String name)
                  throws EBaseException

Sets owner name.

Throws:

EBaseException

getPublicKeyData

public byte[] getPublicKeyData()
                        throws EBaseException

Retrieves the public key.

Returns:

public key data

Throws:

EBaseException - failed to retrieve public key data

setPublicKeyData

public void setPublicKeyData(byte[] key)
                      throws EBaseException

Sets the public key.

Throws:

EBaseException

getDateOfRevocation

public Date[] getDateOfRevocation()
                           throws EBaseException

Retrieves the date(s) of revocation.

Returns:

revocation history

Throws:

EBaseException - failed to retrieve revocation history

setDateOfRevocation

public void setDateOfRevocation(Date[] dates)
                         throws EBaseException

Sets the date of revocation.

Throws:

EBaseException

getAlgorithm

public String getAlgorithm()

Retrieves algorithm of the key pair.

Returns:

key algorithm

getCreateTime

public Date getCreateTime()

Retrieves the creation time of this record.

Returns:

creation time

getModifyTime

public Date getModifyTime()

Retrieves the last modification time of this record.

Returns:

modification time

getClientId

public String getClientId()
                   throws EBaseException

Retrieves the client ID of this record.

Returns:

client id

Throws:

EBaseException - failed to retrieve client id

getKeyStatus

public String getKeyStatus()
                    throws EBaseException

Retrieves the key status of this record.

Returns:

key status

Throws:

EBaseException - failed to retrieve key status

getDataType

public String getDataType()
                   throws EBaseException

Retrieves the key data type of this record.

Returns:

data type

Throws:

EBaseException - failed to retrieve data type

getRealm

public String getRealm()
                throws EBaseException

Retrieves authorization realm.

Returns:

authorization realm

Throws:

EBaseException - failed to retrieve authorization realm

setWrappingParams

public void setWrappingParams(org.mozilla.jss.netscape.security.util.WrappingParams params,
 boolean doEncrypt)
                       throws Exception

Throws:

Exception

getWrappingParams

public org.mozilla.jss.netscape.security.util.WrappingParams getWrappingParams(org.mozilla.jss.netscape.security.util.WrappingParams oldParams)
                                                                        throws Exception

Throws:

Exception

isEncrypted

public Boolean isEncrypted()
                    throws EBaseException

Throws:

EBaseException