iaik.pkcs.pkcs11.objects

Class MonotonicCounter

java.lang.Object

iaik.pkcs.pkcs11.objects.PKCS11Object

iaik.pkcs.pkcs11.objects.HardwareFeature

iaik.pkcs.pkcs11.objects.MonotonicCounter

public class MonotonicCounter
extends HardwareFeature

Objects of this class represent a monotonic counter as specified by PKCS#11 v2.11. Remind that this is a snapshot; this means that this object does not get the values from the token on demand it gets them upon instantiation.

Version:

1.0

Author:

Karl Scheibelhofer

Nested Class Summary

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

HardwareFeature.FeatureType, HardwareFeature.VendorDefinedHardwareFeatureBuilder

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

PKCS11Object.ObjectClass, PKCS11Object.VendorDefinedObjectBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected BooleanAttribute	hasReset True, if this counter has been reset at least once.
protected BooleanAttribute	resetOnInit True, if this counter is reset on token initialization.
protected ByteArrayAttribute	value The value attribute of this monotonic counter.

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

hardwareFeatureType, vendorHardwareFeatureBuilder

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

attributeTable, objectClass, objectClassNames, objectHandle, vendorObjectBuilder

Constructor Summary

Constructors

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

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.
boolean	equals(Object otherObject) Compares all member variables of this object with the other object.
BooleanAttribute	getHasReset() Gets the has-reset attribute of this monotonic counter object.
static PKCS11Object	getInstance(Session session, long objectHandle) The getInstance method of the HardwareFeature class uses this method to create an instance of a PKCS#11 monotonic counter.
ByteArrayAttribute	getValue() Gets the value attribute of this monotonic counter object.
int	hashCode() The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
BooleanAttribute	isResetOnInit() Gets the reset-on-init attribute of this monotonic counter object.
protected static void	putAttributesInTable(MonotonicCounter object) Put all attributes of the given object into the attributes table of this object.
void	readAttributes(Session session) Read the values of the attributes of this object from the token.
String	toString() Returns a string representation of the current object.

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

getHardwareFeatureType, getHardwareFeatureTypeName, getUnknownHardwareFeature, getVendorDefinedHardwareFeatureBuilder, putAttributesInTable, setVendorDefinedHardwareFeatureBuilder

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

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

Methods inherited from class java.lang.Object

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

Field Detail

resetOnInit

protected BooleanAttribute resetOnInit

True, if this counter is reset on token initialization.

hasReset

protected BooleanAttribute hasReset

True, if this counter has been reset at least once.

value

protected ByteArrayAttribute value

The value attribute of this monotonic counter.

Constructor Detail

MonotonicCounter

public MonotonicCounter()

Default Constructor.

MonotonicCounter

protected MonotonicCounter(Session session,
                           long objectHandle)
                    throws TokenException

Called by getInstance to create an instance of a PKCS#11 monotonic counter.

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

getInstance

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

The getInstance method of the HardwareFeature class uses this method to create an instance of a PKCS#11 monotonic counter.

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.

putAttributesInTable

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

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 HardwareFeature

equals

public boolean equals(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 HardwareFeature

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.

getHasReset

public BooleanAttribute getHasReset()

Gets the has-reset attribute of this monotonic counter object.

Returns:

The has-reset attribute.

isResetOnInit

public BooleanAttribute isResetOnInit()

Gets the reset-on-init attribute of this monotonic counter object.

Returns:

The reset-on-init attribute.

getValue

public ByteArrayAttribute getValue()

Gets the value attribute of this monotonic counter object.

Returns:

The value attribute.

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 HardwareFeature

Returns:

The hash code of this object.

readAttributes

public void readAttributes(Session session)
                    throws TokenException

Read the values of the attributes of this object from the token.

Overrides:

readAttributes in class PKCS11Object

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.

Throws:

TokenException - If getting the attributes failed.

toString

public String toString()

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 HardwareFeature

Returns:

A string presentation of this object for debugging output.