@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class InteractiveTransactionSpecificationRequestControl extends Control
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 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.
txnID
-- The transaction ID for the transaction, which was
obtained from a previous
StartInteractiveTransactionExtendedResult
.abortOnFailure
-- Indicates whether the transaction should
be aborted if the request associated with this control does not
complete successfully.writeLock
-- Indicates whether the target entry may be
altered by this or a subsequent operation which is part of the
transaction. It should generally be false
only for read
operations in which it is known that the target entry will not be
altered by a subsequent operation.StartInteractiveTransactionExtendedRequest
class for an example of
processing an interactive transaction.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
INTERACTIVE_TRANSACTION_SPECIFICATION_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.4) for the interactive transaction
specification request control.
|
Constructor and Description |
---|
InteractiveTransactionSpecificationRequestControl(ASN1OctetString transactionID)
Creates a new interactive transaction specification request control with
the provided transaction ID.
|
InteractiveTransactionSpecificationRequestControl(ASN1OctetString transactionID,
boolean abortOnFailure,
boolean writeLock)
Creates a new interactive transaction specification request control with
the provided information.
|
InteractiveTransactionSpecificationRequestControl(Control control)
Creates a new interactive transaction specification request control which
is decoded from the provided generic control.
|
Modifier and Type | Method and Description |
---|---|
boolean |
abortOnFailure()
Indicates whether the transaction should be aborted if the associated
operation does not complete successfully.
|
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.
|
boolean |
writeLock()
Indicates whether the server should attempt to obtain a write lock on
entries targeted by the associated operation.
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo
public static final java.lang.String INTERACTIVE_TRANSACTION_SPECIFICATION_REQUEST_OID
public InteractiveTransactionSpecificationRequestControl(ASN1OctetString transactionID)
transactionID
- The transaction ID for the associated transaction,
as obtained from the start interactive transaction
extended operation. It must not be null
.public InteractiveTransactionSpecificationRequestControl(ASN1OctetString transactionID, boolean abortOnFailure, boolean writeLock)
transactionID
- The transaction ID for the associated transaction,
as obtained from the start interactive transaction
extended operation. It must not be null
.abortOnFailure
- Indicates whether the transaction should be aborted
if the associated operation does not complete
successfully.writeLock
- Indicates whether the server should attempt to
obtain a write lock on the target entry. This
should only be false
if the associated
operation is a search or compare and it is known
that the target entry will not be updated later in
the transaction.public InteractiveTransactionSpecificationRequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as an interactive
transaction specification request control.LDAPException
- If the provided control cannot be decoded as an
interactive transaction specification request
control.public ASN1OctetString getTransactionID()
public boolean abortOnFailure()
true
if the transaction should be aborted if the
associated operation does not complete successfully, or
false
if the server should attempt to keep the transaction
active if the associated operation does not complete successfully.public boolean writeLock()
true
if the server should attempt to obtain a write lock
on entries targeted by the associated operation, or false
if a read lock is acceptable as the entries are not expected to
be altered later in the transaction.public java.lang.String getControlName()
getControlName
in class Control