Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsILDAPOperation Interface Reference

import "nsILDAPOperation.idl";

Inheritance diagram for nsILDAPOperation:
Inheritance graph
[legend]
Collaboration diagram for nsILDAPOperation:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void init (in nsILDAPConnection aConnection, in nsILDAPMessageListener aMessageListener, in nsISupports aClosure)
 Initializes this operation.
void simpleBind (in AUTF8String passwd)
 Asynchronously authenticate to the LDAP server.
void searchExt (in AUTF8String aBaseDn, in PRInt32 aScope, in AUTF8String aFilter, in unsigned long aAttrCount,[array, size_is(aAttrCount)] in string aAttributes, in PRIntervalTime aTimeOut, in PRInt32 aSizeLimit)
 Kicks off an asynchronous search request.
void abandonExt ()
 Cancels an async operation that is in progress.

Public Attributes

readonly attribute
nsILDAPConnection 
connection
 The connection this operation is on.
readonly attribute
nsILDAPMessageListener 
messageListener
 Callback for individual result messages related to this operation (set by the init() method).
readonly attribute long messageID
 The message-id associated with this operation.
attribute nsISupports closure
 private parameter (anything caller desires)
const long NO_LIMIT = 0
 No time and/or size limit specified.
attribute 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").
attribute nsIMutableArray clientControls

Detailed Description

Definition at line 52 of file nsILDAPOperation.idl.


Member Function Documentation

Cancels an async operation that is in progress.

XXX controls not supported yet

Exceptions:
NS_ERROR_NOT_IMPLEMENTEDserver or client controls were set on this object
NS_ERROR_NOT_INITIALIZEDoperation not initialized
NS_ERROR_LDAP_ENCODING_ERRORerror during BER-encoding
NS_ERROR_LDAP_SERVER_DOWNthe LDAP server did not receive the request or the connection was lost
NS_ERROR_OUT_OF_MEMORYout of memory
NS_ERROR_INVALID_ARGinvalid argument
NS_ERROR_UNEXPECTEDinternal error
void nsILDAPOperation::init ( in nsILDAPConnection  aConnection,
in nsILDAPMessageListener  aMessageListener,
in nsISupports  aClosure 
)

Initializes this operation.

Must be called prior to initiating any actual operations. Note that by default, the aMessageListener 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.

Parameters:
aConnectionconnection this operation should use
aMessageListenerinterface used to call back the results.
aClosureprivate parameter (anything caller desires)
Exceptions:
NS_ERROR_ILLEGAL_VALUEa NULL pointer was passed in
NS_ERROR_UNEXPECTEDfailed to get connection handle
void nsILDAPOperation::searchExt ( in AUTF8String  aBaseDn,
in PRInt32  aScope,
in AUTF8String  aFilter,
in unsigned long  aAttrCount,
[array, size_is(aAttrCount)] in string  aAttributes,
in PRIntervalTime  aTimeOut,
in PRInt32  aSizeLimit 
)

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.

Parameters:
aBaseDnBase DN to search
aScopeOne of SCOPE_{BASE,ONELEVEL,SUBTREE}
aFilterSearch filter
aAttrCountNumber of attributes we request (0 for all)
aAttributesArray of strings, holding the attrs we need
aTimeOutHow long to wait
aSizeLimitMaximum number of entries to return.
Exceptions:
NS_ERROR_NOT_INITIALIZED
NS_ERROR_LDAP_ENCODING_ERROR
NS_ERROR_LDAP_SERVER_DOWN
NS_ERROR_OUT_OF_MEMORY
NS_ERROR_INVALID_ARG
NS_ERROR_LDAP_NOT_SUPPORTED
NS_ERROR_LDAP_FILTER_ERROR
NS_ERROR_UNEXPECTED
void nsILDAPOperation::simpleBind ( in AUTF8String  passwd)

Asynchronously authenticate to the LDAP server.

Parameters:
passwdthe password used for binding; NULL for anon-binds
Exceptions:
NS_ERROR_LDAP_ENCODING_ERRORproblem encoding bind request
NS_ERROR_LDAP_SERVER_DOWNserver down (XXX rebinds?)
NS_ERROR_LDAP_CONNECT_ERRORconnection failed or lost
NS_ERROR_OUT_OF_MEMORYran out of memory
NS_ERROR_UNEXPECTEDinternal error

Member Data Documentation

Definition at line 93 of file nsILDAPOperation.idl.

private parameter (anything caller desires)

Definition at line 80 of file nsILDAPOperation.idl.

The connection this operation is on.

Exceptions:
NS_ERROR_ILLEGAL_VALUEa NULL pointer was passed in

Definition at line 59 of file nsILDAPOperation.idl.

The message-id associated with this operation.

Exceptions:
NS_ERROR_ILLEGAL_VALUEa NULL pointer was passed in

Definition at line 75 of file nsILDAPOperation.idl.

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.

Exceptions:
NS_ERROR_ILLEGAL_VALUEa NULL pointer was passed in

Definition at line 68 of file nsILDAPOperation.idl.

No time and/or size limit specified.

Definition at line 85 of file nsILDAPOperation.idl.

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").

Definition at line 92 of file nsILDAPOperation.idl.


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