public final class ProxiedAuthV2RequestControl extends Object implements Control
The target user is specified using an authorization ID, or authzId,
as defined in RFC 4513 section 5.2.1.8.
This example shows an application replacing a description on a user entry on behalf of a directory administrator.
Connection connection = ...;
String bindDN = "cn=My App,ou=Apps,dc=example,dc=com"; // Client app
char[] password = ...;
String targetDn = "uid=bjensen,ou=People,dc=example,dc=com"; // Regular user
String authzId = "dn:uid=kvaughan,ou=People,dc=example,dc=com"; // Admin user
ModifyRequest request =
Requests.newModifyRequest(targetDn)
.addControl(ProxiedAuthV2RequestControl.newControl(authzId))
.addModification(ModificationType.REPLACE, "description",
"Done with proxied authz");
connection.bind(bindDN, password);
connection.modify(request);
Entry entry = connection.readEntry(targetDn, "description");
| Modifier and Type | Field and Description |
|---|---|
static ControlDecoder<ProxiedAuthV2RequestControl> |
DECODER
A decoder which can be used for decoding the proxied authorization v2
request control.
|
static String |
OID
The OID for the proxied authorization v2 control.
|
| Modifier and Type | Method and Description |
|---|---|
String |
getAuthorizationID()
Returns the authorization ID 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 ProxiedAuthV2RequestControl |
newControl(String authorizationID)
Creates a new proxy authorization v2 request control with the provided
authorization ID.
|
String |
toString() |
public static final String OID
public static final ControlDecoder<ProxiedAuthV2RequestControl> DECODER
public static ProxiedAuthV2RequestControl newControl(String authorizationID)
authorizationID - The authorization ID of the user whose authorization is to be
used when performing the operation.LocalizedIllegalArgumentException - If authorizationID was non-empty and did not contain
a valid authorization ID type.NullPointerException - If authorizationName was null.public String getAuthorizationID()
public ByteString getValue()
public boolean hasValue()
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()
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 Controltrue if this control must be processed by the Directory
Server, or false if it can be ignored.Copyright © 2011-2015 ForgeRock AS. All Rights Reserved.