PreParseBindOperation.java revision f71f7a61dec7c9089378d14493ad564a1dedf0b5
/*
* 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
* 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
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. 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
*
*
* Portions Copyright 2006-2007 Sun Microsystems, Inc.
*/
/**
* This class defines a set of methods that are available for use by
* pre-parse 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.
*/
public interface PreParseBindOperation
extends PreParseOperation
{
/**
* Retrieves the authentication type for this bind operation.
*
* @return The authentication type for this bind operation.
*/
public AuthenticationType getAuthenticationType();
/**
* 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.
*/
public ByteString getRawBindDN();
/**
* Specifies the raw, unprocessed bind DN for this bind operation.
*
* @param rawBindDN The raw, unprocessed bind DN for this bind
* operation.
*/
/**
* Retrieves the simple authentication password for this bind
* operation.
*
* @return The simple authentication password for this bind
* operation.
*/
public ByteString getSimplePassword();
/**
* Specifies the simple authentication password for this bind
* operation.
*
* @param simplePassword 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.
*/
public String getSASLMechanism();
/**
* 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.
*/
public ASN1OctetString getSASLCredentials();
/**
* Specifies the SASL credentials for this bind operation.
*
* @param saslMechanism The SASL mechanism for this bind
* operation.
* @param saslCredentials The SASL credentials for this bind
* operation, or <CODE>null</CODE> if there
* are none.
*/
/**
* Specifies the set of server SASL credentials to include in the
* bind response.
*
* @param serverSASLCredentials The set of server SASL credentials
* to include in the bind response.
*/
public void setServerSASLCredentials(ASN1OctetString
/**
* Specifies the reason that the authentication failed.
*
* @param id The unique identifier for the authentication
* failure reason.
* @param reason A human-readable message providing the reason
* that the authentication failed.
*/
}