com.unboundid.ldap.sdk.controls

Class TransactionSpecificationRequestControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.controls.TransactionSpecificationRequestControl

All Implemented Interfaces:

java.io.Serializable

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

This class provides an implementation of the transaction specification request control as defined in RFC 5805. It may be used to indicate that the associated add, delete, modify, modify DN, or password modify operation is part of an LDAP transaction. The transaction should be created with the start transaction extended operation, which will obtain a transaction ID, and the transaction may be committed or aborted using the end transaction extended operation.

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 StartTransactionExtendedRequest 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: account usable request control, DraftBeheraLDAPPasswordPolicy10RequestControl, hard delete request control, intermediate client request control, replication repair request control, soft delete request control, soft deleted entry access request control, SubtreeDeleteRequestControl, and undelete request control.

See the documentation for the StartTransactionExtendedRequest class for an example of processing an LDAP transaction.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TRANSACTION_SPECIFICATION_REQUEST_OID The OID (1.3.6.1.1.21.2) for the transaction specification request control.

Constructor Summary

Constructors

Constructor and Description
TransactionSpecificationRequestControl(ASN1OctetString transactionID) Creates a new transaction specification request control with the provided transaction ID.
TransactionSpecificationRequestControl(Control control) Creates a new transaction specification request control which is decoded from the provided generic control.

Method Summary

Modifier and Type	Method and Description
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, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toJSONControl, toString, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TRANSACTION_SPECIFICATION_REQUEST_OID

@NotNull
public static final java.lang.String TRANSACTION_SPECIFICATION_REQUEST_OID

The OID (1.3.6.1.1.21.2) for the transaction specification request control.

See Also:

Constant Field Values

Constructor Detail

TransactionSpecificationRequestControl

public TransactionSpecificationRequestControl(@NotNull
                                              ASN1OctetString transactionID)

Creates a new transaction specification request control with the provided transaction ID.

Parameters:

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

TransactionSpecificationRequestControl

public TransactionSpecificationRequestControl(@NotNull
                                              Control control)
                                       throws LDAPException

Creates a new transaction specification request control which is decoded from the provided generic control.

Parameters:

control - The generic control to be decoded as a transaction specification request control.

Throws:

LDAPException - If the provided control cannot be decoded as a transaction specification request control.

Method Detail

getTransactionID

@NotNull
public ASN1OctetString getTransactionID()

Retrieves the transaction ID for the associated transaction.

Returns:

The transaction ID for the associated transaction.

getControlName

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