@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class EndInteractiveTransactionExtendedRequest extends ExtendedRequest
StartInteractiveTransactionExtendedRequest
for
an example of processing an interactive transaction.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only
supported for use against Ping Identity, UnboundID, and 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.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
END_INTERACTIVE_TRANSACTION_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.4) for the end interactive transaction
extended request.
|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE
Constructor and Description |
---|
EndInteractiveTransactionExtendedRequest(ASN1OctetString transactionID,
boolean commit)
Creates a new end interactive transaction extended request with the
provided information.
|
EndInteractiveTransactionExtendedRequest(ASN1OctetString transactionID,
boolean commit,
Control[] controls)
Creates a new end interactive transaction extended request with the
provided information.
|
EndInteractiveTransactionExtendedRequest(ExtendedRequest extendedRequest)
Creates a new end interactive transaction extended request from the
provided generic extended request.
|
Modifier and Type | Method and Description |
---|---|
boolean |
commit()
Indicates whether the transaction should be committed or aborted.
|
EndInteractiveTransactionExtendedRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without
impacting this request.
|
EndInteractiveTransactionExtendedRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without
impacting this request.
|
java.lang.String |
getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available.
|
ASN1OctetString |
getTransactionID()
Retrieves the transaction ID for the transaction to commit or abort.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.
|
encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, process, responseReceived, toCode, writeTo
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getReferralConnector, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setResponseTimeoutMillis, toString
public static final java.lang.String END_INTERACTIVE_TRANSACTION_REQUEST_OID
public EndInteractiveTransactionExtendedRequest(ASN1OctetString transactionID, boolean commit)
transactionID
- The transaction ID for the transaction to commit or
abort. It must not be null
.commit
- true
if the transaction should be committed,
or false
if the transaction should be
aborted.public EndInteractiveTransactionExtendedRequest(ASN1OctetString transactionID, boolean commit, Control[] controls)
transactionID
- The transaction ID for the transaction to commit or
abort. It must not be null
.commit
- true
if the transaction should be committed,
or false
if the transaction should be
aborted.controls
- The set of controls to include in the request.public EndInteractiveTransactionExtendedRequest(ExtendedRequest extendedRequest) throws LDAPException
extendedRequest
- The generic extended request to use to create this
end interactive transaction extended request.LDAPException
- If a problem occurs while decoding the request.public ASN1OctetString getTransactionID()
public boolean commit()
true
if the transaction should be committed, or
false
if it should be aborted.public EndInteractiveTransactionExtendedRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
public EndInteractiveTransactionExtendedRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
controls
- The set of controls to include in the duplicate request.public java.lang.String getExtendedRequestName()
getExtendedRequestName
in class ExtendedRequest
public void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
toString
in interface ReadOnlyLDAPRequest
toString
in class ExtendedRequest
buffer
- The buffer to which to append a string representation of
this request.