com.xmlmind.netutil

Class ProxyUtil

java.lang.Object

com.xmlmind.netutil.ProxyUtil

public final class ProxyUtil
extends Object

A collection of utilities (static methods) used to configure proxy servers based on the user preferences and also on the version of Java^TM used to run the XML editor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProxyUtil.ProxyServer Information about a proxy server.

Method Summary

Modifier and Type	Method and Description
static Properties	configureProxies(File propsFile) Configure proxies based on the contents of specifed user preferences file.
static void	configureProxies(Preferences prefs) Configure proxies based on the contents of specifed user preferences object.
static String	getProxySettings(Preferences prefs) Returns which type of proxy configuration to use: "none", "system" (default), "application".
static ProxyUtil.ProxyServer	queryProxySelector(String protocol, String host, int port) Returns which proxy server to use based on what is returned by the default ProxySelector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getProxySettings

public static String getProxySettings(Preferences prefs)

Returns which type of proxy configuration to use: "none", "system" (default), "application".

Parameters:

prefs - the user preferences. May be null.

Returns:

"none", "system", "application" or null if prefs is null or if it does not contain a "proxySettings" entry

configureProxies

public static Properties configureProxies(File propsFile)

Configure proxies based on the contents of specifed user preferences file.

See Also:

configureProxies(Preferences)

configureProxies

public static void configureProxies(Preferences prefs)

Configure proxies based on the contents of specifed user preferences object.

This method sets most of the system properties described in Networking Properties, Proxies. It will at least set "java.net.useSystemProxies" to "true" or "false".

See Also:

configureProxies(File)

queryProxySelector

public static ProxyUtil.ProxyServer queryProxySelector(String protocol,
                                                       String host,
                                                       int port)

Returns which proxy server to use based on what is returned by the default ProxySelector.

Note that the default proxy selector does enforce a set of system Properties related to proxy settings documented here: Networking Properties, Proxies.

Parameters:

protocol - the protocol of the network connection

host - the hostname or address of the server to be connected

port - the port number of the server to be connected

Returns:

which proxy server to use or null (do not use a proxy server)