iaik.x509.attr.attributes

Class IetfAttrSyntax

java.lang.Object

iaik.asn1.structures.AttributeValue

iaik.x509.attr.attributes.IetfAttrSyntax

All Implemented Interfaces:

ASN1Type

Direct Known Subclasses:

ChargingIdentity, Group

public abstract class IetfAttrSyntax
extends AttributeValue

This class implements the IetfAttrSyntax type specified by the PKIX X.509 Attribute Certificate profile ( RFC 5755) to be used as base type for the Charging Identity and Group attribute types.

The ASN.1 definition for the IetfAttrSyntax type is as follows (see RFC 5755):

 IetfAttrSyntax ::= SEQUENCE {
   policyAuthority [0] GeneralNames    OPTIONAL,
   values          SEQUENCE OF CHOICE {
                  octets    OCTET STRING,
                  oid       OBJECT IDENTIFIER,
                  string    UTF8String
   }
 }
 

The policyAuthority field maybe set to separate between the AC issuer and the attribute policy authority. Although the values field is specified as SEQUENCE OF CHOICE of OCTET_STRING, ObjectID, or UTF8String types, only one of these types must be present. This means that in practice values only can be a SEQUENCE OF OCTET_STRING objects, a SEQUENCE OF ObjectID objects, or a SEQUENCE OF UTF8String objects.

See Also:

ChargingIdentity, Group, AttributeCertificate, Attribute, GeneralNames, OCTET_STRING, ObjectID, UTF8String

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IetfAttrSyntax(ASN1Object obj) Creates an IetfAttrSyntax from its ASN.1 representation.
protected	IetfAttrSyntax(boolean multipleValuesAllowed) Creates a new empty IetfAttrSyntax.
protected	IetfAttrSyntax(byte[][] values, boolean multipleValuesAllowed) Creates an IetfAttrSyntax for the given byte[] values array.
protected	IetfAttrSyntax(ObjectID[] values, boolean multipleValuesAllowed) Creates an IetfAttrSyntax for the given ObjectID values array.
protected	IetfAttrSyntax(java.lang.String[] values, boolean multipleValuesAllowed) Creates an IetfAttrSyntax for the given String values array.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsValue(java.lang.Object value) Checks whether the given value is included in this IetfAttrSyntax.
void	decode(ASN1Object obj) Decodes an IetfAttrSyntax from its ASN.1 representation.
ASN	getASN1TypeOfValues() Gets the ASN.1 type of the values contained in this IetfAttrSyntax.
GeneralNames	getPolicyAuthority() Gets the policyAuthority field of this IetfAttrSyntax.
java.util.Enumeration	getValues() Gets an enumeration with all values included in this IetfAttrSyntax.
int	numberOfValues() Gets the number of values included in this IetfAttrSyntax.
void	setPolicyAuthority(GeneralNames policyAuthority) Sets the policyAuthority field of this IetfAttrSyntax.
ASN1Object	toASN1Object() Returns this IetfAttrSyntax as ASN1Object.
java.lang.String	toString() Returns a String representation of this IetfAttrSyntax object.

Methods inherited from class iaik.asn1.structures.AttributeValue

getAttributeType, getName, multipleAllowed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IetfAttrSyntax

protected IetfAttrSyntax(boolean multipleValuesAllowed)

Creates a new empty IetfAttrSyntax.

Parameters:

multipleValuesAllowed - whether multiple values are allowed in the values field of this IetfAttrSyntax (default: true). This does only concern the values field of the IetfAttrSyntax, but not the SET OF AttributeValue of the general Attribute type. For instance, it maybe possible to have multiple IetfAttrSyntax elemnets in the SET OF AttributeValue, but each IetfAttrSyntax itself only must contain one single (OCTET_STRING, ObjectID or UTF8String) value

IetfAttrSyntax

protected IetfAttrSyntax(byte[][] values,
              boolean multipleValuesAllowed)
                  throws java.lang.IllegalArgumentException

Creates an IetfAttrSyntax for the given byte[] values array.
This constructor maybe used for creating an IetfAttrSyntax where the values field consists of OCTET_STRINGs only. The byte[] arrays supplied to this constructor represent the OCTET_STRING values.

