Package com.unboundid.ldap.sdk.unboundidds.controls

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​(@NotNull
                                                        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​(@NotNull
                                                        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,
                                                        @NotNull
                                                        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,
                                                        @NotNull
                                                        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​(@NotNull
                                                        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

        @NotNull
public java.util.Set<SuppressType> getSuppressTypes()
        Retrieves the set of suppress types for this control.
        Returns:
        The set of suppress types for this control.

      • getControlName

        @NotNull
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.

      • toJSONControl

        @NotNull
public JSONObject toJSONControl()
        Retrieves a representation of this suppress operational attribute update request control as a JSON object. The JSON object uses the following fields:
        • oid -- A mandatory string field whose value is the object identifier for this control. For the suppress operational attribute update request control, the OID is "1.3.6.1.4.1.30221.2.5.27".
        • control-name -- An optional string field whose value is a human-readable name for this control. This field is only intended for descriptive purposes, and when decoding a control, the oid field should be used to identify the type of control.
        • criticality -- A mandatory Boolean field used to indicate whether this control is considered critical.
        • value-base64 -- An optional string field whose value is a base64-encoded representation of the raw value for this suppress operational attribute update request control. Exactly one of the value-base64 and value-json fields must be present.
        • value-json -- An optional JSON object field whose value is a user-friendly representation of the value for this suppress operational attribute update control. Exactly one of the value-base64 and value-json fields must be present, and if the value-json field is used, then it will use the following fields:
          • suppress-types -- A mandatory array field whose values are the names of the types of updates that should be suppressed. Allowed values include "last-access-time", "last-login-time", "last-login-ip-address", and "lastmod".
        Overrides:
        toJSONControl in class Control
        Returns:
        A JSON object that contains a representation of this control.

      • decodeJSONControl

        @NotNull
public static SuppressOperationalAttributeUpdateRequestControl decodeJSONControl​(@NotNull
                                                                                 JSONObject controlObject,
                                                                                 boolean strict)
                                                                          throws LDAPException
        Attempts to decode the provided object as a JSON representation of a suppress operational attribute update request control.
        Parameters:
        controlObject - The JSON object to be decoded. It must not be null.
        strict - Indicates whether to use strict mode when decoding the provided JSON object. If this is true, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this is false, then unrecognized fields will be ignored.
        Returns:
        The suppress operational attribute update request control that was decoded from the provided JSON object.
        Throws:
        LDAPException - If the provided JSON object cannot be parsed as a valid suppress operational attribute update request control.

      • toString

        public void toString​(@NotNull
                     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.