@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetUserResourceLimitsRequestControl 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
.
It may optionally have a value, although it should only have a value if the
server advertises OID "1.3.6.1.4.1.30221.2.12.6"
(EXCLUDE_GROUPS_FEATURE_OID
) in the supportedFeatures attribute of
its root DSE. The serverAdvertisesExcludeGroupsFeature(com.unboundid.ldap.sdk.RootDSE)
method can
help clients make that determination.
GetUserResourceLimitsRequest ::= SEQUENCE { excludeGroups [0] BOOLEAN DEFAULT FALSE, ... }
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EXCLUDE_GROUPS_FEATURE_OID
The OID (1.3.6.1.4.1.30221.2.12.6) for the supportedFeature value that a
server should advertise in its root DSE if it supports a value indicating
that the server allows the control to include a value that indicates it
should omit group membership information from the response control.
|
static java.lang.String |
GET_USER_RESOURCE_LIMITS_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.25) for the get user resource limits request
control.
|
Constructor and Description |
---|
GetUserResourceLimitsRequestControl()
Creates a new get user resource limits request control.
|
GetUserResourceLimitsRequestControl(boolean isCritical)
Creates a new get user resource limits request control with the specified
criticality.
|
GetUserResourceLimitsRequestControl(boolean isCritical,
boolean excludeGroups)
Creates a new get user resource limits request control with the specified
criticality.
|
GetUserResourceLimitsRequestControl(Control control)
Creates a new get user resource limits request control which is decoded
from the provided generic control.
|
Modifier and Type | Method and Description |
---|---|
boolean |
excludeGroups()
Indicates whether the control requests that the server exclude information
about group membership from the corresponding response control.
|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available.
|
static boolean |
serverAdvertisesExcludeGroupsFeature(RootDSE rootDSE)
Indicates whether the provided root DSE advertises support for a feature
that indicates it is acceptable for the client to request that the server
omit group membership information from the corresponding response
control.
|
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 GET_USER_RESOURCE_LIMITS_REQUEST_OID
@NotNull public static final java.lang.String EXCLUDE_GROUPS_FEATURE_OID
public GetUserResourceLimitsRequestControl()
public GetUserResourceLimitsRequestControl(boolean isCritical)
isCritical
- Indicates whether this control should be marked
critical.public GetUserResourceLimitsRequestControl(boolean isCritical, boolean excludeGroups)
isCritical
- Indicates whether this control should be marked
critical.excludeGroups
- Indicates whether the server should exclude
information about group membership from the response
control. This should generally only be true
if the client has confirmed that the server supports
this ability, which may be determined using the
serverAdvertisesExcludeGroupsFeature(com.unboundid.ldap.sdk.RootDSE)
method.public GetUserResourceLimitsRequestControl(@NotNull Control control) throws LDAPException
control
- The generic control to be decoded as a get user resource
limits request control.LDAPException
- If the provided control cannot be decoded as a get
user resource limits request control.public boolean excludeGroups()
true
if the server should exclude information about group
membership from the response control, or false
if not.public static boolean serverAdvertisesExcludeGroupsFeature(@NotNull RootDSE rootDSE)
rootDSE
- An object with information from the root DSE of the server
for which to make the determination. It must not be
null
.true
if the provided root DSE object indicates that the
server supports clients requesting to exclude group membership
information from the response control, or false
if not.@NotNull public java.lang.String getControlName()
getControlName
in class Control