com.ibm.crypto.pkcs11impl.provider
Interface PKCS11Key

All Superinterfaces:
java.security.Key, java.io.Serializable
All Known Subinterfaces:
GeneralPKCS11Key, PKCS11DESedeKey, PKCS11DESKey, PKCS11DSAPrivateKey, PKCS11DSAPublicKey, PKCS11PrivateKey, PKCS11PublicKey, PKCS11RSAPrivateKey, PKCS11RSAPublicKey, PKCS11SecretKey
All Known Implementing Classes:
DSAPrivateKey, DSAPublicKey, GeneralKey, RSAPrivateKey, RSAPublicKey

public interface PKCS11Key
extends java.security.Key

A PKCS11 key. This interface contains no methods or constants. It merely serves to group (and provide type safety for) all PKCS11 key interfaces.

See Also:
Key

Field Summary
static long serialVersionUID
           
 
Method Summary
 java.lang.Boolean getDerive()
          Returns true if key supports key derivation
 java.util.Date getEndDate()
          Returns the end date
 byte[] getID()
          Returns the ID
 java.lang.Integer getKeyType()
          Returns the key type
 java.lang.String getLabel()
          Returns label
 java.lang.Boolean getLocal()
          Returns true if key was either: 1, generated locally with a C_GenerateKey or C_GenerateKeyPair call 2, created with a C_CopyObject call as a copy of a key which had its CKA_LOCAL attrobute set to TRUE
 java.lang.Boolean getModifiable()
          Returns modifiable
 com.ibm.pkcs11.PKCS11Object getObject()
          Returns the key object
 java.lang.Boolean getPrivate()
          Returns private
 com.ibm.pkcs11.PKCS11Session getSession()
          Returns the session associated with the key
 java.util.Date getStartDate()
          Returns the start date
 java.lang.Boolean getToken()
          Returns token
 
Methods inherited from interface java.security.Key
getAlgorithm, getEncoded, getFormat
 

Field Detail

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values
Method Detail

getSession

com.ibm.pkcs11.PKCS11Session getSession()
Returns the session associated with the key

Returns:
the session associated with the key

getObject

com.ibm.pkcs11.PKCS11Object getObject()
Returns the key object

Returns:
the key object

getToken

java.lang.Boolean getToken()
Returns token

Returns:
true if object is a token object; false if object is a session object

getPrivate

java.lang.Boolean getPrivate()
Returns private

Returns:
true if object is a private object; false if object is a public object.

getLabel

java.lang.String getLabel()
Returns label

Returns:
the description of the object

getModifiable

java.lang.Boolean getModifiable()
Returns modifiable

Returns:
true if object can be modified; false otherwise

getKeyType

java.lang.Integer getKeyType()
Returns the key type

Returns:
the key type

getID

byte[] getID()
Returns the ID

Returns:
the ID

getStartDate

java.util.Date getStartDate()
Returns the start date

Returns:
the start date

getEndDate

java.util.Date getEndDate()
Returns the end date

Returns:
the end date

getDerive

java.lang.Boolean getDerive()
Returns true if key supports key derivation

Returns:
true if key supports key derivation; false otherwise

getLocal

java.lang.Boolean getLocal()
Returns true if key was either: 1, generated locally with a C_GenerateKey or C_GenerateKeyPair call 2, created with a C_CopyObject call as a copy of a key which had its CKA_LOCAL attrobute set to TRUE

Returns:
true if key was either generated locally or created as a copy of a key which had its CKA_local sttribute set to TRUE