iaik.pkcs.pkcs11.objects

Class Storage

java.lang.Object

iaik.pkcs.pkcs11.objects.Object

iaik.pkcs.pkcs11.objects.Storage

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

Certificate, Data, DomainParameters, Key

public class Storage
extends Object

Objects of this class represent PKCS#11 objects of type storage as defined in PKCSC#11 2.11, but is compatible to version 2.01.

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	label_ The label of this object.
protected BooleanAttribute	modifiable_ True, if this object is modifiable.
protected BooleanAttribute	private_ True, if this is a private object.
protected BooleanAttribute	token_ True, if object is a token object (not a session object).

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

attributeTable_, objectClass_, objectClassNames_, objectHandle_, vendorObjectBuilder_

Constructor Summary

Constructors

Modifier	Constructor and Description
	Storage() The default constructor.
protected	Storage(Session session, long objectHandle) Constructor taking the reference to the PKCS#11 module for accessing the object's attributes, the session handle to use for reading the attribute values and the object handle.

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	getLabel() Get the label attribute of this object.
BooleanAttribute	getModifiable() Check, if this is a modifiable object.
BooleanAttribute	getPrivate() Check, if this is a private object.
BooleanAttribute	getToken() Check, if this is a token object.
int	hashCode() The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
boolean	isModifiable() Check whether this key's modifiable attribute is set to true.
boolean	isPrivate() Check whether this key's private attribute is set to true.
boolean	isToken() Check whether this key's token attribute is set to true.
protected static void	putAttributesInTable(Storage object) Put all attributes of the given object into the attributes table of this object.
char[]	readLabel() Read the value of the label attribute.
boolean	readModifiable() Read the value of the modifiable attribute.
boolean	readPrivate() Read the value of the private attribute.
boolean	readToken() Read the value of the token attribute.
Storage	setLabel(char[] label) Set the value of the label attribute.
Storage	setModifiable(boolean modifiable) Set the value of the modifiable attribute.
Storage	setPrivate(boolean privateObject) Set the value of the private attribute.
Storage	setToken(boolean token) Set the value of the token attribute.
java.lang.String	toString() This method returns a string representation of the current object.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

token_

protected BooleanAttribute token_

True, if object is a token object (not a session object).

private_

protected BooleanAttribute private_

True, if this is a private object.

modifiable_

protected BooleanAttribute modifiable_

True, if this object is modifiable.

label_

protected CharArrayAttribute label_

The label of this object.

Constructor Detail

Storage

public Storage()

The default constructor. An application use this constructor to instantiate an object that serves as a template. It may also be useful for working with vendor-defined objects.

Storage

protected Storage(Session session,
                  long objectHandle)
           throws TokenException

Constructor taking the reference to the PKCS#11 module for accessing the object's attributes, the session handle to use for reading the attribute values and the object handle. This constructor read all attributes that a storage object must contain.

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.

Method Detail

putAttributesInTable

protected static void putAttributesInTable(Storage 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.

allocateAttributes

protected void allocateAttributes()

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

Overrides:

allocateAttributes in class Object

clone

public java.lang.Object clone()

Create a (deep) clone of this object.

Overrides:

clone in class Object

Returns:

A clone of this object.

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 Object

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.

setToken

public Storage setToken(boolean token)

Set the value of the token attribute.

Parameters:

token - the token attribute value

Returns:

this object

getToken

public BooleanAttribute getToken()

Check, if this is a token object.

Returns:

Its value is true, if this is an token object.

readToken

public boolean readToken()

Read the value of the token attribute.

Returns:

the value of the token attribute

isToken

public boolean isToken()

Check whether this key's token attribute is set to true.

Returns:

true if the token attribute is set to true, false otherwise

setPrivate

public Storage setPrivate(boolean privateObject)

Set the value of the private attribute.

Parameters:

privateObject - the private attribute value

Returns:

this object

getPrivate

public BooleanAttribute getPrivate()

Check, if this is a private object.

Returns:

Its value is true, if this is a private object.

readPrivate

public boolean readPrivate()

Read the value of the private attribute.

Returns:

the value of the private attribute

isPrivate

public boolean isPrivate()

Check whether this key's private attribute is set to true.

Returns:

true if the private attribute is set to true, false otherwise

setModifiable

public Storage setModifiable(boolean modifiable)

Set the value of the modifiable attribute.

Parameters:

modifiable - the modifiable attribute value

Returns:

this object

getModifiable

public BooleanAttribute getModifiable()

Check, if this is a modifiable object.

Returns:

Its value is true, if this is a modifiable object.

readModifiable

public boolean readModifiable()

Read the value of the modifiable attribute.

Returns:

the value of the modifiable attribute

isModifiable

public boolean isModifiable()

Check whether this key's modifiable attribute is set to true.

Returns:

true if the modifiable attribute is set to true, false otherwise

setLabel

public Storage setLabel(char[] label)

Set the value of the label attribute.

Parameters:

label - the label attribute value

Returns:

this object

getLabel

public CharArrayAttribute getLabel()

Get the label attribute of this object.

Returns:

Contains the label as a char array.

readLabel

public char[] readLabel()

Read the value of the label attribute.

Returns:

the value of the label attribute

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 Object

Returns:

A string presentation of this object for debugging output.

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 Object

Returns:

The hash code of this object.