AuthorizationIdentityRequestControl.java revision 6870993d12bf8a2b9d5cd103dc5ccabc42f9bf5d
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2010 Sun Microsystems, Inc.
*/
/**
* The authorization request control as defined in RFC 3829. The authorization
* identity control extends the Lightweight Directory Access Protocol (LDAP)
* bind operation with a mechanism for requesting and returning the
* authorization identity it establishes.
* <p>
* The following excerpt shows how to get the authorization identity established
* when binding to the directory server.
*
* <pre>
* Connection connection = ...;
* String bindDN = ...;
* String bindPassword = ...;
*
* BindRequest request =
* Requests.newSimpleBindRequest(bindDN, bindPassword.toCharArray())
* .addControl(AuthorizationIdentityRequestControl
* .newControl(true));
*
* BindResult result = connection.bind(request);
* AuthorizationIdentityResponseControl control =
* result.getControl(AuthorizationIdentityResponseControl.DECODER,
* new DecodeOptions());
* // Authorization ID returned: control.getAuthorizationID()
* </pre>
*
* @see AuthorizationIdentityResponseControl
* @see org.forgerock.opendj.ldap.requests.WhoAmIExtendedRequest
* @see <a href="http://tools.ietf.org/html/rfc3829">RFC 3829 - Lightweight
* Directory Access Protocol (LDAP) Authorization Identity Request and
* Response Controls </a>
* @see <a href="http://tools.ietf.org/html/rfc4532">RFC 4532 - Lightweight
* Directory Access Protocol (LDAP) "Who am I?" Operation </a>
*/
public final class AuthorizationIdentityRequestControl implements Control {
/**
* The OID for the authorization identity request control.
*/
private final boolean isCritical;
private static final AuthorizationIdentityRequestControl CRITICAL_INSTANCE =
new AuthorizationIdentityRequestControl(true);
private static final AuthorizationIdentityRequestControl NONCRITICAL_INSTANCE =
new AuthorizationIdentityRequestControl(false);
/**
* A decoder which can be used for decoding the authorization identity
* request control.
*/
if (control instanceof AuthorizationIdentityRequestControl) {
return (AuthorizationIdentityRequestControl) control;
}
final LocalizableMessage message =
}
}
}
return OID;
}
};
/**
* Creates a new authorization identity request control having the provided
* criticality.
*
* @param isCritical
* {@code true} if it is unacceptable to perform the operation
* without applying the semantics of this control, or
* {@code false} if it can be ignored.
* @return The new control.
*/
}
/** Prevent direct instantiation. */
private AuthorizationIdentityRequestControl(final boolean isCritical) {
this.isCritical = isCritical;
}
/** {@inheritDoc} */
return OID;
}
/** {@inheritDoc} */
public ByteString getValue() {
return null;
}
/** {@inheritDoc} */
public boolean hasValue() {
return false;
}
/** {@inheritDoc} */
public boolean isCritical() {
return isCritical;
}
/** {@inheritDoc} */
}
}