@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class OverrideSearchLimitsRequestControl extends Control
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.
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 }
Modifier and Type | Field and 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 and 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.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.
|
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.
|
Modifier and Type | Method and 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 a
Boolean . |
java.lang.Integer |
getPropertyAsInteger(java.lang.String propertyName,
java.lang.Integer defaultValue)
Retrieves the value of the specified property as an
Integer . |
java.lang.Long |
getPropertyAsLong(java.lang.String propertyName,
java.lang.Long defaultValue)
Retrieves the value of the specified property as a
Long . |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided
buffer.
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
@NotNull public static final java.lang.String OVERRIDE_SEARCH_LIMITS_REQUEST_OID
public OverrideSearchLimitsRequestControl(@NotNull java.lang.String propertyName, @NotNull java.lang.String propertyValue)
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.public OverrideSearchLimitsRequestControl(@NotNull java.util.Map<java.lang.String,java.lang.String> properties, boolean isCritical)
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.public OverrideSearchLimitsRequestControl(@NotNull Control control) throws LDAPException
control
- The generic control to decode as an override search limits
request control. It must not be null
.LDAPException
- If the provided control cannot be decoded as an
override search limits request control.@NotNull public java.util.Map<java.lang.String,java.lang.String> getProperties()
@Nullable public java.lang.String getProperty(@NotNull java.lang.String propertyName)
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.null
if the
property is not set in the control.@Nullable public java.lang.Boolean getPropertyAsBoolean(@NotNull java.lang.String propertyName, @Nullable java.lang.Boolean defaultValue)
Boolean
.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
.Boolean
.@Nullable public java.lang.Integer getPropertyAsInteger(@NotNull java.lang.String propertyName, @Nullable java.lang.Integer defaultValue)
Integer
.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
.Integer
.@Nullable public java.lang.Long getPropertyAsLong(@NotNull java.lang.String propertyName, @Nullable java.lang.Long defaultValue)
Long
.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
.Long
.@NotNull public java.lang.String getControlName()
getControlName
in class Control