com.objsys.asn1j.runtime

Class Asn1EncodeBuffer

java.lang.Object

com.objsys.asn1j.runtime.Asn1MessageBufferBase

com.objsys.asn1j.runtime.Asn1MessageBuffer

com.objsys.asn1j.runtime.Asn1EncodeBuffer

Direct Known Subclasses:

Asn1EncodeBitBuffer, Asn1EncodeByteBuffer, Asn1EncodeByteBufferRev

public abstract class Asn1EncodeBuffer
extends Asn1MessageBuffer

This is the base class to specific encode buffer classes for the different types of encoding rules (BER, DER and PER).

Field Summary

Fields

Modifier and Type	Field and Description
static int	INITIAL_SIZE This constant specifies the default initial size of the encode buffer.

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

context, mTypeCode

Constructor Summary

Constructors

Constructor and Description
Asn1EncodeBuffer()

Method Summary

Modifier and Type	Method and Description
abstract void	binDump(java.io.PrintStream out, java.lang.String varName) This method dumps the encoded message in a human-readable format showing a bit trace of all fields to the given print output stream.
void	binDump(java.lang.String varName) This method invokes an overloaded version of binDump to dump the encoded message to standard output.
abstract void	copy(byte value) This abstract method is used to copy a single byte to the encode buffer.
void	copy(byte[] value) This method copies multiple bytes to the encode buffer
abstract void	copy(byte[] value, int offset, int len) This method copies multiple bytes from the given array to the encode buffer.
static int	encodeIntSigned(long value, byte[] dest, int offset) Encode an integer value as a signed value (2's complement), in the minimum number of octets possible (>=1), into the given array.
static int	encodeIntUnsigned(long value, byte[] dest, int offset) Encode an integer value as an unsigned value (binary integer), in the minimum number of octets possible (>=1), into the given array.
abstract java.io.ByteArrayInputStream	getByteArrayInputStream() This method returns a reference to a byte array input stream representing the encoded message.
java.io.InputStream	getInputStream() This method returns an input stream representing the encoded message.
static int	getMinimalOctetsSigned(long value) Return the minimal number of octets required to represent the given value, when a signed representation is being used.
static int	getMinimalOctetsUnsigned(long value) Return the minimal number of octets required to represent the given value, when an unsigned representation is being used.
abstract byte[]	getMsgCopy() This method returns the encoded message in a byte array.
abstract int	getMsgLength() This method returns the length (in bytes) of the encoded message component.
java.io.OutputStream	getOutputStream() Return an output stream associated with this object.
void	hexDump() This method dumps the encoded message in hex/ascii format to the standard output stream.
void	hexDump(java.io.PrintStream out) This method dumps the encoded message in hex/ascii format to the given print output stream.
abstract void	reset() This method resets the buffer to allow a new record to be encoded into it.
abstract void	write(java.io.OutputStream out) This method writes the encoded record to the given output stream.

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, toString, wait, wait, wait

Field Detail

INITIAL_SIZE

public static final int INITIAL_SIZE

This constant specifies the default initial size of the encode buffer. It is currently set to 1024 bytes.

See Also:

Constant Field Values

Constructor Detail

Asn1EncodeBuffer

public Asn1EncodeBuffer()

Method Detail

binDump

public void binDump(java.lang.String varName)

This method invokes an overloaded version of binDump to dump the encoded message to standard output.

Parameters:

varName - Variable name to include in output.

binDump

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

This method dumps the encoded message in a human-readable format showing a bit trace of all fields to the given print output stream.

Parameters:

out - stream to print to.

varName - Variable name to include in output.

copy

public abstract void copy(byte value)

This abstract method is used to copy a single byte to the encode buffer.

Parameters:

value - The byte value to copy

copy

public void copy(byte[] value)
          throws Asn1Exception

This method copies multiple bytes to the encode buffer

Parameters:

value - Array of bytes to copy to the encode buffer

Throws:

Asn1Exception

copy

public abstract void copy(byte[] value,
                          int offset,
                          int len)
                   throws Asn1Exception

This method copies multiple bytes from the given array to the encode buffer.

Parameters:

value - The bytes to be encoded.

offset - The first byte copied is value[offset]

len - The last byte copied is value[offset + len - 1]

Throws:

Asn1Exception

encodeIntSigned

public static int encodeIntSigned(long value,
                                  byte[] dest,
                                  int offset)

Encode an integer value as a signed value (2's complement), in the minimum number of octets possible (>=1), into the given array.

Parameters:

value - The value to encode.

dest - The array to but the encoding into. It must be large enough to hold the result, taking into account the given offset.

offset - The index where the first byte should go.

Returns:

The number of bytes.

encodeIntUnsigned

public static int encodeIntUnsigned(long value,
                                    byte[] dest,
                                    int offset)

Encode an integer value as an unsigned value (binary integer), in the minimum number of octets possible (>=1), into the given array.

Parameters:

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

dest - The array to but the encoding into. It must be large enough to hold the result, taking into account the given offset.

offset - The index where the first byte should go.

Returns:

The number of bytes.

getByteArrayInputStream

public abstract java.io.ByteArrayInputStream getByteArrayInputStream()

This method returns a reference to a byte array input stream representing the encoded message. This is the preferred way to access the contents of the encoded message as it is the most efficient.

Returns:

byte array input stream containing encoded message

getInputStream

public final java.io.InputStream getInputStream()

This method returns an input stream representing the encoded message. This method is defined as abstract in the base class and must be implemented by all derived classes. In this case, a byte array input stream is returned.

Specified by:

getInputStream in class Asn1MessageBuffer

Returns:

Input stream containing encoded message

getOutputStream

public final java.io.OutputStream getOutputStream()

Return an output stream associated with this object. Anything written to the OutputStream will be written to this buffer using copy(byte) or copy(byte[]).

Returns:

The output sttream.

getMinimalOctetsSigned

public static int getMinimalOctetsSigned(long value)

Return the minimal number of octets required to represent the given value, when a signed representation is being used.

Parameters:

value - The value to determine the minimal octets for.

Returns:

The number of octets, <= 8.

getMinimalOctetsUnsigned

public static int getMinimalOctetsUnsigned(long value)

Return the minimal number of octets required to represent the given value, when an unsigned representation is being used.

Parameters:

value - Must be >=0

Returns:

The number of octets, <= 8.

getMsgCopy

public abstract byte[] getMsgCopy()

This method returns the encoded message in a byte array. This is less efficient than the getInputStream method because the message contents must be copied to a newly created byte array.

Returns:

byte array containing encoded message

getMsgLength

public abstract int getMsgLength()

This method returns the length (in bytes) of the encoded message component.

Returns:

length of encoded message component

hexDump

public void hexDump()

This method dumps the encoded message in hex/ascii format to the standard output stream.

hexDump

public void hexDump(java.io.PrintStream out)

This method dumps the encoded message in hex/ascii format to the given print output stream.

Parameters:

out - Output stream object reference

reset

public abstract void reset()

This method resets the buffer to allow a new record to be encoded into it. Any previously encoded data is lost.

write

public abstract void write(java.io.OutputStream out)
                    throws java.io.IOException

This method writes the encoded record to the given output stream.

Parameters:

out - Output stream to which record is to be written

Throws:

java.io.IOException - for any I/O error.