For registering extended responses
[mono.git] / mcs / class / Novell.Directory.Ldap / Novell.Directory.Ldap.Utilclass / RespExtensionSet.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.Utilclass.RespExtensionSet.cs
25 //
26 // Author:
27 //   Sunil Kumar (Sunilk@novell.com)
28 //
29 // (C) 2003 Novell, Inc (http://www.novell.com)
30 //
31 using System;
32 namespace Novell.Directory.Ldap.Utilclass
33 {
34         
35         /// <summary> This  class  extends the AbstractSet and Implements the Set
36         /// so that it can be used to maintain a list of currently
37         /// registered extended responses.
38         /// </summary>
39         public class RespExtensionSet:SupportClass.AbstractSetSupport
40         {
41                 /// <summary> Returns the number of extensions in this set.
42                 /// 
43                 /// </summary>
44                 /// <returns> number of extensions in this set.
45                 /// </returns>
46                 public override int Count
47                 {
48                         get
49                         {
50                                 return this.map.Count;
51                         }
52                         
53                 }
54                 
55                 private System.Collections.Hashtable map;
56                 
57                 public RespExtensionSet():base()
58                 {
59                         map = new System.Collections.Hashtable();
60                         return ;
61                 }
62                 
63                 
64                 /* Adds a responseExtension to the current list of registered responses.
65                 *
66                 */
67                 public void  registerResponseExtension(System.String oid, System.Type extClass)
68                 {
69                         lock (this)
70                         {
71                                 
72                                 if (!this.map.ContainsKey(oid))
73                                 {
74                                         this.map.Add(oid, (System.Type) extClass);
75                                 }
76                         }
77                 }
78                 
79                 /// <summary> Returns an iterator over the responses in this set.  The responses
80                 /// returned from this iterator are not in any particular order.
81                 /// 
82                 /// </summary>
83                 /// <returns> iterator over the responses in this set
84                 /// </returns>
85                 public override System.Collections.IEnumerator GetEnumerator()
86                 {
87                         return this.map.Values.GetEnumerator();
88                 }
89                 
90                 /* Searches the list of registered responses for a mathcing response.  We
91                 * search using the OID string.  If a match is found we return the
92                 * Class name that was provided to us on registration.
93                 */
94                 public System.Type findResponseExtension(System.String searchOID)
95                 {
96                         lock (this)
97                         {
98                                 if (this.map.ContainsKey(searchOID))
99                                 {
100                                         return (System.Type) this.map[searchOID];
101                                 }
102                                 /* The requested extension does not have a registered response class */
103                                 return null;
104                         }
105                 }
106         }
107 }