Class SuppressOperationalAttributeUpdateRequestControl

  • All Implemented Interfaces:
    java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class SuppressOperationalAttributeUpdateRequestControl
    extends Control
    This class provides an implementation of a control that can be used to indicate that the server should suppress the update to one or more operational attributes for the associated request.
    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.

    The request control has an OID of 1.3.6.1.4.1.30221.2.5.27, and the criticality may be either true or false. The control must have a value with the following encoding:
       SuppressOperationalAttributeUpdateRequestValue ::= SEQUENCE {
            suppressTypes     [0] SEQUENCE OF ENUMERATED {
                 last-access-time     (0),
                 last-login-time      (1),
                 last-login-ip        (2),
                 lastmod              (3),
                 ... },
            ... }
     
    See Also:
    Serialized Form
    • Constructor Detail

      • SuppressOperationalAttributeUpdateRequestControl

        public SuppressOperationalAttributeUpdateRequestControl​(SuppressType... suppressTypes)
        Creates a new instance of this control that will suppress updates to the specified kinds of operational attributes. It will not be critical.
        Parameters:
        suppressTypes - The set of suppress types to include in the control. It must not be null or empty.
      • SuppressOperationalAttributeUpdateRequestControl

        public SuppressOperationalAttributeUpdateRequestControl​(java.util.Collection<SuppressType> suppressTypes)
        Creates a new instance of this control that will suppress updates to the specified kinds of operational attributes. It will not be critical.
        Parameters:
        suppressTypes - The set of suppress types to include in the control. It must not be null or empty.
      • SuppressOperationalAttributeUpdateRequestControl

        public SuppressOperationalAttributeUpdateRequestControl​(boolean isCritical,
                                                                SuppressType... suppressTypes)
        Creates a new instance of this control that will suppress updates to the specified kinds of operational attributes.
        Parameters:
        isCritical - Indicates whether the control should be considered critical.
        suppressTypes - The set of suppress types to include in the control. It must not be null or empty.
      • SuppressOperationalAttributeUpdateRequestControl

        public SuppressOperationalAttributeUpdateRequestControl​(boolean isCritical,
                                                                java.util.Collection<SuppressType> suppressTypes)
        Creates a new instance of this control that will suppress updates to the specified kinds of operational attributes.
        Parameters:
        isCritical - Indicates whether the control should be considered critical.
        suppressTypes - The set of suppress types to include in the control. It must not be null or empty.
      • SuppressOperationalAttributeUpdateRequestControl

        public SuppressOperationalAttributeUpdateRequestControl​(Control control)
                                                         throws LDAPException
        Decodes the provided generic control as a suppress operational attribute update request control.
        Parameters:
        control - The generic control to be decoded as a suppress operational attribute update request control.
        Throws:
        LDAPException - If a problem is encountered while attempting to decode the provided control.
    • Method Detail

      • getSuppressTypes

        public java.util.Set<SuppressTypegetSuppressTypes()
        Retrieves the set of suppress types for this control.
        Returns:
        The set of suppress types for this control.
      • 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.