public final class ProxiedAuthV1RequestControl extends Object implements Control
This control implementation is based on version 1 of the proxied authorization control as defined in early versions of draft-weltman-ldapv3-proxy (this implementation is based on the "-04" revision) and is intended for use in legacy applications. New applications should use the v2 version of this control in preference.
Modifier and Type | Field and Description |
---|---|
static ControlDecoder<ProxiedAuthV1RequestControl> |
DECODER
A decoder which can be used for decoding the proxied authorization v1 request control.
|
static String |
OID
The OID for the proxied authorization v1 control.
|
Modifier and Type | Method and Description |
---|---|
Dn |
getAuthorizationDnName()
Returns the distinguished name of the user whose authorization is to be
used when performing the operation.
|
String |
getOid()
Returns the numeric OID associated with this control.
|
ByteString |
getValue()
Returns the value, if any, associated with this control.
|
boolean |
hasValue()
Returns
true if this control has a value. |
boolean |
isCritical()
Returns
true if it is unacceptable to perform the operation
without applying the semantics of this control. |
static ProxiedAuthV1RequestControl |
newControl(Dn authorizationName)
Creates a new proxy authorization v1 request control with the provided
authorization name.
|
static ProxiedAuthV1RequestControl |
newControl(String authorizationName)
Creates a new proxy authorization v1 request control with the provided
authorization name decoded using the default schema.
|
String |
toString() |
public static final String OID
public static final ControlDecoder<ProxiedAuthV1RequestControl> DECODER
public static ProxiedAuthV1RequestControl newControl(Dn authorizationName)
authorizationName
- The distinguished name of the user whose authorization is to
be used when performing the operation.NullPointerException
- If authorizationName
was null
.public static ProxiedAuthV1RequestControl newControl(String authorizationName)
authorizationName
- The distinguished name of the user whose authorization is to
be used when performing the operation.LocalizedIllegalArgumentException
- If authorizationName
is not a valid LDAP string
representation of a DN.NullPointerException
- If authorizationName
was null
.public Dn getAuthorizationDnName()
public String getOid()
Control
public ByteString getValue()
Control
public boolean hasValue()
Control
true
if this control has a value. In some circumstances
it may be useful to determine if a control has a value, without actually
calculating the value and incurring any performance costs.public boolean isCritical()
Control
true
if it is unacceptable to perform the operation
without applying the semantics of this control.
The criticality field only has meaning in controls attached to request
messages (except UnbindRequest). For controls attached to response
messages and the UnbindRequest, the criticality field SHOULD be
false
, and MUST be ignored by the receiving protocol peer. A
value of true
indicates that it is unacceptable to perform the
operation without applying the semantics of the control.
isCritical
in interface Control
true
if this control must be processed by the Directory
Server, or false
if it can be ignored.Copyright 2010-2022 ForgeRock AS.