* roottypes.cs: Rename from tree.cs.
[mono.git] / mcs / class / Novell.Directory.Ldap / Novell.Directory.Ldap.Extensions / RemoveReplicaRequest.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.RemoveReplicaRequest.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         /// Removes a replica from the specified directory server.
42         /// 
43         /// To remove a replica from a particular server, 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 removeReplicaRequest extension uses the following OID:
48         /// 2.16.840.1.113719.1.27.100.11
49         /// 
50         /// The requestValue has the following format:
51         /// 
52         /// requestValue ::=
53         ///         flags        INTEGER
54         ///         serverName   LdapDN
55         ///         dn           LdapDN
56         /// </summary>
57         public class RemoveReplicaRequest:LdapExtendedOperation
58         {
59                 
60                 /// <summary> Constructs an extended operation object for removing a replica.
61                 /// 
62                 /// </summary>
63                 /// <param name="dn">         The distinguished name of the replica's
64                 /// partition root.
65                 /// 
66                 /// </param>
67                 /// <param name="serverDN">   The distinguished name of server from which the replica
68                 /// will be removed.
69                 /// 
70                 /// </param>
71                 /// <param name="flags">  Determines whether all servers in the replica ring must
72                 /// be up before proceeding. When set to zero, the status of the
73                 /// servers is not checked. When set to Ldap_ENSURE_SERVERS_UP,
74                 /// all servers must be up for the operation to proceed.
75                 /// 
76                 /// </param>
77                 /// <exception> LdapException A general exception which includes an error message
78                 /// and an Ldap error code.
79                 /// </exception>
80                 public RemoveReplicaRequest(System.String dn, System.String serverDN, int flags):base(ReplicationConstants.DELETE_REPLICA_REQ, null)
81                 {
82                         
83                         try
84                         {
85                                 
86                                 if (((System.Object) dn == null) || ((System.Object) serverDN == null))
87                                         throw new System.ArgumentException(ExceptionMessages.PARAM_ERROR);
88                                 
89                                 System.IO.MemoryStream encodedData = new System.IO.MemoryStream();
90                                 LBEREncoder encoder = new LBEREncoder();
91                                 
92                                 Asn1Integer asn1_flags = new Asn1Integer(flags);
93                                 Asn1OctetString asn1_serverDN = new Asn1OctetString(serverDN);
94                                 Asn1OctetString asn1_dn = new Asn1OctetString(dn);
95                                 
96                                 asn1_flags.encode(encoder, encodedData);
97                                 asn1_serverDN.encode(encoder, encodedData);
98                                 asn1_dn.encode(encoder, encodedData);
99                                 
100                                 setValue(SupportClass.ToSByteArray(encodedData.ToArray()));
101                         }
102                         catch (System.IO.IOException ioe)
103                         {
104                                 throw new LdapException(ExceptionMessages.ENCODING_ERROR, LdapException.ENCODING_ERROR, (System.String) null);
105                         }
106                 }
107         }
108 }