|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.unboundidds.extensions.EndBatchedTransactionExtendedResult
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class EndBatchedTransactionExtendedResult
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class provides an implementation of the end batched transaction extended result. It is able to decode a generic extended result to extract the appropriate response information.
failedOpMessageID
-- The message ID associated with the LDAP
request that caused the transaction to fail. It will be "-1
"
if the transaction was committed successfully.opResponseControls
-- A map containing the response controls
associated with each of the operations processed as part of the
transaction, mapped from the message ID of the associated request to
the array of response controls for that operation. If there are no
response controls for a given request, then it will not be included in
the map.LDAPResult.getMessageID()
method in the response
for that operation. When processing operations that are part of a batched,
transaction it may be desirable to keep references to the associated requests
mapped by message ID so that they can be available if necessary for the
failedOpMessageID
and/or opResponseControls
elements.
StartBatchedTransactionExtendedRequest
for an example of performing a batched transaction.
Field Summary |
---|
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse |
---|
NO_CONTROLS |
Constructor Summary | |
---|---|
EndBatchedTransactionExtendedResult(ExtendedResult extendedResult)
Creates a new end batched transaction extended result from the provided extended result. |
|
EndBatchedTransactionExtendedResult(int messageID,
ResultCode resultCode,
java.lang.String diagnosticMessage,
java.lang.String matchedDN,
java.lang.String[] referralURLs,
java.lang.Integer failedOpMessageID,
java.util.Map<java.lang.Integer,Control[]> opResponseControls,
Control[] responseControls)
Creates a new end batched transaction extended result with the provided information. |
Method Summary | |
---|---|
java.lang.String |
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available. |
int |
getFailedOpMessageID()
Retrieves the message ID of the operation that caused the transaction processing to fail, if applicable. |
java.util.Map<java.lang.Integer,Control[]> |
getOperationResponseControls()
Retrieves the set of response controls returned by the operations processed as part of the transaction. |
Control[] |
getOperationResponseControls(int messageID)
Retrieves the set of response controls returned by the specified operation processed as part of the transaction. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this extended result to the provided buffer. |
Methods inherited from class com.unboundid.ldap.sdk.ExtendedResult |
---|
getOID, getValue, hasValue, toString |
Methods inherited from class com.unboundid.ldap.sdk.LDAPResult |
---|
getDiagnosticMessage, getMatchedDN, getMessageID, getReferralURLs, getResponseControl, getResponseControls, getResultCode, hasResponseControl, hasResponseControl |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EndBatchedTransactionExtendedResult(ExtendedResult extendedResult) throws LDAPException
extendedResult
- The extended result to be decoded as an end batched
transaction extended result. It must not be
null
.
LDAPException
- If a problem occurs while attempting to decode the
provided extended result as an end batched
transaction extended result.public EndBatchedTransactionExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.lang.Integer failedOpMessageID, java.util.Map<java.lang.Integer,Control[]> opResponseControls, Control[] responseControls)
messageID
- The message ID for the LDAP message that is
associated with this LDAP result.resultCode
- The result code from the response.diagnosticMessage
- The diagnostic message from the response, if
available.matchedDN
- The matched DN from the response, if available.referralURLs
- The set of referral URLs from the response, if
available.failedOpMessageID
- The message ID for the operation that failed,
or null
if there was no failure.opResponseControls
- A map containing the response controls for each
operation, indexed by message ID. It may be
null
if there were no response
controls.responseControls
- The set of controls from the response, if
available.Method Detail |
---|
public int getFailedOpMessageID()
public java.util.Map<java.lang.Integer,Control[]> getOperationResponseControls()
public Control[] getOperationResponseControls(int messageID)
messageID
- The message ID of the operation for which to retrieve
the response controls.
null
if there were no controls returned for the specified
operation.public java.lang.String getExtendedResultName()
null
will be returned.
getExtendedResultName
in class ExtendedResult
null
if neither a user-friendly name nor a response OID
are available.public void toString(java.lang.StringBuilder buffer)
toString
in interface LDAPResponse
toString
in class ExtendedResult
buffer
- The buffer to which a string representation of this
extended result will be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |