Class EndTransactionExtendedRequest
- java.lang.Object
-
- com.unboundid.ldap.sdk.LDAPRequest
-
- com.unboundid.ldap.sdk.ExtendedRequest
-
- com.unboundid.ldap.sdk.extensions.EndTransactionExtendedRequest
-
- All Implemented Interfaces:
ProtocolOp
,ReadOnlyLDAPRequest
,java.io.Serializable
@NotMutable @ThreadSafety(level=NOT_THREADSAFE) public final class EndTransactionExtendedRequest extends ExtendedRequest
This class provides an implementation of the end transaction extended request as defined in RFC 5805. It may be used to either commit or abort a transaction that was created using the start transaction request. See the documentation for theStartTransactionExtendedRequest
class for an example of processing an LDAP transaction.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
END_TRANSACTION_REQUEST_OID
The OID (1.3.6.1.1.21.3) for the end transaction extended request.-
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE
-
-
Constructor Summary
Constructors Constructor Description EndTransactionExtendedRequest(ASN1OctetString transactionID, boolean commit, Control... controls)
Creates a new end transaction extended request with the provided information.EndTransactionExtendedRequest(ExtendedRequest extendedRequest)
Creates a new end transaction extended request from the provided generic extended request.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
commit()
Indicates whether the transaction should be committed or aborted.EndTransactionExtendedRequest
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.EndTransactionExtendedRequest
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.EndTransactionExtendedResult
process(LDAPConnection connection, int depth)
Sends this extended request to the directory server over the provided connection and returns the associated response.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, responseReceived, toCode, writeTo
-
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getReferralConnector, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setResponseTimeoutMillis, toString
-
-
-
-
Field Detail
-
END_TRANSACTION_REQUEST_OID
@NotNull public static final java.lang.String END_TRANSACTION_REQUEST_OID
The OID (1.3.6.1.1.21.3) for the end transaction extended request.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EndTransactionExtendedRequest
public EndTransactionExtendedRequest(@NotNull ASN1OctetString transactionID, boolean commit, @Nullable Control... controls)
Creates a new end transaction extended request with the provided information.- Parameters:
transactionID
- The transaction ID for the transaction to commit or abort. It must not benull
.commit
-true
if the transaction should be committed, orfalse
if the transaction should be aborted.controls
- The set of controls to include in the request.
-
EndTransactionExtendedRequest
public EndTransactionExtendedRequest(@NotNull ExtendedRequest extendedRequest) throws LDAPException
Creates a new end transaction extended request from the provided generic extended request.- Parameters:
extendedRequest
- The generic extended request to use to create this end transaction extended request.- Throws:
LDAPException
- If a problem occurs while decoding the request.
-
-
Method Detail
-
getTransactionID
@NotNull public ASN1OctetString getTransactionID()
Retrieves the transaction ID for the transaction to commit or abort.- Returns:
- The transaction ID for the transaction to commit or abort.
-
commit
public boolean commit()
Indicates whether the transaction should be committed or aborted.- Returns:
true
if the transaction should be committed, orfalse
if it should be aborted.
-
process
@NotNull public EndTransactionExtendedResult process(@NotNull LDAPConnection connection, int depth) throws LDAPException
Sends this extended request to the directory server over the provided connection and returns the associated response.- Overrides:
process
in classExtendedRequest
- Parameters:
connection
- The connection to use to communicate with the directory server.depth
- The current referral depth for this request. It should always be one for the initial request, and should only be incremented when following referrals.- Returns:
- An LDAP result object that provides information about the result of the extended operation processing.
- Throws:
LDAPException
- If a problem occurs while sending the request or reading the response.
-
duplicate
@NotNull public EndTransactionExtendedRequest duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.. Subclasses should override this method to return a duplicate of the appropriate type.- Specified by:
duplicate
in interfaceReadOnlyLDAPRequest
- Overrides:
duplicate
in classExtendedRequest
- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
duplicate
@NotNull public EndTransactionExtendedRequest duplicate(@Nullable Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.. Subclasses should override this method to return a duplicate of the appropriate type.- Specified by:
duplicate
in interfaceReadOnlyLDAPRequest
- Overrides:
duplicate
in classExtendedRequest
- Parameters:
controls
- The set of controls to include in the duplicate request.- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
getExtendedRequestName
@NotNull public java.lang.String getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. If no user-friendly name has been defined, then the OID will be returned.- Overrides:
getExtendedRequestName
in classExtendedRequest
- Returns:
- The user-friendly name for this extended request, or the OID if no user-friendly name is available.
-
toString
public void toString(@NotNull java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.- Specified by:
toString
in interfaceProtocolOp
- Specified by:
toString
in interfaceReadOnlyLDAPRequest
- Overrides:
toString
in classExtendedRequest
- Parameters:
buffer
- The buffer to which to append a string representation of this request.
-
-