Merge branch 'master' of ssh://github.com/mono/mono
[mono.git] / mcs / class / Novell.Directory.Ldap / Novell.Directory.Ldap.Extensions / GetReplicationFilterRequest.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.GetReplicationFilterRequest.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         /// Gets the Replication filter for all replicas on the server.
42         /// 
43         /// The filter is returned as an array of classnames-attribute names pairs. 
44         /// 
45         /// To get the filter for all replicas on a specific server, you must
46         /// create an instance of this class and then call the
47         /// extendedOperation method with this object as the required
48         /// LdapExtendedOperation parameter.
49         /// 
50         /// The GetReplicationFilterRequest extension uses the following OID:
51         /// 2.16.840.1.113719.1.27.100.37
52         /// 
53         /// The requestValue has the following format:
54         /// 
55         /// requestValue ::=
56         ///  serverName  LdapDN
57         /// </summary>
58         public class GetReplicationFilterRequest:LdapExtendedOperation
59         {
60                 
61                 static GetReplicationFilterRequest() 
62                 {
63                         /*
64                                 * Register the extendedresponse class which is returned by the
65                                 * server in response to a ListReplicasRequest
66                                 */
67                         try
68                         {
69                                 LdapExtendedResponse.register(ReplicationConstants.GET_REPLICATION_FILTER_RES, System.Type.GetType("Novell.Directory.Ldap.Extensions.GetReplicationFilterResponse"));
70                         }
71                         catch (System.Exception e)
72                         {
73                                 System.Console.Error.WriteLine("Could not register Extended Response -" + " Class not found");
74                         }
75                 }
76
77                 /// <summary> 
78                 /// Constructs an extended operations object which contains the ber encoded
79                 /// replication filter.
80                 /// 
81                 /// </summary>
82                 /// <param name="serverDN">The server whose replication filter needs to be read
83                 /// 
84                 /// </param>
85                 /// <exception> LdapException A general exception which includes an error
86                 /// message and an Ldap error code.
87                 /// </exception>
88                 public GetReplicationFilterRequest(System.String serverDN):base(ReplicationConstants.GET_REPLICATION_FILTER_REQ, null)
89                 {
90                         
91                         try
92                         {
93                                 
94                                 if ((System.Object) serverDN == null)
95                                         throw new System.ArgumentException(ExceptionMessages.PARAM_ERROR);
96                                 
97                                 System.IO.MemoryStream encodedData = new System.IO.MemoryStream();
98                                 LBEREncoder encoder = new LBEREncoder();
99                                 
100                                 Asn1OctetString asn1_serverDN = new Asn1OctetString(serverDN);
101                                 
102                                 // Add the serverDN to encoded data
103                                 asn1_serverDN.encode(encoder, encodedData);
104                                 setValue(SupportClass.ToSByteArray(encodedData.ToArray()));
105                         }
106                         catch (System.IO.IOException ioe)
107                         {
108                                 throw new LdapException(ExceptionMessages.ENCODING_ERROR, LdapException.ENCODING_ERROR, (System.String) null);
109                         }
110                 }
111         }
112 }