Proxy

public class Proxy
extends Object

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.

See also:

Summary

Fields

public static final Proxy NO_PROXY

A proxy setting that represents a DIRECT connection, basically telling the protocol handler not to use any proxying.

Public constructors

Proxy(Proxy.Type type, SocketAddress sa)

Creates an entry representing a PROXY connection.

Public methods

SocketAddress address()

Returns the socket address of the proxy, or null if its a direct connection.

final boolean equals(Object obj)

Compares this object against the specified object.

final int hashCode()

Returns a hashcode for this Proxy.

String toString()

Constructs a string representation of this Proxy.

Proxy.Type type()

Returns the proxy type.

Inherited methods

Fields

NO_PROXY

Added in API level 1
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 constructors

Proxy

Added in API level 1
public Proxy (Proxy.Type type, 
                SocketAddress 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 Proxy.Type: the Type of the proxy

sa SocketAddress: the SocketAddress for that proxy

Throws
IllegalArgumentException when the type and the address are incompatible

Public methods

address

Added in API level 1
public SocketAddress address ()

Returns the socket address of the proxy, or null if its a direct connection.

Returns
SocketAddress a SocketAddress representing the socket end point of the proxy

equals

Added in API level 1
public final boolean equals (Object obj)

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.

Parameters
obj Object: the object to compare against.

Returns
boolean true if the objects are the same; false otherwise.

hashCode

Added in API level 1
public final int hashCode ()

Returns a hashcode for this Proxy.

Returns
int a hash code value for this Proxy.

toString

Added in API level 1
public String toString ()

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.

Returns
String a string representation of this object.

type

Added in API level 1
public Proxy.Type type ()

Returns the proxy type.

Returns
Proxy.Type a Type representing the proxy type