com.objsys.asn1j.runtime

Class Asn1XerOutputStream

java.lang.Object

java.io.OutputStream

com.objsys.asn1j.runtime.Asn1OutputStream

com.objsys.asn1j.runtime.Asn1XerOutputStream

All Implemented Interfaces:

Asn1Writable, Asn1XerEncoder, Asn1XmlXerEncoder, java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class Asn1XerOutputStream
extends Asn1OutputStream
implements Asn1XerEncoder

This class implements the output stream to encode ASN.1 messages as specified in the XML Encoding Rules (XER) as specified in the ITU-T X.693 standard. A reference to an object of this type is passed to each of the ASN.1 type encode methods involved in encoding a particular message type.

Field Summary

Fields inherited from class com.objsys.asn1j.runtime.Asn1OutputStream

os

Fields inherited from interface com.objsys.asn1j.runtime.Asn1XerEncoder

XERDATA, XEREND, XERINDENT, XERINIT, XERSTART

Constructor Summary

Constructors

Constructor and Description
Asn1XerOutputStream(java.io.OutputStream os) This constructor creates a buffered XER output stream object with default size of buffer.
Asn1XerOutputStream(java.io.OutputStream os, boolean canonical, int bufSize) This constructor creates a buffered XER output stream object.

Method Summary

Modifier and Type	Method and Description
void	copy(byte value) This method is used to copy a single byte to the output stream.
void	copy(byte[] value) This method copies multiple bytes to the output stream.
void	copy(byte[] value, int off, int len) This method copies multiple bytes to the output stream.
void	copy(java.lang.String value) This method copies a character string to the output stream.
void	decrLevel() This method decrements the element nesting level counter.
void	encodeBinStrValue(byte[] bits, int nbits) This method encodes XML binary string data
void	encodeByte(byte value) This method is used to encode a single byte to the output stream.
void	encodeData(java.lang.String value) This method encodes XML string data
void	encodeEmptyElement(java.lang.String elemName) This method encodes an XML empty element tag.
void	encodeEndDocument() This method encodes standard trailor information at the end of the XML document.
void	encodeEndElement(java.lang.String elemName) This method encodes an XML end element tag.
void	encodeHexStrValue(byte[] data) This method encodes XML hexadecimal string data
void	encodeNamedValue(java.lang.String valueName, java.lang.String elemName) This method encodes an XML named value (with start and end tags).
void	encodeNamedValueElement(java.lang.String elemName) This method encodes an XML named value element tag.
void	encodeRealValue(double value, java.lang.String elemName) This method encodes an XML REAL (double) value (with start and end tags).
void	encodeStartDocument() This method encodes standard header information at the beginning of the XML document.
void	encodeStartElement(java.lang.String elemName) This method encodes an XML start element tag.
int	getState() This method gets the state of the buffer.
void	incrLevel() This method increments the element nesting level counter.
void	indent() This methods indents by adding a new-line followed by whitespace corresponding to the current nesting level to the output stream.
boolean	isCanonical() Return true if the encoder has been put into canonical mode.
void	setCanonical(boolean value) This method sets the canonical encoding flag to the given value.
void	setState(int stat) This method sets the state of the buffer.
void	write(java.lang.String value) This method copies a character string to the output stream.

Methods inherited from class com.objsys.asn1j.runtime.Asn1OutputStream

close, flush, getContext, write, write, write, write2Bytes, write4Bytes

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.objsys.asn1j.runtime.Asn1XmlXerEncoder

getContext

Constructor Detail

Asn1XerOutputStream

public Asn1XerOutputStream(java.io.OutputStream os)

This constructor creates a buffered XER output stream object with default size of buffer. Whenever the buffer becomes full, the buffer will be flushed to the stream.

Parameters:

os - The underlying OutputStream object.

Asn1XerOutputStream

public Asn1XerOutputStream(java.io.OutputStream os,
                           boolean canonical,
                           int bufSize)

This constructor creates a buffered XER output stream object. Whenever the buffer becomes full, the buffer will be flushed to the stream.

Parameters:

os - The underlying OutputStream object.

canonical - Boolean indicating a canonical or non-canonical encoding should be produced as defined in the X.693 standard.

bufSize - The buffer size. If it is 0 then the output stream is used as unbuffered.

