Class OverrideSearchLimitsRequestControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.unboundidds.controls.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 eithertrue
orfalse
, 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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getControlName()
Retrieves the user-friendly name for this control, if available.java.util.Map<java.lang.String,java.lang.String>
getProperties()
Retrieves a map of the properties included in this request control.java.lang.String
getProperty(java.lang.String propertyName)
Retrieves the value of the specified property.java.lang.Boolean
getPropertyAsBoolean(java.lang.String propertyName, java.lang.Boolean defaultValue)
Retrieves the value of the specified property as aBoolean
.java.lang.Integer
getPropertyAsInteger(java.lang.String propertyName, java.lang.Integer defaultValue)
Retrieves the value of the specified property as anInteger
.java.lang.Long
getPropertyAsLong(java.lang.String propertyName, java.lang.Long defaultValue)
Retrieves the value of the specified property as aLong
.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, registerDecodeableControl, toString, writeTo
-
-
-
-
Field Detail
-
OVERRIDE_SEARCH_LIMITS_REQUEST_OID
@NotNull public static final 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.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
OverrideSearchLimitsRequestControl
public OverrideSearchLimitsRequestControl(@NotNull java.lang.String propertyName, @NotNull 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 benull
or empty.propertyValue
- The value for the specified property. It must not benull
or empty.
-
OverrideSearchLimitsRequestControl
public OverrideSearchLimitsRequestControl(@NotNull 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 benull
or empty, and none of the keys or values inside it may benull
or empty.isCritical
- Indicates whether the control should be considered critical.
-
OverrideSearchLimitsRequestControl
public OverrideSearchLimitsRequestControl(@NotNull 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 benull
.- Throws:
LDAPException
- If the provided control cannot be decoded as an override search limits request control.
-
-
Method Detail
-
getProperties
@NotNull 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
@Nullable public java.lang.String getProperty(@NotNull 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 benull
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
@Nullable public java.lang.Boolean getPropertyAsBoolean(@NotNull java.lang.String propertyName, @Nullable java.lang.Boolean defaultValue)
Retrieves the value of the specified property as aBoolean
.- Parameters:
propertyName
- The name of the property for which to retrieve the value. It must not benull
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 aBoolean
. It may benull
if the default value should benull
.- 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
@Nullable public java.lang.Integer getPropertyAsInteger(@NotNull java.lang.String propertyName, @Nullable java.lang.Integer defaultValue)
Retrieves the value of the specified property as anInteger
.- Parameters:
propertyName
- The name of the property for which to retrieve the value. It must not benull
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 anInteger
. It may benull
if the default value should benull
.- 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
@Nullable public java.lang.Long getPropertyAsLong(@NotNull java.lang.String propertyName, @Nullable java.lang.Long defaultValue)
Retrieves the value of the specified property as aLong
.- Parameters:
propertyName
- The name of the property for which to retrieve the value. It must not benull
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 anLong
. It may benull
if the default value should benull
.- 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
@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 classControl
- Returns:
- The user-friendly name for this control, or the OID if no user-friendly name is available.
-
-