iaik.pkcs.pkcs11.objects

Class X509AttributeCertificate

java.lang.Object

iaik.pkcs.pkcs11.objects.Object

iaik.pkcs.pkcs11.objects.Storage

iaik.pkcs.pkcs11.objects.Certificate

iaik.pkcs.pkcs11.objects.X509AttributeCertificate

All Implemented Interfaces:

java.lang.Cloneable

public class X509AttributeCertificate
extends Certificate

Objects of this class represent X.509 attribute certificate as specified by PKCS#11 v2.11.

Version:

1.0

Author:

Karl Scheibelhofer

Invariants:

(owner_ != null) and (acIssuer_ != null) and (serialNumber_ != null) and (attrTypes_ != null) and (value_ != null)

Nested Class Summary

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

Certificate.CertificateType, Certificate.VendorDefinedCertificateBuilder

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 ByteArrayAttribute	acIssuer_ The owner attribute of this certificate.
protected ByteArrayAttribute	attrTypes_ The attribute types attribute of this certificate.
protected ByteArrayAttribute	owner_ The owner attribute of this certificate.
protected ByteArrayAttribute	serialNumber_ The serial number attribute of this certificate.
protected ByteArrayAttribute	value_ The value attribute of this certificate; i.e.

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

certificateCategory_, certificateType_, checkValue_, endDate_, startDate_, trusted_, vendorCertificateBuilder_

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
	X509AttributeCertificate() Default Constructor.
protected	X509AttributeCertificate(Session session, long objectHandle) Called by getInstance to create an instance of a PKCS#11 X.509 attribute certificate.

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.
ByteArrayAttribute	getAcIssuer() Gets the attribute certificate issuer attribute of this X.509 attribute certificate.
ByteArrayAttribute	getAttrTypes() Gets the attribute types attribute of this X.509 attribute certificate.
static Object	getInstance(Session session, long objectHandle) The getInstance method of the Certificate class uses this method to create an instance of a PKCS#11 X.509 attribute certificate.
ByteArrayAttribute	getOwner() Gets the owner attribute of this X.509 attribute certificate.
ByteArrayAttribute	getSerialNumber() Gets the serial number attribute of this X.509 attribute certificate.
ByteArrayAttribute	getValue() Gets the value attribute of this X.509 attribute certificate.
int	hashCode() The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
protected static void	putAttributesInTable(X509AttributeCertificate 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.Certificate

getCertificateCategory, getCertificateType, getCertificateTypeName, getCheckValue, getEndDate, getStartDate, getTrusted, getUnknownCertificate, getVendorDefinedCertificateBuilder, putAttributesInTable, setVendorDefinedCertificateBuilder

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

owner_

protected ByteArrayAttribute owner_

The owner attribute of this certificate.

acIssuer_

protected ByteArrayAttribute acIssuer_

The owner attribute of this certificate.

serialNumber_

protected ByteArrayAttribute serialNumber_

The serial number attribute of this certificate.

attrTypes_

protected ByteArrayAttribute attrTypes_

The attribute types attribute of this certificate.

value_

protected ByteArrayAttribute value_

The value attribute of this certificate; i.e. BER-encoded certificate.

Constructor Detail

X509AttributeCertificate

public X509AttributeCertificate()

Default Constructor.

X509AttributeCertificate

protected X509AttributeCertificate(Session session,
                                   long objectHandle)
                            throws TokenException

Called by getInstance to create an instance of a PKCS#11 X.509 attribute certificate.

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

getInstance

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

The getInstance method of the Certificate class uses this method to create an instance of a PKCS#11 X.509 attribute certificate.

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)

putAttributesInTable

protected static void putAttributesInTable(X509AttributeCertificate 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 Certificate

clone

public java.lang.Object clone()

Create a (deep) clone of this object.

Overrides:

clone in class Certificate

Returns:

A clone of this object.

Postconditions:

(result != null) and (result instanceof X509AttributeCertificate) 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 Certificate

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.

getOwner

public ByteArrayAttribute getOwner()

Gets the owner attribute of this X.509 attribute certificate.

Returns:

The owner attribute of this X.509 attribute certificate.

Postconditions:

(result != null)

getAcIssuer

public ByteArrayAttribute getAcIssuer()

Gets the attribute certificate issuer attribute of this X.509 attribute certificate.

Returns:

The attribute certificate issuer attribute of this X.509 attribute certificate.

Postconditions:

(result != null)

getSerialNumber

public ByteArrayAttribute getSerialNumber()

Gets the serial number attribute of this X.509 attribute certificate.

Returns:

The serial number attribute of this X.509 attribute certificate.

Postconditions:

(result != null)

getAttrTypes

public ByteArrayAttribute getAttrTypes()

Gets the attribute types attribute of this X.509 attribute certificate.

Returns:

The attribute types attribute of this X.509 attribute certificate.

Postconditions:

(result != null)

getValue

public ByteArrayAttribute getValue()

Gets the value attribute of this X.509 attribute certificate.

Returns:

The value attribute of this X.509 attribute certificate.

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 Certificate

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 Certificate

Returns:

A string presentation of this object for debugging output.

Postconditions:

(result != null)