com.objsys.asn1j.runtime

Class Asn1OerEncodeBuffer

java.lang.Object

com.objsys.asn1j.runtime.Asn1MessageBufferBase

com.objsys.asn1j.runtime.Asn1MessageBuffer

com.objsys.asn1j.runtime.Asn1EncodeBuffer

com.objsys.asn1j.runtime.Asn1EncodeBitBuffer

com.objsys.asn1j.runtime.Asn1OerEncodeBuffer

All Implemented Interfaces:

Asn1BitMessageBuffer, Asn1Writable

public class Asn1OerEncodeBuffer
extends Asn1EncodeBitBuffer

This class handles the encoding of ASN.1 messages as specified in the Octet Encoding Rules (OER) as specified in the ITU-T X.696 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.Asn1EncodeBitBuffer

mByteIndex, mData, mTraceHandler

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

INITIAL_SIZE

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

context, mTypeCode

Constructor Summary

Constructors

Constructor and Description
Asn1OerEncodeBuffer() This constructor creates a OER encode buffer object with the default initial size.
Asn1OerEncodeBuffer(int size) This constructor creates a OER encode buffer object with the given initial size.

Method Summary

Modifier and Type	Method and Description
Asn1OerEncodeBuffer	beginSetOf() If canonical mode is on, return a new Asn1OerEncodeBuffer into which the repetitions of a SET OF can be encoded.
void	binDump(java.io.PrintStream out, java.lang.String varName) This method dumps the encoded message in a human-readable format to the given print output stream.
void	encodeIdentifier(int ident) Encode an identifier according to OER.
void	encodeIntSigned(long value) Encode an integer value as a variable length, signed integer, including encoding the length, according to OER.
void	encodeIntSigned(long value, int octets) Encode an integer value as a signed value (2's complement form), in the given number of octets.
void	encodeIntUnsigned(long value) Encode an integer value as a variable length, unsigned integer, including encoding the length, according to OER.
void	encodeIntUnsigned(long value, int octets) Encode an integer value as an unsigned value (binary integer) in the given number of octets.
void	encodeLength(long length) Encode an OER length determinant
void	encodeQuantity(int quantity) Encode an OER quantity (used for SEQUENCE-OF and SET-OF).
void	encodeTag(short tagClass, int tagNumber) Encode a tag according to OER.
Asn1OerEncodeBuffer	endSetOf() If canonical mode is on, encode each of the SET OF occurrences, in sorted order, to the original buffer, the one that created this buffer.
boolean	getCanonicalMode() Return true if canonical mode has been indicated by calling setCanonicalMode(true);
int	getIdentifierLength(int ident) Return the minimal number of octets required to encode the given identifier, where the identifier is encoded following the OER rules for encoding a tag number greater than 62, i.e. in a variable number of octets, with 7 bits of the value encoded in each octet and the first bit serving as a flag bit.
Asn1OerEncodeBuffer	newBuffer() Return a new OER encode buffer with the same canonical mode setting as this buffer.
void	setCanonicalMode(boolean value) Turn canonical mode on/off.
void	setOfRepDone() Invoke this method to signal to the buffer that another occurrence in a SET OF has been completely encoded into it.

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

byteAlign, checkSize, copy, copy, encodeBit, encodeBits, encodeBits, encodeBits, encodeLongBits, encodeLongBits, getBitOffsetInByte, getBuffer, getByteArrayInputStream, getByteIndex, getMsgBitCnt, getMsgByteCnt, getMsgCopy, getMsgLength, getTraceHandler, hexDump, isByteAligned, reset, reverseBytes, setMsgBitCnt, toString, write, write, write, write

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

binDump, copy, encodeIntSigned, encodeIntUnsigned, getInputStream, getMinimalOctetsSigned, getMinimalOctetsUnsigned, getOutputStream, hexDump

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

addNamedEventHandler, getEventHandlerListCount, hasEventHandlers, invokeCharacters, invokeEndElement, invokeStartElement, setEventHandlerList

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

getContext, hexDump, hexDump, setKey, setTypeCode

Methods inherited from class java.lang.Object

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

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

getInputStream

Constructor Detail

Asn1OerEncodeBuffer

public Asn1OerEncodeBuffer()

This constructor creates a OER encode buffer object with the default initial size. Whenever the buffer becomes full, it will be expanded.

Asn1OerEncodeBuffer

public Asn1OerEncodeBuffer(int size)

This constructor creates a OER encode buffer object with the given initial size. Whenever the buffer becomes full, it will be expanded. For best performance, this size should be large enough to prevent resizing in normal operation.

Parameters:

size - The initial size in bytes of an encode buffer.

Method Detail

binDump

public void binDump(java.io.PrintStream out,
                    java.lang.String varName)

This method dumps the encoded message in a human-readable format to the given print output stream.

Overrides:

binDump in class Asn1EncodeBitBuffer

Parameters:

out - stream to print to.

varName - Variable name to include in output.

beginSetOf

public Asn1OerEncodeBuffer beginSetOf()

If canonical mode is on, return a new Asn1OerEncodeBuffer into which the repetitions of a SET OF can be encoded. This should be paired with a later call to endSetOf (which see). If canonical mode is off, this simply returns this buffer. Example usage: buffer = buffer.beginSetOf(); //buffer is now new, temp buffer for each repetition encode repetition to buffer buffer.setOfOccurrenceDone(); buffer = buffer.endSetOf(); //buffer is original buffer again //and SET OF is encoded, sorted, into //it.

Returns:

endSetOf

public Asn1OerEncodeBuffer endSetOf()

If canonical mode is on, encode each of the SET OF occurrences, in sorted order, to the original buffer, the one that created this buffer. If canonical mode is off, this simply returns itself.

Returns:

In canonical mode, the original buffer, the one that was used to create this buffer by calling beginSetOf(). Otherwise, this.

setOfRepDone

public void setOfRepDone()

Invoke this method to signal to the buffer that another occurrence in a SET OF has been completely encoded into it. This has no effect if canonical mode is off.

encodeIntSigned

public final void encodeIntSigned(long value,
                                  int octets)

Encode an integer value as a signed value (2's complement form), in the given number of octets. The given value must be able to fit in the given number of octets.

Parameters:

value - The value to encode. It must fit in the given number of octets.

octets - The number of octets to encode in; 0 < octets <= 8

encodeIntUnsigned

public final void encodeIntUnsigned(long value,
                                    int octets)

Encode an integer value as an unsigned value (binary integer) in the given number of octets.

Parameters:

value - The value to encode. It must be non-negative and fit in the given number of octets.

octets - The number of octets to encode in; 0 < octets <= 8.

encodeIntSigned

public final void encodeIntSigned(long value)

Encode an integer value as a variable length, signed integer, including encoding the length, according to OER. This is used for integer values that have a lower bound less than -2^63, no lower bound, or a lower bound less than zero in combination with an upper bound greater than 2^63-1, or no upper bound. (In other words, it doesn't fit in a signed 64-bit integer.)

Parameters:

value - The value to encode.

encodeIntUnsigned

public final void encodeIntUnsigned(long value)

Encode an integer value as a variable length, unsigned integer, including encoding the length, according to OER. This is used for integer values that are constrained to be non-negative but which have no upper bound or an upper bound greater than 2^64 - 1.

Parameters:

value - The value to encode. It must be non-negative.

encodeLength

public final void encodeLength(long length)

Encode an OER length determinant

Parameters:

length -

encodeQuantity

public final void encodeQuantity(int quantity)

Encode an OER quantity (used for SEQUENCE-OF and SET-OF).

Parameters:

quantity -

getIdentifierLength

public final int getIdentifierLength(int ident)

Return the minimal number of octets required to encode the given identifier, where the identifier is encoded following the OER rules for encoding a tag number greater than 62, i.e. in a variable number of octets, with 7 bits of the value encoded in each octet and the first bit serving as a flag bit.

Parameters:

ident -

encodeIdentifier

public final void encodeIdentifier(int ident)

Encode an identifier according to OER. This is the encoding used for a tag number > 62, i.e. in a variable number of octets, with 7 bits of the value encoded in each octet and the first bit serving as a flag bit. It is also the encoding used for the subidentifiers in an OBJECT IDENTIFIER encoding.

Parameters:

ident - The tag number.

encodeTag

public final void encodeTag(short tagClass,
                            int tagNumber)

Encode a tag according to OER.

Parameters:

tagClass - The tag class. The highest 2 bits shall be set equal to the bits specified in the encoding rules for the tag's class. The remaining bits shall be zero. Asn1Tag.UNIV etc. fulfill this.

tagNumber - The tag number.

getCanonicalMode

public boolean getCanonicalMode()

Return true if canonical mode has been indicated by calling setCanonicalMode(true);

Returns:

newBuffer

public Asn1OerEncodeBuffer newBuffer()

Return a new OER encode buffer with the same canonical mode setting as this buffer.

Returns:

setCanonicalMode

public void setCanonicalMode(boolean value)

Turn canonical mode on/off. Turning canonical mode on acts as a signal to both generated code and runtime code that the user wants to encode according to the canonical OER rules.