Source for javax.net.SocketFactory

   1: /* SocketFactory.java -- factory for client sockets.
   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;
  40: 
  41: import java.io.IOException;
  42: 
  43: import java.net.InetAddress;
  44: import java.net.Socket;
  45: import java.net.UnknownHostException;
  46: 
  47: import java.security.Security;
  48: 
  49: /**
  50:  * A factory for client sockets. The purpose of this class is to serve
  51:  * as the superclass of server socket factories that produce client
  52:  * sockets of a particular type, such as <i>Secure Socket Layer</i>
  53:  * (<b>SSL</b>) sockets.
  54:  *
  55:  * @author Casey Marshall (rsdio@metastatic.org)
  56:  */
  57: public abstract class SocketFactory
  58: {
  59: 
  60:   // Constructor.
  61:   // -------------------------------------------------------------------
  62: 
  63:   /**
  64:    * Default 0-arguments constructor.
  65:    */
  66:   protected SocketFactory()
  67:   {
  68:     super();
  69:   }
  70: 
  71:   // Class methods.
  72:   // -------------------------------------------------------------------
  73: 
  74:   /**
  75:    * Returns the default socket factory. The type of factory
  76:    * returned may depend upon the installation.
  77:    *
  78:    * @return The default socket factory.
  79:    */
  80:   public static synchronized SocketFactory getDefault()
  81:   {
  82:     try
  83:       {
  84:         String s = Security.getProperty("gnu.defaultSocketFactory");
  85:         if (s != null)
  86:           {
  87:             Class c = Class.forName(s);
  88:             return (SocketFactory) c.newInstance();
  89:           }
  90:       }
  91:     catch (Exception e)
  92:       {
  93:       }
  94:     return new VanillaSocketFactory();
  95:   }
  96: 
  97:   // Instance methods.
  98:   // -------------------------------------------------------------------
  99: 
 100:   /**
 101:    * Returns an unbound client socket.
 102:    *
 103:    * @return The new, unbound socket.
 104:    */
 105:   public Socket createSocket() throws IOException
 106:   {
 107:     throw new UnsupportedOperationException();
 108:   }
 109: 
 110:   /**
 111:    * Creates a socket connected to a given host on a given port.
 112:    *
 113:    * @param host The hostname to connect to.
 114:    * @param port The port on <i>host</i> to connect to.
 115:    * @return A socket connected to <i>host</i> on <i>port</i>.
 116:    * @throws IOException If a network error occurs.
 117:    * @throws UnknownHostException If <i>host</i> cannot be resolved.
 118:    */
 119:   public abstract Socket createSocket(String host, int port) throws IOException, UnknownHostException;
 120: 
 121:   /**
 122:    * Creates a socket connected to a given host on a given port,
 123:    * connecting locally to the interface with the given address and port.
 124:    *
 125:    * @param host The hostname to connect to.
 126:    * @param port The port on <i>host</i> to connect to.
 127:    * @param localHost The address of the local interface to bind to.
 128:    * @param localPort The local port to bind to.
 129:    * @return A socket connected to <i>host</i> on <i>port</i>.
 130:    * @throws IOException If a network error occurs.
 131:    * @throws UnknownHostException If <i>host</i> cannot be resolved.
 132:    */
 133:   public abstract Socket createSocket(String host, int port, InetAddress localHost, int localPort) throws IOException, UnknownHostException;
 134: 
 135:   /**
 136:    * Creates a socket connected to a given host on a given port.
 137:    *
 138:    * @param host The host address to connect to.
 139:    * @param port The port on <i>host</i> to connect to.
 140:    * @return A socket connected to <i>host</i> on <i>port</i>.
 141:    * @throws IOException If a network error occurs.
 142:    */
 143:   public abstract Socket createSocket(InetAddress host, int port) throws IOException;
 144: 
 145:   /**
 146:    * Creates a socket connected to a given host on a given port,
 147:    * connecting locally to the interface with the given address and port.
 148:    *
 149:    * @param host The host address  to connect to.
 150:    * @param port The port on <i>host</i> to connect to.
 151:    * @param localHost The address of the local interface to bind to.
 152:    * @param localPort The local port to bind to.
 153:    * @return A socket connected to <i>host</i> on <i>port</i>.
 154:    * @throws IOException If a network error occurs.
 155:    */
 156:   public abstract Socket createSocket(InetAddress hast, int port, InetAddress localHost, int localPort) throws IOException;
 157: }