|
||||||||||
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.XDSCommandDocument
The XmlDocument
passed to method execute(XmlDocument,
XmlQueryProcessor)
of interface XmlCommandProcessor
.
Interface SubscriptionShim
implements this method. An
XmlCommandProcessor
object reference is passed to the
PublicationShim.start(XmlCommandProcessor)
method.
Constructor Summary | |
XDSCommandDocument()
Constructs an empty, writeable command document. |
|
XDSCommandDocument(DTDVersion dtdVersion)
Constructs an empty, writeable command doucment. |
|
XDSCommandDocument(com.novell.nds.dirxml.driver.XmlDocument xdsXML)
Constructs a readable command document from an existing XDS-formatted, XML document. |
Method Summary | |
XDSAddElement |
appendAddElement()
Appends an empty, child <add> element to this
document's <input> element. |
XDSDeleteElement |
appendDeleteElement()
Appends an empty, child <delete> element to this
document's <input> element. |
XDSInitParamsElement |
appendInitParamsElement()
Appends an empty, child <init-params> element to this
document's <input> or <output>
element. |
XDSModifyAssociationElement |
appendModifyAssociationElement()
Appends an empty, child <modify-association> element
to this document's <input> element. |
XDSModifyElement |
appendModifyElement()
Appends an empty, child <modify> element to this
document's <input> element. |
XDSModifyPasswordElement |
appendModifyPasswordElement()
Appends an empty, child <modify-password> element to
this document's <input> element. |
XDSMoveElement |
appendMoveElement()
Appends an empty, child <move> element to this
document's <input> element. |
XDSRenameElement |
appendRenameElement()
Appends an empty, child <rename> element to this
document's <input> element. |
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. |
List |
childElements()
Returns the child elements of this document's <input>
element. |
boolean |
containsIdentityQuery()
Does this document contain an identity query? |
void |
empty()
Removes all child nodes from this document's <input>
or <output> element. |
XDSSourceElement |
extractSourceElement()
Returns this document's <source> element. |
DTDVersion |
getDTDVersion()
Returns the dtdversion attribute value from this document's
<nds> element. |
XDSStatusElement |
heartBeatAppend()
Appends an empty, child <status> element to this
document's <input> element. |
XDSQueryElement |
identityQuery()
Returns a reference to the identity query contained in this document. |
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 XDSCommandDocument(com.novell.nds.dirxml.driver.XmlDocument xdsXML) throws XDSParseException
This constructor should be used to parse documents passed to method
execute(XmlDocument, XmlQueryProcessor)
of interface
SubscriptionShim
.
xdsXML
- must not be null
XDSParseException
- thrown if xdsXML
is empty,
malformed, or invalidSkeletonSubscriptionShim.execute(XmlDocument,
com.novell.nds.dirxml.driver.XmlQueryProcessor)
public XDSCommandDocument()
This constructor should be used to build documents passed to method
XmlCommandProcessor
object passed to the
start(XmlCommandProcessor)
of interface
PublicationShim
SkeletonPublicationShim.start(com.novell.nds.dirxml.driver.XmlCommandProcessor)
public XDSCommandDocument(DTDVersion dtdVersion)
This constructor should be used to build documents passed to the
XmlCommandProcessor
object passed to method
start(XmlCommandProcessor)
of interface
PublicationShim
dtdVersion
- must not be null
SkeletonPublicationShim.start(com.novell.nds.dirxml.driver.XmlCommandProcessor)
Method Detail |
public DTDVersion getDTDVersion()
ReadableDocument
dtdversion
attribute value from this document's
<nds>
element.
getDTDVersion
in interface ReadableDocument
null
; if absent, this method
returns DTDVersion.UNKNOWN
public XDSSourceElement extractSourceElement()
ReadableDocument
<source>
element.
extractSourceElement
in interface ReadableDocument
null
public List childElements()
<input>
element.
childElements
in interface ReadableDocument
Collections.EMPTY_LIST
or a list of
XDSAddElement
, XDSModifyElement
,
XDSDeleteElement
, XDSRenameElement
,
XDSMoveElement
, XDSQuerylement
,
XDSQueryExElement
,
XDSModifyPasswordElement
,
XDSCheckObjectPasswordElement
, and
NonXDSElement
objects; will not return
null
public XDSAddElement appendAddElement()
<add>
element to this
document's <input>
element.
null
public XDSModifyElement appendModifyElement()
<modify>
element to this
document's <input>
element.
null
public XDSRenameElement appendRenameElement()
<rename>
element to this
document's <input>
element.
null
public XDSDeleteElement appendDeleteElement()
<delete>
element to this
document's <input>
element.
null
public XDSMoveElement appendMoveElement()
<move>
element to this
document's <input>
element.
null
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 XDSModifyAssociationElement appendModifyAssociationElement()
<modify-association>
element
to this document's <input>
element.
null
public XDSModifyPasswordElement appendModifyPasswordElement()
<modify-password>
element to
this document's <input>
element.
null
public XDSStatusElement heartBeatAppend()
<status>
element to this
document's <input>
element.
null
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 XDSStatusElement appendStatusElement()
StatusDocument
<status>
element to this
document's <input>
or <output>
element.
appendStatusElement
in interface StatusDocument
null
public XDSInitParamsElement appendInitParamsElement()
StateDocument
<init-params>
element to this
document's <input>
or <output>
element. When called more than once, no action is taken and the same
<init-params>
element is returned.
appendInitParamsElement
in interface StateDocument
null
public void empty()
WriteableDocument
<input>
or <output>
element.
empty
in interface WriteableDocument
public boolean containsIdentityQuery()
true
:false
:public XDSQueryElement identityQuery()
null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |