@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class EndBatchedTransactionExtendedResult extends ExtendedResult
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundiddspackage structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
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
StartBatchedTransactionExtendedRequestfor an example of performing a batched transaction.
|Constructor and Description|
Creates a new end batched transaction extended result from the provided extended result.
Creates a new end batched transaction extended result with the provided information.
|Modifier and Type||Method and Description|
Retrieves the user-friendly name for the extended result, if available.
Retrieves the message ID of the operation that caused the transaction processing to fail, if applicable.
Retrieves the set of response controls returned by the operations processed as part of the transaction.
Retrieves the set of response controls returned by the specified operation processed as part of the transaction.
Appends a string representation of this extended result to the provided buffer.
getOID, getValue, hasValue, toString
getDiagnosticMessage, getMatchedDN, getMessageID, getOperationType, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl
public EndBatchedTransactionExtendedResult(@NotNull ExtendedResult extendedResult) throws LDAPException
extendedResult- The extended result to be decoded as an end batched transaction extended result. It must not be
LDAPException- If a problem occurs while attempting to decode the provided extended result as an end batched transaction extended result.
public EndBatchedTransactionExtendedResult(int messageID, @NotNull ResultCode resultCode, @Nullable java.lang.String diagnosticMessage, @Nullable java.lang.String matchedDN, @Nullable java.lang.String referralURLs, @Nullable java.lang.Integer failedOpMessageID, @Nullable java.util.Map<java.lang.Integer,Control> opResponseControls, @Nullable 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
nullif there was no failure.
opResponseControls- A map containing the response controls for each operation, indexed by message ID. It may be
nullif there were no response controls.
responseControls- The set of controls from the response, if available.
public int getFailedOpMessageID()
@NotNull public java.util.Map<java.lang.Integer,Control> getOperationResponseControls()
@Nullable public Control getOperationResponseControls(int messageID)
messageID- The message ID of the operation for which to retrieve the response controls.
nullif there were no controls returned for the specified operation.
@NotNull public java.lang.String getExtendedResultName()
nullwill be returned.