Class 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.

    This control does not have a value. The criticality may be either true or false.
    See Also:
    GetUserResourceLimitsResponseControl, Serialized Form
    • Constructor Detail

      • 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.