Class StartTransactionExtendedResult
- java.lang.Object
-
- com.unboundid.ldap.sdk.LDAPResult
-
- com.unboundid.ldap.sdk.ExtendedResult
-
- com.unboundid.ldap.sdk.extensions.StartTransactionExtendedResult
-
- All Implemented Interfaces:
LDAPResponse
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class StartTransactionExtendedResult extends ExtendedResult
This class implements a data structure for storing the information from an extended result for the start transaction extended request, as defined in RFC 5805. It is able to decode a generic extended result to extract the transaction ID that it contains, if the operation was successful.
See the documentation for theStartTransactionExtendedRequest
class for an example that demonstrates the use of LDAP transactions.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse
NO_CONTROLS
-
-
Constructor Summary
Constructors Constructor Description StartTransactionExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, ASN1OctetString transactionID, Control[] responseControls)
Creates a new start transaction extended result with the provided information.StartTransactionExtendedResult(ExtendedResult extendedResult)
Creates a new start transaction extended result from the provided extended result.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available.ASN1OctetString
getTransactionID()
Retrieves the transaction ID for this start transaction extended result, if available.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, getOperationType, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl
-
-
-
-
Constructor Detail
-
StartTransactionExtendedResult
public StartTransactionExtendedResult(@NotNull ExtendedResult extendedResult)
Creates a new start transaction extended result from the provided extended result.- Parameters:
extendedResult
- The extended result to be decoded as a start transaction extended result. It must not benull
.
-
StartTransactionExtendedResult
public StartTransactionExtendedResult(int messageID, @NotNull ResultCode resultCode, @Nullable java.lang.String diagnosticMessage, @Nullable java.lang.String matchedDN, @Nullable java.lang.String[] referralURLs, @Nullable ASN1OctetString transactionID, @Nullable Control[] responseControls)
Creates a new start transaction extended result with the provided information.- Parameters:
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.transactionID
- The transaction ID for this response, if available.responseControls
- The set of controls from the response, if available.
-
-
Method Detail
-
getTransactionID
@Nullable public ASN1OctetString getTransactionID()
Retrieves the transaction ID for this start transaction extended result, if available.- Returns:
- The transaction ID for this start transaction extended result, or
null
if none was provided.
-
getExtendedResultName
@NotNull public java.lang.String getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available. If no user-friendly name has been defined, but a response OID is available, then that will be returned. If neither a user-friendly name nor a response OID are available, thennull
will be returned.- Overrides:
getExtendedResultName
in classExtendedResult
- Returns:
- The user-friendly name for this extended request, the response OID
if a user-friendly name is not available but a response OID is, or
null
if neither a user-friendly name nor a response OID are available.
-
toString
public void toString(@NotNull java.lang.StringBuilder buffer)
Appends a string representation of this extended result to the provided buffer.- Specified by:
toString
in interfaceLDAPResponse
- Overrides:
toString
in classExtendedResult
- Parameters:
buffer
- The buffer to which a string representation of this extended result will be appended.
-
-