Public Member Functions | Public Attributes

nsILDAPBERElement Interface Reference

nsILDAPBERElement is a wrapper interface for a C-SDK BerElement object. More...

import "nsILDAPBERElement.idl";

Collaboration diagram for nsILDAPBERElement:

List of all members.

Public Member Functions

void init (in nsILDAPBERValue aValue)
 Initialize this object.
unsigned long putString (in AUTF8String aString, in unsigned long aTag)
 Write a string to this element.
void startSet (in unsigned long aTag)
 Start a set.
unsigned long putSet ()
 Cause the entire set started by the last startSet() call to be written.

Public Attributes

const unsigned long TAG_LBER_ERROR = 0xffffffff
 Most TAG_* constants can be used in the construction or passing in of values to the aTag arguments to most of the methods in this interface.
const unsigned long TAG_LBER_DEFAULT = 0xffffffff
const unsigned long TAG_LBER_END_OF_SEQORSET = 0xfffffffe
const unsigned long TAG_LBER_PRIMITIVE = 0x00
 BER encoding types and masks.
const unsigned long TAG_LBER_CONSTRUCTED = 0x20
 The following two tags are carried over from the LDAP C SDK; their exact purpose there is not well documented.
const unsigned long TAG_LBER_ENCODING_MASK = 0x20
const unsigned long TAG_LBER_BIG_TAG_MASK = 0x1f
const unsigned long TAG_LBER_MORE_TAG_MASK = 0x80
const unsigned long TAG_LBER_BOOLEAN = 0x01
 general BER types we know about
const unsigned long TAG_LBER_INTEGER = 0x02
const unsigned long TAG_LBER_BITSTRING = 0x03
const unsigned long TAG_LBER_OCTETSTRING = 0x04
const unsigned long TAG_LBER_NULL = 0x05
const unsigned long TAG_LBER_ENUMERATED = 0x0a
const unsigned long TAG_LBER_SEQUENCE = 0x30
const unsigned long TAG_LBER_SET = 0x31
readonly attribute nsILDAPBERValue asValue
 an nsILDAPBERValue version of this element.

Detailed Description

nsILDAPBERElement is a wrapper interface for a C-SDK BerElement object.

Typically, this is used as an intermediate object to aid in the manual construction of a BER value. Once the construction is completed by calling methods on this object, an nsILDAPBERValue can be retrieved from the asValue attribute on this interface.

<http://www.mozilla.org/directory/ietf-docs/draft-ietf-ldapext-ldap-c-api-05.txt> contains some documentation that mostly (but not exactly) matches the code that this wraps in section 17.


Member Function Documentation

void nsILDAPBERElement::init ( in nsILDAPBERValue  aValue  ) 

Initialize this object.

Must be called before calling any other method on this interface.

Parameters:
aValue value to preinitialize with; 0 for a new empty object
Exceptions:
NS_ERROR_NOT_IMPLEMENTED preinitialization is currently not implemented
NS_ERROR_OUT_OF_MEMORY unable to allocate the internal BerElement
unsigned long nsILDAPBERElement::putSet (  ) 

Cause the entire set started by the last startSet() call to be written.

Exceptions:
NS_ERROR_FAILUE C-SDK returned an error
Returns:
number of bytes written
unsigned long nsILDAPBERElement::putString ( in AUTF8String  aString,
in unsigned long  aTag 
)

Write a string to this element.

Parameters:
aString string to write
aTag tag for this string (if TAG_LBER_DEFAULT is used, TAG_LBER_OCTETSTRING will be written).
Returns:
number of bytes written
Exceptions:
NS_ERROR_FAILUE C-SDK returned error
void nsILDAPBERElement::startSet ( in unsigned long  aTag  ) 

Start a set.

Sets may be nested.

Parameters:
aTag tag for this set (if TAG_LBER_DEFAULT is used, TAG_LBER_SET will be written).
Exceptions:
NS_ERROR_FAILUE C-SDK returned an error

Member Data Documentation

an nsILDAPBERValue version of this element.

Calls ber_flatten() under the hood.

Exceptions:
NS_ERROR_OUT_OF_MEMORY 
const unsigned long nsILDAPBERElement::TAG_LBER_BIG_TAG_MASK = 0x1f
const unsigned long nsILDAPBERElement::TAG_LBER_BITSTRING = 0x03
const unsigned long nsILDAPBERElement::TAG_LBER_BOOLEAN = 0x01

general BER types we know about

const unsigned long nsILDAPBERElement::TAG_LBER_CONSTRUCTED = 0x20

The following two tags are carried over from the LDAP C SDK; their exact purpose there is not well documented.

They both have the same value there as well.

const unsigned long nsILDAPBERElement::TAG_LBER_DEFAULT = 0xffffffff
const unsigned long nsILDAPBERElement::TAG_LBER_ENCODING_MASK = 0x20
const unsigned long nsILDAPBERElement::TAG_LBER_END_OF_SEQORSET = 0xfffffffe
const unsigned long nsILDAPBERElement::TAG_LBER_ENUMERATED = 0x0a
const unsigned long nsILDAPBERElement::TAG_LBER_ERROR = 0xffffffff

Most TAG_* constants can be used in the construction or passing in of values to the aTag arguments to most of the methods in this interface.

When returned from a parsing method, 0xffffffff is referred to has the parse-error semantic (ie TAG_LBER_ERROR); when passing it to a construction method, it is used to mean "pick the default tag for this type" (ie TAG_LBER_DEFAULT).

const unsigned long nsILDAPBERElement::TAG_LBER_INTEGER = 0x02
const unsigned long nsILDAPBERElement::TAG_LBER_MORE_TAG_MASK = 0x80
const unsigned long nsILDAPBERElement::TAG_LBER_NULL = 0x05
const unsigned long nsILDAPBERElement::TAG_LBER_OCTETSTRING = 0x04
const unsigned long nsILDAPBERElement::TAG_LBER_PRIMITIVE = 0x00

BER encoding types and masks.

const unsigned long nsILDAPBERElement::TAG_LBER_SEQUENCE = 0x30
const unsigned long nsILDAPBERElement::TAG_LBER_SET = 0x31

The documentation for this interface was generated from the following file: