org.forgerock.opendj.io

Interface Asn1Reader

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractAsn1Reader

public interface Asn1Reader
extends Closeable

An interface for decoding ASN.1 elements from a data source.

Methods for creating Asn1Readers are provided in the Asn1 class.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this ASN.1 reader.
boolean	elementAvailable() Indicates whether the next element can be read without blocking.
boolean	hasNextElement() Indicates whether the current stream, sequence, or set contains another element.
int	peekLength() Returns the data length of the next element without actually reading it.
byte	peekType() Returns the type of the next element without actually reading it.
boolean	readBoolean() Reads the next element as a boolean having the Universal Boolean ASN.1 type tag.
boolean	readBoolean(byte type) Reads the next element as a boolean having the provided type tag.
void	readEndExplicitTag() Finishes reading an explicit tag and discards any unread elements.
void	readEndSequence() Finishes reading a sequence and discards any unread elements.
void	readEndSet() Finishes reading a set and discards any unread elements.
int	readEnumerated() Reads the next element as an enumerated having the Universal Enumerated ASN.1 type tag.
int	readEnumerated(byte type) Reads the next element as an enumerated having the provided type tag.
long	readInteger() Reads the next element as an integer having the Universal Integer ASN.1 type tag.
long	readInteger(byte type) Reads the next element as an integer having the provided type tag.
void	readNull() Reads the next element as a null element having the Universal Null ASN.1 type tag.
void	readNull(byte type) Reads the next element as a null element having the provided type tag.
ByteString	readOctetString() Reads the next element as an octet string having the Universal Octet String ASN.1 type tag.
ByteString	readOctetString(byte type) Reads the next element as an octet string having the provided type tag.
ByteStringBuilder	readOctetString(byte type, ByteStringBuilder builder) Reads the next element as an octet string having the provided type tag and appends it to the provided ByteStringBuilder.
ByteStringBuilder	readOctetString(ByteStringBuilder builder) Reads the next element as an octet string having the Universal Octet String ASN.1 type tag and appends it to the provided ByteStringBuilder.
String	readOctetStringAsString() Reads the next element as an octet string having the Universal Octet String ASN.1 type tag and decodes the value as a UTF-8 encoded string.
String	readOctetStringAsString(byte type) Reads the next element as an octet string having the provided type tag and decodes the value as a UTF-8 encoded string.
void	readStartExplicitTag() Reads the next element as an explicit ignoring the ASN.1 type tag.
void	readStartExplicitTag(byte type) Reads the next element as an explicit tag having the provided tag type.
void	readStartSequence() Reads the next element as a sequence having the Universal Sequence ASN.1 type tag.
void	readStartSequence(byte type) Reads the next element as a sequence having the provided type tag.
void	readStartSet() Reads the next element as a set having the Universal Set ASN.1 type tag.
void	readStartSet(byte type) Reads the next element as a set having the provided type tag.
Asn1Reader	skipElement() Skips the next element without decoding it.
Asn1Reader	skipElement(byte type) Skips the next element having the provided type tag without decoding it.

Method Detail

close

void close()
    throws IOException

Closes this ASN.1 reader.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - If an error occurs while closing.

elementAvailable

boolean elementAvailable()
                  throws IOException

Indicates whether the next element can be read without blocking.

Returns:

true if a complete element is available or false otherwise.

Throws:

DecodeException - If the available data was not valid ASN.1.

IOException - If an unexpected IO error occurred.

hasNextElement

boolean hasNextElement()
                throws IOException

