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         /// 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.
  46         ///
  47         /// The returned LdapExtendedResponse object can then be converted to
  48         /// a PartitionEntryCountResponse object. This class contains
  49         /// methods for retrieving the returned count.
  50         ///
  51         /// The PartitionEntryCountRequest extension uses the following
  52         /// OID:
  53         /// 2.16.840.1.113719.1.27.100.13
  54         ///
  55         /// The requestValue has the following format:
  56         ///
  57         /// requestValue ::=
  58         ///     dn      LdapDN
  59         /// </summary>
  60         public class PartitionEntryCountRequest:LdapExtendedOperation
  61         {
  62
  63                 static PartitionEntryCountRequest()
  64                 {
  65                         /*
  66                                 * Register the extendedresponse class which is returned by the
  67                                 * server in response to a ListReplicasRequest
  68                                 */
  69                         try
  70                         {
  71                                 LdapExtendedResponse.register(ReplicationConstants.NAMING_CONTEXT_COUNT_RES, System.Type.GetType("Novell.Directory.Ldap.Extensions.PartitionEntryCountResponse"));
  72                         }
  73                         catch (System.Exception e)
  74                         {
  75                                 System.Console.Error.WriteLine("Could not register Extended Response -" + " Class not found");
  76                         }
  77                 }
  78
  79                 /// <summary>  Constructs an extended operation object for counting entries
  80                 /// in a naming context.
  81                 ///
  82                 /// </summary>
  83                 /// <param name="dn"> The distinguished name of the partition.
  84                 ///
  85                 /// </param>
  86                 /// <exception> LdapException A general exception which includes an
  87                 /// error message and an Ldap error code.
  88                 /// </exception>
  89
  90                 public PartitionEntryCountRequest(System.String dn):base(ReplicationConstants.NAMING_CONTEXT_COUNT_REQ, null)
  91                 {
  92
  93                         try
  94                         {
  95
  96                                 if (((System.Object) dn == null))
  97                                         throw new System.ArgumentException(ExceptionMessages.PARAM_ERROR);
  98
  99                                 System.IO.MemoryStream encodedData = new System.IO.MemoryStream();
 100                                 LBEREncoder encoder = new LBEREncoder();
 101
 102                                 Asn1OctetString asn1_dn = new Asn1OctetString(dn);
 103
 104                                 asn1_dn.encode(encoder, encodedData);
 105
 106                                 setValue(SupportClass.ToSByteArray(encodedData.ToArray()));
 107                         }
 108                         catch (System.IO.IOException ioe)
 109                         {
 110                                 throw new LdapException(ExceptionMessages.ENCODING_ERROR, LdapException.ENCODING_ERROR, (System.String) null);
 111                         }
 112                 }
 113         }
 114 }