blob: 5fc9522e41f2cfd236fed3e36385b62f0c34d9cf (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsISupports.idl"
#include "nsILDAPConnection.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;
/**
* protocol version to be used (see nsILDAPConnection.idl for constants)
* Defaults to 3.
*
* @exception NS_ERROR_NULL_POINTER NULL pointer passed to getter
* @exception NS_ERROR_INVALID_ARG Invalid version passed to setter
*/
attribute unsigned long protocolVersion;
};
|
