mcs/class/Novell.Directory.Ldap/Novell.Directory.Ldap.Extensions/ListReplicasRequest.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.ListReplicasRequest.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>
  41         /// Lists all the replicas that reside on the the specified directory server.
  42         ///
  43         /// To list replicas, you must create an instance
  44         /// of this class and then call the extendedOperation method with this
  45         /// object as the required LdapExtendedOperation parameter.
  46         ///
  47         /// The listReplicaRequest extension uses the following OID:
  48         /// 2.16.840.1.113719.1.27.100.19
  49         ///
  50         /// The requestValue has the following format:
  51         ///
  52         /// requestValue ::=
  53         ///   serverName  LdapDN
  54         /// </summary>
  55         public class ListReplicasRequest:LdapExtendedOperation
  56         {
  57                 static ListReplicasRequest()
  58                 {
  59                         /*
  60                                 * Register the extendedresponse class which is returned by the
  61                                 * server in response to a ListReplicasRequest
  62                                 */
  63                         try
  64                         {
  65                                 LdapExtendedResponse.register(ReplicationConstants.LIST_REPLICAS_RES, System.Type.GetType("Novell.Directory.Ldap.Extensions.ListReplicasResponse"));
  66                         }
  67                         catch (System.Exception e)
  68                         {
  69                                 System.Console.Error.WriteLine("Could not register Extended Response -" + " Class not found");
  70                         }
  71                 }
  72
  73                 /// <summary>  Constructs an extended operation object for listing replicas.
  74                 ///
  75                 /// </summary>
  76                 /// <param name="serverName">The server which contains replicas.
  77                 ///
  78                 /// </param>
  79                 /// <exception> LdapException A general exception which includes an error
  80                 /// message and an Ldap error code.
  81                 /// </exception>
  82                 public ListReplicasRequest(System.String serverName):base(ReplicationConstants.LIST_REPLICAS_REQ, null)
  83                 {
  84                         try
  85                         {
  86
  87                                 if ((System.Object) serverName == null)
  88                                         throw new System.ArgumentException(ExceptionMessages.PARAM_ERROR);
  89
  90                                 System.IO.MemoryStream encodedData = new System.IO.MemoryStream();
  91                                 LBEREncoder encoder = new LBEREncoder();
  92
  93                                 Asn1OctetString asn1_serverName = new Asn1OctetString(serverName);
  94
  95                                 asn1_serverName.encode(encoder, encodedData);
  96
  97                                 setValue(SupportClass.ToSByteArray(encodedData.ToArray()));
  98                         }
  99                         catch (System.IO.IOException ioe)
 100                         {
 101                                 throw new LdapException(ExceptionMessages.ENCODING_ERROR, LdapException.ENCODING_ERROR, (System.String) null);
 102                         }
 103                 }
 104         }
 105 }