Class TransactionSettingsResponseControl

  • All Implemented Interfaces:
    DecodeableControl, java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class TransactionSettingsResponseControl
    extends Control
    implements DecodeableControl
    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.
    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.

    This control has an OID of 1.3.6.1.4.1.30221.2.5.39. It should have a criticality of false, and a value with the following encoding:
       TransactionSettingsResponseValue ::= SEQUENCE {
            numLockConflicts        [0] INTEGER
            backendLockAcquired     [1] BOOLEAN,
            ... }
     
    See Also:
    Serialized Form
    • Constructor Detail

      • TransactionSettingsResponseControl

        public TransactionSettingsResponseControl​(int numLockConflicts,
                                                  boolean backendLockAcquired)
        Creates a new transaction settings response control with the provided information.
        Parameters:
        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.
      • TransactionSettingsResponseControl

        public TransactionSettingsResponseControl​(java.lang.String oid,
                                                  boolean isCritical,
                                                  ASN1OctetString value)
                                           throws LDAPException
        Creates a new transaction settings response control with the provided information.
        Parameters:
        oid - The OID for the control.
        isCritical - Indicates whether the control should be considered critical.
        value - The value for the control.
        Throws:
        LDAPException - If the provided information cannot be used to create a valid soft delete response control.
    • Method Detail

      • decodeControl

        public TransactionSettingsResponseControl decodeControl​(java.lang.String oid,
                                                                boolean isCritical,
                                                                ASN1OctetString value)
                                                         throws LDAPException
        Creates a new instance of this decodeable control from the provided information.
        Specified by:
        decodeControl in interface DecodeableControl
        Parameters:
        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.
        Returns:
        The decoded representation of this control.
        Throws:
        LDAPException - If the provided information cannot be decoded as a valid instance of this decodeable control.
      • getNumLockConflicts

        public int getNumLockConflicts()
        Retrieves the number of lock conflicts encountered during the course of processing the associated operation.
        Returns:
        The number of lock conflicts encountered during the course of processing the associated operation.
      • backendLockAcquired

        public boolean backendLockAcquired()
        Indicates whether the exclusive backend lock was acquired at any point during the course of processing the associated operation.
        Returns:
        true if the backend lock was acquired, or false if not.
      • get

        public static TransactionSettingsResponseControl get​(ExtendedResult extendedResult)
                                                      throws LDAPException
        Extracts a transaction settings response control from the provided extended result.
        Parameters:
        extendedResult - The extended result from which to retrieve the transaction settings response control.
        Returns:
        The transaction settings response control contained in the provided extended result, or null if the result did not contain a transaction settings response control.
        Throws:
        LDAPException - If a problem is encountered while attempting to decode the transaction settings response control contained in the provided result.
      • getControlName

        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​(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.