com.unboundid.ldap.sdk.unboundidds.controls

Class GetUserResourceLimitsRequestControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.unboundidds.controls.GetUserResourceLimitsRequestControl

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class GetUserResourceLimitsRequestControl
extends Control

This class provides a request control which may be used to request that the server return resource limit information for the authenticated user in the response to a successful bind operation. Resource limits that may be returned include custom size limit, time limit, idle time limit, lookthrough limit, equivalent authorization user DN, client connection policy name, and privilege names.

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 criticality for this control may be either 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.

If the control does have a value, then it should use the following encoding:

   GetUserResourceLimitsRequest ::= SEQUENCE {
        excludeGroups     [0] BOOLEAN DEFAULT FALSE,
        ... }
 

If the control does not have a value, then the server will assume the default behavior for all elements that would be in the value.

See Also:

GetUserResourceLimitsResponseControl, Serialized Form

Field Summary

Fields

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 Summary

Constructors

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.

Method Summary

Modifier and Type	Method and Description
static GetUserResourceLimitsRequestControl	decodeJSONControl(JSONObject controlObject, boolean strict) Attempts to decode the provided object as a JSON representation of a get user resource limits request control.
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.
JSONObject	toJSONControl() Retrieves a representation of this get user resource limits request control as a JSON object.
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, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

GET_USER_RESOURCE_LIMITS_REQUEST_OID

@NotNull
public static final 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.

See Also:

Constant Field Values

EXCLUDE_GROUPS_FEATURE_OID

@NotNull
public static final 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.

See Also:

Constant Field Values

Constructor Detail

GetUserResourceLimitsRequestControl

public GetUserResourceLimitsRequestControl()

Creates a new get user resource limits request control. It will not be marked critical.

GetUserResourceLimitsRequestControl

public GetUserResourceLimitsRequestControl(boolean isCritical)

Creates a new get user resource limits request control with the specified criticality.

Parameters:

isCritical - Indicates whether this control should be marked critical.

GetUserResourceLimitsRequestControl

public GetUserResourceLimitsRequestControl(boolean isCritical,
                                           boolean excludeGroups)

Creates a new get user resource limits request control with the specified criticality.

Parameters:

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.

GetUserResourceLimitsRequestControl

public GetUserResourceLimitsRequestControl(@NotNull
                                           Control control)
                                    throws LDAPException

Creates a new get user resource limits request control which is decoded from the provided generic control.

Parameters:

control - The generic control to be decoded as a get user resource limits request control.

Throws:

LDAPException - If the provided control cannot be decoded as a get user resource limits request control.

Method Detail

excludeGroups

public boolean excludeGroups()

Indicates whether the control requests that the server exclude information about group membership from the corresponding response control.

Returns:

true if the server should exclude information about group membership from the response control, or false if not.

serverAdvertisesExcludeGroupsFeature

public static boolean serverAdvertisesExcludeGroupsFeature(@NotNull
                                                           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.

Parameters:

rootDSE - An object with information from the root DSE of the server for which to make the determination. It must not be null.

Returns:

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.

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 class Control

Returns:

The user-friendly name for this control, or the OID if no user-friendly name is available.

toJSONControl

@NotNull
public JSONObject toJSONControl()

Retrieves a representation of this get user resource limits request control as a JSON object. The JSON object uses the following fields:

• oid -- A mandatory string field whose value is the object identifier for this control. For the get user resource limits request control, the OID is "1.3.6.1.4.1.30221.2.5.15".
• control-name -- An optional string field whose value is a human-readable name for this control. This field is only intended for descriptive purposes, and when decoding a control, the oid field should be used to identify the type of control.
• criticality -- A mandatory Boolean field used to indicate whether this control is considered critical.
• value-base64 -- An optional string field whose value is a base64-encoded representation of the raw value for this get user resource limits request control. Exactly one of the value-base64 and value-json fields must be present.
• value-json -- An optional JSON object field whose value is a user-friendly representation of the value for this get user resource limits request control. Exactly one of the value-base64 and value-json fields must be present, and if the value-json field is used, then it will use the following fields:
  • exclude-groups -- A mandatory Boolean field that indicates whether to exclude information about the user's group membership from the response control.

Overrides:

toJSONControl in class Control

Returns:

A JSON object that contains a representation of this control.

decodeJSONControl

@NotNull
public static GetUserResourceLimitsRequestControl decodeJSONControl(@NotNull
                                                                             JSONObject controlObject,
                                                                             boolean strict)
                                                                      throws LDAPException

Attempts to decode the provided object as a JSON representation of a get user resource limits request control.

Parameters:

controlObject - The JSON object to be decoded. It must not be null.

strict - Indicates whether to use strict mode when decoding the provided JSON object. If this is true, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this is false, then unrecognized fields will be ignored.

Returns:

The authorization identity request control that was decoded from the provided JSON object.

Throws:

LDAPException - If the provided JSON object cannot be parsed as a valid authorization identity request control.

toString

public void toString(@NotNull
                     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.