Use method setPolicyAuthority for specifying an attribute policy authority, if required.

Parameters:

values - a number of byte arrays representing the OCTET_STRING values of this IetfAttrSyntax

multipleValuesAllowed - whether multiple values are allowed in the values field of this IetfAttrSyntax (default: true). This does only concern the values field of the IetfAttrSyntax, but not the SET OF AttributeValue of the general Attribute type. For instance, it maybe possible to have multiple IetfAttrSyntax elemnets in the SET OF AttributeValue, but each IetfAttrSyntax itself only must contain one single OCTET_STRING value

Throws:

java.lang.IllegalArgumentException - if this IetfAttrSyntax only allows one value but the given array contains more than one value

java.lang.NullPointerException - if values is null

IetfAttrSyntax

protected IetfAttrSyntax(java.lang.String[] values,
              boolean multipleValuesAllowed)
                  throws java.lang.IllegalArgumentException

Creates an IetfAttrSyntax for the given String values array.
This constructor maybe used for creating an IetfAttrSyntax where the values field consists of UTF8Strings only. The String array supplied to this constructor represent the UTF8String values.

Use method setPolicyAuthority for specifying an attribute policy authority, if required.

Parameters:

values - a String array representing the UTF8String values of this IetfAttrSyntax

multipleValuesAllowed - whether multiple values are allowed in the values field of this IetfAttrSyntax (default: true). This does only concern the values field of the IetfAttrSyntax, but not the SET OF AttributeValue of the general Attribute type. For instance, it maybe possible to have multiple IetfAttrSyntax elemnets in the SET OF AttributeValue, but each IetfAttrSyntax itself only must contain one single UTF8String value

Throws:

java.lang.IllegalArgumentException - if this IetfAttrSyntax only allows one value but the given array contains more than one value

java.lang.NullPointerException - if values is null

IetfAttrSyntax

protected IetfAttrSyntax(ObjectID[] values,
              boolean multipleValuesAllowed)
                  throws java.lang.IllegalArgumentException

Creates an IetfAttrSyntax for the given ObjectID values array.
This constructor maybe used for creating an IetfAttrSyntax where the values field consists of ObjectIDs only.

Use method setPolicyAuthority for specifying an attribute policy authority, if required.

Parameters:

values - an ObjectID array representing the ObjectID values of this IetfAttrSyntax

multipleValuesAllowed - whether multiple values are allowed in the values field of this IetfAttrSyntax (default: true). This does only concern the values field of the IetfAttrSyntax, but not the SET OF AttributeValue of the general Attribute type. For instance, it maybe possible to have multiple IetfAttrSyntax elemnets in the SET OF AttributeValue, but each IetfAttrSyntax itself only must contain one single ObjectID value

Throws:

java.lang.IllegalArgumentException - if this IetfAttrSyntax only allows one value but the given array contains more than one value

java.lang.NullPointerException - if values is null

IetfAttrSyntax

protected IetfAttrSyntax(ASN1Object obj)
                  throws CodingException

Creates an IetfAttrSyntax from its ASN.1 representation. This constructor parses the policyAuthority and values fields from the given ASN.1 object:

 IetfAttrSyntax ::= SEQUENCE {
   policyAuthority [0] GeneralNames    OPTIONAL,
   values          SEQUENCE OF CHOICE {
                  octets    OCTET STRING,
                  oid       OBJECT IDENTIFIER,
                  string    UTF8String
   }
 }
 

The policyAuthority field maybe set to separate between the AC issuer and the attribute policy authority. Although the values field is specified as SEQUENCE OF CHOICE of OCTET_STRING, ObjectID, or UTF8String types, only one of these types must be present. This means that in practice values only can be a SEQUENCE OF OCTET_STRING objects, a SEQUENCE OF ObjectID objects, or a SEQUENCE OF UTF8String objects.

Parameters:

obj - the IetfAttrSyntax as ASN1Object

Throws:

