java.net: public class: Proxy

java.net
public class: Proxy [javadoc | source]

java.lang.Object
   java.net.Proxy

This class represents a proxy setting, typically a type (http, socks) and a socket address. A Proxy is an immutable object.

Also see:

java.net.ProxySelector

author: Yingxian - Wang

author: Jean-Christophe - Collet

since: 1.5 -

Nested Class Summary:
public enum class	Proxy.Type	Represents the proxy type.

Field Summary

Field Summary
public static final Proxy	NO_PROXY	A proxy setting that represents a `DIRECT` connection, basically telling the protocol handler not to use any proxying. Used, for instance, to create sockets bypassing any other global proxy settings (like SOCKS): `Socket s = new Socket(Proxy.NO_PROXY);`

public static final Proxy

NO_PROXY

A proxy setting that represents a DIRECT connection, basically telling the protocol handler not to use any proxying. Used, for instance, to create sockets bypassing any other global proxy settings (like SOCKS):

Socket s = new Socket(Proxy.NO_PROXY);

Constructor:

Constructor:
public Proxy(Proxy.Type type, SocketAddress sa) { if ((type == Type.DIRECT) \|\| !(sa instanceof InetSocketAddress)) throw new IllegalArgumentException("type " + type + " is not compatible with address " + sa); this.type = type; this.sa = sa; } Creates an entry representing a PROXY connection. Certain combinations are illegal. For instance, for types Http, and Socks, a SocketAddress must be provided. Use the `Proxy.NO_PROXY` constant for representing a direct connection. Parameters: `type` - the `Type` of the proxy `sa` - the `SocketAddress` for that proxy Throws: `IllegalArgumentException` - when the type and the address are incompatible

 public Proxy(Proxy.Type type,
    SocketAddress sa) {
        if ((type == Type.DIRECT) || !(sa instanceof InetSocketAddress))
            throw new IllegalArgumentException("type " + type + " is not compatible with address " + sa);
        this.type = type;
        this.sa = sa;
}

must

Use the Proxy.NO_PROXY constant for representing a direct connection.

Parameters:

type - the Type of the proxy

sa - the SocketAddress for that proxy

Throws:

IllegalArgumentException - when the type and the address are incompatible

Method from java.net.Proxy Summary:
address, equals, hashCode, toString, type

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.net.Proxy Detail:
public SocketAddress address() { return sa; } Returns the socket address of the proxy, or `null` if its a direct connection.
public final boolean equals(Object obj) { if (obj == null \|\| !(obj instanceof Proxy)) return false; Proxy p = (Proxy) obj; if (p.type() == type()) { if (address() == null) { return (p.address() == null); } else return address().equals(p.address()); } return false; } Compares this object against the specified object. The result is `true` if and only if the argument is not `null` and it represents the same proxy as this object. Two instances of `Proxy` represent the same address if both the SocketAddresses and type are equal.
public final int hashCode() { if (address() == null) return type().hashCode(); return type().hashCode() + address().hashCode(); } Returns a hashcode for this Proxy.
public String toString() { if (type() == Type.DIRECT) return "DIRECT"; return type() + " @ " + address(); } Constructs a string representation of this Proxy. This String is constructed by calling toString() on its type and concatenating " @ " and the toString() result from its address if its type is not `DIRECT`.
public Proxy.Type type() { return type; } Returns the proxy type.

Method from java.net.Proxy Detail:

 public SocketAddress address() {
        return sa;
}

null

 public final boolean equals(Object obj) {
        if (obj == null || !(obj instanceof Proxy))
            return false;
        Proxy p = (Proxy) obj;
        if (p.type() == type()) {
            if (address() == null) {
                return (p.address() == null);
            } else
                return address().equals(p.address());
        }
        return false;
}

true

null

Two instances of Proxy represent the same address if both the SocketAddresses and type are equal.

 public final int hashCode() {
        if (address() == null)
            return type().hashCode();
        return type().hashCode() + address().hashCode();
}

Returns a hashcode for this Proxy.

 public String toString() {
        if (type() == Type.DIRECT)
            return "DIRECT";
        return type() + " @ " + address();
}

DIRECT

 public Proxy.Type type() {
        return type;
}

Returns the proxy type.