mcs/class/Novell.Directory.Ldap/Novell.Directory.Ldap/LdapDeleteRequest.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.LdapDeleteRequest.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 using Novell.Directory.Ldap.Rfc2251;
  34
  35 namespace Novell.Directory.Ldap
  36 {
  37
  38         /// <summary> Represents a request to delete an entry.
  39         ///
  40         /// </summary>
  41         /// <seealso cref="LdapConnection.SendRequest">
  42         /// </seealso>
  43    /*
  44         *       DelRequest ::= [APPLICATION 10] LdapDN
  45         */
  46         public class LdapDeleteRequest:LdapMessage
  47         {
  48                 /// <summary> Returns of the dn of the entry to delete from the directory
  49                 ///
  50                 /// </summary>
  51                 /// <returns> the dn of the entry to delete
  52                 /// </returns>
  53                 virtual public System.String DN
  54                 {
  55                         get
  56                         {
  57                                 return Asn1Object.RequestDN;
  58                         }
  59
  60                 }
  61                 /// <summary> Constructs a request to delete an entry from the directory
  62                 ///
  63                 /// </summary>
  64                 /// <param name="dn">the dn of the entry to delete.
  65                 ///
  66                 /// </param>
  67                 /// <param name="cont">Any controls that apply to the abandon request
  68                 /// or null if none.
  69                 /// </param>
  70                 public LdapDeleteRequest(System.String dn, LdapControl[] cont):base(LdapMessage.DEL_REQUEST, new RfcDelRequest(dn), cont)
  71                 {
  72                         return ;
  73                 }
  74
  75                 /// <summary> Return an Asn1 representation of this delete request
  76                 ///
  77                 /// #return an Asn1 representation of this object
  78                 /// </summary>
  79                 public override System.String ToString()
  80                 {
  81                         return Asn1Object.ToString();
  82                 }
  83         }
  84 }