|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.controls.ProxiedAuthorizationV2RequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ProxiedAuthorizationV2RequestControl
This class provides an implementation of the proxied authorization V2
request control, as defined in
RFC 4370. It may be used
to request that the associated operation be performed as if it has been
requested by some other user.
The target authorization identity for this control is specified as an
"authzId" value as described in section 5.2.1.8 of
RFC 4513. That is, it
should be either "dn:" followed by the distinguished name of the target user,
or "u:" followed by the username. If the "u:" form is used, then the
mechanism used to resolve the provided username to an entry may vary from
server to server.
This control may be used in conjunction with add, delete, compare, delete,
extended, modify, modify DN, and search requests. In that case, the
associated operation will be processed under the authority of the specified
authorization identity rather than the identity associated with the client
connection (i.e., the user as whom that connection is bound). Note that
because of the inherent security risks associated with the use of the proxied
authorization control, most directory servers which support its use enforce
strict restrictions on the users that are allowed to request this control.
If a user attempts to use the proxied authorization V2 request control and
does not have sufficient permission to do so, then the server will return a
failure response with the ResultCode.AUTHORIZATION_DENIED
result
code.
There is no corresponding response control for this request control.
// Create a delete request to delete an entry. Include the proxied // authorization v2 request control in the delete request so that the // delete will be processed as the user with username "alternate.user" // instead of the user that's actually authenticated on the connection. DeleteRequest deleteRequest = new DeleteRequest("uid=test.user,ou=People,dc=example,dc=com"); deleteRequest.addControl(new ProxiedAuthorizationV2RequestControl( "u:alternate.user")); LDAPResult deleteResult; try { deleteResult = connection.delete(deleteRequest); // If we got here, then the delete was successful. } catch (LDAPException le) { // The delete failed for some reason. In addition to all of the normal // reasons a delete could fail (e.g., the entry doesn't exist, or has one // or more subordinates), proxied-authorization specific failures may // include that the authenticated user doesn't have permission to use the // proxied authorization control to impersonate the alternate user, that // the alternate user doesn't exist, or that the alternate user doesn't // have permission to perform the requested operation. deleteResult = le.toLDAPResult(); ResultCode resultCode = le.getResultCode(); String errorMessageFromServer = le.getDiagnosticMessage(); }
Field Summary | |
---|---|
static java.lang.String |
PROXIED_AUTHORIZATION_V2_REQUEST_OID
The OID (2.16.840.1.113730.3.4.18) for the proxied authorization v2 request control. |
Constructor Summary | |
---|---|
ProxiedAuthorizationV2RequestControl(Control control)
Creates a new proxied authorization v2 request control which is decoded from the provided generic control. |
|
ProxiedAuthorizationV2RequestControl(java.lang.String authorizationID)
Creates a new proxied authorization V2 request control that will proxy as the specified user. |
Method Summary | |
---|---|
java.lang.String |
getAuthorizationID()
Retrieves the authorization ID string that will be used to identify the user under whose authorization the associated operation should be performed. |
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 |
---|
public static final java.lang.String PROXIED_AUTHORIZATION_V2_REQUEST_OID
Constructor Detail |
---|
public ProxiedAuthorizationV2RequestControl(java.lang.String authorizationID)
authorizationID
- The authorization ID string that will be used to
identify the user under whose authorization the
associated operation should be performed. It may
take one of three forms: it can be an empty
string (to indicate that the operation should use
anonymous authorization), a string that begins
with "dn:" and is followed by the DN of the target
user, or a string that begins with "u:" and is
followed by the username for the target user
(where the process of mapping the provided
username to the corresponding entry will depend on
the server configuration). It must not be
null
.public ProxiedAuthorizationV2RequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as a proxied
authorization v2 request control.
LDAPException
- If the provided control cannot be decoded as a
proxied authorization v2 request control.Method Detail |
---|
public java.lang.String getAuthorizationID()
public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |