public interface DriverShimV2 extends DriverShim
Modifier and Type | Method and Description |
---|---|
XmlDocument |
initv1(XmlDocument initParameters,
ThreadNotifier notifier)
The
initv1 method is the first method called in a DriverShimV2 implementation if implemented. |
getPublicationShim, getSchema, getSubscriptionShim, init, shutdown
XmlDocument initv1(XmlDocument initParameters, ThreadNotifier notifier)
initv1
method is the first method called in a DriverShimV2
implementation if implemented.
Otherwise init method of DriverShim
is called. In addition to the driver initialization, the
other purpose of initv1
method is to allow the driver to register any of the driver's threads with the
Engine so that any changes done in eDirectory by those threads are filtered out before writing to the driver's cache.
The return from init
is an XDS output document containing a <status> element indicating the result of
initialization. A null
return is allowed and is interpreted as success. A <status> element
with a level="error"
or level="fatal"
XML attribute will cause the Engine to
abort the shim initialization.
initParameters
- XML document containing shim initialization parametersnotifier
- ThreadNotifier object which can be used by the driver's threads to register themselves as driver threadsnull
or an XML document indicating the result of the initialization operation