104 lines
3.8 KiB
Plaintext
104 lines
3.8 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public
|
|
* License Version 1.1 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS
|
|
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
|
* implied. See the License for the specific language governing
|
|
* rights and limitations under the License.
|
|
*
|
|
* The Original Code is the mozilla.org LDAP XPCOM component.
|
|
*
|
|
* The Initial Developer of the Original Code is Netscape
|
|
* Communications Corporation. Portions created by Netscape are
|
|
* Copyright (C) 2000 Netscape Communications Corporation. All
|
|
* Rights Reserved.
|
|
*
|
|
* Contributor(s): Leif Hedstrom <leif@netscape.com>
|
|
*
|
|
* Alternatively, the contents of this file may be used under the
|
|
* terms of the GNU General Public License Version 2 or later (the
|
|
* "GPL"), in which case the provisions of the GPL are applicable
|
|
* instead of those above. If you wish to allow use of your
|
|
* version of this file only under the terms of the GPL and not to
|
|
* allow others to use your version of this file under the MPL,
|
|
* indicate your decision by deleting the provisions above and
|
|
* replace them with the notice and other provisions required by
|
|
* the GPL. If you do not delete the provisions above, a recipient
|
|
* may use your version of this file under either the MPL or the
|
|
* GPL.
|
|
*/
|
|
|
|
#include "nsISupports.idl"
|
|
interface nsILDAPURL;
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
|
|
|
|
[scriptable, uuid(8aa717a4-1dd2-11b2-99c7-f01e2d449ded)]
|
|
interface nsILDAPServer : nsISupports {
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @exception NS_ERROR_NULL_POINTER NULL pointer to GET method
|
|
* @exception NS_ERROR_OUT_OF_MEMORY ran out of memory
|
|
*/
|
|
attribute wstring key;
|
|
|
|
/**
|
|
* the password string used to bind to this server. An empty
|
|
* string here implies binding as anonymous.
|
|
*
|
|
* @exception NS_ERROR_NULL_POINTER NULL pointer to GET method
|
|
* @exception NS_ERROR_OUT_OF_MEMORY ran out of memory
|
|
*/
|
|
attribute AUTF8String password;
|
|
|
|
/**
|
|
* the user name to authenticate as. An empty string here would
|
|
* imply binding as anonymous.
|
|
*
|
|
* @exception NS_ERROR_NULL_POINTER NULL pointer to GET method
|
|
* @exception NS_ERROR_OUT_OF_MEMORY ran out of memory
|
|
*/
|
|
attribute AUTF8String username;
|
|
|
|
/**
|
|
* the bind DN (Distinguished Name).
|
|
*
|
|
* @exception NS_ERROR_NULL_POINTER NULL pointer to GET method
|
|
* @exception NS_ERROR_OUT_OF_MEMORY ran out of memory
|
|
*/
|
|
attribute AUTF8String binddn;
|
|
|
|
/** maximum number of hits we want to accept from an LDAP search
|
|
* operation.
|
|
*
|
|
* @exception NS_ERROR_NULL_POINTER NULL pointer to GET method
|
|
*/
|
|
attribute unsigned long sizelimit;
|
|
|
|
/**
|
|
* the URL for this server.
|
|
*
|
|
* @exception NS_ERROR_NULL_POINTER NULL pointer to GET method
|
|
*/
|
|
attribute nsILDAPURL url;
|
|
};
|