Back to index

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

Extends nsIAutoCompleteSession to have various LDAP-specific parameters. More...

import "nsILDAPAutoCompleteSession.idl";

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

List of all members.

Public Member Functions

void onStartLookup (in wstring searchString, in nsIAutoCompleteResults previousSearchResult, in nsIAutoCompleteListener listener)
void onStopLookup ()
void onAutoComplete (in wstring searchString, in nsIAutoCompleteResults previousSearchResult, in nsIAutoCompleteListener listener)

Public Attributes

attribute AUTF8String filterTemplate
 A template used to construct the RFC 1960 LDAP search filter to use while autocompleting.
attribute long maxHits
 At most this many nsIAutoCompleteItems will be returned.
attribute unsigned long minStringLength
 Strings shorter than this will return |nsIAutoCompleteStatus::ignored| rather than triggering a search.
attribute unsigned long cjkMinStringLength
attribute nsILDAPURL serverURL
 LDAP server to complete against, in ldap: URL format.
attribute nsILDAPAutoCompFormatter formatter
 Callback used to format an individual LDAP message into an nsIAutoCompleteItem.
attribute AUTF8String login
 "Login as..." this ID.
attribute nsIAuthPrompt authPrompter
 If set, use this object to get a password for logging in to the server.
attribute unsigned long version
 What version of the LDAP protocol should be used? Allowed version number constants are defined in nsILDAPConnection.idl.
attribute nsIMutableArray searchServerControls
 If set, these arrays of nsILDAPControls are passed through to the nsILDAPOperation that searchExt is called on.
attribute nsIMutableArray searchClientControls

Detailed Description

Extends nsIAutoCompleteSession to have various LDAP-specific parameters.

and output format.

Definition at line 54 of file nsILDAPAutoCompleteSession.idl.


Member Function Documentation

void nsIAutoCompleteSession::onAutoComplete ( in wstring  searchString,
in nsIAutoCompleteResults  previousSearchResult,
in nsIAutoCompleteListener  listener 
) [inherited]
void nsIAutoCompleteSession::onStartLookup ( in wstring  searchString,
in nsIAutoCompleteResults  previousSearchResult,
in nsIAutoCompleteListener  listener 
) [inherited]

Member Data Documentation

If set, use this object to get a password for logging in to the server.

Definition at line 132 of file nsILDAPAutoCompleteSession.idl.

Definition at line 106 of file nsILDAPAutoCompleteSession.idl.

A template used to construct the RFC 1960 LDAP search filter to use while autocompleting.

The authoritative documentation for the format in use can be found at at http://docs.iplanet.com/docs/manuals/dirsdk/csdk41/html/filter.htm. The Linux/OpenLDAP man page for ldapfilter.conf(5) does a pretty decent job as well, however.

As of this writing, the "@mozilla.org/autocompleteSession;1?type=ldap" contractid happens to use a default value of (|(cn=v1*v2-*)(mail=v1*v2-*)(sn=v1*v2-*))

Exceptions:
NS_ERROR_NULL_POINTERNULL pointer passed to getter
NS_ERROR_OUT_OF_MEMORYGetter couldn't allocate string

Definition at line 72 of file nsILDAPAutoCompleteSession.idl.

Callback used to format an individual LDAP message into an nsIAutoCompleteItem.

Definition at line 120 of file nsILDAPAutoCompleteSession.idl.

"Login as..." this ID.

Currently, this must be specified as a DN. In the future, we may support userid and/or email address as well. If unset, bind anonymously.

Definition at line 127 of file nsILDAPAutoCompleteSession.idl.

At most this many nsIAutoCompleteItems will be returned.

This is useful for keeping bandwidth usage over slow-speed connections as well as ensuring that the number of choices offered in the UI is manageble.

1-65535 are interpreted literally 0 means "unlimited" -1 uses the default limit for the LDAP connection in use

Exceptions:
NS_ERROR_NULL_POINTERNULL pointer passed to getter
NS_ERROR_ILLEGAL_VALUEOut-of-range value passed to setter

Definition at line 87 of file nsILDAPAutoCompleteSession.idl.

Strings shorter than this will return |nsIAutoCompleteStatus::ignored| rather than triggering a search.

This allows browsers to be configured to not search on substrings so short that they aren't indexed by the LDAP server (such searches can use significantly more server resources and return a very large number of entries). cjkMinStringLength is used for CJK languages, and minStringLength for everything else. As of this writing, the "@mozilla.org/autocompleteSession;1?type=ldap" contractid uses defaults of two and zero, respectively. This avoids most unindexed searches with at least one widely-deployed webserver, but allows CJK languages, where a single glyph can be an an entire name to still get results.

Exceptions:
NS_ERROR_NULL_POINTERNULL pointer passed to getter

Definition at line 105 of file nsILDAPAutoCompleteSession.idl.

Definition at line 148 of file nsILDAPAutoCompleteSession.idl.

If set, these arrays of nsILDAPControls are passed through to the nsILDAPOperation that searchExt is called on.

Definition at line 147 of file nsILDAPAutoCompleteSession.idl.

LDAP server to complete against, in ldap: URL format.

May change to an nsILDAPServer once that infrastructure lands.

Exceptions:
NS_ERROR_NULL_POINTERNULL pointer passed to getter

Definition at line 114 of file nsILDAPAutoCompleteSession.idl.

What version of the LDAP protocol should be used? Allowed version number constants are defined in nsILDAPConnection.idl.

Exceptions:
NS_ERROR_ILLEGAL_VALUEillegal version num passed to setter
NS_ERROR_NULL_POINTERnull pointer passed to getter

Definition at line 141 of file nsILDAPAutoCompleteSession.idl.


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