Public Attributes

nsILDAPServer Interface Reference

this interface provides a way to store, retrieve and manipulate information related to a specific LDAP server. More...

import "nsILDAPServer.idl";

Collaboration diagram for nsILDAPServer:

List of all members.

Public Attributes

attribute wstring key
 unique identifier for this server, used (typically) to identify a particular server object in a list of servers.
attribute AUTF8String password
 the password string used to bind to this server.
attribute AUTF8String username
 the user name to authenticate as.
attribute AUTF8String binddn
 the bind DN (Distinguished Name).
attribute unsigned long sizelimit
 maximum number of hits we want to accept from an LDAP search operation.
attribute nsILDAPURL url
 the URL for this server.
attribute unsigned long protocolVersion
 protocol version to be used (see nsILDAPConnection.idl for constants) Defaults to 3.

Detailed Description

this interface provides a way to store, retrieve and manipulate information related to a specific LDAP server.

This includes the LDAP URL, as well as certain user specific data (e.g. credentials).

The implementation of nsILDAPService relies heavily on this interface, managing all LDAP connections (nsILDAPConnection). The Service manages LDAP connections (connect and disconnect etc.), using the information available from these LDAP Server objects.


Member Data Documentation

attribute AUTF8String nsILDAPServer::binddn

the bind DN (Distinguished Name).

Exceptions:
NS_ERROR_NULL_POINTER NULL pointer to GET method
NS_ERROR_OUT_OF_MEMORY ran out of memory
attribute wstring nsILDAPServer::key

unique identifier for this server, used (typically) to identify a particular server object in a list of servers.

This key can be any "string", but in our case it will most likely be the same identifier as used in a Mozilla preferences files.

Exceptions:
NS_ERROR_NULL_POINTER NULL pointer to GET method
NS_ERROR_OUT_OF_MEMORY ran out of memory
attribute AUTF8String nsILDAPServer::password

the password string used to bind to this server.

An empty string here implies binding as anonymous.

Exceptions:
NS_ERROR_NULL_POINTER NULL pointer to GET method
NS_ERROR_OUT_OF_MEMORY ran out of memory
attribute unsigned long nsILDAPServer::protocolVersion

protocol version to be used (see nsILDAPConnection.idl for constants) Defaults to 3.

Exceptions:
NS_ERROR_NULL_POINTER NULL pointer passed to getter
NS_ERROR_INVALID_ARG Invalid version passed to setter
attribute unsigned long nsILDAPServer::sizelimit

maximum number of hits we want to accept from an LDAP search operation.

Exceptions:
NS_ERROR_NULL_POINTER NULL pointer to GET method

the URL for this server.

Exceptions:
NS_ERROR_NULL_POINTER NULL pointer to GET method
attribute AUTF8String nsILDAPServer::username

the user name to authenticate as.

An empty string here would imply binding as anonymous.

Exceptions:
NS_ERROR_NULL_POINTER NULL pointer to GET method
NS_ERROR_OUT_OF_MEMORY ran out of memory

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