001    /* SSLContextSpi.java -- SPI for SSL contexts.
002       Copyright (C) 2004 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package javax.net.ssl;
040    
041    import java.security.KeyManagementException;
042    import java.security.SecureRandom;
043    
044    /**
045     * The <i>Service Provider Interface</i> (<b>SPI</b>) for SSLContext
046     * objects.
047     *
048     * @author Casey Marshall (rsdio@metastatic.org)
049     */
050    public abstract class SSLContextSpi
051    {
052    
053      // Constructor.
054      // -------------------------------------------------------------------
055    
056      /**
057       * Create a new SSLContextSpi.
058       */
059      public SSLContextSpi()
060      {
061        super();
062      }
063    
064      // Abstract methods.
065      // -------------------------------------------------------------------
066    
067      // Sun, you've broken existing applications by introducing new
068      // abstract methods! Goodjob!!!
069    
070      /**
071       * Returns a new {@link SSLEngine} for this context.
072       *
073       * @return A new SSLEngine.
074       * @since 1.5
075       */
076      protected abstract SSLEngine engineCreateSSLEngine ();
077    
078      /**
079       * Returns a new {@link SSLEngine} for this context, for the given
080       * host name and port number.
081       *
082       * @param host The local host name.
083       * @param port The local port number.
084       * @return A new SSLEngine.
085       * @since 1.5
086       */
087      protected abstract SSLEngine engineCreateSSLEngine (String host, int port);
088    
089      /**
090       * Returns the set of SSL sessions available for client connections.
091       *
092       * @return The set of SSL sessions available for client connections.
093       */
094      protected abstract SSLSessionContext engineGetClientSessionContext();
095    
096      /**
097       * Returns the set of SSL sessions available for server connections.
098       *
099       * @return The set of SSL sessions available for server connections.
100       */
101      protected abstract SSLSessionContext engineGetServerSessionContext();
102    
103      /**
104       * Returns the SSL server socket factory.
105       *
106       * @return The SSL server socket factory.
107       */
108      protected abstract SSLServerSocketFactory engineGetServerSocketFactory();
109    
110      /**
111       * Returns the SSL client socket factory.
112       *
113       * @return The SSL client socket factory.
114       */
115      protected abstract SSLSocketFactory engineGetSocketFactory();
116    
117      /**
118       * Initialize this context with key and trust managers, and a source
119       * of randomness. All of the parameters are optional.
120       *
121       * @param keyManagers The set of key managers.
122       * @param trustManagers The set of trust managers.
123       * @param random The source of randomness.
124       * @throws KeyManagementException If this context cannot be
125       *   initialized with these parameters.
126       */
127      protected abstract void engineInit(KeyManager[] keyManagers,
128                                         TrustManager[] trustManagers,
129                                         SecureRandom random)
130        throws KeyManagementException;
131    }