Class BERTag

java.lang.Object

netscape.ldap.ber.stream.BERElement

netscape.ldap.ber.stream.BERTag

All Implemented Interfaces:

Serializable

public class BERTag
extends BERElement

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

ENCODING RULE:
 tag    = whatever it is constructed with

Version:

1.0 seeAlso CCITT X.209

See Also:

• Serialized Form

Field Summary

Fields inherited from class BERElement

ANY, APPLICATION, BITSTRING, BOOLEAN, CHOICE, CONSTRUCTED, CONTEXT, ENUMERATED, EOC, EXOP_REQ_OID, EXOP_REQ_VALUE, EXOP_RES_OID, EXOP_RES_VALUE, GENERALSTRING, GRAPHICSTRING, IA5STRING, INTEGER, MRA_DNATTRS, MRA_OID, MRA_TYPE, MRA_VALUE, NULL, NUMERICSTRING, OBJECTID, OCTETSTRING, PRIMITIVE, PRINTABLESTRING, PRIVATE, REAL, SASLCONTEXT, SEQUENCE, SET, SK_MATCHRULE, SK_REVERSE, SR_ATTRTYPE, TAG, TELETEXSTRING, UNIVERSAL, UTCTIME, VIDEOTEXSTRING, VISIBLESTRING

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

Constructor Summary

Constructors

Constructor	Description
BERTag(int tag, BERElement element, boolean implicit)	Constructs a tag element.
BERTag(BERTagDecoder decoder, int tag, InputStream stream, int[] bytes_read)	Constructs a tag element from an input stream.

Method Summary

Modifier and Type	Method	Description
int	getTag()	Gets the element tag.
int	getType()	Gets the element type.
BERElement	getValue()	Gets the element from the tagged object.
void	setImplicit(boolean value)	Sets the implicit tag.
String	toString()	Gets the string representation.
void	write(OutputStream stream)	Sends the BER encoding directly to a stream.

Methods inherited from class BERElement

byteToHexString, getElement, readLengthOctets, readTwosComplement, readUnsignedBinary, sendDefiniteLength

Modifier and Type	Method	Description
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.
static int	readLengthOctets(InputStream stream, int[] bytes_read)	Reads and decodes a length byte and then that many octets from the input stream.
protected int	readTwosComplement(InputStream stream, int[] bytes_read, int length)	Reads the two's complement representation of an integer from an input stream.
protected int	readUnsignedBinary(InputStream stream, int[] bytes_read, int length)	Reads a number of bytes from an input stream and form an integer..
static void	sendDefiniteLength(OutputStream stream, int num_content_octets)	Writes length octets (definite length only) to stream.

Methods inherited from class Object

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

Constructor Details

BERTag

public BERTag(int tag,
 BERElement element,
 boolean implicit)

Constructs a tag element.

Parameters:

tag - tag value

element - ber element

implicit - tagged implicitly

BERTag

public BERTag(BERTagDecoder decoder,
 int tag,
 InputStream stream,
 int[] bytes_read)
       throws IOException

Constructs a tag element from an input stream.

Parameters:

decoder - decoder object for application-specific tags

tag - tag value; already stripped from stream

stream - source

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

Throws:

IOException - failed to construct

Method Details

getValue

public BERElement getValue()

Gets the element from the tagged object.

Returns:

BER element.

setImplicit

public void setImplicit(boolean value)

Sets the implicit tag. If it is an implicit tag, the next element tag can be omitted (it will not be sent to a stream or buffer).

Parameters:

value - implicit flag

write

public void write(OutputStream stream)
           throws IOException

Sends the BER encoding directly to a stream.

Specified by:

write in class BERElement

Parameters:

stream - output stream

Throws:

IOException - failed to send

getType

public int getType()

Gets the element type.

Specified by:

getType in class BERElement

Returns:

element type.

getTag

public int getTag()

Gets the element tag.

Returns:

element tag.

toString

public String toString()

Gets the string representation.

Specified by:

toString in class BERElement

Returns:

string representation of tag.