Class RejectUnindexedSearchRequestControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.unboundidds.controls.RejectUnindexedSearchRequestControl
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class RejectUnindexedSearchRequestControl extends Control
This class provides an implementation of a request control that may be included in a search request to indicate that the server should reject the request if the server cannot use its defined indexes to identify matching entries efficiently. This can prevent a requester with the unindexed search privilege from inadvertently submitting an expensive search request that could require a long time to complete and potentially consume significant server resources. This request control has an OID of "1.3.6.1.4.1.30221.2.5.54", may have a criticality of either true or false, and does not take a value.
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.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
REJECT_UNINDEXED_SEARCH_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.54) for the reject unindexed search request control.
-
Constructor Summary
Constructors Constructor Description RejectUnindexedSearchRequestControl()
Creates a new reject unindexed search request control with a criticality oftrue
.RejectUnindexedSearchRequestControl(boolean isCritical)
Creates a new reject unindexed search request control with the specified criticality.RejectUnindexedSearchRequestControl(Control control)
Creates a new reject unindexed search request control that is decoded from the provided generic control.
-
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.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
-
-
-
-
Field Detail
-
REJECT_UNINDEXED_SEARCH_REQUEST_OID
public static final java.lang.String REJECT_UNINDEXED_SEARCH_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.54) for the reject unindexed search request control.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
RejectUnindexedSearchRequestControl
public RejectUnindexedSearchRequestControl()
Creates a new reject unindexed search request control with a criticality oftrue
.
-
RejectUnindexedSearchRequestControl
public RejectUnindexedSearchRequestControl(boolean isCritical)
Creates a new reject unindexed search request control with the specified criticality.- Parameters:
isCritical
- Indicates whether the control should be considered critical.
-
RejectUnindexedSearchRequestControl
public RejectUnindexedSearchRequestControl(Control control) throws LDAPException
Creates a new reject unindexed search request control that is decoded from the provided generic control.- Parameters:
control
- The generic control to be decoded as a reject unindexed search request control.- Throws:
LDAPException
- If the provided control cannot be decoded as a reject unindexed search request control.
-
-
Method Detail
-
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 classControl
- Returns:
- The user-friendly name for this control, or the OID if no user-friendly name is available.
-
-