iaik.pkcs.pkcs11.objects

Class Data

java.lang.Object

iaik.pkcs.pkcs11.objects.Object

iaik.pkcs.pkcs11.objects.Storage

iaik.pkcs.pkcs11.objects.Data

All Implemented Interfaces:

java.lang.Cloneable

public class Data
extends Storage

Objects of this class represent a data object as specified by PKCS#11 v2.11.

Version:

1.0

Author:

Karl Scheibelhofer

Invariants:

(application_ != null) and (objectID_ != null) and (value_ != null)

Nested Class Summary

Nested classes/interfaces inherited from class iaik.pkcs.pkcs11.objects.Object

Object.ObjectClass, Object.VendorDefinedObjectBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected CharArrayAttribute	application_ The application description attribute of this data object.
protected ByteArrayAttribute	objectID_ The object ID attribute of this data object (DER-encoded).
protected ByteArrayAttribute	value_ The value attribute of this data object.

Fields inherited from class iaik.pkcs.pkcs11.objects.Storage

label_, modifiable_, private_, token_

Fields inherited from class iaik.pkcs.pkcs11.objects.Object

attributeTable_, objectClass_, objectClassNames_, objectHandle_, vendorObjectBuilder_

Constructor Summary

Constructors

Modifier	Constructor and Description
	Data() Default Constructor.
protected	Data(Session session, long objectHandle) Called by getInstance to create an instance of a PKCS#11 data object.

Method Summary

Modifier and Type	Method and Description
protected void	allocateAttributes() Allocates the attribute objects for this class and adds them to the attribute table.
java.lang.Object	clone() Create a (deep) clone of this object.
boolean	equals(java.lang.Object otherObject) Compares all member variables of this object with the other object.
CharArrayAttribute	getApplication() Gets the application attribute of this data object.
static Object	getInstance(Session session, long objectHandle) The getInstance method of the Object class uses this method to create an instance of a PKCS#11 data object.
ByteArrayAttribute	getObjectID() Gets the object ID attribute of this data object.
ByteArrayAttribute	getValue() Gets the value attribute of this data object.
int	hashCode() The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
protected static void	putAttributesInTable(Data object) Put all attributes of the given object into the attributes table of this object.
java.lang.String	toString() This method returns a string representation of the current object.

Methods inherited from class iaik.pkcs.pkcs11.objects.Storage

getLabel, getModifiable, getPrivate, getToken, putAttributesInTable

Methods inherited from class iaik.pkcs.pkcs11.objects.Object

checkAttributesState, checkAttributeState, getAttribute, getAttributeTable, getAttributeValue, getAttributeValues, getObjectClass, getObjectClassName, getObjectHandle, getSetAttributes, getSetAttributes, getUnknownObject, getVendorDefinedObjectBuilder, putAttribute, putAttributesInTable, readAttributes, removeAttribute, setObjectHandle, setVendorDefinedObjectBuilder, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

application_

protected CharArrayAttribute application_

The application description attribute of this data object.

objectID_

protected ByteArrayAttribute objectID_

The object ID attribute of this data object (DER-encoded).

value_

protected ByteArrayAttribute value_

The value attribute of this data object.

Constructor Detail

Data

public Data()

Default Constructor.

Data

protected Data(Session session,
               long objectHandle)
        throws TokenException

Called by getInstance to create an instance of a PKCS#11 data object.

Parameters:

session - The session to use for reading attributes. This session must have the appropriate rights; i.e. it must be a user-session, if it is a private object.

objectHandle - The object handle as given from the PKCS#111 module.

Throws:

TokenException - If getting the attributes failed.

Preconditions:

(session != null)

Method Detail

putAttributesInTable

protected static void putAttributesInTable(Data object)

Put all attributes of the given object into the attributes table of this object. This method is only static to be able to access invoke the implementation of this method for each class separately (see use in clone()).

Parameters:

object - The object to handle.

Preconditions:

(object != null)

allocateAttributes

protected void allocateAttributes()

Allocates the attribute objects for this class and adds them to the attribute table.

Overrides:

allocateAttributes in class Storage

getInstance

public static Object getInstance(Session session,
                                 long objectHandle)
                          throws TokenException

The getInstance method of the Object class uses this method to create an instance of a PKCS#11 data object.

Parameters:

session - The session to use for reading attributes. This session must have the appropriate rights; i.e. it must be a user-session, if it is a private object.

objectHandle - The object handle as given from the PKCS#111 module.

Returns:

The object representing the PKCS#11 object. The returned object can be casted to the according sub-class.

Throws:

TokenException - If getting the attributes failed.

Postconditions:

(result != null)

Preconditions:

(session != null)

clone

public java.lang.Object clone()

Create a (deep) clone of this object.

Overrides:

clone in class Storage

Returns:

A clone of this object.

Postconditions:

(result != null) and (result instanceof Data) and (result.equals(this))

equals

public boolean equals(java.lang.Object otherObject)

Compares all member variables of this object with the other object. Returns only true, if all are equal in both objects.

Overrides:

equals in class Storage

Parameters:

otherObject - The other object to compare to.

Returns:

True, if other is an instance of this class and all member variables of both objects are equal. False, otherwise.

getApplication

public CharArrayAttribute getApplication()

Gets the application attribute of this data object.

Returns:

The application attribute.

Postconditions:

(result != null)

getObjectID

public ByteArrayAttribute getObjectID()

Gets the object ID attribute of this data object.

Returns:

The object ID attribute.

Postconditions:

(result != null)

getValue

public ByteArrayAttribute getValue()

Gets the value attribute of this data object.

Returns:

The value attribute.

Postconditions:

(result != null)

hashCode

public int hashCode()

The overriding of this method should ensure that the objects of this class work correctly in a hashtable.

Overrides:

hashCode in class Storage

Returns:

The hash code of this object.

toString

public java.lang.String toString()

This method returns a string representation of the current object. The output is only for debugging purposes and should not be used for other purposes.

Overrides:

toString in class Storage

Returns:

A string presentation of this object for debugging output.

Postconditions:

(result != null)