Proxy

AI-generated Key Takeaways

• The Proxy class represents a proxy setting, typically a type (http, socks) and a socket address, and is immutable.

• Proxy.NO_PROXY represents a direct connection, instructing the protocol handler to bypass proxying.

• A Proxy instance is created using a Proxy.Type and a SocketAddress, with specific types requiring a valid address.

• Methods like address(), type(), equals(), hashCode(), and toString() provide information and functionality related to the proxy settings.

• Direct connections can be established using Proxy.NO_PROXY to circumvent global proxy settings.

public class Proxy extends Object

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

See Also

• ProxySelector

Nested Class Summary

enum

Proxy.Type

Represents the proxy type.

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.

Public Constructor Summary

Proxy(Proxy.Type type, SocketAddress sa) Creates an entry representing a PROXY connection.

Public Method Summary

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 Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

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. Used, for instance, to create sockets bypassing any other global proxy settings (like SOCKS):

Socket s = new Socket(Proxy.NO_PROXY);

Public Constructors

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	the Type of the proxy
sa	the SocketAddress for that proxy

Throws

IllegalArgumentException	when the type and the address are incompatible

Public Methods

public SocketAddress address ()

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

Returns

• a SocketAddress representing the socket end point of the proxy

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	the object to compare against.

Returns

• true if the objects are the same; false otherwise.

See Also

• InetSocketAddress.equals(java.lang.Object)

public final int hashCode ()

Returns a hashcode for this Proxy.

Returns

• a hash code value for this Proxy.

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

• a string representation of this object.

public Proxy.Type type ()

Returns the proxy type.

Returns

• a Type representing the proxy type