| 1 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- |
|---|
| 2 | * |
|---|
| 3 | * The contents of this file are subject to the Mozilla Public |
|---|
| 4 | * License Version 1.1 (the "License"); you may not use this file |
|---|
| 5 | * except in compliance with the License. You may obtain a copy of |
|---|
| 6 | * the License at http://www.mozilla.org/MPL/ |
|---|
| 7 | * |
|---|
| 8 | * Software distributed under the License is distributed on an "AS |
|---|
| 9 | * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or |
|---|
| 10 | * implied. See the License for the specific language governing |
|---|
| 11 | * rights and limitations under the License. |
|---|
| 12 | * |
|---|
| 13 | * The Original Code is mozilla.org code. |
|---|
| 14 | * |
|---|
| 15 | * The Initial Developer of the Original Code is Netscape |
|---|
| 16 | * Communications Corporation. Portions created by Netscape are |
|---|
| 17 | * Copyright (C) 2001 Netscape Communications Corporation. All |
|---|
| 18 | * Rights Reserved. |
|---|
| 19 | * |
|---|
| 20 | * Contributor(s): |
|---|
| 21 | * Srilatha Moturi <srilatha@netscape.com> |
|---|
| 22 | * |
|---|
| 23 | * nsILDAPPrefsService.idl |
|---|
| 24 | */ |
|---|
| 25 | |
|---|
| 26 | #include "nsISupports.idl" |
|---|
| 27 | #include "nsILDAPURL.idl" |
|---|
| 28 | #include "nsILDAPService.idl" |
|---|
| 29 | #include "nsIPrefBranch.idl" |
|---|
| 30 | |
|---|
| 31 | /** |
|---|
| 32 | * this service implements migrating ldap prefs from 4.x format |
|---|
| 33 | * to mozilla format. |
|---|
| 34 | */ |
|---|
| 35 | [scriptable, uuid(5a4911e0-44cd-11d5-9074-0010a4b26cda)] |
|---|
| 36 | interface nsILDAPPrefsService: nsISupports { |
|---|
| 37 | |
|---|
| 38 | /** |
|---|
| 39 | * Convert 4.x ldap prefs to mozilla format |
|---|
| 40 | * hostname, dn, scope, port are converted to uri |
|---|
| 41 | * Also converts the autocompletion preference from 4.x format |
|---|
| 42 | * (ldap_2.servers.<server-name>.autocomplete.enabled) |
|---|
| 43 | * to mozilla format (ldap_2.servers.directoryServer) |
|---|
| 44 | */ |
|---|
| 45 | void migrate(); |
|---|
| 46 | |
|---|
| 47 | /** |
|---|
| 48 | * This will create an array with entries |
|---|
| 49 | * "ldap_2.servers.<server-name>" |
|---|
| 50 | * Each entry in the array is unique. |
|---|
| 51 | * |
|---|
| 52 | * @param aPrefBranch prefBranch object. |
|---|
| 53 | * @param aCount Receives the number of elements in the array. |
|---|
| 54 | * @param aChildArray Receives the array with "ldap_2.servers.<server-name>". |
|---|
| 55 | * |
|---|
| 56 | * @return NS_OK The preference list was successfully retrieved. |
|---|
| 57 | * @return Other The preference(s) do not exist or an error occurred. |
|---|
| 58 | */ |
|---|
| 59 | void getServerList(in nsIPrefBranch aPrefBranch, |
|---|
| 60 | out unsigned long aCount, |
|---|
| 61 | [array, size_is(aCount), retval] out string aChildArray); |
|---|
| 62 | }; |
|---|
