PostResponseBindOperation.java revision 94e9037522922b67e8af412b4cfe476f5e991118
/*
* 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 2006-2008 Sun Microsystems, Inc.
* Portions Copyright 2014-2015 ForgeRock AS
*/
/**
* This class defines a set of methods that are available for use by
* post-response plugins for bind operations. Note that this
* interface is intended only to define an API for use by plugins and
* is not intended to be implemented by any custom classes.
*/
mayInstantiate=false,
mayExtend=false,
mayInvoke=true)
public interface PostResponseBindOperation
extends PostOperationOperation
{
/**
* Retrieves the authentication type for this bind operation.
*
* @return The authentication type for this bind operation.
*/
/**
* Retrieves a string representation of the protocol version
* associated with this bind request.
*
* @return A string representation of the protocol version
* associated with this bind request.
*/
/**
* Retrieves the raw, unprocessed bind DN for this bind operation as
* contained in the client request. The value may not actually
* contain a valid DN, as no validation will have been performed.
*
* @return The raw, unprocessed bind DN for this bind operation as
* contained in the client request.
*/
/**
* Retrieves the bind DN for this bind operation.
*
* @return The bind DN for this bind operation.
*/
/**
* Retrieves the simple authentication password for this bind
* operation.
*
* @return The simple authentication password for this bind
* operation.
*/
/**
* Retrieves the SASL mechanism for this bind operation.
*
* @return The SASL mechanism for this bind operation, or
* <CODE>null</CODE> if the bind does not use SASL
* authentication.
*/
/**
* Retrieves the SASL credentials for this bind operation.
*
* @return The SASL credentials for this bind operation, or
* <CODE>null</CODE> if there are none or if the bind does
* not use SASL authentication.
*/
/**
* Retrieves the set of server SASL credentials to include in the
* bind response.
*
* @return The set of server SASL credentials to include in the
* bind response, or <CODE>null</CODE> if there are none.
*/
/**
* Retrieves the user entry associated with the SASL authentication
* attempt. This should be set by any SASL mechanism in which the
* processing was able to get far enough to make this determination,
* regardless of whether the authentication was ultimately
* successful.
*
* @return The user entry associated with the SASL authentication
* attempt, or <CODE>null</CODE> if it was not a SASL
* authentication or the SASL processing was not able to
* map the request to a user.
*/
/**
* Retrieves a human-readable message providing the reason that the
* authentication failed, if available.
*
* @return A human-readable message providing the reason that the
* authentication failed, or <CODE>null</CODE> if none is
* available.
*/
/**
* Retrieves the user entry DN for this bind operation. It will
* only be available if the bind processing has proceeded far enough
* to identify the user attempting to authenticate.
*
* @return The user entry DN for this bind operation, or
* <CODE>null</CODE> if the bind processing has not
* progressed far enough to identify the user or if the
* user DN could not be determined.
*/
DN getUserEntryDN();
}