libjava/classpath/java/net/ProxySelector.java

   1 /* ProxySelector.java -- A proxy selector class
   2    Copyright (C) 2006  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 package java.net;
  39
  40 import gnu.java.net.DefaultProxySelector;
  41
  42 import java.io.IOException;
  43 import java.util.List;
  44
  45 /**
  46  * Class for handling proxies for different connections.
  47  *
  48  * @since 1.5
  49  */
  50 public abstract class ProxySelector
  51 {
  52   /**
  53    * Default proxy selector.
  54    */
  55   private static ProxySelector defaultSelector = new DefaultProxySelector();
  56
  57   /**
  58    * Creates a new <code>ProxySelector</code> object.
  59    */
  60   public ProxySelector()
  61   {
  62     // Do nothing here.
  63   }
  64
  65   /**
  66    * Returns the default proxy selector.
  67    *
  68    * @return the default proxy selector
  69    *
  70    * @throws SecurityException If a security manager is installed and it
  71    * denies NetPermission("getProxySelector")
  72    */
  73   public static ProxySelector getDefault()
  74   {
  75     SecurityManager sm = System.getSecurityManager();
  76
  77     if (sm != null)
  78       sm.checkPermission(new NetPermission("getProxySelector"));
  79
  80     return defaultSelector;
  81   }
  82
  83   /**
  84    * Sets the default proxy selector.
  85    *
  86    * @param selector the defualt proxy selector
  87    *
  88    * @throws SecurityException If a security manager is installed and it
  89    * denies NetPermission("setProxySelector")
  90    */
  91   public static void setDefault(ProxySelector selector)
  92   {
  93     SecurityManager sm = System.getSecurityManager();
  94
  95     if (sm != null)
  96       sm.checkPermission(new NetPermission("setProxySelector"));
  97
  98     defaultSelector = selector;
  99   }
 100
 101   /**
 102    * Signals to the selector that a proxy was no available.
 103    *
 104    * @throws IllegalArgumentException If one argument is null
 105    */
 106   public abstract void connectFailed(URI uri, SocketAddress address,
 107                                      IOException exception);
 108
 109   /**
 110    * Returns the list of proxy settings for a given URI.
 111    *
 112    * @return list of proxy settings
 113    *
 114    * @throws IllegalArgumentException If uri is null
 115    */
 116   public abstract List<Proxy> select(URI uri);
 117 }