Class OverrideSearchLimitsRequestControl

  • All Implemented Interfaces:
    java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class OverrideSearchLimitsRequestControl
    extends Control
    This class provides an implementation of a control that may be included in a search request to override certain default limits that would normally be in place for the operation. The override behavior is specified using one or more name-value pairs, with property names being case sensitive.
    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 control has an OID of 1.3.6.1.4.1.30221.2.5.56, a criticality of either true or false, and a value with the provided encoding: that contains a mapping of one or more case-sensitive property-value pairs. Property names will be treated in a case-sensitive manner. the following encoding:
       OverrideSearchLimitsRequestValue ::= SEQUENCE OF SEQUENCE {
            propertyName      OCTET STRING,
            propertyValue     OCTET STRING }
     
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String OVERRIDE_SEARCH_LIMITS_REQUEST_OID
      The OID (1.3.6.1.4.1.30221.2.5.56) for the override search limits request control.
    • Constructor Summary

      Constructors 
      Constructor Description
      OverrideSearchLimitsRequestControl​(Control control)
      Creates a new instance of this override search limits request control that is decoded from the provided generic control.
      OverrideSearchLimitsRequestControl​(java.lang.String propertyName, java.lang.String propertyValue)
      Creates a new instance of this override search limits request control with the specified property name and value.
      OverrideSearchLimitsRequestControl​(java.util.Map<java.lang.String,​java.lang.String> properties, boolean isCritical)
      Creates a new instance of this override search limits request control with the provided set of properties.
    • Constructor Detail

      • OverrideSearchLimitsRequestControl

        public OverrideSearchLimitsRequestControl​(java.lang.String propertyName,
                                                  java.lang.String propertyValue)
        Creates a new instance of this override search limits request control with the specified property name and value. It will not be critical.
        Parameters:
        propertyName - The name of the property to set. It must not be null or empty.
        propertyValue - The value for the specified property. It must not be null or empty.
      • OverrideSearchLimitsRequestControl

        public OverrideSearchLimitsRequestControl​(java.util.Map<java.lang.String,​java.lang.String> properties,
                                                  boolean isCritical)
        Creates a new instance of this override search limits request control with the provided set of properties.
        Parameters:
        properties - The map of properties to set in this control. It must not be null or empty, and none of the keys or values inside it may be null or empty.
        isCritical - Indicates whether the control should be considered critical.
      • OverrideSearchLimitsRequestControl

        public OverrideSearchLimitsRequestControl​(Control control)
                                           throws LDAPException
        Creates a new instance of this override search limits request control that is decoded from the provided generic control.
        Parameters:
        control - The generic control to decode as an override search limits request control. It must not be null.
        Throws:
        LDAPException - If the provided control cannot be decoded as an override search limits request control.
    • Method Detail

      • getProperties

        public java.util.Map<java.lang.String,​java.lang.String> getProperties()
        Retrieves a map of the properties included in this request control.
        Returns:
        A map of the properties included in this request control.
      • getProperty

        public java.lang.String getProperty​(java.lang.String propertyName)
        Retrieves the value of the specified property.
        Parameters:
        propertyName - The name of the property for which to retrieve the value. It must not be null or empty, and it will be treated in a case-sensitive manner.
        Returns:
        The value of the requested property, or null if the property is not set in the control.
      • getPropertyAsBoolean

        public java.lang.Boolean getPropertyAsBoolean​(java.lang.String propertyName,
                                                      java.lang.Boolean defaultValue)
        Retrieves the value of the specified property as a Boolean.
        Parameters:
        propertyName - The name of the property for which to retrieve the value. It must not be null or empty, and it will be treated in a case-sensitive manner.
        defaultValue - The default value that will be used if the requested property is not set or if its value cannot be parsed as a Boolean. It may be null if the default value should be null.
        Returns:
        The Boolean value of the requested property, or the provided default value if the property is not set or if its value cannot be parsed as a Boolean.
      • getPropertyAsInteger

        public java.lang.Integer getPropertyAsInteger​(java.lang.String propertyName,
                                                      java.lang.Integer defaultValue)
        Retrieves the value of the specified property as an Integer.
        Parameters:
        propertyName - The name of the property for which to retrieve the value. It must not be null or empty, and it will be treated in a case-sensitive manner.
        defaultValue - The default value that will be used if the requested property is not set or if its value cannot be parsed as an Integer. It may be null if the default value should be null.
        Returns:
        The integer value of the requested property, or the provided default value if the property is not set or if its value cannot be parsed as an Integer.
      • getPropertyAsLong

        public java.lang.Long getPropertyAsLong​(java.lang.String propertyName,
                                                java.lang.Long defaultValue)
        Retrieves the value of the specified property as a Long.
        Parameters:
        propertyName - The name of the property for which to retrieve the value. It must not be null or empty, and it will be treated in a case-sensitive manner.
        defaultValue - The default value that will be used if the requested property is not set or if its value cannot be parsed as an Long. It may be null if the default value should be null.
        Returns:
        The long value of the requested property, or the provided default value if the property is not set or if its value cannot be parsed as a Long.
      • 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.