|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.TransactionSettingsResponseControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class TransactionSettingsResponseControl
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 a response control that may be used to provide the client with information about transaction-related information over the course of the associated operation.
false
, and a value with the following encoding:
TransactionSettingsResponseValue ::= SEQUENCE { numLockConflicts [0] INTEGER backendLockAcquired [1] BOOLEAN, ... }
Field Summary | |
---|---|
static java.lang.String |
TRANSACTION_SETTINGS_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.5.39) for the transaction settings response control. |
Constructor Summary | |
---|---|
TransactionSettingsResponseControl(int numLockConflicts,
boolean backendLockAcquired)
Creates a new transaction settings response control with the provided information. |
|
TransactionSettingsResponseControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new transaction settings response control with the provided information. |
Method Summary | |
---|---|
boolean |
backendLockAcquired()
Indicates whether the exclusive backend lock was acquired at any point during the course of processing the associated operation. |
TransactionSettingsResponseControl |
decodeControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new instance of this decodeable control from the provided information. |
static TransactionSettingsResponseControl |
get(ExtendedResult extendedResult)
Extracts a transaction settings response control from the provided extended result. |
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available. |
int |
getNumLockConflicts()
Retrieves the number of lock conflicts encountered during the course of processing the associated operation. |
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 |
---|
public static final java.lang.String TRANSACTION_SETTINGS_RESPONSE_OID
Constructor Detail |
---|
public TransactionSettingsResponseControl(int numLockConflicts, boolean backendLockAcquired)
numLockConflicts
- The number of lock conflicts encountered
during the course of processing the operation.backendLockAcquired
- Indicates whether the exclusive backend lock
was acquired at any point during the course of
processing the operation.public TransactionSettingsResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
oid
- The OID for the control.isCritical
- Indicates whether the control should be considered
critical.value
- The value for the control.
LDAPException
- If the provided information cannot be used to
create a valid soft delete response control.Method Detail |
---|
public TransactionSettingsResponseControl 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 int getNumLockConflicts()
public boolean backendLockAcquired()
true
if the backend lock was acquired, or false
if
not.public static TransactionSettingsResponseControl get(ExtendedResult extendedResult) throws LDAPException
extendedResult
- The extended result from which to retrieve the
transaction settings response control.
null
if the result did not
contain a transaction settings response control.
LDAPException
- If a problem is encountered while attempting to
decode the transaction settings response control
contained in the provided result.public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |