Package com.unboundid.ldap.sdk.unboundidds.controls

Class BatchedTransactionSpecificationRequestControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.BatchedTransactionSpecificationRequestControl
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class BatchedTransactionSpecificationRequestControl extends Control
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.
NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

Note that directory servers may limit the set of controls that are available for use in requests that are part of a transaction. RFC 5805 section 4 indicates that the following controls may be used in conjunction with the transaction specification request control: AssertionRequestControl, ManageDsaITRequestControl, PreReadRequestControl, and PostReadRequestControl. The ProxiedAuthorizationV1RequestControl and ProxiedAuthorizationV2RequestControl controls cannot be included in requests that are part of a transaction, but you can include them in the StartBatchedTransactionExtendedRequest to indicate that all operations within the transaction should be processed with the specified authorization identity.

The Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products support the following additional UnboundID-specific controls in conjunction with operations included in a transaction: AccountUsableRequestControl, HardDeleteRequestControl, IntermediateClientRequestControl, PasswordPolicyRequestControl, ReplicationRepairRequestControl, SoftDeleteRequestControl, SoftDeletedEntryAccessRequestControl, SubtreeDeleteRequestControl, and UndeleteRequestControl.

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

  • Field Details

  • Constructor Details

    • BatchedTransactionSpecificationRequestControl

      public BatchedTransactionSpecificationRequestControl(@NotNull 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(@NotNull 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 Details

    • getTransactionID

      @NotNull public ASN1OctetString getTransactionID()
      Retrieves the transaction ID for the associated transaction.
      Returns:
      The transaction ID for the associated transaction.

    • getControlName

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