001 /* Proxy.java -- Represends a proxy for a network connection
002 Copyright (C) 2006, 2007 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 package java.net;
039
040
041 /**
042 * Defines a proxy setting. This setting contains a type (https, socks,
043 * direct) and a socket address.
044 *
045 * @since 1.5
046 */
047 public class Proxy
048 {
049 /**
050 * Represents the proxy type.
051 */
052 public enum Type
053 {
054 DIRECT, HTTP, SOCKS;
055
056 /**
057 * For compatability with Sun's JDK
058 */
059 private static final long serialVersionUID = -2231209257930100533L;
060 }
061
062 public static final Proxy NO_PROXY = new Proxy(Type.DIRECT, null);
063
064 private Type type;
065 private SocketAddress address;
066
067 /**
068 * Creates a new <code>Proxy</code> object.
069 *
070 * @param type The type for this proxy
071 * @param address The address of this proxy
072 */
073 public Proxy(Type type, SocketAddress address)
074 {
075 this.type = type;
076 this.address = address;
077 }
078
079 /**
080 * Returns the socket address for this proxy object.
081 *
082 * @return the socket address
083 */
084 public SocketAddress address()
085 {
086 return address;
087 }
088
089 /**
090 * Returns the of this proxy instance.
091 *
092 * @return the type
093 *
094 * @see Type
095 */
096 public Type type()
097 {
098 return type;
099 }
100
101 /**
102 * Compares the given object with this object.
103 *
104 * @return <code>true</code> if both objects or equals,
105 * <code>false</code> otherwise.
106 */
107 public final boolean equals(Object obj)
108 {
109 if (! (obj instanceof Proxy))
110 return false;
111
112 Proxy tmp = (Proxy) obj;
113
114 return (type.equals(tmp.type)
115 && (address == null ? tmp.address == null
116 : address.equals(tmp.address)));
117 }
118
119 /**
120 * Returns the hashcode for this <code>Proxy</code> object.
121 *
122 * @return the hashcode
123 */
124 public final int hashCode()
125 {
126 return type.hashCode() ^ (address == null ? 0 : address.hashCode());
127 }
128
129 /**
130 * Returns a string representation of this <code>Proxy</code> object.
131 *
132 * @return the string
133 */
134 public String toString()
135 {
136 return type.toString() + (address == null ? ""
137 : (":" + address.toString()));
138 }
139 }