b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * CDDL HEADER START
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * The contents of this file are subject to the terms of the
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Common Development and Distribution License, Version 1.0 only
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * (the "License"). You may not use this file except in compliance
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * with the License.
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac * or http://forgerock.org/license/CDDLv1.0.html.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * See the License for the specific language governing permissions
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * and limitations under the License.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * When distributing Covered Code, include this CDDL HEADER in each
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac * file and include the License file at legal-notices/CDDLv1_0.txt.
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac * If applicable, add the following below this CDDL HEADER, with the
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac * fields enclosed by brackets "[]" replaced with your own identifying
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac * information:
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Portions Copyright [yyyy] [name of copyright owner]
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * CDDL HEADER END
a395dd575518d9e5280fc5d5d5ef47c61b174647ludovicp * Copyright 2006-2008 Sun Microsystems, Inc.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilsonimport org.opends.server.types.AuthenticationType;
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * This class defines a set of methods that are available for use by
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * post-operation plugins for bind operations. Note that this
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * interface is intended only to define an API for use by plugins and
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * is not intended to be implemented by any custom classes.
8d7126a8f999e88851c7dd851a17c27cb6d2ec3fneil_a_wilson stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Retrieves the authentication type for this bind operation.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @return The authentication type for this bind operation.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson public AuthenticationType getAuthenticationType();
86548277ecc6d1ad5fa9126c63b44bdd24666e07neil_a_wilson * Retrieves a string representation of the protocol version
86548277ecc6d1ad5fa9126c63b44bdd24666e07neil_a_wilson * associated with this bind request.
86548277ecc6d1ad5fa9126c63b44bdd24666e07neil_a_wilson * @return A string representation of the protocol version
86548277ecc6d1ad5fa9126c63b44bdd24666e07neil_a_wilson * associated with this bind request.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Retrieves the raw, unprocessed bind DN for this bind operation as
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * contained in the client request. The value may not actually
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * contain a valid DN, as no validation will have been performed.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @return The raw, unprocessed bind DN for this bind operation as
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * contained in the client request.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Retrieves the bind DN for this bind operation.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @return The bind DN for this bind operation.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Retrieves the simple authentication password for this bind
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @return The simple authentication password for this bind
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Retrieves the SASL mechanism for this bind operation.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @return The SASL mechanism for this bind operation, or
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * <CODE>null</CODE> if the bind does not use SASL
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * authentication.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Retrieves the SASL credentials for this bind operation.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @return The SASL credentials for this bind operation, or
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * <CODE>null</CODE> if there are none or if the bind does
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * not use SASL authentication.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Retrieves the set of server SASL credentials to include in the
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * bind response.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @return The set of server SASL credentials to include in the
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * bind response, or <CODE>null</CODE> if there are none.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Specifies the set of server SASL credentials to include in the
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * bind response.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @param serverSASLCredentials The set of server SASL credentials
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * to include in the bind response.
7185b49f58c4cdb16d035ecc45e38ec9b1cd9bd0matthew_swift public void setServerSASLCredentials(ByteString
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Retrieves the user entry associated with the SASL authentication
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * attempt. This should be set by any SASL mechanism in which the
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * processing was able to get far enough to make this determination,
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * regardless of whether the authentication was ultimately
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * successful.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @return The user entry associated with the SASL authentication
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * attempt, or <CODE>null</CODE> if it was not a SASL
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * authentication or the SASL processing was not able to
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * map the request to a user.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Retrieves a human-readable message providing the reason that the
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * authentication failed, if available.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @return A human-readable message providing the reason that the
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * authentication failed, or <CODE>null</CODE> if none is
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Specifies the reason that the authentication failed.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @param reason A human-readable message providing the reason
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * that the authentication failed.
53247d28ba99538f841a13ea2cde01c3faa3ef36kenneth_suter public void setAuthFailureReason(Message reason);
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Retrieves the user entry DN for this bind operation. It will
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * only be available if the bind processing has proceeded far enough
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * to identify the user attempting to authenticate.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @return The user entry DN for this bind operation, or
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * <CODE>null</CODE> if the bind processing has not
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * progressed far enough to identify the user or if the
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * user DN could not be determined.