|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.ExtendedRequest
com.unboundid.ldap.sdk.unboundidds.extensions.EndInteractiveTransactionExtendedRequest
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class EndInteractiveTransactionExtendedRequest
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 interactive transaction extended request. It may be used to either commit or abort a transaction that was created using the start interactive transaction request. See the documentation in the
StartInteractiveTransactionExtendedRequest
for
an example of processing an interactive transaction.
Field Summary | |
---|---|
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. |
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE |
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
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. |
Methods inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, process, responseReceived, writeTo |
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest |
---|
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String END_INTERACTIVE_TRANSACTION_REQUEST_OID
Constructor Detail |
---|
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.Method Detail |
---|
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |