com.unboundid.ldap.sdk.unboundidds.controls
Class BatchedTransactionSpecificationRequestControl

java.lang.Object
  extended by com.unboundid.ldap.sdk.Control
      extended by com.unboundid.ldap.sdk.unboundidds.controls.BatchedTransactionSpecificationRequestControl
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class BatchedTransactionSpecificationRequestControl
extends Control

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 batched transaction specification request control, which may be used to indicate that the associated add, delete, modify, modify DN, or password modify operation is part of a batched transaction. The transaction should be created with the start batched transaction extended operation, which will obtain a transaction ID, and the transaction may be committed or aborted using the end batched transaction extended operation.

See the documentation for the StartBatchedTransactionExtendedRequest class for an example of processing a batched transaction.

See Also:
Serialized Form

Field Summary
static java.lang.String BATCHED_TRANSACTION_SPECIFICATION_REQUEST_OID
          The OID (1.3.6.1.4.1.30221.2.5.1) for the batched transaction specification request control.
 
Constructor Summary
BatchedTransactionSpecificationRequestControl(ASN1OctetString transactionID)
          Creates a new batched transaction specification request control with the provided transaction ID.
BatchedTransactionSpecificationRequestControl(Control control)
          Creates a new batched transaction specification request control which is decoded from the provided generic control.
 
Method Summary
 java.lang.String getControlName()
          Retrieves the user-friendly name for this control, if available.
 ASN1OctetString getTransactionID()
          Retrieves the transaction ID for the associated transaction.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this LDAP control to the provided buffer.
 
Methods inherited from class com.unboundid.ldap.sdk.Control
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

BATCHED_TRANSACTION_SPECIFICATION_REQUEST_OID

public static final java.lang.String BATCHED_TRANSACTION_SPECIFICATION_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.1) for the batched transaction specification request control.

See Also:
Constant Field Values
Constructor Detail

BatchedTransactionSpecificationRequestControl

public BatchedTransactionSpecificationRequestControl(ASN1OctetString transactionID)
Creates a new batched transaction specification request control with the provided transaction ID.

Parameters:
transactionID - The transaction ID for the associated transaction, as obtained from the start batched transaction extended operation. It must not be null.

BatchedTransactionSpecificationRequestControl

public BatchedTransactionSpecificationRequestControl(Control control)
                                              throws LDAPException
Creates a new batched transaction specification request control which is decoded from the provided generic control.

Parameters:
control - The generic control to be decoded as a batched transaction specification request control.
Throws:
LDAPException - If the provided control cannot be decoded as a batched transaction specification request control.
Method Detail

getTransactionID

public ASN1OctetString getTransactionID()
Retrieves the transaction ID for the associated transaction.

Returns:
The transaction ID for the associated transaction.

getControlName

public java.lang.String getControlName()
Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.

Overrides:
getControlName in class Control
Returns:
The user-friendly name for this control, or the OID if no user-friendly name is available.

toString

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

Overrides:
toString in class Control
Parameters:
buffer - The buffer to which to append the string representation of this buffer.