|
||||||||||
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.XDSInitDocument
The XmlDocument
passed to method init(XmlDocument)
of interfaces DriverShim
, PublicationShim
, and
SubscriptionShim
and the getSchema(XmlDocument)
method of interface DriverShim
.
Constructor Summary | |
XDSInitDocument(com.novell.nds.dirxml.driver.XmlDocument xdsXML)
Constructs a readable init document from an existing XDS-formatted, XML document. |
Method Summary | |
List |
childElements()
Returns the child elements of this document's <input>
element. |
String |
containerDN()
Returns the container RDN (Relative Distinguished Name) from this document's <init-params> element's
src-dn attribute value. |
com.novell.nds.dirxml.driver.DriverFilter |
driverFilter()
Returns this document's filter. |
XDSInitParamsElement |
extractInitParamsElement()
Returns this document's first <init-params> element. |
XDSSourceElement |
extractSourceElement()
Returns this document's <source> element. |
DTDVersion |
getDTDVersion()
Returns the dtdversion attribute value from this document's
<nds> element. |
void |
parameters(Map params)
Returns parameter values from this document's <authentication-info> ,
<driver-options> , <driver-state> ,
<subscriber-options> ,
<subscriber-state> ,
<publisher-options> , and
<publisher-state> elements. |
String |
rdn()
Returns the right-most RDN (Relative Distinguished Name) from this document's <init-params> element's
srcDN attribute value. |
String |
srcDN()
Gets the value of this document's <init-params>
element's srcDN attribute value. |
String |
treeName()
Returns the left-most RDN from this document's <init-params> element's src-dn
attribute value. |
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 XDSInitDocument(com.novell.nds.dirxml.driver.XmlDocument xdsXML) throws XDSParseException
This constructor should be used to parse documents passed to method
init(XmlDocument)
of interfaces DriverShim
,
SubscriptionShim
, and PublicationShim
.
xdsXML
- the XML document to parse; must not be null
XDSParseException
- thrown if xdsXML
is empty,
malformed, or invalidSkeletonDriverShim.init(XmlDocument)
,
SkeletonSubscriptionShim.init(XmlDocument)
,
SkeletonPublicationShim.init(XmlDocument)
Method Detail |
public XDSSourceElement extractSourceElement()
ReadableDocument
<source>
element.
extractSourceElement
in interface ReadableDocument
null
public com.novell.nds.dirxml.driver.DriverFilter driverFilter()
null
public String srcDN()
<init-params>
element's srcDN
attribute value.
null
; will not return ""
public String rdn()
<init-params>
element's
srcDN
attribute value. The naming RDN is the instance
name of the driver, publisher, or subscriber object.
null
; will not return ""
public String treeName()
<init-params>
element's src-dn
attribute value. This is the tree name.
null
; will not return ""
public String containerDN()
<init-params>
element's
src-dn
attribute value. This is the driver set or driver
DN.
null
; will not return ""
public void parameters(Map params) throws XDSParameterException
<authentication-info>
,
<driver-options>
, <driver-state>
,
<subscriber-options>
,
<subscriber-state>
,
<publisher-options>
, and
<publisher-state>
elements.
In order to retrieve parameters at the document level, parameter tag names must be globally unique. If parameter tag names are not unique within a document, parameters must be retrieved through their respective parent elements.
params
- the map of Parameter
objects to extract; must
not be null
XDSParameterException
- if a parameter constraint is violated
or parameter tag names are not uniqueParamParent.parameters(Map)
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 XDSInitParamsElement extractInitParamsElement()
<init-params>
element.
null
; while this element is
strictly optional under the DTD, a driver cannot function
without itpublic List childElements()
<input>
element.
childElements
in interface ReadableDocument
XDSInitParamsElement
and
NonXDSElement
objects; will not return
null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |