mcs/class/Novell.Directory.Ldap/Novell.Directory.Ldap/LdapAuthHandler.cs

   1 /******************************************************************************
   2 * The MIT License
   3 * Copyright (c) 2003 Novell Inc.  www.novell.com
   4 *
   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:
  11 *
  12 * The above copyright notice and this permission notice shall be included in
  13 * all copies or substantial portions of the Software.
  14 *
  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
  21 * SOFTWARE.
  22 *******************************************************************************/
  23 //
  24 // Novell.Directory.Ldap.LdapAuthHandler.cs
  25 //
  26 // Author:
  27 //   Sunil Kumar (Sunilk@novell.com)
  28 //
  29 // (C) 2003 Novell, Inc (http://www.novell.com)
  30 //
  31
  32 using System;
  33 namespace Novell.Directory.Ldap
  34 {
  35
  36         /// <summary>
  37         /// Used to provide credentials for authentication when processing a
  38         /// referral.
  39         ///
  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.
  47         ///
  48         ///
  49         /// </summary>
  50         /// <seealso cref="LdapBindHandler">
  51         /// </seealso>
  52         /// <seealso cref="LdapConstraints.ReferralFollowing">
  53         /// </seealso>
  54         public interface LdapAuthHandler : LdapReferralHandler
  55                 {
  56
  57                         /// <summary> Returns an object which can provide credentials for authenticating to
  58                         /// a server at the specified host and port.
  59                         ///
  60                         /// </summary>
  61                         /// <param name="host">   Contains a host name or the IP address (in dotted string
  62                         /// format) of a host running an Ldap server.
  63                         ///
  64                         /// </param>
  65                         /// <param name="port">   Contains the TCP or UDP port number of the host.
  66                         ///
  67                         /// </param>
  68                         /// <returns> An object with authentication credentials to the specified
  69                         /// host and port.
  70                         /// </returns>
  71                         LdapAuthProvider getAuthProvider(System.String host, int port);
  72                 }
  73 }