Method Detail

copy

public void copy(byte value)
          throws java.io.IOException

This method is used to copy a single byte to the output stream. It first converts the byte to a hex character representation and then copies it to the output buffer.

Specified by:

copy in interface Asn1XmlXerEncoder

Parameters:

value - The byte value to copy

Throws:

java.io.IOException - Any exception thrown by the underlying OutputStream.

copy

public void copy(byte[] value)
          throws java.io.IOException,
                 Asn1Exception

This method copies multiple bytes to the output stream. It is assumed the byte are already formatted into a valid XML encoding type (for example, UTF-8).

Specified by:

copy in interface Asn1XmlXerEncoder

Parameters:

value - Array of bytes to copy to the output stream

Throws:

java.io.IOException - Any exception thrown by the underlying OutputStream.

Asn1Exception - Thrown, if operation is failed.

copy

public void copy(byte[] value,
                 int off,
                 int len)
          throws java.io.IOException,
                 Asn1Exception

This method copies multiple bytes to the output stream. It is assumed the byte are already formatted into a valid XML encoding type (for example, UTF-8).

Specified by:

copy in interface Asn1XmlXerEncoder

Parameters:

value - Array of bytes to copy to the output stream

off - Starting offset in array

len - The length to be encoded

Throws:

java.io.IOException - Any exception thrown by the underlying OutputStream.

Asn1Exception - Thrown, if operation is failed.

copy

public void copy(java.lang.String value)
          throws java.io.IOException,
                 Asn1Exception

This method copies a character string to the output stream.

Specified by:

copy in interface Asn1XmlXerEncoder

Parameters:

value - The string value to copy

Throws:

java.io.IOException - Any exception thrown by the underlying OutputStream.

Asn1Exception - Thrown, if operation is failed.

write

public void write(java.lang.String value)
           throws java.io.IOException,
                  Asn1Exception

This method copies a character string to the output stream.

Parameters:

value - The string value to copy

Throws:

java.io.IOException - Any exception thrown by the underlying OutputStream.

Asn1Exception - Thrown, if operation is failed.

decrLevel

public void decrLevel()

This method decrements the element nesting level counter.

Specified by:

decrLevel in interface Asn1XmlXerEncoder

encodeByte

public void encodeByte(byte value)
                throws java.io.IOException

This method is used to encode a single byte to the output stream. It first converts the byte to a hex character representation and then copies it to the output buffer.

Parameters:

value - The byte value to copy

Throws:

java.io.IOException - Any exception thrown by the underlying OutputStream.

encodeData

public void encodeData(java.lang.String value)
                throws java.io.IOException,
                       Asn1Exception

This method encodes XML string data

Specified by:

encodeData in interface Asn1XmlXerEncoder

Parameters:

value - String value to encode

Throws:

java.io.IOException - Any exception thrown by the underlying OutputStream.

Asn1Exception - Thrown, if operation is failed.

encodeBinStrValue

public void encodeBinStrValue(byte[] bits,
                              int nbits)
                       throws java.io.IOException,
                              Asn1Exception

This method encodes XML binary string data

Specified by:

encodeBinStrValue in interface Asn1XmlXerEncoder

Parameters:

bits - Bit string to encode

Throws:

java.io.IOException - Any exception thrown by the underlying OutputStream.

Asn1Exception - Thrown, if operation is failed.

encodeHexStrValue

public void encodeHexStrValue(byte[] data)
                       throws java.io.IOException,
                              Asn1Exception

This method encodes XML hexadecimal string data

Specified by:

encodeHexStrValue in interface Asn1XmlXerEncoder

Parameters:

data - Data to encode

Throws:

java.io.IOException - Any exception thrown by the underlying OutputStream.

Asn1Exception - Thrown, if operation is failed.

encodeEndDocument

public void encodeEndDocument()
                       throws java.io.IOException,
                              Asn1Exception

This method encodes standard trailor information at the end of the XML document.

Specified by:

encodeEndDocument in interface Asn1XmlXerEncoder

Throws:

java.io.IOException - Any exception thrown by the underlying OutputStream.

Asn1Exception - Thrown, if operation is failed.

encodeEndElement

