com.objsys.asn1j.runtime

Class Asn1BerEncodeBuffer

java.lang.Object

com.objsys.asn1j.runtime.Asn1MessageBufferBase

com.objsys.asn1j.runtime.Asn1MessageBuffer

com.objsys.asn1j.runtime.Asn1EncodeBuffer

com.objsys.asn1j.runtime.Asn1EncodeByteBufferRev

com.objsys.asn1j.runtime.Asn1BerEncodeBuffer

Direct Known Subclasses:

Asn1DerEncodeBuffer

public class Asn1BerEncodeBuffer
extends Asn1EncodeByteBufferRev

This class handles the encoding of ASN.1 messages as specified in the Basic Encoding Rules (BER) as specified in the ITU-T X.690 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.Asn1EncodeByteBufferRev

mByteIndex, mData

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
Asn1BerEncodeBuffer() This constructor creates a BER encode buffer object with the default initial size.
Asn1BerEncodeBuffer(int size) This constructor creates a BER encode buffer object with the given initial size.

Method Summary

Modifier and Type	Method and Description
void	binDump()
void	binDump(java.io.PrintStream out, java.lang.String varName) This method dumps the encoded message in a human-readable format showing tags and contents to the given print output stream.
protected void	checkSize(int bytesRequired) This method determines if the encode buffer can hold the requested number of bytes.
int	encodeIdentifier(java.math.BigInteger ident) This method encodes an ASN.1 identifier value such as the ones used in a tags or object identifiers.
int	encodeIdentifier(int ident) This method encodes an ASN.1 identifier value such as the ones used in a tags or object identifiers.
int	encodeIntValue(long ivalue) This method encodes an ASN.1 integer value's contents according to the ASN.1 Basic Encoding Rules (BER)..
int	encodeLength(int len) This method encodes a length value.
int	encodeTag(Asn1Tag tag) This method encodes a tag value.
int	encodeTag(short tagClass, short tagForm, int tagIdent) This method encodes a tag value.
int	encodeTagAndLength(Asn1Tag tag, int len) This method encodes both a tag and length value.
int	encodeTagAndLength(short tagClass, short tagForm, int tagIDCode, int len) This overloaded version of encodeTagAndLength allows tag value components to be specified instead of an Asn1Tag object
boolean	isBER() This method is used for testing encode rules type.

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

copy, copy, copy, copy, getByteArrayInputStream, getMsgCopy, getMsgLength, initBuffer, reset, toString, write

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

binDump, encodeIntSigned, encodeIntUnsigned, getInputStream, getMinimalOctetsSigned, getMinimalOctetsUnsigned, getOutputStream, hexDump, 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

Constructor Detail

Asn1BerEncodeBuffer

public Asn1BerEncodeBuffer()

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

Asn1BerEncodeBuffer

public Asn1BerEncodeBuffer(int size)

This constructor creates a BER 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

checkSize

protected void checkSize(int bytesRequired)

Description copied from class: Asn1EncodeByteBufferRev

This method determines if the encode buffer can hold the requested number of bytes. If not, the buffer is expanded. This treats mByteIndex as unused and reflects the fact that we're writing into the buffer from right to left.

Overrides:

checkSize in class Asn1EncodeByteBufferRev

Parameters:

bytesRequired - Number of required bytes.

encodeIdentifier

public int encodeIdentifier(int ident)

This method encodes an ASN.1 identifier value such as the ones used in a tags or object identifiers.

Parameters:

ident - The identifier to be encoded.

Returns:

Length of the encoded component in octets.

encodeIdentifier

public int encodeIdentifier(java.math.BigInteger ident)

This method encodes an ASN.1 identifier value such as the ones used in a tags or object identifiers.

Parameters:

ident - The identifier to be encoded.

Returns:

Length of the encoded component in octets.

encodeIntValue

public int encodeIntValue(long ivalue)

This method encodes an ASN.1 integer value's contents according to the ASN.1 Basic Encoding Rules (BER)..

Parameters:

ivalue - Integer value to encode

Returns:

Length of encoded component

encodeLength

public int encodeLength(int len)

This method encodes a length value.

Parameters:

len - The length to be encoded.

Returns:

Length of encoded component

encodeTag

public int encodeTag(Asn1Tag tag)

This method encodes a tag value.

Parameters:

tag - The tag to be encoded.

Returns:

Length of component or negative status value

encodeTag

public int encodeTag(short tagClass,
                     short tagForm,
                     int tagIdent)

This method encodes a tag value.

Parameters:

tagClass - Tag class value (UNIV, APPL, CTXT, or PRIV)

tagForm - Tag form value (PRIM or CONS)

tagIdent - Tag identifer code

Returns:

Length of component or negative status value

encodeTagAndLength

public int encodeTagAndLength(Asn1Tag tag,
                              int len)

This method encodes both a tag and length value.

Parameters:

tag - The tag to be encoded.

len - The length to be encoded.

Returns:

Length of encoded component

encodeTagAndLength

public int encodeTagAndLength(short tagClass,
                              short tagForm,
                              int tagIDCode,
                              int len)

This overloaded version of encodeTagAndLength allows tag value components to be specified instead of an Asn1Tag object

Parameters:

tagClass - The class of the tag to be encoded.

tagForm - The form of the tag to be encoded.

tagIDCode - The ID code of the tag to be encoded.

len - The length to be encoded.

Returns:

status value (see Asn1Status.java)

binDump

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

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

Specified by:

binDump in class Asn1EncodeBuffer

Parameters:

out - stream to print to.

varName - Variable name to include in output.

binDump

public void binDump()

isBER

public boolean isBER()

This method is used for testing encode rules type.

Returns:

true