com.unboundid.ldap.sdk.unboundidds.extensions
Class EndBatchedTransactionExtendedRequest

java.lang.Object
  extended by com.unboundid.ldap.sdk.LDAPRequest
      extended by com.unboundid.ldap.sdk.ExtendedRequest
          extended by com.unboundid.ldap.sdk.unboundidds.extensions.EndBatchedTransactionExtendedRequest
All Implemented Interfaces:
ProtocolOp, ReadOnlyLDAPRequest, java.io.Serializable

@NotMutable
@ThreadSafety(level=NOT_THREADSAFE)
public final class EndBatchedTransactionExtendedRequest
extends ExtendedRequest

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 batched transaction extended request. It may be used to either commit or abort a transaction that was created using the start batched transaction request. See the documentation for the StartBatchedTransactionExtendedRequest for an example of processing a batched transaction.

See Also:
Serialized Form

Field Summary
static java.lang.String END_BATCHED_TRANSACTION_REQUEST_OID
          The OID (1.3.6.1.4.1.30221.2.6.2) for the end batched transaction extended request.
 
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE
 
Constructor Summary
EndBatchedTransactionExtendedRequest(ASN1OctetString transactionID, boolean commit)
          Creates a new end batched transaction extended request with the provided information.
EndBatchedTransactionExtendedRequest(ASN1OctetString transactionID, boolean commit, Control[] controls)
          Creates a new end batched transaction extended request with the provided information.
EndBatchedTransactionExtendedRequest(ExtendedRequest extendedRequest)
          Creates a new end batched transaction extended request from the provided generic extended request.
 
Method Summary
 boolean commit()
          Indicates whether the transaction should be committed or aborted.
 EndBatchedTransactionExtendedRequest duplicate()
          Creates a new instance of this LDAP request that may be modified without impacting this request.
 EndBatchedTransactionExtendedRequest 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.
 EndBatchedTransactionExtendedResult 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, 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

END_BATCHED_TRANSACTION_REQUEST_OID

public static final java.lang.String END_BATCHED_TRANSACTION_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.2) for the end batched transaction extended request.

See Also:
Constant Field Values
Constructor Detail

EndBatchedTransactionExtendedRequest

public EndBatchedTransactionExtendedRequest(ASN1OctetString transactionID,
                                            boolean commit)
Creates a new end batched transaction extended request with the provided information.

Parameters:
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.

EndBatchedTransactionExtendedRequest

public EndBatchedTransactionExtendedRequest(ASN1OctetString transactionID,
                                            boolean commit,
                                            Control[] controls)
Creates a new end batched transaction extended request with the provided information.

Parameters:
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.

EndBatchedTransactionExtendedRequest

public EndBatchedTransactionExtendedRequest(ExtendedRequest extendedRequest)
                                     throws LDAPException
Creates a new end batched transaction extended request from the provided generic extended request.

Parameters:
extendedRequest - The generic extended request to use to create this end batched transaction extended request.
Throws:
LDAPException - If a problem occurs while decoding the request.
Method Detail

getTransactionID

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, or false if it should be aborted.

process

public EndBatchedTransactionExtendedResult process(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 class ExtendedRequest
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

public EndBatchedTransactionExtendedRequest 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 interface ReadOnlyLDAPRequest
Overrides:
duplicate in class ExtendedRequest
Returns:
A new instance of this LDAP request that may be modified without impacting this request.

duplicate

public EndBatchedTransactionExtendedRequest duplicate(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 interface ReadOnlyLDAPRequest
Overrides:
duplicate in class ExtendedRequest
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

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 class ExtendedRequest
Returns:
The user-friendly name for this extended request, or the OID if no user-friendly name is available.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.

Specified by:
toString in interface ProtocolOp
Specified by:
toString in interface ReadOnlyLDAPRequest
Overrides:
toString in class ExtendedRequest
Parameters:
buffer - The buffer to which to append a string representation of this request.