|
LDAP Classes Implements Java LDAP |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.novell.ldap.util.DOMReader
Reads pre-parsed DSML as LDAPMessages.
Some applications have access to DSML(Directory Services Markup Language) pre-parsed into DOM(Document Object Model) objects. This utility class will read a DOM structure and translate it into LDAPMessages. If DSML comes from a stream or file then DSMLReader may also be used.
DOMWriter
,
DSMLReader
,
LDAPMessage
,
LDAPConnection.sendRequest(com.novell.ldap.LDAPMessage, com.novell.ldap.LDAPMessageQueue)
Constructor Summary | |
DOMReader(org.w3c.dom.Document dsmlDoc)
Deprecated. use #DOMReader(Element) Creates a reader that reads a DOM document and translates it into LDAPMessages. The first batchRequest or batchResponse is located and all nodes within it will be read and translated into LDAPMessages |
|
DOMReader(org.w3c.dom.Element root)
Creates a reader that read a DOM element and translate it into LDAPMessages. |
Method Summary | |
java.lang.String |
getBatchRequestID()
Retrieves the optional requestID attribute on a BatchRequests. |
java.lang.String |
getVersion()
Retrieves the version of DSML being written. |
boolean |
isParallelProcessing()
Indicates whether the requests in a batchRequest can be executed in parallel. |
boolean |
isRequest()
Used to identify if the root node is a batchRequest or not. |
boolean |
isResponseUnordered()
If requests in a batchRequest can be executed in parallel, this specifies whether the responses can be written in any order. |
boolean |
isResumeOnError()
Indicates whether the execution of requests in a batchRequest should resume or stop should an error occur. |
LDAPMessage |
readMessage()
Reads the current element and returns an LDAPMessage. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DOMReader(org.w3c.dom.Document dsmlDoc) throws LDAPLocalException
The first batchRequest or batchResponse is located and all nodes within it will be read and translated into LDAPMessages
dsmlDoc
- Document with a DSML batchRequest or batchResponse
LDAPLocalException
- Occurs when no batchRequest or batchResponse
is found, or the document is invalid DSML.public DOMReader(org.w3c.dom.Element root) throws LDAPLocalException
Requests or responses must be inside of the batchRequest or batchResponse specified
root
- Element with a name of batchRequest or batchResponse.
LDAPLocalException
- Occurs when no batchRequest or batchResponse
is found, or the Element is invalid DSML.Method Detail |
public java.lang.String getVersion()
getVersion
in interface LDAPReader
public boolean isRequest()
isRequest
in interface LDAPReader
public LDAPMessage readMessage()
readMessage
in interface LDAPReader
public java.lang.String getBatchRequestID()
public boolean isParallelProcessing()
This is determined by reading the "processing" attribute on the tag batchRequest. This attribute can take on the values of "sequential" or "parallel" and defaults to "sequential" when the attribute is absent.
Other batchRequest properties:
getBatchRequestID()
,
isResponseUnordered()
,
isResumeOnError()
public boolean isResponseUnordered()
This is determined by reading the "responseOrder" attribute on the tag batchRequest. This attribute can take on the values of "sequential" or "unordered" and defaults to "sequential" when the attribute is absent.
public boolean isResumeOnError()
This is determined by reading the "onError" attribute on the tag batchRequest. This attribute can take on the values of "resume" or "exit" and defaults to "exit" when the attribute is absent.
Other batchRequest properties:
getBatchRequestID()
,
isParallelProcessing()
,
isResponseUnordered()
|
LDAP Classes Implements Java LDAP |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |