netscape.ldap.ber.stream
Class BEROctetString

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

All Implemented Interfaces:

Serializable

public class BEROctetString

extends BERElement

This class is for the OctetString type.

 ENCODING RULE:
   Primitive Definite length.
   tag = 0x04
   length = (short or long form)
   one or more contents octets
 

See Also:

Serialized Form

Field Summary

Fields inherited from class netscape.ldap.ber.stream.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

Constructor Summary

BEROctetString(BERTagDecoder decoder, InputStream stream, int[] bytes_read)
Constructs an octet string element from an input stream (for constructed encoding)

BEROctetString(byte[] buffer)
Constructs an octet string element containing a reference to buffer.

BEROctetString(byte[] buffer, int start, int end)
Constructs an octet string element containing a subset of buffer.

BEROctetString(InputStream stream, int[] bytes_read)
Constructs an octet string element from an input stream (for primitive encoding)

BEROctetString(String buffer)
Constructs an octet string element containing a copy of the contents of buffer.

Method Summary

int	getType() Gets the element type.
byte[]	getValue() Gets the element value.
String	toString() Gets the string representation.
void	write(OutputStream stream) Writes BER to stream

Methods inherited from class netscape.ldap.ber.stream.BERElement

byteToHexString, getElement, readLengthOctets, sendDefiniteLength

Methods inherited from class java.lang.Object

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

Constructor Detail

BEROctetString

public BEROctetString(String buffer)

Constructs an octet string element containing a copy of the contents of buffer.

Parameters:

buffer - a UCS-2 String

BEROctetString

public BEROctetString(byte[] buffer)

Constructs an octet string element containing a reference to buffer.

Parameters:

buffer - a byte array, which must be in UTF-8 format if it is string data

BEROctetString

public BEROctetString(byte[] buffer,
                      int start,
                      int end)

Constructs an octet string element containing a subset of buffer.

Parameters:

buffer - buffer containing 'octets'

start - start of buffer range to copy

end - end of buffer range to copy

BEROctetString

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

Constructs an octet string element from an input stream (for constructed encoding)

Parameters:

decoder - a decode that understands the specific tags

stream - source

bytes_read - array of 1 int, incremented by number of bytes read

Throws:

IOException - failed to construct

BEROctetString

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

Constructs an octet string element from an input stream (for primitive encoding)

Parameters:

stream - source

bytes_read - array of 1 int, incremented by number of bytes read

Throws:

IOException - failed to construct

Method Detail

write

public void write(OutputStream stream)
           throws IOException

Writes BER to stream

Specified by:

write in class BERElement

Parameters:

stream - output stream

Returns:

number of bytes written to stream.

Throws:

IOException - failed to write

getValue

public byte[] getValue()

Gets the element value.

Returns:

element value

getType

public int getType()

Gets the element type.

Specified by:

getType in class BERElement

Returns:

element type

toString

public String toString()

Gets the string representation. NOTE: currently prints out values in decimal form.

Specified by:

toString in class BERElement

Returns:

string representation of tag.