IAdmServiceSchema

The IAdmServiceSchema interface represents the directory schema managed by the Adaxes service.

Methods

Properties

Details

GetClassesByName()

Returns a collection of schema object classes by name. Each schema class object in the collection is represented by the IAdmClass interface.

IADsCollection GetClassesByName(string objectClassName)

---

GetPropertiesByName()

Returns a collection of property types by name.

IADsCollection GetPropertiesByName(string propertyName)

---

QueryProperties()

Returns a collection of schema properties that the specified object classes contain. Each property in the collection is represented by the IAdmProperty interface.

IADsCollection QueryProperties(string[] objectClassNames,
                               int queryCriteria,
                               bool sharedOnly)

Parameters

• objectClassNames - Specifies an array of object class names to collect properties for.
• queryCriteria - Specifies the filter criterion that determines whether the property type should be included in the resulting collection.
• sharedOnly - Specifies whether only the properties that are shared among all the classes specified by the objectClassNames parameter will be included in the resulting collection.

---

LookupClass()

Returns an object class by name.

IADsClass LookupClass(string objectClassName, string contextName)

Parameters

• objectClassName - Specifies the name of the object class to get.
• contextName - Specifies the name of the forest to lookup the object class for. If this parameter is set to null, the method looks up in the backend server schema (ADAM or AD LDS).

---

LookupProperty()

Returns a property type by name.

IADsProperty LookupClass(string propertyName, string contextName)

Parameters

• propertyName - Specifies the name of the property to get.
• contextName - Specifies the name of the forest to lookup the property type for. If this parameter is set to null, the method looks up in the backend server schema (ADAM or AD LDS).

---

GetInstantiatedObjectClass()

Returns the name of the main structural object class among given.

string GetInstantiatedObjectClass(string[] objectClassNames)

Parameters

The objectClassNames parameter specifies the names of object classes (e.g. user) to check.

---

GetPropertyDirectoryType()

Returns types of directories where the property is defined for the specified object class.

DirectoryTypes GetPropertyDirectoryType(string propertyName, string objectClassName)

Parameters

• propertyName - Specifies the name of the property as defined in the directory schema.
• objectClassName - Specifies the name of the object class (e.g. user).

---

LastModificationTime

Gets the time of the last schema modification.

---

Syntaxes

Gets a collection of schema syntax objects. Each syntax object in the collection is represented by the IAdmSyntax interface.

---

Properties

Gets a collection of schema property objects. Each property object in the collection is represented by the IAdmProperty interface.

---

Classes

Gets a collection of schema class objects. Each class object in the collection is represented by the IAdmClass interface.

---

MatchingRules

Gets a collection of schema matching rule objects. Each matching rule object in the collection is represented by the IAdmMatchingRule interface.

---

Requirements

Minimum required version: 2023

See also

• IADsCollection
• DirectoryTypes