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