C# Class Novell.Directory.Ldap.LdapSchemaElement

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 UnsupportedOperationException if either of those methods are invoked by an application.

Inheritance: LdapAttribute

Exibir arquivo Open project: EventStore/csharp-ldap Class Usage Examples

Protected Properties

Property	Type	Description
hashQualifier	System.Collections.Hashtable
oid	System.String
qualifier	System.String[]

Public Methods

Method	Description
ToString ( ) : System.String	Returns a string in a format suitable for directly adding to a directory, as a value of the particular schema element.
addValue ( System value_Renamed ) : void	LdapSchemaElement is read-only and this method is over-ridden to throw an exception. @throws UnsupportedOperationException always thrown since LdapSchemaElement is read-only
getQualifier ( System name ) : System.String[]	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-").
removeValue ( System value_Renamed ) : void	LdapSchemaElement is read-only and this method is over-ridden to throw an exception. @throws UnsupportedOperationException always thrown since LdapSchemaElement is read-only
setQualifier ( System name, System values ) : void	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-").

Protected Methods

Method	Description
LdapSchemaElement ( System attrName ) : System	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.
formatString ( ) : System.String	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.

Private Methods

Method	Description
InitBlock ( ) : void

Method Details

LdapSchemaElement() protected method

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.

protected LdapSchemaElement ( System attrName ) : System
attrName	System	The attribute name of the schema definition. Valid /// names are one of the following: /// "attributeTypes", "objectClasses", "ldapSyntaxes", /// "nameForms", "dITContentRules", "dITStructureRules", /// "matchingRules", or "matchingRuleUse" ///
return	System

ToString() public method

Returns a string in a format suitable for directly adding to a directory, as a value of the particular schema element.

public ToString ( ) : System.String
return	System.String

addValue() public method

LdapSchemaElement is read-only and this method is over-ridden to throw an exception. @throws UnsupportedOperationException always thrown since LdapSchemaElement is read-only

public addValue ( System value_Renamed ) : void
value_Renamed	System
return	void

formatString() protected abstract method

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.

protected abstract formatString ( ) : System.String
return	System.String

getQualifier() public method

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-").

public getQualifier ( System name ) : System.String[]
name	System	The name of the qualifier, case-sensitive. /// ///
return	System.String[]

removeValue() public method

LdapSchemaElement is read-only and this method is over-ridden to throw an exception. @throws UnsupportedOperationException always thrown since LdapSchemaElement is read-only

public removeValue ( System value_Renamed ) : void
value_Renamed	System
return	void

setQualifier() public method

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-").

public setQualifier ( System name, System values ) : void
name	System	The name of the qualifier, case-sensitive. /// ///
values	System	The values to set for the qualifier. ///
return	void

Property Details

hashQualifier protected_oe property

A hash table that contains the vendor-specific qualifiers (for example, the X-NDS flags).

protected System.Collections.Hashtable hashQualifier
return	System.Collections.Hashtable

oid protected_oe property

The OID for the schema element.

protected String,System oid
return	System.String

qualifier protected_oe property

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".

protected String[],System qualifier
return	System.String[]