oracle.security.crypto.cmp.attribute

Class RegistrationInfo

java.lang.Object

oracle.security.crypto.cert.AttributeTypeAndValue

oracle.security.crypto.cmp.attribute.RegistrationInfo

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

CertRequestRegInfo, UTF8PairsRegInfo

public class RegistrationInfo
extends AttributeTypeAndValue

CRMF base class for registration info structures.

The CRMF specification (RFC 2511) defines several registration info types and their OIDs (e.g., id-regInfo-asciiPairs) but, technically, any valid attributeTypeAndValue structure may be used. For ease of use, the classes representing the info types defined in CRMF provide methods for accessing their values that are tailored to their particular structures. For this reason, it is desirable that a registration info be cast-able to its subclass type after being input from, for example, a stream.

To facilitate this behavior, a static inputInstance(java.io.InputStream) method is provided in the RegistrationInfo base class. For defined/recognized infos, the method returns an instance of the appropriate RegistrationInfo subclass, which can then be cast to its real type. For all other valid AttributeTypeAndValue objects, an instance of the RegistrationInfo base class is returned, which can be manipulated using its AttributeTypeAndValue superclass methods.

See Also:

AttributeTypeAndValue, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	decoded This field is used for coordinating ASN.1 input with the superclass.
protected boolean	encoded This field is used for coordinating ASN.1 output with the superclass.

Constructor Summary

Constructors

Constructor and Description
RegistrationInfo(ASN1ObjectID type, ASN1Object value) Creates a new RegistrationInfo instance.

Method Summary

Modifier and Type	Method and Description
protected void	decodeValue() Decodes the superclass AttributeTypeAndValue's ASN1Object value to populate this control's fields.
protected void	encodeValue() Encodes this control's fields as an ASN1Object for the superclass AttributeTypeAndValue's value.
void	input(java.io.InputStream is) Initializes this object by reading its encoding from the given input stream.
static RegistrationInfo	inputInstance(java.io.InputStream is) Creates a new CRMF RegistrationInfo by reading its encoding from the given input stream.
int	length() Returns the length of this object's encoding.
void	output(java.io.OutputStream os) Writes this object's encoding to the specified output stream.
void	setValue(ASN1Object value) Sets the value.

Methods inherited from class oracle.security.crypto.cert.AttributeTypeAndValue

getType, getValue, readExternal, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

encoded

protected boolean encoded

This field is used for coordinating ASN.1 output with the superclass. If the subclass representation of the value has been modified, encoded must be set to false. When the new value has been communicated to the superclass, encoded must be set to true.

The initial value is false.

decoded

protected boolean decoded

This field is used for coordinating ASN.1 input with the superclass. If the superclass representation of the value has been modified, decoded must be set to false. When the new value has been communicated to the subclass, decoded must be set to true.

The initial value is true.

Constructor Detail

RegistrationInfo

public RegistrationInfo(ASN1ObjectID type,
                        ASN1Object value)

Creates a new RegistrationInfo instance.

Method Detail

setValue

public void setValue(ASN1Object value)

Description copied from class: AttributeTypeAndValue

Sets the value.

Overrides:

setValue in class AttributeTypeAndValue

encodeValue

protected void encodeValue()

Encodes this control's fields as an ASN1Object for the superclass AttributeTypeAndValue's value.

Subclasses must override this method to properly test and set the encoded field, and invoke the superclass setValue(ASN1Object) method to set the encoded structure.

decodeValue

protected void decodeValue()

Decodes the superclass AttributeTypeAndValue's ASN1Object value to populate this control's fields.

Subclasses must override this method to invoke the superclass AttributeTypeAndValue.getValue() method to get the structure to decode, and properly test and set the decoded field.

inputInstance

public static RegistrationInfo inputInstance(java.io.InputStream is)
                                      throws java.io.IOException

Creates a new CRMF RegistrationInfo by reading its encoding from the given input stream.

Parameters:

is - the input stream.

Throws:

java.io.IOException - if an I/O error occurs during input, or the encoding does not have the correct format.

input

public void input(java.io.InputStream is)
           throws java.io.IOException

Initializes this object by reading its encoding from the given input stream.

Overrides:

input in class AttributeTypeAndValue

Parameters:

is - the input stream.

Throws:

java.io.IOException - if an I/O error occurs during input, or the encoding does not have the correct format.

output

public void output(java.io.OutputStream os)
            throws java.io.IOException

Writes this object's encoding to the specified output stream.

Overrides:

output in class AttributeTypeAndValue

Parameters:

os - the output stream.

Throws:

java.io.IOException - if an I/O error occurs during output.

length

public int length()

Returns the length of this object's encoding.

Overrides:

length in class AttributeTypeAndValue

Returns:

the length of the encoding in bytes.