- java.lang.Object
-
- java.net.ProxySelector
-
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 thesetDefault
method. The currently registered proxy selector can be retrieved by callinggetDefault
method.When a proxy selector is registered, for instance, a subclass of URLConnection class should call the
select
method for each URL request so that the proxy selector can decide if a direct, or proxied connection should be used. Theselect
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
connectFailed
method to notify the proxy selector that the proxy server is unavailable.The default proxy selector does enforce a set of System Properties related to proxy settings.
- Since:
- 1.5
-
-
Constructor Summary
Constructors Constructor and Description ProxySelector()
-
Method Summary
Methods Modifier and Type Method and Description 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<Proxy>
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.
-
-
-
Method Detail
-
getDefault
public static ProxySelector getDefault()
Gets the system-wide proxy selector.- Returns:
- the system-wide
ProxySelector
- Throws:
SecurityException
- If a security manager has been installed and it deniesNetPermission
("getProxySelector")- Since:
- 1.5
- See Also:
setDefault(ProxySelector)
-
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, ornull
to unset the proxy selector.- Throws:
SecurityException
- If a security manager has been installed and it deniesNetPermission
("setProxySelector")- Since:
- 1.5
- See Also:
getDefault()
-
select
public abstract List<Proxy> 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
Proxy
; when no proxy is available, the list will contain one element of typeProxy
that represents a direct connection. - Throws:
IllegalArgumentException
- if the argument is null
-
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 byselect(URI)
, using the address and the IOException caught when trying to connect.- Parameters:
uri
- The URI that the proxy at sa failed to serve.sa
- The socket address of the proxy/SOCKS serverioe
- The I/O exception thrown when the connect failed.- Throws:
IllegalArgumentException
- if either argument is null
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/net/ProxySelector.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.