Indicates whether the current stream, sequence, or set contains another element. Note that this method may return true even if a previous call to elementAvailable() returned false, indicating that the current set or sequence contains another element but an attempt to read that element may block. This method will block if there is not enough data available to make the determination (typically only the next element's type is required).

Returns:

true if the current stream, sequence, or set contains another element, or false if the end of the stream, sequence, or set has been reached.

Throws:

DecodeException - If the available data was not valid ASN.1.

IOException - If an unexpected IO error occurred.

peekLength

int peekLength()
        throws IOException

Returns the data length of the next element without actually reading it.

Returns:

The data length of the next element, or -1 if the end of the stream, sequence, or set has been reached.

Throws:

DecodeException - If the available data was not valid ASN.1.

IOException - If an unexpected IO error occurred.

peekType

byte peekType()
       throws IOException

Returns the type of the next element without actually reading it.

Returns:

The type of the next element, or -1 if the end of the stream, sequence, or set has been reached.

Throws:

DecodeException - If the available data was not valid ASN.1.

IOException - If an unexpected IO error occurred.

readBoolean

boolean readBoolean()
             throws IOException

Reads the next element as a boolean having the Universal Boolean ASN.1 type tag.

Returns:

The decoded boolean value.

Throws:

DecodeException - If the element cannot be decoded as a boolean.

IOException - If an unexpected IO error occurred.

readBoolean

boolean readBoolean(byte type)
             throws IOException

Reads the next element as a boolean having the provided type tag.

Parameters:

type - The expected type tag of the element.

Returns:

The decoded boolean value.

Throws:

DecodeException - If the element cannot be decoded as a boolean.

IOException - If an unexpected IO error occurred.

readEndSequence

void readEndSequence()
              throws IOException

Finishes reading a sequence and discards any unread elements.

Throws:

DecodeException - If an error occurs while advancing to the end of the sequence.

IOException - If an unexpected IO error occurred.

IllegalStateException - If there is no sequence being read.

readEndExplicitTag

void readEndExplicitTag()
                 throws IOException

Finishes reading an explicit tag and discards any unread elements.

Throws:

DecodeException - If an error occurs while advancing to the end of the explicit tag.

IOException - If an unexpected IO error occurred.

IllegalStateException - If there is no explicit tag being read.

readEndSet

void readEndSet()
         throws IOException

Finishes reading a set and discards any unread elements.

Throws:

DecodeException - If an error occurs while advancing to the end of the set.

IOException - If an unexpected IO error occurred.

IllegalStateException - If there is no set being read.

readEnumerated

int readEnumerated()
            throws IOException

Reads the next element as an enumerated having the Universal Enumerated ASN.1 type tag.

Returns:

The decoded enumerated value.

Throws:

DecodeException - If the element cannot be decoded as an enumerated value.

IOException - If an unexpected IO error occurred.

readEnumerated

int readEnumerated(byte type)
            throws IOException

Reads the next element as an enumerated having the provided type tag.

Parameters:

type - The expected type tag of the element.

Returns:

The decoded enumerated value.

Throws:

DecodeException - If the element cannot be decoded as an enumerated value.

IOException - If an unexpected IO error occurred.

readInteger

long readInteger()
          throws IOException

Reads the next element as an integer having the Universal Integer ASN.1 type tag.

Returns:

The decoded integer value.

Throws:

DecodeException - If the element cannot be decoded as an integer.

IOException - If an unexpected IO error occurred.

readInteger

long readInteger(byte type)
          throws IOException

Reads the next element as an integer having the provided type tag.

Parameters:

type - The expected type tag of the element.

Returns:

The decoded integer value.

Throws:

DecodeException - If the element cannot be decoded as an integer.

IOException - If an unexpected IO error occurred.

readNull

void readNull()
       throws IOException

Reads the next element as a null element having the Universal Null ASN.1 type tag.

Throws:

DecodeException - If the element cannot be decoded as a null element.

IOException - If an unexpected IO error occurred.

readNull

void readNull(byte type)
       throws IOException

Reads the next element as a null element having the provided type tag.

Parameters:

type - The expected type tag of the element.

Throws:

DecodeException - If the element cannot be decoded as a null element.

IOException - If an unexpected IO error occurred.

readOctetString

ByteString readOctetString()
                    throws IOException

Reads the next element as an octet string having the Universal Octet String ASN.1 type tag.

Returns:

The decoded octet string represented using a ByteString.

Throws:

DecodeException - If the element cannot be decoded as an octet string.

IOException - If an unexpected IO error occurred.

readOctetString

ByteString readOctetString(byte type)
                    throws IOException

Reads the next element as an octet string having the provided type tag.

Parameters:

type - The expected type tag of the element.

Returns:

The decoded octet string represented using a ByteString.

Throws:

DecodeException - If the element cannot be decoded as an octet string.

IOException - If an unexpected IO error occurred.

readOctetString

ByteStringBuilder readOctetString(byte type,
                                  ByteStringBuilder builder)
                           throws IOException

Reads the next element as an octet string having the provided type tag and appends it to the provided ByteStringBuilder.

Parameters:

type - The expected type tag of the element.

builder - The ByteStringBuilder to append the octet string to.

Returns:

A reference to builder.

Throws:

DecodeException - If the element cannot be decoded as an octet string.

IOException - If an unexpected IO error occurred.

readOctetString

ByteStringBuilder readOctetString(ByteStringBuilder builder)
                           throws IOException

Reads the next element as an octet string having the Universal Octet String ASN.1 type tag and appends it to the provided ByteStringBuilder.

Parameters:

builder - The ByteStringBuilder to append the octet string to.

Returns:

A reference to builder.

Throws:

DecodeException - If the element cannot be decoded as an octet string.

IOException - If an unexpected IO error occurred.

readOctetStringAsString

String readOctetStringAsString()
                        throws IOException

Reads the next element as an octet string having the Universal Octet String ASN.1 type tag and decodes the value as a UTF-8 encoded string.

Returns:

The decoded octet string as a UTF-8 encoded string.

Throws:

DecodeException - If the element cannot be decoded as an octet string.

IOException - If an unexpected IO error occurred.

readOctetStringAsString

String readOctetStringAsString(byte type)
                        throws IOException

Reads the next element as an octet string having the provided type tag and decodes the value as a UTF-8 encoded string.

Parameters:

type - The expected type tag of the element.

Returns:

The decoded octet string as a UTF-8 encoded string.

Throws:

DecodeException - If the element cannot be decoded as an octet string.

IOException - If an unexpected IO error occurred.

readStartSequence

void readStartSequence()
                throws IOException

Reads the next element as a sequence having the Universal Sequence ASN.1 type tag. All further reads will read the elements in the sequence until readEndSequence() is called.

Throws:

DecodeException - If the element cannot be decoded as a sequence.

IOException - If an unexpected IO error occurred.

readStartExplicitTag

void readStartExplicitTag()
                   throws IOException

Reads the next element as an explicit ignoring the ASN.1 type tag. All further reads will read the elements in the explicit tag until readEndExplicitTag() is called.

Throws:

DecodeException - If the element cannot be decoded as an explicit tag.

IOException - If an unexpected IO error occurred.

readStartExplicitTag

void readStartExplicitTag(byte type)
                   throws IOException

Reads the next element as an explicit tag having the provided tag type. All further reads will read the elements in the explicit tag until readEndExplicitTag() is called.

Parameters:

type - The expected type tag of the element.

Throws:

DecodeException - If the element cannot be decoded as an explicit tag.

IOException - If an unexpected IO error occurred.

readStartSequence

void readStartSequence(byte type)
                throws IOException

Reads the next element as a sequence having the provided type tag. All further reads will read the elements in the sequence until readEndSequence() is called.

Parameters:

type - The expected type tag of the element.

Throws:

DecodeException - If the element cannot be decoded as a sequence.

IOException - If an unexpected IO error occurred.

readStartSet

void readStartSet()
           throws IOException

Reads the next element as a set having the Universal Set ASN.1 type tag. All further reads will read the elements in the set until readEndSet() is called.

Throws:

DecodeException - If the element cannot be decoded as a set.

IOException - If an unexpected IO error occurred.

readStartSet

void readStartSet(byte type)
           throws IOException

Reads the next element as a set having the provided type tag. All further reads will read the elements in the set until readEndSet() is called.

Parameters:

type - The expected type tag of the element.

Throws:

DecodeException - If the element cannot be decoded as a set.

IOException - If an unexpected IO error occurred.

skipElement

Asn1Reader skipElement()
                throws IOException

Skips the next element without decoding it.

Returns:

A reference to this ASN.1 reader.

Throws:

DecodeException - If the next element could not be skipped.

IOException - If an unexpected IO error occurred.

skipElement

Asn1Reader skipElement(byte type)
                throws IOException

Skips the next element having the provided type tag without decoding it.

Parameters:

type - The expected type tag of the element.

Returns:

A reference to this ASN.1 reader.

Throws:

DecodeException - If the next element does not have the provided type tag.

IOException - If an unexpected IO error occurred.