@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class InteractiveTransactionSpecificationResponseControl extends Control implements DecodeableControl
InteractiveTransactionSpecificationRequestControl
.
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.
transactionValid
-- Indicates whether the transaction is
still valid in the server. This should be checked if the associated
operation did not complete successfully.baseDNs
-- This may specify the set of base DNs below
which the client is allowed to request operations as part of this
transaction. It may be absent if there are no restrictions on which
base DNs may be used, or if it has not changed since the last
response within this transaction.StartInteractiveTransactionExtendedRequest
class for an example of
processing interactive transactions.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
INTERACTIVE_TRANSACTION_SPECIFICATION_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.5.4) for the interactive transaction
specification response control.
|
Constructor and Description |
---|
InteractiveTransactionSpecificationResponseControl(boolean transactionValid,
java.util.List<java.lang.String> baseDNs)
Creates a new interactive transaction specification response control with
the provided information.
|
InteractiveTransactionSpecificationResponseControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new interactive transaction specification response control with
the provided information.
|
Modifier and Type | Method and Description |
---|---|
InteractiveTransactionSpecificationResponseControl |
decodeControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new instance of this decodeable control from the provided
information.
|
static InteractiveTransactionSpecificationResponseControl |
get(LDAPResult result)
Extracts an interactive transaction specification response control from the
provided result.
|
java.util.List<java.lang.String> |
getBaseDNs()
Retrieves the set of base DNs below which operations which are part of the
transaction may be performed.
|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided
buffer.
|
boolean |
transactionValid()
Indicates whether the associated transaction is still valid on the server.
|
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_RESPONSE_OID
public InteractiveTransactionSpecificationResponseControl(boolean transactionValid, java.util.List<java.lang.String> baseDNs)
transactionValid
- Indicates whether the associated transaction is
still valid.baseDNs
- The set of base DNs that may be targeted over the
course of the transaction. It may be
null
if there are no restrictions or the
set of restrictions has not changed since the
last response.public InteractiveTransactionSpecificationResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.LDAPException
- If the provided control cannot be decoded as an
interactive transaction specification response
control.public InteractiveTransactionSpecificationResponseControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.public static InteractiveTransactionSpecificationResponseControl get(LDAPResult result) throws LDAPException
result
- The result from which to retrieve the interactive
transaction specification response control.null
if the result
did not contain an interactive transaction specification response
control.LDAPException
- If a problem is encountered while attempting to
decode the interactive transaction specification
response control contained in the provided result.public boolean transactionValid()
true
if the associated transaction is still valid on the
server and may be used for future operations, or false
if
the transaction has been aborted and may no longer be used.public java.util.List<java.lang.String> getBaseDNs()
null
if there are no
restrictions or if the set of restrictions has not changed since
the last response.public java.lang.String getControlName()
getControlName
in class Control