| Frames | No Frames |
1: /* SaslServerFactory.java 2: Copyright (C) 2003, 2005, Free Software Foundation, Inc. 3: 4: This file is part of GNU Classpath. 5: 6: GNU Classpath is free software; you can redistribute it and/or modify 7: it under the terms of the GNU General Public License as published by 8: the Free Software Foundation; either version 2, or (at your option) 9: any later version. 10: 11: GNU Classpath is distributed in the hope that it will be useful, but 12: WITHOUT ANY WARRANTY; without even the implied warranty of 13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14: General Public License for more details. 15: 16: You should have received a copy of the GNU General Public License 17: along with GNU Classpath; see the file COPYING. If not, write to the 18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19: 02110-1301 USA. 20: 21: Linking this library statically or dynamically with other modules is 22: making a combined work based on this library. Thus, the terms and 23: conditions of the GNU General Public License cover the whole 24: combination. 25: 26: As a special exception, the copyright holders of this library give you 27: permission to link this library with independent modules to produce an 28: executable, regardless of the license terms of these independent 29: modules, and to copy and distribute the resulting executable under 30: terms of your choice, provided that you also meet, for each linked 31: independent module, the terms and conditions of the license of that 32: module. An independent module is a module which is not derived from 33: or based on this library. If you modify this library, you may extend 34: this exception to your version of the library, but you are not 35: obligated to do so. If you do not wish to do so, delete this 36: exception statement from your version. */ 37: 38: 39: package javax.security.sasl; 40: 41: import java.util.Map; 42: 43: import javax.security.auth.callback.CallbackHandler; 44: 45: /** 46: * <p>An interface for creating instances of {@link SaslServer}. A class that 47: * implements this interface must be thread-safe and handle multiple 48: * simultaneous requests. It must also have a public constructor that accepts 49: * no arguments.</p> 50: * 51: * <p>This interface is not normally accessed directly by a server, which will 52: * use the {@link Sasl} static methods to create a {@link SaslServer} instance 53: * instead. However, a particular environment may provide and install a new or 54: * different <code>SaslServerFactory</code>.</p> 55: * 56: * @see SaslServer 57: * @see Sasl 58: * 59: * @since 1.5 60: */ 61: public interface SaslServerFactory 62: { 63: 64: /** 65: * Creates a {@link SaslServer} instance using the parameters supplied. It 66: * returns <code>null</code> if no {@link SaslServer} instance can be created 67: * using the parameters supplied. Throws {@link SaslException} if it cannot 68: * create a {@link SaslServer} because of an error. 69: * 70: * @param mechanism the non-null IANA-registered name of a SASL mechanism 71: * (e.g. "GSSAPI", "CRAM-MD5"). 72: * @param protocol the non-null string name of the protocol for which the 73: * authentication is being performed (e.g. "ldap"). 74: * @param serverName the non-null fully qualified host name of the server to 75: * authenticate to. 76: * @param props the possibly null set of properties used to select the SASL 77: * mechanism and to configure the authentication exchange of the selected 78: * mechanism. See the {@link Sasl} class for a list of standard properties. 79: * Other, possibly mechanism-specific, properties can be included. Properties 80: * not relevant to the selected mechanism are ignored. 81: * @param cbh the possibly null callback handler to used by the SASL 82: * mechanisms to get further information from the application/library to 83: * complete the authentication. For example, a SASL mechanism might require 84: * the authentication ID, password and realm from the caller. The 85: * authentication ID is requested by using a 86: * {@link javax.security.auth.callback.NameCallback}. The password is 87: * requested by using a {@link javax.security.auth.callback.PasswordCallback}. 88: * The realm is requested by using a {@link RealmChoiceCallback} if there is 89: * a list of realms to choose from, and by using a {@link RealmCallback} if 90: * the realm must be entered. 91: * @return a possibly null {@link SaslServer} created using the parameters 92: * supplied. If <code>null</code> is returned, it means that this factory 93: * cannot produce a {@link SaslServer} using the parameters supplied. 94: * @throws SaslException if a SaslServer instance cannot be created because 95: * of an error. 96: */ 97: SaslServer createSaslServer(String mechanism, String protocol, 98: String serverName, Map<String, ?> props, 99: CallbackHandler cbh) 100: throws SaslException; 101: 102: /** 103: * Returns an array of names of mechanisms that match the specified mechanism 104: * selection policies. 105: * 106: * @param props the possibly <code>null</code> set of properties used to 107: * specify the security policy of the SASL mechanisms. For example, if props 108: * contains the {@link Sasl#POLICY_NOPLAINTEXT} property with the value 109: * <code>"true"</code>, then the factory must not return any SASL mechanisms 110: * that are susceptible to simple plain passive attacks. See the {@link Sasl} 111: * class for a complete list of policy properties. Non-policy related 112: * properties, if present in props, are ignored. 113: * @return a non-null array containing IANA-registered SASL mechanism names. 114: */ 115: String[] getMechanismNames(Map<String, ?> props); 116: }