public void encodeEndElement(java.lang.String elemName)
                      throws java.io.IOException,
                             Asn1Exception

This method encodes an XML end element tag.

Specified by:

encodeEndElement in interface Asn1XerEncoder

Parameters:

elemName - The name of element.

Throws:

java.io.IOException - If I/O error occurs.

Asn1Exception - Thrown, if operation is failed.

encodeStartDocument

public void encodeStartDocument()
                         throws java.io.IOException,
                                Asn1Exception

This method encodes standard header information at the beginning of the XML document.

Specified by:

encodeStartDocument in interface Asn1XmlXerEncoder

Throws:

java.io.IOException - If I/O error occurs.

Asn1Exception - Thrown, if operation is failed.

encodeStartElement

public void encodeStartElement(java.lang.String elemName)
                        throws java.io.IOException,
                               Asn1Exception

This method encodes an XML start element tag.

Specified by:

encodeStartElement in interface Asn1XerEncoder

Parameters:

elemName - The name of element.

Throws:

java.io.IOException - If I/O error occurs.

Asn1Exception - Thrown, if operation is failed.

encodeEmptyElement

public void encodeEmptyElement(java.lang.String elemName)
                        throws java.io.IOException,
                               Asn1Exception

This method encodes an XML empty element tag.

Specified by:

encodeEmptyElement in interface Asn1XerEncoder

Parameters:

elemName - The name of element.

Throws:

java.io.IOException - If I/O error occurs.

Asn1Exception - Thrown, if operation is failed.

encodeNamedValueElement

public void encodeNamedValueElement(java.lang.String elemName)
                             throws java.io.IOException,
                                    Asn1Exception

This method encodes an XML named value element tag.

Specified by:

encodeNamedValueElement in interface Asn1XmlXerEncoder

Parameters:

elemName - The name of element.

Throws:

java.io.IOException - If I/O error occurs.

Asn1Exception - Thrown, if operation is failed.

encodeNamedValue

public void encodeNamedValue(java.lang.String valueName,
                             java.lang.String elemName)
                      throws java.io.IOException,
                             Asn1Exception

This method encodes an XML named value (with start and end tags).

Specified by:

encodeNamedValue in interface Asn1XerEncoder

Parameters:

valueName - The name of value.

elemName - The name of element.

Throws:

java.io.IOException - If I/O error occurs.

Asn1Exception - Thrown, if operation is failed.

encodeRealValue

public void encodeRealValue(double value,
                            java.lang.String elemName)
                     throws java.io.IOException,
                            Asn1Exception

This method encodes an XML REAL (double) value (with start and end tags).

Specified by:

encodeRealValue in interface Asn1XerEncoder

Parameters:

value - The value to be encoded.

elemName - The name of element. If null, then start and end tags won't be encoded.

Throws:

java.io.IOException - If I/O error occurs.

Asn1Exception - Thrown, if operation is failed.

getState

public int getState()

This method gets the state of the buffer.

Specified by:

getState in interface Asn1XerEncoder

Returns:

Buffer Stat

incrLevel

public void incrLevel()

This method increments the element nesting level counter.

Specified by:

incrLevel in interface Asn1XmlXerEncoder

indent

public void indent()
            throws java.io.IOException,
                   Asn1Exception

This methods indents by adding a new-line followed by whitespace corresponding to the current nesting level to the output stream.

Specified by:

indent in interface Asn1XmlXerEncoder

Throws:

java.io.IOException - Any exception thrown by the underlying OutputStream.

Asn1Exception - Thrown, if operation is failed.

isCanonical

public boolean isCanonical()

Description copied from interface: Asn1XmlXerEncoder

Return true if the encoder has been put into canonical mode. For XER, canonical mode turns off extra whitespace output. For XML and XER, canonical mode signals the generated encoders to always encode ASN.1 elements that have a DEFAULT value.

Specified by:

isCanonical in interface Asn1XmlXerEncoder

See Also:

Asn1XmlXerEncoder

setCanonical

public void setCanonical(boolean value)

This method sets the canonical encoding flag to the given value.

Parameters:

value - Canonical encoding flag.

setState

public void setState(int stat)

This method sets the state of the buffer.

Specified by:

setState in interface Asn1XerEncoder

Parameters:

stat - Buffer Stat