WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsILDAPOperation

IID:b9a7ed9d-adf9-4612-8cb7-cdb5c4ef16fd
Inherits From:nsISupports

This interface is implemented by the following components:


Constants

No time and/or size limit specified
PRInt32 NO_LIMIT = 0

Properties

nsIMutableArray clientControls

nsISupports closure

Private parameter (anything caller desires)

readonly nsILDAPConnection connection

The connection this operation is on.

readonly PRInt32 messageID

The message-id associated with this operation.

readonly nsILDAPMessageListener messageListener

Callback for individual result messages related to this operation (set by the init() method). This is actually an nsISupports proxy object, as the callback will happen from another thread.

nsIMutableArray serverControls

If specified, these arrays of nsILDAPControls are passed into the LDAP C SDK for any extended operations (ie method calls on this interface ending in "Ext").


Methods

void abandonExt ( ) void addExt ( AUTF8String baseDn , nsIArray mods ) void deleteExt ( AUTF8String baseDn ) void init ( nsILDAPConnection connection , nsILDAPMessageListener messageListener , nsISupports closure ) void modifyExt ( AUTF8String baseDn , nsIArray mods ) void rename ( AUTF8String baseDn , AUTF8String newRDn , AUTF8String newParent , PRBool deleteOldRDn ) void searchExt ( AUTF8String baseDn , PRInt32 scope , AUTF8String filter , PRUint32 attrCount , arrayof char* attributes , PRIntervalTime timeOut , PRInt32 sizeLimit ) void simpleBind ( AUTF8String passwd )

void abandonExt ( )

Cancels an async operation that is in progress.

XXX controls not supported yet


void addExt ( AUTF8String baseDn , nsIArray mods )

Kicks off an asynchronous add request. The "ext" stands for "extensions", and is intended to convey that this method will eventually support the extensions described in the draft-ietf-ldapext-ldap-c-api-04.txt Internet Draft.

XXX doesn't currently handle LDAPControl params

Arguments:
baseDn: Base DN to add
mods: Array of modifications

void deleteExt ( AUTF8String baseDn )

Kicks off an asynchronous delete request. The "ext" stands for "extensions", and is intended to convey that this method will eventually support the extensions described in the draft-ietf-ldapext-ldap-c-api-04.txt Internet Draft.

XXX doesn't currently handle LDAPControl params

Arguments:
baseDn: Base DN to delete

void init ( nsILDAPConnection connection , nsILDAPMessageListener messageListener , nsISupports closure )

Initializes this operation. Must be called prior to initiating any actual operations. Note that by default, the messageListener callbacks happen on the LDAP connection thread. If you need them to happen on the main thread (or any other thread), then you should created an nsISupports proxy object and pass that in.

Arguments:
connection: connection this operation should use
messageListener: interface used to call back the results.
closure: private parameter (anything caller desires)

void modifyExt ( AUTF8String baseDn , nsIArray mods )

Kicks off an asynchronous modify request. The "ext" stands for "extensions", and is intended to convey that this method will eventually support the extensions described in the draft-ietf-ldapext-ldap-c-api-04.txt Internet Draft.

XXX doesn't currently handle LDAPControl params

Arguments:
baseDn: Base DN to modify
mods: Array of modifications

void rename ( AUTF8String baseDn , AUTF8String newRDn , AUTF8String newParent , PRBool deleteOldRDn )

Kicks off an asynchronous rename request.

XXX doesn't currently handle LDAPControl params

Arguments:
baseDn: Base DN to rename
newRDn: New relative DN
newParent: DN of the new parent under which to move the entry
deleteOldRDn: Indicates whether to remove the old relative DN as a value in the entry or not

void searchExt ( AUTF8String baseDn , PRInt32 scope , AUTF8String filter , PRUint32 attrCount , arrayof char* attributes , PRIntervalTime timeOut , PRInt32 sizeLimit )

Kicks off an asynchronous search request. The "ext" stands for "extensions", and is intended to convey that this method will eventually support the extensions described in the draft-ietf-ldapext-ldap-c-api-04.txt Internet Draft.

Arguments:
baseDn: Base DN to search
scope: One of SCOPE_{BASE,ONELEVEL,SUBTREE}
filter: Search filter
attrCount: Number of attributes we request (0 for all)
attributes: Array of strings, holding the attrs we need
timeOut: How long to wait
sizeLimit: Maximum number of entries to return.

void simpleBind ( AUTF8String passwd )

Asynchronously authenticate to the LDAP server.

Arguments:
passwd: the password used for binding; NULL for anon-binds

References

This interface is the type of the following properties:

nsILDAPMessage.operation

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com