2010-03-02 Jb Evain <jbevain@novell.com>
[mcs.git] / class / Novell.Directory.Ldap / Novell.Directory.Ldap.Extensions / GetEffectivePrivilegesRequest.cs
blob85d193e1da8fff493bb1a4dd65d310f5c17114da
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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 *******************************************************************************/
24 // Novell.Directory.Ldap.Extensions.GetEffectivePrivilegesRequest.cs
26 // Author:
27 // Sunil Kumar (Sunilk@novell.com)
29 // (C) 2003 Novell, Inc (http://www.novell.com)
32 using System;
33 using Novell.Directory.Ldap;
34 using Novell.Directory.Ldap.Asn1;
35 using Novell.Directory.Ldap.Utilclass;
37 namespace Novell.Directory.Ldap.Extensions
40 /// <summary>
41 /// Returns the effective rights of one object to an attribute of another object.
42 ///
43 /// To use this class, you must instantiate an object of this class and then
44 /// call the extendedOperation method with this object as the required
45 /// LdapExtendedOperation parameter.
46 ///
47 /// The returned LdapExtendedResponse object can then be converted to
48 /// a GetEffectivePrivilegesResponse object with the ExtendedResponseFactory class.
49 /// The GetEffectivePrivilegesResponse class contains methods for
50 /// retrieving the effective rights.
51 ///
52 /// The getEffectivePrivilegesRequest extension uses the following OID:
53 /// 2.16.840.1.113719.1.27.100.33
54 ///
55 /// The requestValue has the following format:
56 ///
57 /// requestValue ::=
58 /// dn LdapDN
59 /// trusteeDN LdapDN
60 /// attrName LdapDN
61 /// </summary>
62 public class GetEffectivePrivilegesRequest:LdapExtendedOperation
64 static GetEffectivePrivilegesRequest()
67 * Register the extendedresponse class which is returned by the
68 * server in response to a ListReplicasRequest
70 try
72 LdapExtendedResponse.register(ReplicationConstants.GET_EFFECTIVE_PRIVILEGES_RES, System.Type.GetType("Novell.Directory.Ldap.Extensions.GetEffectivePrivilegesResponse"));
74 catch (System.Exception e)
76 System.Console.Error.WriteLine("Could not register Extended Response -" + " Class not found");
80 /// <summary> Constructs an extended operation object for checking effective rights.
81 ///
82 /// </summary>
83 /// <param name="dn"> The distinguished name of the entry whose attribute is
84 /// being checked.
85 ///
86 /// </param>
87 /// <param name="trusteeDN">The distinguished name of the entry whose trustee rights
88 /// are being returned
89 ///
90 /// </param>
91 /// <param name="attrName"> The Ldap attribute name.
92 ///
93 /// </param>
94 /// <exception> LdapException A general exception which includes an error
95 /// message and an Ldap error code.
96 /// </exception>
98 public GetEffectivePrivilegesRequest(System.String dn, System.String trusteeDN, System.String attrName):base(ReplicationConstants.GET_EFFECTIVE_PRIVILEGES_REQ, null)
104 if (((System.Object) dn == null))
105 throw new System.ArgumentException(ExceptionMessages.PARAM_ERROR);
107 System.IO.MemoryStream encodedData = new System.IO.MemoryStream();
108 LBEREncoder encoder = new LBEREncoder();
110 Asn1OctetString asn1_dn = new Asn1OctetString(dn);
111 Asn1OctetString asn1_trusteeDN = new Asn1OctetString(trusteeDN);
112 Asn1OctetString asn1_attrName = new Asn1OctetString(attrName);
114 asn1_dn.encode(encoder, encodedData);
115 asn1_trusteeDN.encode(encoder, encodedData);
116 asn1_attrName.encode(encoder, encodedData);
118 setValue(SupportClass.ToSByteArray(encodedData.ToArray()));
120 catch (System.IO.IOException ioe)
122 throw new LdapException(ExceptionMessages.ENCODING_ERROR, LdapException.ENCODING_ERROR, (System.String) null);