com.unboundid.ldap.sdk.extensions

Class StartTransactionExtendedRequest

java.lang.Object

com.unboundid.ldap.sdk.LDAPRequest

com.unboundid.ldap.sdk.ExtendedRequest

com.unboundid.ldap.sdk.extensions.StartTransactionExtendedRequest

All Implemented Interfaces:

ProtocolOp, ReadOnlyLDAPRequest, java.io.Serializable

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

This class provides an implementation of the start transaction extended request as defined in RFC 5805. It may be used to begin a transaction that allows multiple write operations to be processed as a single atomic unit. The StartTransactionExtendedResult that is returned will include a transaction ID. For each operation that is performed as part of the transaction, this transaction ID should be included in the corresponding request through the TransactionSpecificationRequestControl. Finally, after all requests for the transaction have been submitted to the server, the EndTransactionExtendedRequest should be used to commit that transaction, or it may also be used to abort the transaction if it is decided that it is no longer needed.

Example

The following example demonstrates the process for using LDAP transactions. It will modify two different entries as a single atomic unit.

 // Use the start transaction extended operation to begin a transaction.
 StartTransactionExtendedResult startTxnResult;
 try
 {
   startTxnResult = (StartTransactionExtendedResult)
        connection.processExtendedOperation(
             new StartTransactionExtendedRequest());
   // This doesn't necessarily mean that the operation was successful, since
   // some kinds of extended operations return non-success results under
   // normal conditions.
 }
 catch (LDAPException le)
 {
   // For an extended operation, this generally means that a problem was
   // encountered while trying to send the request or read the result.
   startTxnResult = new StartTransactionExtendedResult(
        new ExtendedResult(le));
 }
 LDAPTestUtils.assertResultCodeEquals(startTxnResult, ResultCode.SUCCESS);
 ASN1OctetString txnID = startTxnResult.getTransactionID();


 // At this point, we have a transaction available for use.  If any problem
 // arises, we want to ensure that the transaction is aborted, so create a
 // try block to process the operations and a finally block to commit or
 // abort the transaction.
 boolean commit = false;
 try
 {
   // Create and process a modify operation to update a first entry as part
   // of the transaction.  Make sure to include the transaction specification
   // control in the request to indicate that it should be part of the
   // transaction.
   ModifyRequest firstModifyRequest = new ModifyRequest(
        "cn=first,dc=example,dc=com",
        new Modification(ModificationType.REPLACE, "description", "first"));
   firstModifyRequest.addControl(
        new TransactionSpecificationRequestControl(txnID));
   LDAPResult firstModifyResult;
   try
   {
     firstModifyResult = connection.modify(firstModifyRequest);
   }
   catch (LDAPException le)
   {
     firstModifyResult = le.toLDAPResult();
   }
   LDAPTestUtils.assertResultCodeEquals(firstModifyResult,
        ResultCode.SUCCESS);

   // Perform a second modify operation as part of the transaction.
   ModifyRequest secondModifyRequest = new ModifyRequest(
        "cn=second,dc=example,dc=com",
        new Modification(ModificationType.REPLACE, "description", "second"));
   secondModifyRequest.addControl(
        new TransactionSpecificationRequestControl(txnID));
   LDAPResult secondModifyResult;
   try
   {
     secondModifyResult = connection.modify(secondModifyRequest);
   }
   catch (LDAPException le)
   {
     secondModifyResult = le.toLDAPResult();
   }
   LDAPTestUtils.assertResultCodeEquals(secondModifyResult,
        ResultCode.SUCCESS);

   // If we've gotten here, then all writes have been processed successfully
   // and we can indicate that the transaction should be committed rather
   // than aborted.
   commit = true;
 }
 finally
 {
   // Commit or abort the transaction.
   EndTransactionExtendedResult endTxnResult;
   try
   {
     endTxnResult = (EndTransactionExtendedResult)
          connection.processExtendedOperation(
               new EndTransactionExtendedRequest(txnID, commit));
   }
   catch (LDAPException le)
   {
     endTxnResult = new EndTransactionExtendedResult(new ExtendedResult(le));
   }
   LDAPTestUtils.assertResultCodeEquals(endTxnResult, ResultCode.SUCCESS);
 }
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	START_TRANSACTION_REQUEST_OID The OID (1.3.6.1.1.21.1) for the start transaction extended request.

Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest

TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE

Constructor Summary

Constructors

Constructor and Description
StartTransactionExtendedRequest() Creates a new start transaction extended request.
StartTransactionExtendedRequest(Control[] controls) Creates a new start transaction extended request.
StartTransactionExtendedRequest(ExtendedRequest extendedRequest) Creates a new start transaction extended request from the provided generic extended request.

Method Summary

Modifier and Type	Method and Description
StartTransactionExtendedRequest	duplicate() Creates a new instance of this LDAP request that may be modified without impacting this request.
StartTransactionExtendedRequest	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.
StartTransactionExtendedResult	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, getReferralConnectorInternal, getReferralDepth, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setReferralDepth, setResponseTimeoutMillis, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

START_TRANSACTION_REQUEST_OID

@NotNull
public static final java.lang.String START_TRANSACTION_REQUEST_OID

The OID (1.3.6.1.1.21.1) for the start transaction extended request.

See Also:

Constant Field Values

Constructor Detail

StartTransactionExtendedRequest

public StartTransactionExtendedRequest()

Creates a new start transaction extended request.

StartTransactionExtendedRequest

public StartTransactionExtendedRequest(@Nullable
                                       Control[] controls)

Creates a new start transaction extended request.

Parameters:

controls - The set of controls to include in the request.

StartTransactionExtendedRequest

public StartTransactionExtendedRequest(@NotNull
                                       ExtendedRequest extendedRequest)
                                throws LDAPException

Creates a new start transaction extended request from the provided generic extended request.

Parameters:

extendedRequest - The generic extended request to use to create this start transaction extended request.

Throws:

LDAPException - If a problem occurs while decoding the request.

Method Detail

process

@NotNull
public StartTransactionExtendedResult 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 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

@NotNull
public StartTransactionExtendedRequest 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

@NotNull
public StartTransactionExtendedRequest 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 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

@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 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(@NotNull
                     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.