mcs/class/Novell.Directory.Ldap/Novell.Directory.Ldap.Extensions/AddReplicaRequest.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.AddReplicaRequest.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         /// Adds a replica to the specified directory server.
  42         ///
  43         /// To add a replica to a particular server, you must create an instance of
  44         /// this class and then call the extendedOperation method with this
  45         /// object as the required LdapExtendedOperation parameter.
  46         ///
  47         /// The addReplicaRequest extension uses the following OID:
  48         /// 2.16.840.1.113719.1.27.100.7
  49         ///
  50         /// The requestValue has the following format:
  51         ///
  52         /// requestValue ::=
  53         ///  flags       INTEGER
  54         ///  replicaType INTEGER
  55         ///  serverName  LdapDN
  56         ///  dn          LdapDN
  57         /// </summary>
  58         public class AddReplicaRequest:LdapExtendedOperation
  59         {
  60
  61                 /// <summary>
  62                 /// Constructs a new extended operation object for adding a replica to the
  63                 /// specified server.
  64                 ///
  65                 /// </summary>
  66                 /// <param name="dn">The distinguished name of the replica's partition root.
  67                 ///
  68                 /// </param>
  69                 /// <param name="serverDN">The server on which the new replica will be added.
  70                 ///
  71                 /// </param>
  72                 /// <param name="replicaType">The type of replica to add. The replica
  73                 /// types are defined in the ReplicationConstants class.
  74                 ///
  75                 /// </param>
  76                 /// <param name="flags">Specifies whether all servers in the replica ring must be up
  77                 /// before proceeding. When set to zero, the status of the servers is not
  78                 /// checked. When set to Ldap_ENSURE_SERVERS_UP, all servers must be up for the
  79                 /// operation to proceed.
  80                 ///
  81                 /// </param>
  82                 /// <exception> LdapException A general exception which includes an error message
  83                 /// and an Ldap error code.
  84                 ///
  85                 /// </exception>
  86                 /// <seealso cref="ReplicationConstants.Ldap_RT_MASTER">
  87                 /// </seealso>
  88                 /// <seealso cref="ReplicationConstants.Ldap_RT_SECONDARY">
  89                 /// </seealso>
  90                 /// <seealso cref="ReplicationConstants.Ldap_RT_READONLY">
  91                 /// </seealso>
  92                 /// <seealso cref="ReplicationConstants.Ldap_RT_SUBREF">
  93                 /// </seealso>
  94                 /// <seealso cref="ReplicationConstants.Ldap_RT_SPARSE_WRITE">
  95                 /// </seealso>
  96                 /// <seealso cref="ReplicationConstants.Ldap_RT_SPARSE_READ">
  97                 /// </seealso>
  98                 public AddReplicaRequest(System.String dn, System.String serverDN, int replicaType, int flags):base(ReplicationConstants.ADD_REPLICA_REQ, null)
  99                 {
 100
 101                         try
 102                         {
 103
 104                                 if (((System.Object) dn == null) || ((System.Object) serverDN == null))
 105                                         throw new System.ArgumentException(ExceptionMessages.PARAM_ERROR);
 106
 107                                 System.IO.MemoryStream encodedData = new System.IO.MemoryStream();
 108                                 LBEREncoder encoder = new LBEREncoder();
 109
 110                                 Asn1Integer asn1_flags = new Asn1Integer(flags);
 111                                 Asn1Integer asn1_replicaType = new Asn1Integer(replicaType);
 112                                 Asn1OctetString asn1_serverDN = new Asn1OctetString(serverDN);
 113                                 Asn1OctetString asn1_dn = new Asn1OctetString(dn);
 114
 115                                 asn1_flags.encode(encoder, encodedData);
 116                                 asn1_replicaType.encode(encoder, encodedData);
 117                                 asn1_serverDN.encode(encoder, encodedData);
 118                                 asn1_dn.encode(encoder, encodedData);
 119
 120                                 setValue(SupportClass.ToSByteArray(encodedData.ToArray()));
 121                         }
 122                         catch (System.IO.IOException ioe)
 123                         {
 124                                 throw new LdapException(ExceptionMessages.ENCODING_ERROR, LdapException.ENCODING_ERROR, (System.String) null);
 125                         }
 126                 }
 127         }
 128 }