com.entrust.toolkit.asn1.cmpv1

Class InfoTypeAndValue

java.lang.Object

com.entrust.toolkit.asn1.cmpv1.InfoTypeAndValue

All Implemented Interfaces:

ASN1Type

public class InfoTypeAndValue
extends java.lang.Object
implements ASN1Type

This class implements the ASN.1 structure for InfoTypeAndValue as defined in the CRMF specification.

 InfoTypeAndValue ::= SEQUENCE {
     infoType     OBJECT IDENTIFIER,
     infoValue    ANY DEFINED BY infoType    OPTIONAL
 }
 -- Example InfoTypeAndValue contents include, but are not limited to:
 --     { CAProtEncCert    = {id-it 1}, Certificate                     }
 --     { SignKeyPairTypes = {id-it 2}, SEQUENCE OF AlgorithmIdentifier }
 --     { EncKeyPairTypes  = {id-it 3}, SEQUENCE OF AlgorithmIdentifier }
 --     { PreferredSymmAlg = {id-it 4}, AlgorithmIdentifier             }
 --     { CAKeyUpdateInfo  = {id-it 5}, CAKeyUpdAnnContent              }
 --     { CurrentCRL       = {id-it 6}, CertificateList                 }
 -- where {id-it} = {id-pkix 4} = {1 3 6 1 5 5 7 4}
 -- This construct MAY also be used to define new PKIX Certificate
 -- Management Protocol request and response messages, or general-
 -- purpose (e.g., announcement) messages for future needs or for
 -- specific environments.
 

Since:

7.0

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectID	m_type An object identifier for the information.
protected ASN1Object	m_value The actual information value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InfoTypeAndValue() This is the default constructor.
	InfoTypeAndValue(ASN1Object obj) Creates a new InfoTypeAndValue object from an ASN1Object.
	InfoTypeAndValue(ObjectID type) Creates a new InfoTypeAndValue object with the specified component.
	InfoTypeAndValue(ObjectID type, ASN1Object value) Creates a new InfoTypeAndValue object with the specified components.

Method Summary

Methods

Modifier and Type	Method and Description
void	decode(ASN1Object obj) Decodes an InfoTypeAndValue structure from an ASN1Object.
ObjectID	getType() Returns the object identifier for the information.
ASN1Object	getValue() Returns the actual information value if it exists; otherwise null is returned.
protected void	setType(ObjectID type) Sets the information type.
void	setValue(ASN1Object value) Sets the information value.
ASN1Object	toASN1Object() Encodes this InfoTypeAndValue object as an ASN1Object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this InfoTypeAndValue object.

Methods inherited from class java.lang.Object

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

Field Detail

m_type

protected ObjectID m_type

An object identifier for the information.

m_value

protected ASN1Object m_value

The actual information value.

Constructor Detail

InfoTypeAndValue

protected InfoTypeAndValue()

This is the default constructor. It is required by InfoTypeAndValue sub-classes, and is not intended for any other use.

InfoTypeAndValue

public InfoTypeAndValue(ObjectID type)

Creates a new InfoTypeAndValue object with the specified component.

Parameters:

type - an object identifier for the information

InfoTypeAndValue

public InfoTypeAndValue(ObjectID type,
                ASN1Object value)

Creates a new InfoTypeAndValue object with the specified components.

Parameters:

type - an object identifier for the information

value - the actual value of the information

InfoTypeAndValue

public InfoTypeAndValue(ASN1Object obj)
                 throws CodingException

Creates a new InfoTypeAndValue object from an ASN1Object.

Parameters:

obj - the ASN.1 representation of an InfoTypeAndValue structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

Method Detail

getType

public ObjectID getType()

Returns the object identifier for the information.

Returns:

the type component

getValue

public ASN1Object getValue()

Returns the actual information value if it exists; otherwise null is returned.

Returns:

the value component

setType

protected void setType(ObjectID type)

Sets the information type.

The information type cannot be set to null.

Parameters:

type - the type component

setValue

public void setValue(ASN1Object value)

Sets the information value.

Parameters:

value - the value component

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes an InfoTypeAndValue structure from an ASN1Object.

Specified by:

decode in interface ASN1Type

Parameters:

obj - an ASN.1 representation of an InfoTypeAndValue structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

Encodes this InfoTypeAndValue object as an ASN1Object.

Specified by:

toASN1Object in interface ASN1Type

Returns:

an ASN.1 representation of this object

toString

public java.lang.String toString()

Creates a text representation of the ASN.1 structure of this InfoTypeAndValue object.

Overrides:

toString in class java.lang.Object

Returns:

a text representation of the ASN.1 structure of this object