зеркало из https://github.com/mozilla/gecko-dev.git
74 строки
3.0 KiB
Java
74 строки
3.0 KiB
Java
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
*
|
|
* The contents of this file are subject to the Netscape Public
|
|
* License Version 1.1 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.mozilla.org/NPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS
|
|
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
|
* implied. See the License for the specific language governing
|
|
* rights and limitations under the License.
|
|
*
|
|
* The Original Code is mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is Netscape
|
|
* Communications Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1999 Netscape Communications Corporation. All
|
|
* Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*/
|
|
package com.netscape.sasl;
|
|
|
|
import java.util.Hashtable;
|
|
import javax.security.auth.callback.CallbackHandler;
|
|
|
|
/**
|
|
* An interface for creating instances of <tt>SaslClient</tt>.
|
|
*
|
|
* @see SaslClient
|
|
* @see Sasl
|
|
*/
|
|
public abstract interface SaslClientFactory {
|
|
/**
|
|
* Creates a SaslClient using the parameters supplied.
|
|
*
|
|
* @param mechanisms The non-null list of mechanism names to try. Each is the
|
|
* IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5").
|
|
* @param authorizationId The possibly null authorization ID to use. When
|
|
* the SASL authentication completes successfully, the entity named
|
|
* by authorizationId is granted access.
|
|
* @param protocol The non-null string name of the protocol for which
|
|
* the authentication is being performed (e.g., "ldap").
|
|
* @param serverName The non-null string name of the server to which
|
|
* we are creating an authenticated connection.
|
|
* @param props The possibly null properties to be used by the SASL
|
|
* mechanisms to configure the authentication exchange. For example,
|
|
* "javax.security.sasl.encryption.maximum" might be used to specify
|
|
* the maximum key length to use for encryption.
|
|
* @param cbh The possibly null callback handler to used by the SASL
|
|
* mechanisms to get further information from the application/library
|
|
* to complete the authentication. For example, a SASL mechanism might
|
|
* require the authentication ID and password from the caller.
|
|
*@return A possibly null <tt>SaslClient</tt> created using the parameters
|
|
* supplied. If null, this factory cannot produce a <tt>SaslClient</tt>
|
|
* using the parameters supplied.
|
|
*@exception SaslException If cannot create a <tt>SaslClient</tt> because
|
|
* of an error.
|
|
*/
|
|
public abstract SaslClient createSaslClient(
|
|
String[] mechanisms,
|
|
String authorizationId,
|
|
String protocol,
|
|
String serverName,
|
|
Hashtable props,
|
|
CallbackHandler cbh) throws SaslException;
|
|
|
|
/**
|
|
* Returns an array of names of mechanisms supported by this factory.
|
|
* @return A non-null array containing a IANA-registered SASL mechanism names.
|
|
*/
|
|
public abstract String[] getMechanismNames();
|
|
}
|