java.net
Class Proxy

java.lang.Object
  java.net.Proxy

public class Proxy
extends Object

This class is about proxy setting. A proxy contains type, proxy host address information. There are three types of Proxy:

Direct type proxy

HTTP type proxy

SOCKS type proxy

A Proxy instance is immutable.

Nested Class Summary

static class

Proxy.Type The proxy type, includes DIRECT, HTTP and SOCKS.

Field Summary

static Proxy

NO_PROXY Represents Proxy.Type.DIRECT type proxy setting.

Constructor Summary

Proxy(Proxy.Type type, SocketAddress sa)
New a Proxy instance.

Method Summary

SocketAddress	address() Gets the proxy address.
boolean	equals(Object obj) Compare obj with current proxy.
int	hashCode() gets the hash code of Proxy.
String	toString() Representing string of the proxy.
Proxy.Type	type() Gets the proxy type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_PROXY

public static final Proxy NO_PROXY

Represents Proxy.Type.DIRECT type proxy setting. It tells protocol handlers not to use any proxy.

Constructor Detail

Proxy

public Proxy(Proxy.Type type,
             SocketAddress sa)

New a Proxy instance. SocketAddress must NOT be null when type is either Proxy.Type.HTTP or Proxy.Type.SOCKS. For Proxy.Type.DIRECT type proxy, use Proxy.NO_PROXY directly instead of constructing it.

Parameters:

type - proxy type

sa - proxy address

Throws:

IllegalArgumentException - when type is Proxy.Type.DIRECT or SocketAddress is null.

Method Detail

type

public Proxy.Type type()

Gets the proxy type.

Returns:

the proxy type.

address

public SocketAddress address()

Gets the proxy address.

Returns:

the proxy address for HTTP and SOCKS type proxy. Returns null for DIRECT type proxy.

toString

public String toString()

Representing string of the proxy. The string consists of type.toString() and address.toString() if type and address are not null.

Overrides:

toString in class Object

Returns:

representing string of the proxy.

See Also:

Object.equals(java.lang.Object)

equals

public final boolean equals(Object obj)

Compare obj with current proxy. Returns false if the obj is not a Proxy object. Returns true if and only if the obj has the same address and type value as current proxy.

Overrides:

equals in class Object

Parameters:

obj - Object the object to compare with this object.

Returns:

true if obj represents the same proxy. Otherwise, returns false.

See Also:

Object.equals(java.lang.Object)

hashCode

public final int hashCode()

gets the hash code of Proxy.

Overrides:

hashCode in class Object

Returns:

the hash code of Proxy.

See Also:

Object.hashCode()