ProxySelector (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.net
class ProxySelector

java.lang.Object
  java.net.ProxySelector

Most common way to construct:

ProxySelector ps = ProxySelector.getDefault();

Based on 41 examples

public abstract class ProxySelector
extends Object

Selects the proxy server to use, if any, when connecting to the network resource referenced by a URL. A proxy selector is a concrete sub-class of this class and is registered by invoking the {@link java.net.ProxySelector#setDefault setDefault} method. The currently registered proxy selector can be retrieved by calling {@link java.net.ProxySelector#getDefault getDefault} method.

When a proxy selector is registered, for instance, a subclass of URLConnection class should call the {@link #select select} method for each URL request so that the proxy selector can decide if a direct, or proxied connection should be used. The {@link #select select} method returns an iterator over a collection with the preferred connection approach.

If a connection cannot be established to a proxy (PROXY or SOCKS) servers then the caller should call the proxy selector's {@link #connectFailed connectFailed} method to notify the proxy selector that the proxy server is unavailable.

Constructor Summary
`ProxySelector()`

Method Summary
`abstract void`	`connectFailed(URI uri, SocketAddress sa, IOException ioe)` Called to indicate that a connection could not be established to a proxy/socks server.
`static ProxySelector`	`getDefault()` Gets the system-wide proxy selector.
`abstract List`	`select(URI uri)` Selects all the applicable proxies based on the protocol to access the resource with and a destination address to access the resource at.
`static void`	`setDefault(ProxySelector ps)` Sets (or unsets) the system-wide proxy selector.

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

Constructor Detail

ProxySelector

public ProxySelector()

Method Detail

connectFailed

public abstract void connectFailed(URI uri,
                                   SocketAddress sa,
                                   IOException ioe)

Called to indicate that a connection could not be established to a proxy/socks server. An implementation of this method can temporarily remove the proxies or reorder the sequence of proxies returned by select(String, String), using the address and they kind of IOException given.

Parameters:: uri - The URI that the proxy at sa failed to serve.; sa - The socket address of the proxy/SOCKS server; ioe - The I/O exception thrown when the connect failed.

getDefault

public static ProxySelector getDefault()

Gets the system-wide proxy selector.

Returns:: the system-wide ProxySelector

select

public abstract List select(URI uri)

Selects all the applicable proxies based on the protocol to access the resource with and a destination address to access the resource at. The format of the URI is defined as follow:

http URI for http connections
https URI for https connections
ftp URI for ftp connections
socket://host:port
for tcp client sockets connections

Parameters:: uri - The URI that a connection is required to
Returns:: a List of Proxies. Each element in the the List is of type {@link java.net.Proxy Proxy}; when no proxy is available, the list will contain one element of type {@link java.net.Proxy Proxy} that represents a direct connection.

setDefault

public static void setDefault(ProxySelector ps)

Sets (or unsets) the system-wide proxy selector. Note: non-standard protocol handlers may ignore this setting.

Parameters:: ps - The HTTP proxy selector, or null to unset the proxy selector.