FileDocCategorySizeDatePackage
PolicyQualifierInfo.javaAPI DocJava SE 5 API5752Fri Aug 26 14:57:18 BST 2005java.security.cert

PolicyQualifierInfo

public class PolicyQualifierInfo extends Object
An immutable policy qualifier represented by the ASN.1 PolicyQualifierInfo structure.

The ASN.1 definition is as follows: 

PolicyQualifierInfo ::= SEQUENCE {
policyQualifierId PolicyQualifierId,
qualifier ANY DEFINED BY policyQualifierId }

A certificate policies extension, if present in an X.509 version 3 certificate, contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. In an end-entity certificate, these policy information terms indicate the policy under which the certificate has been issued and the purposes for which the certificate may be used. In a CA certificate, these policy information terms limit the set of policies for certification paths which include this certificate.

A Set of PolicyQualifierInfo objects are returned by the {@link PolicyNode#getPolicyQualifiers PolicyNode.getPolicyQualifiers} method. This allows applications with specific policy requirements to process and validate each policy qualifier. Applications that need to process policy qualifiers should explicitly set the policyQualifiersRejected flag to false (by calling the {@link PKIXParameters#setPolicyQualifiersRejected PKIXParameters.setPolicyQualifiersRejected} method) before validating a certification path.

Note that the PKIX certification path validation algorithm specifies that any policy qualifier in a certificate policies extension that is marked critical must be processed and validated. Otherwise the certification path must be rejected. If the policyQualifiersRejected flag is set to false, it is up to the application to validate all policy qualifiers in this manner in order to be PKIX compliant.

Concurrent Access

All PolicyQualifierInfo objects must be immutable and thread-safe. That is, multiple threads may concurrently invoke the methods defined in this class on a single PolicyQualifierInfo object (or more than one) with no ill effects. Requiring PolicyQualifierInfo objects to be immutable and thread-safe allows them to be passed around to various pieces of code without worrying about coordinating access.

author
seth proctor
author
Sean Mullan
version
1.11 12/19/03
since
1.4

Fields Summary
private byte[]
mEncoded
private String
mId
private byte[]
mData
private String
pqiString
Constructors Summary
public PolicyQualifierInfo(byte[] encoded)
Creates an instance of PolicyQualifierInfo from the encoded bytes. The encoded byte array is copied on construction.

param
encoded a byte array containing the qualifier in DER encoding
exception
IOException thrown if the byte array does not represent a valid and parsable policy qualifier

	mEncoded = (byte[]) encoded.clone();
		
	DerValue val = new DerValue(mEncoded);
	if (val.tag != DerValue.tag_Sequence)
	    throw new IOException("Invalid encoding for PolicyQualifierInfo");

	mId = (val.data.getDerValue()).getOID().toString();
	byte [] tmp = val.data.toByteArray();
	if (tmp == null) {
	    mData = null;
	} else {
	    mData = new byte[tmp.length];
	    System.arraycopy(tmp, 0, mData, 0, tmp.length);
	}
Methods Summary
public final byte[]getEncoded()
Returns the ASN.1 DER encoded form of this PolicyQualifierInfo.

return
the ASN.1 DER encoded bytes (never null). Note that a copy is returned, so the data is cloned each time this method is called.

	return (byte[]) mEncoded.clone();
public final byte[]getPolicyQualifier()
Returns the ASN.1 DER encoded form of the qualifier field of this PolicyQualifierInfo.

return
the ASN.1 DER encoded bytes of the qualifier field. Note that a copy is returned, so the data is cloned each time this method is called.

	return (mData == null ? null : (byte[]) mData.clone());
public final java.lang.StringgetPolicyQualifierId()
Returns the policyQualifierId field of this PolicyQualifierInfo. The policyQualifierId is an Object Identifier (OID) represented by a set of nonnegative integers separated by periods.

return
the OID (never null)

	return mId;
public java.lang.StringtoString()
Return a printable representation of this PolicyQualifierInfo.

return
a String describing the contents of this PolicyQualifierInfo

	if (pqiString != null)
	    return pqiString;
        HexDumpEncoder enc = new HexDumpEncoder();
        StringBuffer sb = new StringBuffer();
        sb.append("PolicyQualifierInfo: [\n");
        sb.append("  qualifierID: " + mId + "\n");
        sb.append("  qualifier: " + 
	    (mData == null ? "null" : enc.encodeBuffer(mData)) + "\n");
        sb.append("]");
	pqiString = sb.toString();
	return pqiString;