1/*
2 *  Licensed to the Apache Software Foundation (ASF) under one or more
3 *  contributor license agreements.  See the NOTICE file distributed with
4 *  this work for additional information regarding copyright ownership.
5 *  The ASF licenses this file to You under the Apache License, Version 2.0
6 *  (the "License"); you may not use this file except in compliance with
7 *  the License.  You may obtain a copy of the License at
8 *
9 *     http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *  Unless required by applicable law or agreed to in writing, software
12 *  distributed under the License is distributed on an "AS IS" BASIS,
13 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *  See the License for the specific language governing permissions and
15 *  limitations under the License.
16 */
17
18package javax.net.ssl;
19
20import java.security.InvalidAlgorithmParameterException;
21import java.security.KeyStore;
22import java.security.KeyStoreException;
23
24/**
25 * The <i>Service Provider Interface</i> (SPI) for the
26 * {@code TrustManagerFactory} class.
27 */
28public abstract class TrustManagerFactorySpi {
29
30    /**
31     * Creates a new {@code TrustManagerFactorySpi} instance.
32     */
33    public TrustManagerFactorySpi() {
34    }
35
36    /**
37     * Initializes this factory instance with the specified keystore as source
38     * of certificate authorities and trust material.
39     *
40     * @param ks
41     *            the keystore or {@code null}.
42     * @throws KeyStoreException
43     *             if the initialization fails.
44     */
45    protected abstract void engineInit(KeyStore ks) throws KeyStoreException;
46
47    /**
48     * Initializes this factory instance with the specified provider-specific
49     * parameters for a source of trust material.
50     *
51     * @param spec
52     *            the provider-specific parameters.
53     * @throws InvalidAlgorithmParameterException
54     *             if the initialization fails.
55     */
56    protected abstract void engineInit(ManagerFactoryParameters spec)
57            throws InvalidAlgorithmParameterException;
58
59    /**
60     * Returns the list of {@code TrustManager}s with one entry for each type
61     * of trust material.
62     *
63     * @return the list of {@code TrustManager}s
64     */
65    protected abstract TrustManager[] engineGetTrustManagers();
66}
67