@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetUserResourceLimitsResponseControl extends Control implements DecodeableControl
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.
false
. It must have a
value with the following encoding:
USER_RESOURCE_LIMITS_VALUE ::= SEQUENCE { sizeLimit [0] INTEGER OPTIONAL, timeLimitSeconds [1] INTEGER OPTIONAL, idleTimeLimitSeconds [2] INTEGER OPTIONAL, lookthroughLimit [3] INTEGER OPTIONAL, equivalentAuthzUserDN [4] LDAPDN OPTIONAL, clientConnectionPolicyName [5] OCTET STRING OPTIONAL, groupDNs [6] SET OF OCTET STRING OPTIONAL, privilegeNames [7] SET OF OCTET STRING OPTIONAL, otherAttributes [8] PartialAttributeList OPTIONAL, ... }
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
GET_USER_RESOURCE_LIMITS_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.5.26) for the get user resource limits
response control.
|
Constructor and Description |
---|
GetUserResourceLimitsResponseControl(java.lang.Long sizeLimit,
java.lang.Long timeLimitSeconds,
java.lang.Long idleTimeLimitSeconds,
java.lang.Long lookthroughLimit,
java.lang.String equivalentAuthzUserDN,
java.lang.String clientConnectionPolicyName)
Creates a new get user resource limits response control with the provided
information.
|
GetUserResourceLimitsResponseControl(java.lang.Long sizeLimit,
java.lang.Long timeLimitSeconds,
java.lang.Long idleTimeLimitSeconds,
java.lang.Long lookthroughLimit,
java.lang.String equivalentAuthzUserDN,
java.lang.String clientConnectionPolicyName,
java.util.List<java.lang.String> groupDNs,
java.util.List<java.lang.String> privilegeNames,
java.util.List<Attribute> otherAttributes)
Creates a new get user resource limits response control with the provided
information.
|
GetUserResourceLimitsResponseControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new get user resource limits response control decoded from the
given generic control contents.
|
Modifier and Type | Method and Description |
---|---|
GetUserResourceLimitsResponseControl |
decodeControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new instance of this decodeable control from the provided
information.
|
static GetUserResourceLimitsResponseControl |
get(BindResult result)
Extracts a get user resource limits response control from the provided
result.
|
java.lang.String |
getClientConnectionPolicyName()
Retrieves the name of the client connection policy that has been assigned
to the user, if available.
|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available.
|
java.lang.String |
getEquivalentAuthzUserDN()
Retrieves the equivalent authorization user DN, for use in servers in an
entry-balancing environment in which the user's entry does not exist.
|
java.util.List<java.lang.String> |
getGroupDNs()
Retrieves the DNs of any groups in which the user is a member.
|
java.lang.Long |
getIdleTimeLimitSeconds()
Retrieves the custom idle time limit for the user in seconds, if available.
|
java.lang.Long |
getLookthroughLimit()
Retrieves the custom lookthrough limit for the user, if available.
|
Attribute |
getOtherAttribute(java.lang.String name)
Retrieves the "other" attribute with the specified name.
|
java.util.List<Attribute> |
getOtherAttributes()
Retrieves a list containing additional attributes from the user's entry.
|
java.util.List<java.lang.String> |
getPrivilegeNames()
Retrieves the names of any privileges assigned to the user.
|
java.lang.Long |
getSizeLimit()
Retrieves the custom size limit for the user, if available.
|
java.lang.Long |
getTimeLimitSeconds()
Retrieves the custom time limit for the user in seconds, if available.
|
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_RESPONSE_OID
public GetUserResourceLimitsResponseControl(@Nullable java.lang.Long sizeLimit, @Nullable java.lang.Long timeLimitSeconds, @Nullable java.lang.Long idleTimeLimitSeconds, @Nullable java.lang.Long lookthroughLimit, @Nullable java.lang.String equivalentAuthzUserDN, @Nullable java.lang.String clientConnectionPolicyName)
sizeLimit
- The custom size limit for the user.
It may be less than or equal to zero
if no size limit should be enforced for
the user. It may be null
if
there is no custom size limit or it is
not to be included in the control.timeLimitSeconds
- The custom time limit for the user, in
seconds. It may be less than or equal
to zero if no time limit should be
enforced for the user. It may be
null
if there is no custom time
limit or it is not to be included in
the control.idleTimeLimitSeconds
- The custom idle time limit for the
user, in seconds. It may be less than
or equal to zero if no idle time limit
should be enforced for the user. It
may be null
if there is no
custom idle time limit or it is not to
be included in the control.lookthroughLimit
- The custom lookthrough limit for the
user. It may be less than or equal to
zero if no lookthrough limit should
be enforced for the user. It may be
null
if there is no custom
lookthrough limit for the user or it is
not to be included in the control.equivalentAuthzUserDN
- The DN of a user with equivalent
authorization rights for use in servers
in an entry-balancing environment in
which the user's entry does not exist.
It may be an empty string if the
equivalent authorization should be
anonymous, or null
if there is
no custom equivalent authorization user
DN or it is not to be included in the
control.clientConnectionPolicyName
- The name of the client connection
policy that has been assigned to the
user, or null
if the client
connection policy name is not to be
included in the control.public GetUserResourceLimitsResponseControl(@Nullable java.lang.Long sizeLimit, @Nullable java.lang.Long timeLimitSeconds, @Nullable java.lang.Long idleTimeLimitSeconds, @Nullable java.lang.Long lookthroughLimit, @Nullable java.lang.String equivalentAuthzUserDN, @Nullable java.lang.String clientConnectionPolicyName, @Nullable java.util.List<java.lang.String> groupDNs, @Nullable java.util.List<java.lang.String> privilegeNames, @Nullable java.util.List<Attribute> otherAttributes)
sizeLimit
- The custom size limit for the user.
It may be less than or equal to zero
if no size limit should be enforced for
the user. It may be null
if
there is no custom size limit or it is
not to be included in the control.timeLimitSeconds
- The custom time limit for the user, in
seconds. It may be less than or equal
to zero if no time limit should be
enforced for the user. It may be
null
if there is no custom time
limit or it is not to be included in
the control.idleTimeLimitSeconds
- The custom idle time limit for the
user, in seconds. It may be less than
or equal to zero if no idle time limit
should be enforced for the user. It
may be null
if there is no
custom idle time limit or it is not to
be included in the control.lookthroughLimit
- The custom lookthrough limit for the
user. It may be less than or equal to
zero if no lookthrough limit should
be enforced for the user. It may be
null
if there is no custom
lookthrough limit for the user or it is
not to be included in the control.equivalentAuthzUserDN
- The DN of a user with equivalent
authorization rights for use in servers
in an entry-balancing environment in
which the user's entry does not exist.
It may be an empty string if the
equivalent authorization should be
anonymous, or null
if there is
no custom equivalent authorization user
DN or it is not to be included in the
control.clientConnectionPolicyName
- The name of the client connection
policy that has been assigned to the
user, or null
if the client
connection policy name is not to be
included in the control.groupDNs
- The DNs of the groups in which the user
is a member. It may be null
if
group membership is not known, or
empty if the user isn't a member of any
groups.privilegeNames
- The names of the privileges assigned to
the user. It may be null
if
the privilege names are not known, or
empty if the user doesn't have any
privileges.otherAttributes
- A set of additional attributes from the
user's entry. It may be null
or empty if no additional attributes
are needed.public GetUserResourceLimitsResponseControl(@NotNull java.lang.String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
oid
- The OID for the control.isCritical
- Indicates whether this control should be marked
critical.value
- The value for the control. It may be null
if
the control to decode does not have a value.LDAPException
- If a problem occurs while attempting to decode the
generic control as a get user resource limits
response control.@NotNull public GetUserResourceLimitsResponseControl decodeControl(@NotNull java.lang.String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.@Nullable public static GetUserResourceLimitsResponseControl get(@NotNull BindResult result) throws LDAPException
result
- The bind result from which to retrieve the get user
resource limits response control.null
if the result did not contain a
get user resource limits response control.LDAPException
- If a problem is encountered while attempting to
decode the get user resource limits response
control contained in the provided result.@Nullable public java.lang.Long getSizeLimit()
null
if no custom size limit
was included in the control.@Nullable public java.lang.Long getTimeLimitSeconds()
null
if no custom time
limit was included in the control.@Nullable public java.lang.Long getIdleTimeLimitSeconds()
null
if no
custom idle time limit was included in the control.@Nullable public java.lang.Long getLookthroughLimit()
null
if no
custom lookthrough limit was included in the control.@Nullable public java.lang.String getEquivalentAuthzUserDN()
null
if
no equivalent authorization user DN was included in the control.@Nullable public java.lang.String getClientConnectionPolicyName()
null
if the client connection policy name was
not included in the control.@Nullable public java.util.List<java.lang.String> getGroupDNs()
null
if the
set of group DNs is not known.@Nullable public java.util.List<java.lang.String> getPrivilegeNames()
null
if the
set of user privileges is not known.@NotNull public java.util.List<Attribute> getOtherAttributes()
@Nullable public Attribute getOtherAttribute(@NotNull java.lang.String name)
name
- The name of the "other" attribute to retrieve. It must not
be null
.null
if
there is no such "other" attribute.@NotNull public java.lang.String getControlName()
getControlName
in class Control