1 / 80

Novell DirXML ™ Commands, Events, and Transformations

Novell DirXML ™ Commands, Events, and Transformations. Shon Vella Software Engineer, Consultant Novell, Inc. svella@novell.com Perin Blanchard Software Engineer, Consultant Novell, Inc. pblanchard@novell.com. DirXML ™ and XML. DirXML is a flexible data sharing service

etana
Download Presentation

Novell DirXML ™ Commands, Events, and Transformations

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Novell DirXML™ Commands, Events, and Transformations Shon Vella Software Engineer, Consultant Novell, Inc. svella@novell.com Perin Blanchard Software Engineer, Consultant Novell, Inc. pblanchard@novell.com

  2. DirXML™ and XML • DirXML is a flexible data sharing service • Shares data between disparate systems throughout the network • Flexibility is achieved by encoding the shared data in XML and using configurable rules to transform the data as it is transferred between systems • In order to use DirXML effectively to implement complex business processes it is necessary to understand DirXML’s XML vocabulary and the ways that the XML can be transformed by rules

  3. Vision…one Net A world where networks of all types—corporate and public, intranets, extranets, and the Internet—work together as one Net and securely connect employees, customers, suppliers, and partners across organizational boundaries Mission To solve complex business and technical challenges with Net business solutions that enable people, processes, and systems to work together and our customers to profit from the opportunities of a networked world

  4. DirXML and XSLT • XSLT is a transformation language for XML • XSLT is an acronym for eXtensible Stylesheet Language Transformations • XSLT 1.0 is a World Wide Web Consortium (W3C) recommendation published in 1999 • XSLT is a vocabulary of XML that specifies transformation semantics that operate on XML documents • DirXML uses XSLT 1.0 as a method of implementing rules

  5. Convert an XML document For display in HTML as An Introductory Stylesheet <person> <given-name>John</given-name> <surname>Doe</surname> <telephone>801-555-1234</telephone> </person> <html> <body> First name: John<br> Last name: Doe<br> Phone: 801-555-1234<br> </body> </html>

  6. An Introductory Stylesheet:Stylesheet Element <xsl:transform xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> <xsl:template match="person"> <html><body> First name: <xsl:apply-templates select="given-name"/><br/> Last name: <xsl:apply-templates select="surname"/><br/> Phone: <xsl:apply-templates select="telephone"/><br/> </body></html> </xsl:template> </xsl:transform>

  7. An Introductory Stylesheet:Namespace and Instructions <xsl:transformxmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> <xsl:template match="person"> <html><body> First name: <xsl:apply-templates select="given-name"/><br/> Last name: <xsl:apply-templates select="surname"/><br/> Phone: <xsl:apply-templates select="telephone"/><br/> </body></html> </xsl:template> </xsl:transform>

  8. An Introductory Stylesheet:Templates and Match Patterns <xsl:transform xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> <xsl:template match="person"> <html><body> First name: <xsl:apply-templates select="given-name"/><br/> Last name: <xsl:apply-templates select="surname"/><br/> Phone: <xsl:apply-templates select="telephone"/><br/> </body></html> </xsl:template> </xsl:transform>

  9. An Introductory Stylesheet:Recursion and XPath Expressions <xsl:transform xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> <xsl:template match="person"> <html><body> First name: <xsl:apply-templates select="given-name"/><br/> Last name: <xsl:apply-templates select="surname"/><br/> Phone: <xsl:apply-templates select="telephone"/><br/> </body></html> </xsl:template> </xsl:transform>

  10. An Introductory Stylesheet:Literal Result Elements and Text <xsl:transform xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> <xsl:template match="person"> <html><body> First name: <xsl:apply-templates select="given-name"/><br/> Last name: <xsl:apply-templates select="surname"/><br/> Phone: <xsl:apply-templates select="telephone"/><br/> </body></html> </xsl:template> </xsl:transform>

  11. Event Event caching API DirXML application shim DirXML engine Novell eDirectory™ DirXML Application eDirectory server DirXML Architecture

  12. NDS.DTD • NDS.DTD defines document structure for • Commands and events in the DirXML Engine (XDS) • The simple form of the following DirXML rules • Schema mapping rules • Matching rules • Create rules • Placement rules • The NDS.DTD file, together with documentation on semantics and usage, is available in the NDK • http://developer.novell.com/ndk/dirxml.htm

  13. DirXML’s XML Vocabulary • DirXML defines an XML vocabulary that DirXML uses to encode data events and commands • The vocabulary is called XDS • XDS documents are used as the medium of communication between the DirXML engine and a DirXML application shim • Used internally by the DirXML engine • Operated on by DirXML rules • XDS is user-extensible and is not validated against the DTD by the DirXML engine

  14. Input and Output Documents • An XDS document consists of an <nds> element with an optional <source> element and a single <input> or <output> element • Documents used to report data events from eDirectory or from an application are input documents • Documents used to command eDirectory or an application to perform an action are input documents • Documents returned in response to an input document are output documents

  15. Input Example An application shim is sent the following document as input <nds dtdversion="1.1" ndsversion="8.5"> <source> <product version="1.1">DirXML</product> <contact>Novell, Inc.</contact> </source> <input> <add class-name="User" src-dn="Users\Julia" dest-dn="cn=Julia,o=Users" event-id="0"> <add-attr attr-name="Surname"> <value type="string">Gulia</value> </add-attr> </add> </input> </nds>

  16. Output Example The application shim might respond with <nds dtdversion="1.1" ndsversion="8.5"> <output> <status event-id="0" level="success"/> <add-association dest-dn="Users\Julia">JuliaGulia1</add-association> </output> </nds>

  17. Events vs. Commands • An event is a report of a data change event in either Novell eDirectoryor an application • A command is an instruction to either eDirectory or an application • When an event notification is sent to DirXML the DirXML engine will determine, based on the rules, what commands need to be issued to keep the data synchronized

  18. Input Events and Commands • Events and commands that may be children of an <input> element include • <add> • <modify> • <delete> • <rename> • <move> • <query> • Other allowed children of <input> are less frequently used

  19. Input Events and Commands • The <add>, <modify>, <delete>, <rename>, and <move> elements represent both commands and events • Commands and events have essentially the same syntax • Interpretation depends on context • Events are sent to the DirXML engine by the application shim and by eDirectory • Commands are sent to the application shim and to eDirectory by DirXML

  20. Output Responses • Events and commands that can be children of an <output> element include • <status> • <instance> • <add-association> • Other allowed children of <output> are less frequently used

  21. Common Attributes • Attributes common to many events and commands and responses include • class-name • The base class of the object • dest-dn • The DN of the target object for commands • src-dn • The DN of the source object for events • event-id • An identifier used to tag the results of an event or command

  22. Common Content Elements • Content elements that are common to many events, commands, and responses include • <association> • <value> • <component>

  23. Association • The value of the <association> element is a unique key provided by the application shim used to identify the source application object of an event or the target application object of a command • The key is used to associate objects in eDirectory with an object in another application and is stored as an attribute of the eDirectory object • The state attribute is used internally by DirXML for control purposes

  24. Value • <value> elements are used to represent object values or properties • The type attribute is used to determine how to interpret the <value> content • “Octet” values contain base64-encoded binary data • “Structured” values consist of zero or more <component> elements • All other value types use a simple string representation of the value • The association-ref attribute is used in conjunction with referential attributes

  25. Values Examples • Example <value> elements • <value type="string">Fred</value> • <value type="octet">RM8FFyP21kirzwqLjr+Q6g==</value> • <value type="structured"> • <component name="protectedName">[All Attributes Rights]</component> • <component name="trustee" association-ref="cn=b,o=n">\TREE\O\Admin</component> • <component name="privileges">2</component> • </value>

  26. Status • A <status> element is used to return the status of processing a command or event • More than one <status> element can be returned as a result of a given event or command • The level attribute indicates the disposition of the associated event or command • Possible values “success”, “warning”, “error”, “retry”, and “fatal” • The event-id attribute—the event-ID value of the corresponding event or command element • The content is a specific error or warning message

  27. Status Examples • Example <status> elements <status event-id="0" level="success"/> <status event-id="37" level="warning">Operation vetoed by Placement Rule</status> <status event-id="4" level="error">ERR_NO_ACCESS</status>

  28. Add • An <add> element is used • As an event from an application shim or from eDirectory notifying DirXML that an object was added • As a command from DirXML instructing an application shim to add an object in the application or instructing eDirectory to add an object

  29. Add Example • A simple object-creation event from a hypothetical application • <nds dtdversion="1.0" ndsversion="8.5"> • <input> • <add class-name="User" src-dn="cn=John Doe,o=novell"> • <association>JDoe2474</association> • <add-attr attr-name="Given Name"> • <value type="string">John</value> • </add-attr> • <add-attr attr-name="Surname"> • <value type="string">Doe</value> • </add-attr> • <add-attr attr-name="Telephone Number"> • <value type="string">555-2474</value> • </add-attr> • </add> • </input> • </nds>

  30. Modify • A <modify> element is used • As an event from an application shim or from eDirectory notifying DirXML that one or more of an object’s attribute values were modified • As a command from DirXML instructing an application shim to modify attribute values in an application object or instructing eDirectory to modify attribute values in an eDirectory object

  31. Modify Example • A simple object-modification event from a hypothetical application • <nds dtdversion="1.0" ndsversion="8.5"> • <input> • <modify class-name="User" src-dn="cn=John Doe,o=novell"> • <association>JDoe2474</association> • <modify-attr attr-name="Telephone Number"> • <remove-value> • <value type="string">555-2474</value> • </remove-value> • <add-value> • <value type="string">555-1234</value> • </add-value> • </modify-attr> • </modify> • </input> • </nds>

  32. Rename • A <rename> element is used • As an event from an application shim or from eDirectory notifying DirXML that an object was renamed • As a command from DirXML instructing an application shim to rename an application object or from DirXML instructing eDirectory to rename an eDirectory object

  33. Rename Example • A simple object-rename event from a hypothetical application <nds dtdversion="1.0" ndsversion="8.5"> <input> <rename class-name="User" src-dn="cn=JDoe,o=novell" old-src-dn="cn=John Doe,o=novell"> <association>JDoe2474</association> <new-name>JDoe</new-name> </rename> </input> </nds>

  34. Move • A <move> element is used • As an event from an application shim or from eDirectory notifying DirXML that an object was moved • As a command from DirXML instructing an application shim to move an application object or from DirXML instructing eDirectory to move an eDirectory object

  35. Move Example • A simple object-move event from a hypothetical application <nds dtdversion="1.0" ndsversion="8.5"> <input> <move class-name="User" src-dn="cn=JDoe,o=Inactive" old-src-dn="cn=JDoe,o=novell"> <association>JDoe2474</association> <parent src-dn="o=Inactive"> <association>TC234689887</association> </parent> </move> </input> </nds>

  36. Query • A <query> element is used as a command instructing an application shim or eDirectory to find and/or read objects and their attributes • Queries are limited by specification of • A base object • Scope • Entry, subordinates, or subtree • Classes to include • Attribute values to search for • Attributes to return in the response

  37. Query (cont.) • A query that reads attributes values from an object <nds dtdversion="1.0" ndsversion="8.5"> <input> <query class-name="User" scope="entry"> <association>JDoe2474</association> <read-attr attr-name="Telephone Number"/> </query> </input> </nds>

  38. Query (cont.) • A query that searches for objects of a particular class with particular attribute values <nds dtdversion="1.0" ndsversion="8.5"> <input> <query class-name="User" scope="subtree"> <search-class class-name="User"/> <search-attr attr-name="Given Name"> <value type="string">John</value> </search-attr> <read-attr/> </query> </input> </nds>

  39. Query Response • Zero or more <instance> elements are contained in the response to a query

  40. Query Response Example • A potential response to a query that reads an attribute value from an object • <nds dtdversion="1.0" ndsversion="8.5"> • <output> • <instance class-name="User" src-dn="cn=JDoe,o=Inactive"> • <association>JDoe2474</association> • <attr attr-name="Telephone Number"> • <value type="string">555-2474</value> • </attr> • </instance > • </output> • </nds>

  41. Delete • A <delete> element is used • As an event from an application shim or from eDirectory notifying DirXML that an object was deleted • As a command from DirXML instructing an application shim or instructing eDirectory to delete an object

  42. Delete (cont.) • A simple object-delete event from a hypothetical application <nds dtdversion="1.0" ndsversion="8.5"> <input> <delete class-name="User" src-dn="cn=JDoe,o=Inactive"> <association>JDoe2474</association> </delete> </input> </nds>

  43. Submitting samples to DirXML • <add> • <modify> • <rename> • <move> • <query> • <delete> demonstratio

  44. Rules:XML Transformations • Rules control how the DirXML engine transforms an event reported on a channel input into set of commands for the channel output • Subscriber • Input event comes from eDirectory and the output command(s) are sent to the application shim • Publisher • Input event comes from the application shim and the output command(s) are sent to eDirectory • Any DirXML rule can be implemented as an XSLT stylesheet

  45. Simple Rules • Four types of rules perform a well-defined role and have a simple XML vocabulary to describe the event-to-command transformation • Schema Mapping rules • Matching rules • Create rules • Placement rules • Any of the above rule types can also be implemented using an XSLT stylesheet

  46. XSLT-Only Rules • Four types of rules allow for more general customization and must be implemented with an XSLT stylesheet • Event Transformation Rules • Command Transformation Rules • Input Transformation Rules • Output Transformation Rules

  47. Rule Chaining • Any rule can be implemented as a series of individual rule objects chained together • The output of each rule object is passed as the input to the next rule object in the chain • Used to supplement the behavior of a simple rule with a stylesheet without having to implement all the rule logic in a stylesheet

  48. Schema Mapping Rules • Schema Mapping Rules are used to map class names and attribute names between eDirectory and application namespaces • Maps all class-name attributes in an XDS document • Maps all attr-name attributes in an XDS document • attr-name mapping may be based on the class-name that is in scope • Is bi-directional and same rule operates on both channels

  49. Simple Schema Mapping Rules • Simple Schema Mapping Rules provide a 1-1 mapping of schema names • Attribute name mappings may be optionally dependent on the class name • Any other more complex mapping must be done with an XSLT stylesheet

More Related