1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
|
/******************************************************************************
* The MIT License
* Copyright (c) 2003 Novell Inc. www.novell.com
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the Software), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*******************************************************************************/
//
// Novell.Directory.Ldap.LdapSchemaElement.cs
//
// Author:
// Sunil Kumar (Sunilk@novell.com)
//
// (C) 2003 Novell, Inc (http://www.novell.com)
//
using System;
using Novell.Directory.Ldap.Utilclass;
namespace Novell.Directory.Ldap
{
/// <summary> The LdapSchemaElement class is the base class representing schema
/// elements (definitions) in Ldap.
///
/// An LdapSchemaElement is read-only, single-valued LdapAttribute.
/// Therefore, it does not support the addValue and removeValue methods from
/// LdapAttribute. This class overrides those methods and throws
/// <code>UnsupportedOperationException</code> if either of those methods are
/// invoked by an application.
///
/// </summary>
/// <seealso cref="LdapSchema">
/// </seealso>
/// <seealso cref="LdapConnection.FetchSchema">
/// </seealso>
public abstract class LdapSchemaElement:LdapAttribute
{
private void InitBlock()
{
hashQualifier = new System.Collections.Hashtable();
}
/// <summary> Returns an array of names for the element, or null if
/// none is found.
///
/// The getNames method accesses the NAME qualifier (from the BNF
/// descriptions of Ldap schema definitions). The array consists of all
/// values of the NAME qualifier.
///
/// </summary>
/// <returns> An array of names for the element, or null if none
/// is found.
/// </returns>
virtual public System.String[] Names
{
get
{
if (names == null)
return null;
System.String[] generated_var = new System.String[names.Length];
names.CopyTo(generated_var, 0);
return generated_var;
}
}
/// <summary> Returns the description of the element.
///
/// The getDescription method returns the value of the DESC qualifier
/// (from the BNF descriptions of Ldap schema definitions).
///
/// </summary>
/// <returns> The description of the element.
///
/// </returns>
virtual public System.String Description
{
get
{
return description;
}
}
/// <summary> Returns the unique object identifier (OID) of the element.
///
/// </summary>
/// <returns> The OID of the element.
/// </returns>
virtual public System.String ID
{
get
{
return oid;
}
}
/// <summary> Returns an enumeration of all qualifiers of the element which are
/// vendor specific (begin with "X-").
///
/// </summary>
/// <returns> An enumeration of all qualifiers of the element.
/// </returns>
virtual public System.Collections.IEnumerator QualifierNames
{
get
{
return new EnumeratedIterator(new SupportClass.SetSupport(hashQualifier.Keys).GetEnumerator());
}
}
/// <summary> Returns whether the element has the OBSOLETE qualifier
/// in its Ldap definition.
///
/// </summary>
/// <returns> True if the Ldap definition contains the OBSOLETE qualifier;
/// false if OBSOLETE qualifier is not present.
/// </returns>
virtual public bool Obsolete
{
get
{
return obsolete;
}
}
/// <summary> Creates an LdapSchemaElement by setting the name of the LdapAttribute.
/// Because this is the only constructor, all extended classes are expected
/// to call this constructor. The value of the LdapAttribute must be set
/// by the setValue method.
/// </summary>
/// <param name="attrName"> The attribute name of the schema definition. Valid
/// names are one of the following:
/// "attributeTypes", "objectClasses", "ldapSyntaxes",
/// "nameForms", "dITContentRules", "dITStructureRules",
/// "matchingRules", or "matchingRuleUse"
/// </param>
protected internal LdapSchemaElement(System.String attrName):base(attrName)
{
InitBlock();
}
/// <summary> The names of the schema element.</summary>
[CLSCompliantAttribute(false)]
protected internal System.String[] names = new System.String[]{""};
/// <summary> The OID for the schema element.</summary>
protected internal System.String oid = "";
/// <summary> The description for the schema element.</summary>
[CLSCompliantAttribute(false)]
protected internal System.String description = "";
/// <summary> If present, indicates that the element is obsolete, no longer in use in
/// the directory.
/// </summary>
[CLSCompliantAttribute(false)]
protected internal bool obsolete = false;
/// <summary> A string array of optional, or vendor-specific, qualifiers for the
/// schema element.
///
/// These optional qualifiers begin with "X-"; the Novell eDirectory
/// specific qualifiers begin with "X-NDS".
/// </summary>
protected internal System.String[] qualifier = new System.String[]{""};
/// <summary> A hash table that contains the vendor-specific qualifiers (for example,
/// the X-NDS flags).
/// </summary>
protected internal System.Collections.Hashtable hashQualifier;
/// <summary> Returns an array of all values of a specified optional or non-
/// standard qualifier of the element.
///
/// The getQualifier method may be used to access the values of
/// vendor-specific qualifiers (which begin with "X-").
///
/// </summary>
/// <param name="name"> The name of the qualifier, case-sensitive.
///
/// </param>
/// <returns> An array of values for the specified non-standard qualifier.
/// </returns>
public virtual System.String[] getQualifier(System.String name)
{
AttributeQualifier attr = (AttributeQualifier) hashQualifier[name];
if (attr != null)
{
return attr.Values;
}
return null;
}
/// <summary> Returns a string in a format suitable for directly adding to a directory,
/// as a value of the particular schema element.
///
/// </summary>
/// <returns> A string that can be used to add the element to the directory.
/// </returns>
public override System.String ToString()
{
return formatString();
}
/// <summary> Implementations of formatString format a schema element into a string
/// suitable for using in a modify (ADD) operation to the directory.
/// toString uses this method. This method is needed because a call to
/// setQualifier requires reconstructing the string value of the schema
/// element.
/// </summary>
abstract protected internal System.String formatString();
/// <summary> Sets the values of a specified optional or non-standard qualifier of
/// the element.
///
/// The setQualifier method is used to set the values of vendor-
/// specific qualifiers (which begin with "X-").
///
/// </summary>
/// <param name="name"> The name of the qualifier, case-sensitive.
///
/// </param>
/// <param name="values"> The values to set for the qualifier.
/// </param>
public virtual void setQualifier(System.String name, System.String[] values)
{
AttributeQualifier attrQualifier = new AttributeQualifier(name, values);
SupportClass.PutElement(hashQualifier, name, attrQualifier);
/*
* This is the only method that modifies the schema element.
* We need to reset the attribute value since it has changed.
*/
base.Value = formatString();
return ;
}
/// <summary> LdapSchemaElement is read-only and this method is over-ridden to
/// throw an exception.
/// @throws UnsupportedOperationException always thrown since
/// LdapSchemaElement is read-only
/// </summary>
public override void addValue(System.String value_Renamed)
{
throw new System.NotSupportedException("addValue is not supported by LdapSchemaElement");
}
/// <summary> LdapSchemaElement is read-only and this method is over-ridden to
/// throw an exception.
/// @throws UnsupportedOperationException always thrown since
/// LdapSchemaElement is read-only
/// </summary>
public virtual void addValue(System.Byte[] value_Renamed)
{
throw new System.NotSupportedException("addValue is not supported by LdapSchemaElement");
}
/// <summary> LdapSchemaElement is read-only and this method is over-ridden to
/// throw an exception.
/// @throws UnsupportedOperationException always thrown since
/// LdapSchemaElement is read-only
/// </summary>
public override void removeValue(System.String value_Renamed)
{
throw new System.NotSupportedException("removeValue is not supported by LdapSchemaElement");
}
/// <summary> LdapSchemaElement is read-only and this method is over-ridden to
/// throw an exception.
/// @throws UnsupportedOperationException always thrown since
/// LdapSchemaElement is read-only
/// </summary>
public virtual void removeValue(System.Byte[] value_Renamed)
{
throw new System.NotSupportedException("removeValue is not supported by LdapSchemaElement");
}
}
}
|