javacard.security
Interface Key

All Known Subinterfaces:

AESKey, DESKey, DSAPrivateKey, DSAPublicKey, ECPrivateKey, ECPublicKey, PrivateKey, PublicKey, RSAPrivateCrtKey, RSAPrivateKey, RSAPublicKey, SecretKey

public interface Key

The Key interface is the base interface for all keys.

A Key object sets its initialized state to true only when all the associated Key object parameters have been set at least once since the time the initialized state was set to false.

A newly created Key object sets its initialized state to false. Invocation of the clearKey() method sets the initialized state to false. A key with transient key data sets its initialized state to false on the associated clear events.

See Also:

KeyBuilder

Method Summary

void	clearKey() Clears the key and sets its initialized state to false.
short	getSize() Returns the key size in number of bits.
byte	getType() Returns the key interface type.
boolean	isInitialized() Reports the initialized state of the key.

Method Detail

getType

public byte getType()

Returns the key interface type.

Returns:

the key interface type. Valid codes listed in TYPE.. constants See KeyBuilder.TYPE_DES_TRANSIENT_RESET

See Also:

KeyBuilder

clearKey

public void clearKey()

Clears the key and sets its initialized state to false.

isInitialized

public boolean isInitialized()

Reports the initialized state of the key. Keys must be initialized before being used.

A Key object sets its initialized state to true only when all the associated Key object parameters have been set at least once since the time the initialized state was set to false.

A newly created Key object sets its initialized state to false. Invocation of the clearKey() method sets the initialized state to false. A key with transient key data sets its initialized state to false on the associated clear events.

Returns:

true if the key has been initialized

getSize

public short getSize()

Returns the key size in number of bits.

Returns:

the key size in number of bits