|
IAIK PKCS#11 Wrapper version 1.2.18 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--iaik.pkcs.pkcs11.objects.Object | +--iaik.pkcs.pkcs11.objects.HardwareFeature
This is the base class for hardware feature classes. Objects of this class represent hardware features as specified by PKCS#11 v2.20. A hardware feature is of a specific type: MONOTONIC_COUNTER, CLOCK, CKH_USER_INTERFAC or VENDOR_DEFINED. If an application needs to use vendor-defined hardware features, it must set a VendorDefinedHardwareFeatureBuilder using the setVendorDefinedHardwareFeatureBuilder method.
Inner Class Summary | |
static interface |
HardwareFeature.FeatureType
This interface defines the available hardware feature types as defined by PKCS#11 2.20: MONOTONIC_COUNTER, CLOCK, CKH_USER_INTERFAC or VENDOR_DEFINED. |
static interface |
HardwareFeature.VendorDefinedHardwareFeatureBuilder
If an application uses vendor defined hardware features, it must implement this interface and install such an object handler using setVendorDefinedHardwareFeatureBuilder. |
Inner classes inherited from class iaik.pkcs.pkcs11.objects.Object |
Object.ObjectClass, Object.VendorDefinedObjectBuilder |
Field Summary | |
protected HardwareFeatureTypeAttribute |
hardwareFeatureType_
The type of this hardware feature. |
protected static HardwareFeature.VendorDefinedHardwareFeatureBuilder |
vendorHardwareFeatureBuilder_
The currently set vendor defined hardware feature builder, or null. |
Fields inherited from class iaik.pkcs.pkcs11.objects.Object |
attributeTable_, objectClass_, objectClassNames_, objectHandle_, vendorObjectBuilder_ |
Constructor Summary | |
|
HardwareFeature()
The default constructor. |
protected |
HardwareFeature(Session session,
long objectHandle)
Called by getInstance to create an instance of a PKCS#11 hardware feature. |
Method Summary | |
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. |
LongAttribute |
getHardwareFeatureType()
Gets the hardware feature type attribute of the PKCS#11 key. |
static java.lang.String |
getHardwareFeatureTypeName(java.lang.Long hardwareFeatureType)
Get the given hardware feature type as string. |
static Object |
getInstance(Session session,
long objectHandle)
Called by sub-classes to create an instance of a PKCS#11 hardware feature. |
protected static Object |
getUnknownHardwareFeature(Session session,
long objectHandle)
Try to create a hardware feature which has no or an unkown harware feature type attribute. |
static HardwareFeature.VendorDefinedHardwareFeatureBuilder |
getVendorDefinedHardwareFeatureBuilder()
Get the currently set vendor-defined hardware feature builder. |
int |
hashCode()
The overriding of this method should ensure that the objects of this class work correctly in a hashtable. |
protected static void |
putAttributesInTable(HardwareFeature object)
Put all attributes of the given object into the attributes table of this object. |
static void |
setVendorDefinedHardwareFeatureBuilder(HardwareFeature.VendorDefinedHardwareFeatureBuilder builder)
Set a vendor-defined hardware feature builder that should be called to create an* instance of an vendor-defined PKCS#11 hardware feature; i.e. |
java.lang.String |
toString()
This method returns a string representation of the current object. |
Methods inherited from class iaik.pkcs.pkcs11.objects.Object |
getAttributeTable, getAttributeValue, getAttributeValues, getObjectClass, getObjectClassName, getObjectHandle, getSetAttributes, getSetAttributes, getUnknownObject, getVendorDefinedObjectBuilder, putAttributesInTable, readAttributes, setObjectHandle, setVendorDefinedObjectBuilder |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
protected static HardwareFeature.VendorDefinedHardwareFeatureBuilder vendorHardwareFeatureBuilder_
protected HardwareFeatureTypeAttribute hardwareFeatureType_
Constructor Detail |
public HardwareFeature()
protected HardwareFeature(Session session, long objectHandle) throws TokenException
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.TokenException
- If getting the attributes failed.Method Detail |
public static java.lang.String getHardwareFeatureTypeName(java.lang.Long hardwareFeatureType)
hardwareFeatureType
- The hardware feature type to get as string.public static Object getInstance(Session session, long objectHandle) throws TokenException
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.TokenException
- If getting the attributes failed.protected static Object getUnknownHardwareFeature(Session session, long objectHandle) throws TokenException
HardwareFeature
.session
- The session to use.objectHandle
- The handle of the objectTokenException
- If no object could be created.public static void setVendorDefinedHardwareFeatureBuilder(HardwareFeature.VendorDefinedHardwareFeatureBuilder builder)
builder
- The vendor-defined hardware feature builder. Null to clear
any previously installed vendor-defined builder.public static HardwareFeature.VendorDefinedHardwareFeatureBuilder getVendorDefinedHardwareFeatureBuilder()
protected static void putAttributesInTable(HardwareFeature object)
object
- The object to handle.protected void allocateAttributes()
allocateAttributes
in class Object
public java.lang.Object clone()
clone
in class Object
public boolean equals(java.lang.Object otherObject)
equals
in class Object
otherObject
- The other object to compare to.public LongAttribute getHardwareFeatureType()
public int hashCode()
hashCode
in class Object
public java.lang.String toString()
toString
in class Object
|
IAIK PKCS#11 Wrapper version 1.2.18 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |