init-params

<init-params> is used to specify initialization parameters for a DriverShim/SubscriptionShim/PublicationShim.

<init-params> can also be included in any <output> or <input> from the driver to DirXML, which will instruct DirXML to store the contents of the enclosed <driver-state>, <subscriber-state>, and/or <publisher-state> into the DirXML-DriverStorage attribute of the DirXML-Driver object in eDirectory. The states will be included in the <init-params> sent to the corresponding init() function when a driver, subscriber, or publisher is started.

Example

<!-- for DriverShim.init() -->
<init-params src-dn="\MY_TREE\MyOrg\MyDriverSet\MyDriver">
<authentication-info>
<server>localhost</server>
<user>Fred</user>
<password>foobar</password>
</authentication-info>
<driver-options>
<!-- some driver defined driver options -->
</driver-options>
<driver-state>
<!-- some driver defined driver state -->
</driver-state>
</init-params>

<!-- for SubscriptionShim.init() -->
<init-params src-dn="\MY_TREE\MyOrg\MyDriverSet\MyDriver\Subscriber">
<authentication-info>
<server>localhost</server>
<user>Fred</user>
<password>foobar</password>
</authentication-info>
<driver-filter type="subscriber">
<allow-class class-name="User">
<allow-attr attr-name="Telephone Number"/>
<allow-attr attr-name="CN"/>
<allow-attr attr-name="Surname"/>
<allow-attr attr-name="Given Name"/>
<allow-attr attr-name="Description"/>
<allow-attr attr-name="Title"/>
<allow-attr attr-name="Postal Address"/>
<allow-attr attr-name="GUID"/>
<allow-attr attr-name="Full Name"/>
</allow-class>
<allow-class class-name="Organizational Unit">
<allow-attr attr-name="OU"/>
</allow-class>
<allow-class class-name="Organizational">
<allow-attr attr-name="O"/>
</allow-class>
</driver-filter>
<subscriber-options>
<!-- some driver defined subscriber options -->
</subscriber-options>
<subscriber-state>
<!-- some driver defined subscriber state -->
</subscriber-state>
</init-params>

<!-- for PublicationShim.init() -->
<init-params src-dn="\MY_TREE\MyOrg\MyDriverSet\MyDriver\Publisher">
<authentication-info>
<server>localhost</server>
<user>Fred</user>
<password>foobar</password>
</authentication-info>
<driver-filter type="publisher">
<allow-class class-name="User">
<allow-attr attr-name="Telephone Number"/>
<allow-attr attr-name="CN"/>
<allow-attr attr-name="Surname"/>
<allow-attr attr-name="Given Name"/>
<allow-attr attr-name="Description"/>
<allow-attr attr-name="Title"/>
<allow-attr attr-name="Postal Address"/>
<allow-attr attr-name="GUID"/>
<allow-attr attr-name="Full Name"/>
</allow-class>
<allow-class class-name="Organizational Unit">
<allow-attr attr-name="OU"/>
</allow-class>
<allow-class class-name="Organizational">
<allow-attr attr-name="O"/>
</allow-class>
</driver-filter>
<publisher-options>
<!-- some driver defined publisher options -->
</publisher-options>
<publisher-state>
<!-- some driver defined publisher state -->
</publisher-state>
</init-params>

<!-- for DriverShim.getSchema() -->
<init-params>
<authentication-info>
<server>localhost</server>
<user>Fred</user>
<password>foobar</password>
</authentication-info>
<driver-filter type="subscriber">
<allow-class class-name="User">
<allow-attr attr-name="Telephone Number"/>
<allow-attr attr-name="CN"/>
<allow-attr attr-name="Surname"/>
<allow-attr attr-name="Given Name"/>
<allow-attr attr-name="Description"/>
<allow-attr attr-name="Title"/>
<allow-attr attr-name="Postal Address"/>
<allow-attr attr-name="GUID"/>
<allow-attr attr-name="Full Name"/>
</allow-class>
<allow-class class-name="Organizational Unit">
<allow-attr attr-name="OU"/>
</allow-class>
<allow-class class-name="Organizational">
<allow-attr attr-name="O"/>
</allow-class>
</driver-filter>
<driver-filter type="publisher">
<allow-class class-name="User">
<allow-attr attr-name="Telephone Number"/>
<allow-attr attr-name="CN"/>
<allow-attr attr-name="Surname"/>
<allow-attr attr-name="Given Name"/>
<allow-attr attr-name="Description"/>
<allow-attr attr-name="Title"/>
<allow-attr attr-name="Postal Address"/>
<allow-attr attr-name="GUID"/>
<allow-attr attr-name="Full Name"/>
</allow-class>
<allow-class class-name="Organizational Unit">
<allow-attr attr-name="OU"/>
</allow-class>
<allow-class class-name="Organizational">
<allow-attr attr-name="O"/>
</allow-class>
</driver-filter>
<driver-options>
<!-- some driver defined driver options -->
</driver-options>
<subscriber-options>
<!-- some driver defined subscriber options -->
</subscriber-options>
<publisher-options>
<!-- some driver defined publisher options -->
</publisher-options>
<driver-state>
<!-- some driver defined driver state -->
</driver-state>
<subscriber-state>
<!-- some driver defined subscriber state -->
</subscriber-state>
<publisher-state>
<!-- some driver defined publisher state -->
</publisher-state>
</init-params>

1. Allowed Content

authentication-info
Information for connecting and authenticating to the application.
driver-filter
Publication/Subscription class/attribute event filter.
driver-options
Driver specific DriverShim configuration options.
subscriber-options
Driver specific SubscriptionShim configuration options.
publisher-options
Driver specific PublicationShim configuration options.
driver-state
Driver specific state information
subscriber-state
Driver SubscriptionShim state information.
publisher-state
Driver PublicationShim state information.
operation-data
Operation additional custom data.

2. Attributes

AttributeValue(s)Default Value
src-dn CDATA
The distinguished name of DirXML-Driver, DirXML-Publisher, or DirXML-Subscriber.
#IMPLIED

3. Content Rule

( authentication-info ? , driver-filter ? , driver-options ? , subscriber-options ? , publisher-options ? , driver-state ? , subscriber-state ? , publisher-state ? , operation-data ? )

4. Parent Elements

input
  Input events or commands.
output
  Results of events or commands.

Top Elements || All Elements || Tree


NDS DTD