@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ProxiedAuthorizationV1RequestControl extends Control
ProxiedAuthorizationV2RequestControl
instead if this version.
ResultCode.AUTHORIZATION_DENIED
result for a proxied authorization V2
control if the requester does not have the appropriate permission to use that
control, this result will not necessarily be used for the same condition with
the proxied authorization V1 control because this result code was not defined
until the release of the proxied authorization V2 specification.
code.
// Create a delete request to delete an entry. Include the proxied // authorization v1 request control in the delete request so that the // delete will be processed as user // "uid=alternate.user,ou=People,dc=example,dc=com" 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 ProxiedAuthorizationV1RequestControl( "uid=alternate.user,ou=People,dc=example,dc=com")); 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(); }
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PROXIED_AUTHORIZATION_V1_REQUEST_OID
The OID (2.16.840.1.113730.3.4.12) for the proxied authorization v1 request
control.
|
Constructor and Description |
---|
ProxiedAuthorizationV1RequestControl(Control control)
Creates a new proxied authorization v1 request control which is decoded
from the provided generic control.
|
ProxiedAuthorizationV1RequestControl(DN proxyDN)
Creates a new proxied authorization V1 request control that will proxy as
the specified user.
|
ProxiedAuthorizationV1RequestControl(java.lang.String proxyDN)
Creates a new proxied authorization V1 request control that will proxy as
the specified user.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available.
|
java.lang.String |
getProxyDN()
Retrieves the DN of the target user under whose authorization the
associated request should be performed.
|
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, toString, writeTo
public static final java.lang.String PROXIED_AUTHORIZATION_V1_REQUEST_OID
public ProxiedAuthorizationV1RequestControl(java.lang.String proxyDN)
proxyDN
- The DN of the target user under whose authorization the
associated request should be performed. It must not be
null
, although it may be an empty string to
request an anonymous authorization.public ProxiedAuthorizationV1RequestControl(DN proxyDN)
proxyDN
- The DN of the target user under whose authorization the
associated request should be performed. It must not be
null
.public ProxiedAuthorizationV1RequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as a proxied
authorization v1 request control.LDAPException
- If the provided control cannot be decoded as a
proxied authorization v1 request control.public java.lang.String getProxyDN()
public java.lang.String getControlName()
getControlName
in class Control