mcs/class/Novell.Directory.Ldap/Novell.Directory.Ldap.Extensions/PartitionEntryCountRequest.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.Extensions.PartitionEntryCountRequest.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;
  34 using Novell.Directory.Ldap.Asn1;
  35 using Novell.Directory.Ldap.Utilclass;
  36
  37 namespace Novell.Directory.Ldap.Extensions
  38 {
  39
  40         /// <summary>  Returns a count of the number of entries (objects) in the
  41         /// specified partition.
  42         ///
  43         /// <p>To obtain the count of entries, you must create an instance of this
  44         /// class and then call the extendedOperation method with this
  45         /// object as the required LdapExtendedOperation parameter.</p>
  46         ///
  47         /// <p>The returned LdapExtendedResponse object can then be converted to
  48         /// a PartitionEntryCountResponse object. This class contains
  49         /// methods for retrieving the returned count.</p>
  50         ///
  51         /// <p>The PartitionEntryCountRequest extension uses the following
  52         /// OID:<br>
  53         /// &nbsp;&nbsp;&nbsp;2.16.840.1.113719.1.27.100.13</p>
  54         ///
  55         /// <p>The requestValue has the following format:<br>
  56         ///
  57         /// requestValue ::=<br><br>
  58         /// &nbsp;&nbsp;&nbsp;&nbsp;    dn &nbsp;&nbsp;&nbsp;     LdapDN
  59         /// </summary>
  60         public class PartitionEntryCountRequest:LdapExtendedOperation
  61         {
  62
  63                 /// <summary>  Constructs an extended operation object for counting entries
  64                 /// in a naming context.
  65                 ///
  66                 /// </summary>
  67                 /// <param name="dn"> The distinguished name of the partition.
  68                 ///
  69                 /// </param>
  70                 /// <exception cref=""> LdapException A general exception which includes an
  71                 /// error message and an Ldap error code.
  72                 /// </exception>
  73
  74                 public PartitionEntryCountRequest(System.String dn):base(ReplicationConstants.NAMING_CONTEXT_COUNT_REQ, null)
  75                 {
  76
  77                         try
  78                         {
  79
  80                                 if (((System.Object) dn == null))
  81                                         throw new System.ArgumentException(ExceptionMessages.PARAM_ERROR);
  82
  83                                 System.IO.MemoryStream encodedData = new System.IO.MemoryStream();
  84                                 LBEREncoder encoder = new LBEREncoder();
  85
  86                                 Asn1OctetString asn1_dn = new Asn1OctetString(dn);
  87
  88                                 asn1_dn.encode(encoder, encodedData);
  89
  90                                 setValue(SupportClass.ToSByteArray(encodedData.ToArray()));
  91                         }
  92                         catch (System.IO.IOException ioe)
  93                         {
  94                                 throw new LdapException(ExceptionMessages.ENCODING_ERROR, LdapException.ENCODING_ERROR, (System.String) null);
  95                         }
  96                 }
  97         }
  98 }