mcs/class/Novell.Directory.Ldap/Novell.Directory.Ldap.Utilclass/BindProperties.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.Utilclass.BindProperties.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
  34 namespace Novell.Directory.Ldap.Utilclass
  35 {
  36
  37         /// <summary> Encapsulates an Ldap Bind properties</summary>
  38         public class BindProperties
  39         {
  40                 /// <summary> gets the protocol version</summary>
  41                 virtual public int ProtocolVersion
  42                 {
  43                         get
  44                         {
  45                                 return version;
  46                         }
  47
  48                 }
  49                 /// <summary> Gets the authentication dn
  50                 ///
  51                 /// </summary>
  52                 /// <returns> the authentication dn for this connection
  53                 /// </returns>
  54                 virtual public System.String AuthenticationDN
  55                 {
  56                         get
  57                         {
  58                                 return dn;
  59                         }
  60
  61                 }
  62                 /// <summary> Gets the authentication method
  63                 ///
  64                 /// </summary>
  65                 /// <returns> the authentication method for this connection
  66                 /// </returns>
  67                 virtual public System.String AuthenticationMethod
  68                 {
  69                         get
  70                         {
  71                                 return method;
  72                         }
  73
  74                 }
  75                 /// <summary> Gets the SASL Bind properties
  76                 ///
  77                 /// </summary>
  78                 /// <returns> the sasl bind properties for this connection
  79                 /// </returns>
  80                 virtual public System.Collections.Hashtable SaslBindProperties
  81                 {
  82                         get
  83                         {
  84                                 return bindProperties;
  85                         }
  86
  87                 }
  88
  89                 /// <summary> Gets the SASL callback handler
  90                 ///
  91                 /// </summary>
  92                 /// <returns> the sasl callback handler for this connection
  93                 /// </returns>
  94                 virtual public System.Object SaslCallbackHandler
  95                 {
  96                         get
  97                         {
  98                                 return bindCallbackHandler;
  99                         }
 100
 101                 }
 102
 103                 /// <summary> Indicates whether or not the bind properties specify an anonymous bind
 104                 ///
 105                 /// </summary>
 106                 /// <returns> true if the bind properties specify an anonymous bind
 107                 /// </returns>
 108                 virtual public bool Anonymous
 109                 {
 110                         get
 111                         {
 112                                 return anonymous;
 113                         }
 114
 115                 }
 116
 117                 private int version = 3;
 118                 private System.String dn = null;
 119                 private System.String method = null;
 120                 private bool anonymous;
 121                 private System.Collections.Hashtable bindProperties = null;
 122                 private System.Object bindCallbackHandler = null;
 123
 124                 public BindProperties(int version, System.String dn, System.String method, bool anonymous, System.Collections.Hashtable bindProperties, System.Object bindCallbackHandler)
 125                 {
 126                         this.version = version;
 127                         this.dn = dn;
 128                         this.method = method;
 129                         this.anonymous = anonymous;
 130                         this.bindProperties = bindProperties;
 131                         this.bindCallbackHandler = bindCallbackHandler;
 132                 }
 133         }
 134 }