Public Attributes

nsILDAPAutoCompleteSession Interface Reference

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

import "nsILDAPAutoCompleteSession.idl";

Inheritance diagram for nsILDAPAutoCompleteSession:
Collaboration diagram for nsILDAPAutoCompleteSession:

List of all members.

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 |nsIAutoCompleteStatusignored| 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 ACString saslMechanism
 SASL Mechanism to use to perform bind.
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.


Member Data Documentation

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_POINTER NULL pointer passed to getter
NS_ERROR_OUT_OF_MEMORY Getter couldn't allocate string

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

attribute AUTF8String nsILDAPAutoCompleteSession::login

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

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_POINTER NULL pointer passed to getter
NS_ERROR_ILLEGAL_VALUE Out-of-range value passed to setter

Strings shorter than this will return |nsIAutoCompleteStatusignored| 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_POINTER NULL pointer passed to getter

SASL Mechanism to use to perform bind.

If unset, a simple bind will be performed.

Exceptions:
NS_ERROR_OUT_OF_MEMORY Getter couldn't allocate string
NS_ERROR_NULL_POINTER null pointer passed to getter

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

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

May change to an nsILDAPServer once that infrastructure lands.

Exceptions:
NS_ERROR_NULL_POINTER NULL pointer passed to getter
attribute unsigned long nsILDAPAutoCompleteSession::version

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

Exceptions:
NS_ERROR_ILLEGAL_VALUE illegal version num passed to setter
NS_ERROR_NULL_POINTER null pointer passed to getter

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