org.nhindirect.policy.x509

Class SubjectAttributeField

java.lang.Object

org.nhindirect.policy.x509.AbstractX509Field<P>

org.nhindirect.policy.x509.AbstractTBSField<Collection<String>>

org.nhindirect.policy.x509.IssuerAttributeField

org.nhindirect.policy.x509.SubjectAttributeField

All Implemented Interfaces:

Serializable, LiteralPolicyExpression<Collection<String>>, PolicyExpression, ReferencePolicyExpression<X509Certificate,Collection<String>>, TBSField<Collection<String>>, X509Field<Collection<String>>

public class SubjectAttributeField
extends IssuerAttributeField

Subject field of TBS section of certificate

The policy value of this field is returned as a string containing the value of a specific attribute in the subject relative distinguished name (RDN).
If the requested attribute does not exist in the issue RDN, the policy value returned by this class evaluates to an empty string.

Since:

1.0

Author:

Greg Meyer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SubjectAttributeField(boolean required, RDNAttributeIdentifier rdnAttributeId) Constructor

Method Summary

Modifier and Type	Method and Description
TBSFieldName	getFieldName() Gets the TBS field name of the attribute extracted from the certificate.
void	injectReferenceValue(X509Certificate value) Injects the referenced value into the expressions.

Methods inherited from class org.nhindirect.policy.x509.IssuerAttributeField

getRDNAttributeFieldId

Methods inherited from class org.nhindirect.policy.x509.AbstractTBSField

getX509FieldType, toString

Methods inherited from class org.nhindirect.policy.x509.AbstractX509Field

getExpressionType, getPolicyExpressionReferenceType, getPolicyValue, isRequired, setRequired

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nhindirect.policy.x509.X509Field

isRequired, setRequired

Methods inherited from interface org.nhindirect.policy.ReferencePolicyExpression

getPolicyExpressionReferenceType

Methods inherited from interface org.nhindirect.policy.LiteralPolicyExpression

getPolicyValue

Methods inherited from interface org.nhindirect.policy.PolicyExpression

getExpressionType

Constructor Detail

SubjectAttributeField

public SubjectAttributeField(boolean required,
                             RDNAttributeIdentifier rdnAttributeId)

Constructor

Parameters:

required - Indicates if the field is required to be present in the certificate to be compliant with the policy.

rdnAttributeId - Id of the attribute to extract from the subject RDN

Method Detail

injectReferenceValue

public void injectReferenceValue(X509Certificate value)
                          throws PolicyProcessException

Injects the referenced value into the expressions. The relevant accessible attribute of the reference object can be retrieved by calling the LiteralPolicyExpression.getPolicyValue() method.

Specified by:

injectReferenceValue in interface ReferencePolicyExpression<X509Certificate,Collection<String>>

Overrides:

injectReferenceValue in class IssuerAttributeField

Parameters:

value - The reference value.

Throws:

PolicyProcessException - Thrown if the reference value cannot be successfully processed or the relevant accessible attribute cannot be retrieved from the value. For example, the X509 reference expressions may require an X509 attribute to be present in a certificate. If the required certificate attribute is not present, the this exception would be thrown.

getFieldName

public TBSFieldName getFieldName()

Gets the TBS field name of the attribute extracted from the certificate.

Specified by:

getFieldName in interface TBSField<Collection<String>>

Overrides:

getFieldName in class IssuerAttributeField

Returns:

The TBS field name of the attribute extracted from the certificate.