error messages review
[mono.git] / mcs / class / Novell.Directory.Ldap / Novell.Directory.Ldap.Extensions / GetBindDNRequest.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.GetBindDNRequest.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>  Returns the distingusihed name of the object your are logged in as.
41         /// 
42         /// To use this class, you must create an instance of the
43         /// class and then call the extendedOperation method with this
44         /// object as the required LdapExtendedOperation parameter.
45         /// 
46         /// The returned LdapExtendedResponse object can then be converted to
47         /// a GetBindDNResponse object with the ExtendedREsponseFactory
48         /// class. This object contains  methods for retrieving the distinguished
49         /// name.
50         /// 
51         /// The GetBindDNRequest extension uses the following OID:
52         /// 2.16.840.1.113719.1.27.100.31
53         /// 
54         /// The request value has a value of null.
55         /// 
56         /// </summary>
57         public class GetBindDNRequest:LdapExtendedOperation
58         {
59
60                 static GetBindDNRequest() 
61                 {
62                         /*
63                                 * Register the extendedresponse class which is returned by the
64                                 * server in response to a ListReplicasRequest
65                                 */
66                         try
67                         {
68                                 LdapExtendedResponse.register(ReplicationConstants.GET_IDENTITY_NAME_RES, System.Type.GetType("Novell.Directory.Ldap.Extensions.GetBindDNResponse"));
69                         }
70                         catch (System.Exception e)
71                         {
72                                 System.Console.Error.WriteLine("Could not register Extended Response -" + " Class not found");
73                         }
74                 }
75                 
76                 /// <summary>   Constructs an extended operation object for retrieving the bind dn.
77                 /// 
78                 /// </summary>
79                 /// <exception> LdapException A general exception which includes an error 
80                 /// message and an Ldap error code.    
81                 /// </exception>
82                 
83                 public GetBindDNRequest():base(ReplicationConstants.GET_IDENTITY_NAME_REQ, null)
84                 {
85                 }
86         }
87 }