oracle.security.crypto.cryptoki.crypto

Class CkiData

java.lang.Object

oracle.security.crypto.cryptoki.crypto.CkiData

public class CkiData
extends java.lang.Object

A class representing data on a PKCS #11 token.

Constructor Summary

Constructors

Constructor and Description
CkiData()
CkiData(CkiSession session, byte[] keyID) Creates a new CkiData object.
CkiData(CkiSession session, CkiObject ckiObject) Creates a new CkiData object.
CkiData(CkiSlot slot, byte[] keyID) Creates a new CkiData object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApplicationName() Gets the description of the application that manages this CkiData object from the token, or null if this field was not set on the token.
CkiObject	getCkiObject() Returns the CkiObject of this CkiData.
byte[]	getKeyID() Gets the keyID of this CkiData object.
java.lang.String	getLabel() Retrieves the label of this CkiData passed in parameter
ASN1ObjectID	getOID() Gets the Object Identifier indicating the type of this CkiData object from the token, or null if this field was not set on the token.
CkiSlot	getSlot() Gets the cki slot corresponding to this CkiData object.
byte[]	getValue() Gets the value of this CkiData object from the token, or null if this field was not set on the token.
void	setKeyID(byte[] keyID) Sets the keyID of this CkiData object.
void	setLabel(java.lang.String label) Sets the label of this CkiData passed in parameter
void	setSlot(CkiSlot slot) Sets the slot.
java.lang.String	toString() Returns a string representation of the CkiData object.

Methods inherited from class java.lang.Object

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

Constructor Detail

CkiData

public CkiData()

CkiData

public CkiData(CkiSlot slot,
               byte[] keyID)
        throws CryptokiException

Creates a new CkiData object.

Parameters:

slot - The ckislot where the data can be found.

keyID - The keyID of the data.

Throws:

CryptokiException

CkiData

public CkiData(CkiSession session,
               byte[] keyID)
        throws CryptokiException

Creates a new CkiData object.

Parameters:

session - The session to use to retrieve the data.

keyID - The keyID of the data.

Throws:

CryptokiException

CkiData

public CkiData(CkiSession session,
               CkiObject ckiObject)
        throws CryptokiException

Creates a new CkiData object.

Parameters:

session - The CkiSession object.

handle - The CkiObject pointing to the object on the token within the session.

Throws:

CryptokiException

Method Detail

getValue

public byte[] getValue()
                throws CryptokiException

Gets the value of this CkiData object from the token, or null if this field was not set on the token.

Throws:

CryptokiException

getOID

public ASN1ObjectID getOID()
                    throws CryptokiException

Gets the Object Identifier indicating the type of this CkiData object from the token, or null if this field was not set on the token.

Throws:

CryptokiException

getApplicationName

public java.lang.String getApplicationName()
                                    throws CryptokiException

Gets the description of the application that manages this CkiData object from the token, or null if this field was not set on the token.

Throws:

CryptokiException

getKeyID

public byte[] getKeyID()

Gets the keyID of this CkiData object.

Returns:

byte[] representing the keyID.

setKeyID

public void setKeyID(byte[] keyID)
              throws CryptokiException

Sets the keyID of this CkiData object.

Parameters:

keyID - The new key ID.

Throws:

CryptokiException

setLabel

public void setLabel(java.lang.String label)
              throws CryptokiException

Sets the label of this CkiData passed in parameter

Parameters:

label - The new label.

Throws:

CryptokiException

getLabel

public java.lang.String getLabel()
                          throws CryptokiException

Retrieves the label of this CkiData passed in parameter

Returns:

The keyID in a byte[]

Throws:

CryptokiException

setSlot

public void setSlot(CkiSlot slot)

Sets the slot.

getSlot

public CkiSlot getSlot()

Gets the cki slot corresponding to this CkiData object.

Returns:

CkiSlot representing the slot where the data is stored.

getCkiObject

public CkiObject getCkiObject()
                       throws CryptokiException

Returns the CkiObject of this CkiData.

Throws:

CryptokiException

toString

public java.lang.String toString()

Returns a string representation of the CkiData object.

Overrides:

toString in class java.lang.Object