CodingException - if the ASN.1 object cannot be parsed or is invalid structured (e.g. if the values component does not contain only OCTET_STRING, ObjectID, or UTF8String objects

Method Detail

containsValue

public boolean containsValue(java.lang.Object value)

Checks whether the given value is included in this IetfAttrSyntax. Depending on the ASN.1 type of the values contained in this IetfAttrSyntax, the given value to be checked may either be a byte[] array (for OCTET_STRING), String (for UTF8String), or ObjectID object.

Parameters:

value - the value to be checked if being included

Returns:

true if the value is included, false if it is not included

getASN1TypeOfValues

public ASN getASN1TypeOfValues()

Gets the ASN.1 type of the values contained in this IetfAttrSyntax. All values must have the same ASN.1 type (either OCTET_STRING, ObjectID, or UTF8String)

Returns:

the ASN.1 type of the values contained in this IetfAttrSyntay, either OCTET_STRING, ObjectID, or UTF8String, or null if this IetfAttrSyntax does not contain any values

getValues

public java.util.Enumeration getValues()

Gets an enumeration with all values included in this IetfAttrSyntax. Depending on the ASN.1 type of the values, the array returned by this method may either contain byte[] array (for OCTET_STRING values), String (for UTF8String values), or ObjectID values.

Returns:

an enumeration with all values included in this IetfAttrSyntax; the enumeration may be empty if no values are included

numberOfValues

public int numberOfValues()

Gets the number of values included in this IetfAttrSyntax.

Returns:

how many values are included in this IetfAttrSyntax

getPolicyAuthority

public GeneralNames getPolicyAuthority()

Gets the policyAuthority field of this IetfAttrSyntax. The policyAuthority field maybe set to separate between the AC issuer and the attribute policy authority.

Returns:

the policy authority of this IetfAttrSyntax, or null if no policyAuthority is included

setPolicyAuthority

public void setPolicyAuthority(GeneralNames policyAuthority)

Sets the policyAuthority field of this IetfAttrSyntax. The policyAuthority field maybe set to separate between the AC issuer and the attribute policy authority.

Parameters:

policyAuthority - the policy authority to be set

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes an IetfAttrSyntax from its ASN.1 representation. This method parses the policyAuthority and values fields from the given ASN.1 object:

 IetfAttrSyntax ::= SEQUENCE {
   policyAuthority [0] GeneralNames    OPTIONAL,
   values          SEQUENCE OF CHOICE {
                  octets    OCTET STRING,
                  oid       OBJECT IDENTIFIER,
                  string    UTF8String
   }
 }
 

The policyAuthority field maybe set to separate between the AC issuer and the attribute policy authority. Although the values field is specified as SEQUENCE OF CHOICE of OCTET_STRING, ObjectID, or UTF8String types, only one of these types must be present. This means that in practice values only can be a SEQUENCE OF OCTET_STRING objects, a SEQUENCE OF ObjectID objects, or a SEQUENCE OF UTF8String objects.

Parameters:

obj - the IetfAttrSyntax as ASN1Object

Throws:

CodingException - if the ASN.1 object cannot be parsed or is invalid structured (e.g. if the values component does not contain only OCTET_STRING, ObjectID, or UTF8String objects

toASN1Object

public ASN1Object toASN1Object()
                        throws CodingException

Returns this IetfAttrSyntax as ASN1Object.
The ASN.1 definition for the IetfAttrSyntax type is as follows (see RFC 5755):

 IetfAttrSyntax ::= SEQUENCE {
   policyAuthority [0] GeneralNames    OPTIONAL,
   values          SEQUENCE OF CHOICE {
                  octets    OCTET STRING,
                  oid       OBJECT IDENTIFIER,
                  string    UTF8String
   }
 }
 

The policyAuthority field maybe set to separate between the AC issuer and the attribute policy authority. Although the values field is specified as SEQUENCE OF CHOICE of OCTET_STRING, ObjectID, or UTF8String types, only one of these types must be present. This means that in practice values only can be a SEQUENCE OF OCTET_STRING objects, a SEQUENCE OF ObjectID objects, or a SEQUENCE OF UTF8String objects.

Returns:

this IetfAttrSyntax as ASN1Object

Throws:

CodingException - if an error occurs when creating the ASN1Object

toString

public java.lang.String toString()

Returns a String representation of this IetfAttrSyntax object.

Specified by:

toString in class AttributeValue

Returns:

the String representation