com.unboundid.ldap.sdk.unboundidds.controls
Class SuppressOperationalAttributeUpdateRequestControl

java.lang.Object
  extended by com.unboundid.ldap.sdk.Control
      extended by com.unboundid.ldap.sdk.unboundidds.controls.SuppressOperationalAttributeUpdateRequestControl
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class SuppressOperationalAttributeUpdateRequestControl
extends Control

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

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

Field Summary
static java.lang.String SUPPRESS_OP_ATTR_UPDATE_REQUEST_OID
          The OID (1.3.6.1.4.1.30221.2.5.27) for the suppress operational attribute update request control.
 
Constructor Summary
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.
SuppressOperationalAttributeUpdateRequestControl(boolean isCritical, SuppressType... suppressTypes)
          Creates a new instance of this control that will suppress updates to the specified kinds of operational attributes.
SuppressOperationalAttributeUpdateRequestControl(java.util.Collection<SuppressType> suppressTypes)
          Creates a new instance of this control that will suppress updates to the specified kinds of operational attributes.
SuppressOperationalAttributeUpdateRequestControl(Control control)
          Decodes the provided generic control as a suppress operational attribute update request control.
SuppressOperationalAttributeUpdateRequestControl(SuppressType... suppressTypes)
          Creates a new instance of this control that will suppress updates to the specified kinds of operational attributes.
 
Method Summary
 java.lang.String getControlName()
          Retrieves the user-friendly name for this control, if available.
 java.util.Set<SuppressType> getSuppressTypes()
          Retrieves the set of suppress types for this control.
 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

SUPPRESS_OP_ATTR_UPDATE_REQUEST_OID

public static final java.lang.String SUPPRESS_OP_ATTR_UPDATE_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.27) for the suppress operational attribute update request control.

See Also:
Constant Field Values
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<SuppressType> getSuppressTypes()
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.