|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.novell.nds.dirxml.driver.xds.DocumentImpl
com.novell.nds.dirxml.driver.xds.XDSHeartbeatDocument
A specific instance of the XmlDocument
passed to method
execute(XmlDocument, XmlQueryProcessor)
of interface
XmlCommandProcessor
.
A heartbeat document is periodically sent on the publisher channel to facilitate driver health monitoring.
An XmlCommandProcessor
object reference is passed to the
PublicationShim.start(XmlCommandProcessor)
method.
Constructor Summary | |
XDSHeartbeatDocument()
Constructs a populated heartbeat document. |
|
XDSHeartbeatDocument(DTDVersion dtdVersion)
Constructs a populated heartbeat document. |
Method Summary | |
XDSSourceElement |
appendSourceElement()
Appends an empty, child <source> element to this
document's <nds> element. |
XDSStatusElement |
appendStatusElement()
Appends an empty, child <status> element to this
document's <input> or <output>
element. |
void |
empty()
Removes all child nodes from this document's <input>
or <output> element. |
com.novell.nds.dirxml.driver.XmlDocument |
toXML()
Converts this document into an XmlDocument . |
void |
validate()
Validates this document. |
Methods inherited from class com.novell.nds.dirxml.driver.xds.DocumentImpl |
domDocument, domIOElement, domNDSElement, isEmpty |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.novell.nds.dirxml.driver.xds.XDSDocument |
domDocument, domIOElement, domNDSElement, isEmpty |
Constructor Detail |
public XDSHeartbeatDocument()
<status>
element with a type
attribute value of 'heartbeat'.
This constructor should be used to build documents passed to the
execute
method of the XmlCommandProcessor
object passed to the start(XmlCommandProcessor)
of
interface PublicationShim
SkeletonPublicationShim.start(com.novell.nds.dirxml.driver.XmlCommandProcessor)
public XDSHeartbeatDocument(DTDVersion dtdVersion)
<status>
element with a type
attribute value of 'heartbeat'. The DTD version used is configurable.
This constructor should be used to build documents passed to the
execute
method of the XmlCommandProcessor
object passed to the start(XmlCommandProcessor)
of
interface PublicationShim
dtdVersion
- must not be null
; must be >= 1.1
IllegalArgumentException
- thrown if dtdVersion
is
null
or < 1.1SkeletonPublicationShim.start(com.novell.nds.dirxml.driver.XmlCommandProcessor)
Method Detail |
public XDSSourceElement appendSourceElement()
WriteableDocument
<source>
element to this
document's <nds>
element. When called more than
once, no action is taken and the same <source>
element is returned.
appendSourceElement
in interface WriteableDocument
null
public void empty()
WriteableDocument
<input>
or <output>
element.
empty
in interface WriteableDocument
public void validate() throws XDSParseException
WriteableDocument
validate
in interface WriteableDocument
XDSParseException
- if this document is malformed or invalidpublic com.novell.nds.dirxml.driver.XmlDocument toXML()
WriteableDocument
XmlDocument
.
toXML
in interface WriteableDocument
XmlDocument
public XDSStatusElement appendStatusElement()
StatusDocument
<status>
element to this
document's <input>
or <output>
element.
appendStatusElement
in interface StatusDocument
null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |