netscape.ldap.ber.stream
Class BERElement

java.lang.Object
  netscape.ldap.ber.stream.BERElement

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BERAny, BERBitString, BERBoolean, BERCharacterString, BERChoice, BERConstruct, BERIntegral, BERNull, BERObjectId, BEROctetString, BERReal, BERTag, BERUTCTime

public abstract class BERElement

extends Object

implements Serializable

This class is for the tagged object type. A nested tag is allowed. A tagged element contains another BER element.

See Also:

Serialized Form

Field Summary

static int	ANY
static int	APPLICATION
static int	BITSTRING
static int	BOOLEAN Possible element types.
static int	CHOICE
static int	CONSTRUCTED
static int	CONTEXT
static int	ENUMERATED
static int	EOC Possible tags.
static int	EXOP_REQ_OID
static int	EXOP_REQ_VALUE
static int	EXOP_RES_OID
static int	EXOP_RES_VALUE
static int	GENERALSTRING
static int	GRAPHICSTRING
static int	IA5STRING
static int	INTEGER
static int	MRA_DNATTRS
static int	MRA_OID
static int	MRA_TYPE
static int	MRA_VALUE
static int	NULL
static int	NUMERICSTRING
static int	OBJECTID
static int	OCTETSTRING
static int	PRIMITIVE
static int	PRINTABLESTRING
static int	PRIVATE
static int	REAL
static int	SASLCONTEXT
static int	SEQUENCE
static int	SET
static int	SK_MATCHRULE
static int	SK_REVERSE
static int	SR_ATTRTYPE
static int	TAG Internal (non-transmitted) tags.
static int	TELETEXSTRING
static int	UNIVERSAL
static int	UTCTIME
static int	VIDEOTEXSTRING
static int	VISIBLESTRING

Constructor Summary

BERElement()

Method Summary

String	byteToHexString(byte value) Converts byte to hex string.
static BERElement	getElement(BERTagDecoder decoder, InputStream stream, int[] bytes_read) Gets a ber element from the input stream.
abstract int	getType() Gets the element type.
static int	readLengthOctets(InputStream stream, int[] bytes_read) Reads and decodes a length byte and then that many octets from the input stream.
static void	sendDefiniteLength(OutputStream stream, int num_content_octets) Writes length octets (definite length only) to stream.
abstract String	toString() Gets the string representation.
abstract void	write(OutputStream stream) Sends the BER encoding directly to a stream.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BOOLEAN

public static final int BOOLEAN

Possible element types.

See Also:

Constant Field Values

INTEGER

public static final int INTEGER

See Also:

Constant Field Values

BITSTRING

public static final int BITSTRING

See Also:

Constant Field Values

OCTETSTRING

public static final int OCTETSTRING

See Also:

Constant Field Values

NULL

public static final int NULL

See Also:

Constant Field Values

OBJECTID

public static final int OBJECTID

See Also:

Constant Field Values

REAL

public static final int REAL

See Also:

Constant Field Values

ENUMERATED

public static final int ENUMERATED

See Also:

Constant Field Values

SET

public static final int SET

See Also:

Constant Field Values

SEQUENCE

public static final int SEQUENCE

See Also:

Constant Field Values

NUMERICSTRING

public static final int NUMERICSTRING

See Also:

Constant Field Values

PRINTABLESTRING

public static final int PRINTABLESTRING

See Also:

Constant Field Values

TELETEXSTRING

public static final int TELETEXSTRING

See Also:

Constant Field Values

VIDEOTEXSTRING

public static final int VIDEOTEXSTRING

See Also:

Constant Field Values

IA5STRING

public static final int IA5STRING

See Also:

Constant Field Values

UTCTIME

public static final int UTCTIME

See Also:

Constant Field Values

GRAPHICSTRING

public static final int GRAPHICSTRING

See Also:

Constant Field Values

VISIBLESTRING

public static final int VISIBLESTRING

See Also:

Constant Field Values

GENERALSTRING

public static final int GENERALSTRING

See Also:

Constant Field Values

TAG

public static final int TAG

Internal (non-transmitted) tags.

See Also:

Constant Field Values

CHOICE

public static final int CHOICE

See Also:

Constant Field Values

ANY

public static final int ANY

See Also:

Constant Field Values

EOC

public static final int EOC

Possible tags.

See Also:

Constant Field Values

UNIVERSAL

public static final int UNIVERSAL

See Also:

Constant Field Values

APPLICATION

public static final int APPLICATION

See Also:

Constant Field Values

CONTEXT

public static final int CONTEXT

See Also:

Constant Field Values

SASLCONTEXT

public static final int SASLCONTEXT

See Also:

Constant Field Values

PRIVATE

public static final int PRIVATE

See Also:

Constant Field Values

PRIMITIVE

public static final int PRIMITIVE

See Also:

Constant Field Values

CONSTRUCTED

public static final int CONSTRUCTED

See Also:

Constant Field Values

MRA_OID

public static final int MRA_OID

See Also:

Constant Field Values

MRA_TYPE

public static final int MRA_TYPE

See Also:

Constant Field Values

MRA_VALUE

public static final int MRA_VALUE

See Also:

Constant Field Values

MRA_DNATTRS

public static final int MRA_DNATTRS

See Also:

Constant Field Values

EXOP_REQ_OID

public static final int EXOP_REQ_OID

See Also:

Constant Field Values

EXOP_REQ_VALUE

public static final int EXOP_REQ_VALUE

See Also:

Constant Field Values

EXOP_RES_OID

public static final int EXOP_RES_OID

See Also:

Constant Field Values

EXOP_RES_VALUE

public static final int EXOP_RES_VALUE

See Also:

Constant Field Values

SK_MATCHRULE

public static final int SK_MATCHRULE

See Also:

Constant Field Values

SK_REVERSE

public static final int SK_REVERSE

See Also:

Constant Field Values

SR_ATTRTYPE

public static final int SR_ATTRTYPE

See Also:

Constant Field Values

Constructor Detail

BERElement

public BERElement()

Method Detail

getElement

public static BERElement getElement(BERTagDecoder decoder,
                                    InputStream stream,
                                    int[] bytes_read)
                             throws IOException

Gets a ber element from the input stream.

Parameters:

decoder - decoder for application specific BER

stream - source of ber encoding

bytes_read - array of 1 int; value incremented by number of bytes read from stream

Throws:

IOException - failed to decode an element.

readLengthOctets

public static int readLengthOctets(InputStream stream,
                                   int[] bytes_read)
                            throws IOException

Reads and decodes a length byte and then that many octets from the input stream.

Parameters:

stream - input stream from which to read

bytes_read - array of 1 int; value incremented by number of bytes read from stream

Returns:

length of contents or -1 if indefinite length.

Throws:

IOException - failed to read octets

sendDefiniteLength

public static void sendDefiniteLength(OutputStream stream,
                                      int num_content_octets)
                               throws IOException

Writes length octets (definite length only) to stream. Uses shortform whenever possible.

Parameters:

stream - output stream to write to

num_content_octets - value to be encode into length octets

Returns:

number of bytes sent to stream.

Throws:

IOException - failed to read octets

byteToHexString

public String byteToHexString(byte value)

Converts byte to hex string.

Parameters:

value - byte value

Returns:

string representation of Hex String

write

public abstract void write(OutputStream stream)
                    throws IOException

Sends the BER encoding directly to a stream.

Parameters:

stream - output stream

Returns:

bytes written to stream.

Throws:

IOException

getType

public abstract int getType()

Gets the element type.

Returns:

element type.

toString

public abstract String toString()

Gets the string representation.

Returns:

string representation of an element.