Source for javax.net.ssl.SSLContextSpi

   1: /* SSLContextSpi.java -- SPI for SSL contexts.
   2:    Copyright (C) 2004 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.net.ssl;
  40: 
  41: import java.security.KeyManagementException;
  42: import java.security.SecureRandom;
  43: 
  44: /**
  45:  * The <i>Service Provider Interface</i> (<b>SPI</b>) for SSLContext
  46:  * objects.
  47:  *
  48:  * @author Casey Marshall (rsdio@metastatic.org)
  49:  */
  50: public abstract class SSLContextSpi
  51: {
  52: 
  53:   // Constructor.
  54:   // -------------------------------------------------------------------
  55: 
  56:   /**
  57:    * Create a new SSLContextSpi.
  58:    */
  59:   public SSLContextSpi()
  60:   {
  61:     super();
  62:   }
  63: 
  64:   // Abstract methods.
  65:   // -------------------------------------------------------------------
  66: 
  67:   // Sun, you've broken existing applications by introducing new
  68:   // abstract methods! Goodjob!!!
  69: 
  70:   /**
  71:    * Returns a new {@link SSLEngine} for this context.
  72:    *
  73:    * @return A new SSLEngine.
  74:    * @since 1.5
  75:    */
  76:   protected abstract SSLEngine engineCreateSSLEngine ();
  77: 
  78:   /**
  79:    * Returns a new {@link SSLEngine} for this context, for the given
  80:    * host name and port number.
  81:    *
  82:    * @param host The local host name.
  83:    * @param port The local port number.
  84:    * @return A new SSLEngine.
  85:    * @since 1.5
  86:    */
  87:   protected abstract SSLEngine engineCreateSSLEngine (String host, int port);
  88: 
  89:   /**
  90:    * Returns the set of SSL sessions available for client connections.
  91:    *
  92:    * @return The set of SSL sessions available for client connections.
  93:    */
  94:   protected abstract SSLSessionContext engineGetClientSessionContext();
  95: 
  96:   /**
  97:    * Returns the set of SSL sessions available for server connections.
  98:    *
  99:    * @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: }