Novell Documentation: Novell Nsure Identity Manager Driver Kit

query-schema

Specifies an input which returns an XML document that describes the schema of the target application.

Description

The query-schema command is an input command or event. It is used to read the schema definition from eDirectory or the external application. It includes only one piece of data, an event-id which identifies the command. Currently this is an optional command, but if it is not implemented, rule configuration is more difficult.

The DirXML engine has implemented this command so that

The DirXML driver and the ConsoleOne snapin can query eDirectory and receive back an XML schema-def document that defines the eDirectory schema.
The DirXML engine and ConsoleOne snapin can query the DirXML driver and receive back an XML schema-def document that defines the schema of the external application.

Definition

  <!ELEMENT query-schema       EMPTY>
  <!ATTLIST query-schema
            event-id           CDATA          #IMPLIED>

Attributes

event-id: Specifies an identifier used to identify a particular instance of the command or event.

Request Format

The request command or event includes the event-id attribute.

Reply Format

The receiving application should respond to a query-schema command with a schema-def document and a status command indicating whether the command was processed successfully.

Parent

input

Remarks

If the DirXML driver implements this command, the DirXML engine queries the driver for its schema and stores the returned XML document in the DirXML-ApplicationSchema attribute of the driver object. The DriverShim init method should include procedures to update the DirXML-ApplicationSchema attribute when the schema of the external application is modified.

For more information on the format of the schema-def document, see schema-def.

Example

  <query-schema/>