davmail.ldap

Class BerEncoder

java.lang.Object

davmail.ldap.Ber

davmail.ldap.BerEncoder

public final class BerEncoder
extends Ber

A BER encoder.

Author:

Jagane Sundar, Scott Seligman, Vincent Ryan

Field Summary

Fields inherited from class davmail.ldap.Ber

ASN_APPLICATION, ASN_BIT_STRING, ASN_BOOLEAN, ASN_CONSTRUCTOR, ASN_CONTEXT, ASN_ENUMERATED, ASN_INTEGER, ASN_NULL, ASN_OBJECT_ID, ASN_OCTET_STR, ASN_PRIMITIVE, ASN_PRIVATE, ASN_SEQUENCE, ASN_SET, ASN_SIMPLE_STRING, ASN_UNIVERSAL, buf, bufsize, offset

Constructor Summary

Constructors

Constructor and Description
BerEncoder() Creates a BER buffer for encoding.
BerEncoder(int bufsize) Creates a BER buffer of a specified size for encoding.

Method Summary

Modifier and Type	Method and Description
void	beginSeq(int tag) Begin encoding a sequence with a tag.
void	encodeBoolean(boolean b) Encodes a boolean.
void	encodeBoolean(boolean b, int tag) Encodes a boolean and a tag
void	encodeByte(int b) Encode a single byte.
void	encodeInt(int i)
void	encodeInt(int i, int tag) Encodes an int and a tag.
void	encodeOctetString(byte[] tb, int tag) Encodes an octet string and a tag.
void	encodeOctetString(byte[] tb, int tag, int tboffset, int length) Encodes a portion of an octet string and a tag.
void	encodeString(String str, boolean encodeUTF8) Encodes a string.
void	encodeString(String str, int tag, boolean encodeUTF8) Encodes a string and a tag.
void	encodeStringArray(String[] strs, boolean encodeUTF8) Encodes an array of strings.
void	endSeq() Terminate a BER sequence.
byte[]	getBuf() Gets the buffer that contains the BER encoding.
int	getDataLen() Gets the number of encoded bytes in this BER buffer.
byte[]	getTrimmedBuf() Gets the buffer that contains the BER encoding, trimming unused bytes.
void	reset() Resets encoder to state when newly constructed.

Methods inherited from class davmail.ldap.Ber

dumpBER

Methods inherited from class java.lang.Object

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

Constructor Detail

BerEncoder

public BerEncoder()

Creates a BER buffer for encoding.

BerEncoder

public BerEncoder(int bufsize)

Creates a BER buffer of a specified size for encoding. Specify the initial bufsize. Buffer will be expanded as needed.

Parameters:

bufsize - The number of bytes for the buffer.

Method Detail

reset

public void reset()

Resets encoder to state when newly constructed. Zeros out internal data structures.

getDataLen

public int getDataLen()

Gets the number of encoded bytes in this BER buffer.

getBuf

public byte[] getBuf()

Gets the buffer that contains the BER encoding. Throws an exception if unmatched beginSeq() and endSeq() pairs were encountered. Not entire buffer contains encoded bytes. Use getDataLen() to determine number of encoded bytes. Use getBuffer(true) to get rid of excess bytes in array.

Throws:

IllegalStateException - If buffer contains unbalanced sequence.

getTrimmedBuf

public byte[] getTrimmedBuf()

Gets the buffer that contains the BER encoding, trimming unused bytes.

Throws:

IllegalStateException - If buffer contains unbalanced sequence.

beginSeq

public void beginSeq(int tag)

Begin encoding a sequence with a tag.

endSeq

public void endSeq()
            throws davmail.ldap.Ber.EncodeException

Terminate a BER sequence.

Throws:

davmail.ldap.Ber.EncodeException

encodeByte

public void encodeByte(int b)

Encode a single byte.

encodeInt

public void encodeInt(int i)

encodeInt

public void encodeInt(int i,
                      int tag)

Encodes an int and a tag.

 BER integer w tag ::= tag berlength byte {byte}*

encodeBoolean

public void encodeBoolean(boolean b)

Encodes a boolean.

 BER boolean ::= 0x01 0x01 {0xff|0x00}

encodeBoolean

public void encodeBoolean(boolean b,
                          int tag)

Encodes a boolean and a tag

 BER boolean w TAG ::= tag 0x01 {0xff|0x00}

encodeString

public void encodeString(String str,
                         boolean encodeUTF8)
                  throws davmail.ldap.Ber.EncodeException

Encodes a string.

 BER string ::= 0x04 strlen byte1 byte2...

The string is converted into bytes using UTF-8 or ISO-Latin-1.

Throws:

davmail.ldap.Ber.EncodeException

encodeString

public void encodeString(String str,
                         int tag,
                         boolean encodeUTF8)
                  throws davmail.ldap.Ber.EncodeException

Encodes a string and a tag.

 BER string w TAG ::= tag strlen byte1 byte2...

Throws:

davmail.ldap.Ber.EncodeException

encodeOctetString

public void encodeOctetString(byte[] tb,
                              int tag,
                              int tboffset,
                              int length)
                       throws davmail.ldap.Ber.EncodeException

Encodes a portion of an octet string and a tag.

Throws:

davmail.ldap.Ber.EncodeException

encodeOctetString

public void encodeOctetString(byte[] tb,
                              int tag)
                       throws davmail.ldap.Ber.EncodeException

Encodes an octet string and a tag.

Throws:

davmail.ldap.Ber.EncodeException

encodeStringArray

public void encodeStringArray(String[] strs,
                              boolean encodeUTF8)
                       throws davmail.ldap.Ber.EncodeException

Encodes an array of strings.

Throws:

davmail.ldap.Ber.EncodeException