1 /******************************************************************************
3 * Copyright (c) 2003 Novell Inc. www.novell.com
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the Software), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 *******************************************************************************/
24 // Novell.Directory.Ldap.LdapAuthHandler.cs
27 // Sunil Kumar (Sunilk@novell.com)
29 // (C) 2003 Novell, Inc (http://www.novell.com)
33 namespace Novell.Directory.Ldap
37 /// Used to provide credentials for authentication when processing a
40 /// A programmer desiring to supply authentication credentials
41 /// to the API when automatically following referrals MUST
42 /// implement this interface. If LdapAuthHandler or LdapBindHandler are not
43 /// implemented, automatically followed referrals will use anonymous
44 /// authentication. Referral URLs of any type other than Ldap (i.e. a
45 /// referral URL other than ldap://something) are not chased automatically
46 /// by the API on automatic following.
50 /// <seealso cref="LdapBindHandler">
52 /// <seealso cref="LdapConstraints.ReferralFollowing">
54 public interface LdapAuthHandler : LdapReferralHandler
57 /// <summary> Returns an object which can provide credentials for authenticating to
58 /// a server at the specified host and port.
61 /// <param name="host"> Contains a host name or the IP address (in dotted string
62 /// format) of a host running an Ldap server.
65 /// <param name="port"> Contains the TCP or UDP port number of the host.
68 /// <returns> An object with authentication credentials to the specified
71 LdapAuthProvider getAuthProvider(System.String host, int port);