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

java.lang.Object
  extended by com.unboundid.ldap.sdk.Control
      extended by com.unboundid.ldap.sdk.unboundidds.controls.GetUserResourceLimitsRequestControl
All Implemented Interfaces:
java.io.Serializable

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

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
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.

This control does not have a value. The criticality may be either true or false.

See Also:
GetUserResourceLimitsResponseControl, Serialized Form

Field Summary
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
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(Control control)
          Creates a new get user resource limits request control which is decoded from the provided generic control.
 
Method Summary
 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
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

GET_USER_RESOURCE_LIMITS_REQUEST_OID

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
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(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

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 class Control
Returns:
The user-friendly name for this control, or the OID if no user-friendly name is available.

toString

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