01 /*
02 * Copyright 1999-2001 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.net.ssl;
27
28 import java.security.*;
29
30 /**
31 * This class defines the <i>Service Provider Interface</i> (<b>SPI</b>)
32 * for the <code>KeyManagerFactory</code> class.
33 *
34 * <p> All the abstract methods in this class must be implemented by each
35 * cryptographic service provider who wishes to supply the implementation
36 * of a particular key manager factory.
37 *
38 * @since 1.4
39 * @see KeyManagerFactory
40 * @see KeyManager
41 * @version 1.20
42 */
43 public abstract class KeyManagerFactorySpi {
44 /**
45 * Initializes this factory with a source of key material.
46 *
47 * @param ks the key store or null
48 * @param password the password for recovering keys
49 * @throws KeyStoreException if this operation fails
50 * @throws NoSuchAlgorithmException if the specified algorithm is not
51 * available from the specified provider.
52 * @throws UnrecoverableKeyException if the key cannot be recovered
53 * @see KeyManagerFactory#init(KeyStore, char[])
54 */
55 protected abstract void engineInit(KeyStore ks, char[] password)
56 throws KeyStoreException, NoSuchAlgorithmException,
57 UnrecoverableKeyException;
58
59 /**
60 * Initializes this factory with a source of key material.
61 * <P>
62 * In some cases, initialization parameters other than a keystore
63 * and password may be needed by a provider. Users of that
64 * particular provider are expected to pass an implementation of
65 * the appropriate <CODE>ManagerFactoryParameters</CODE> as
66 * defined by the provider. The provider can then call the
67 * specified methods in the ManagerFactoryParameters
68 * implementation to obtain the needed information.
69 *
70 * @param spec an implementation of a provider-specific parameter
71 * specification
72 * @throws InvalidAlgorithmParameterException if there is problem
73 * with the parameters
74 * @see KeyManagerFactory#init(ManagerFactoryParameters spec)
75 */
76 protected abstract void engineInit(ManagerFactoryParameters spec)
77 throws InvalidAlgorithmParameterException;
78
79 /**
80 * Returns one key manager for each type of key material.
81 *
82 * @return the key managers
83 * @throws IllegalStateException
84 * if the KeyManagerFactorySpi is not initialized
85 */
86 protected abstract KeyManager[] engineGetKeyManagers();
87 }
|