org.apache.commons.httpclient.contrib.proxy

Class PluginProxyUtil

java.lang.Object

org.apache.commons.httpclient.contrib.proxy.PluginProxyUtil

public class PluginProxyUtil
extends java.lang.Object

A utility class that gives applets the ability to detect proxy host settings. This was adapted from a post from Chris Forster on 20030227 to a Sun Java forum here: http://forum.java.sun.com/thread.jspa?threadID=364342&tstart=120 The algorithm - which relies on Sun java plugin internal classes in some cases - was maintained, but the following changes were made: 1. Logging was used to allow control of debug type messages. 2. Reflection is used instead of direct references to Sun internal classes to avoid the need to have these classes in the CLASSPATH to compile. 3. Removed the use of global variables to allow this class to be used in a multi-threaded environment. 4. Add the use of exception to indicate to the caller when proxy detection failed as opposed to when no proxy is configured.

DISCLAIMER: HttpClient developers DO NOT actively support this component. The component is provided as a reference material, which may be inappropriate for use without additional customization.

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.commons.logging.Log	LOG Log object for this class
private static org.apache.http.HttpHost	NO_PROXY_HOST This is used internally to indicate that no proxy detection succeeded and no proxy setting is to be used - failover is unnecessary
private static java.lang.String	PLUGIN_PROXY_CONFIG_PROP The system property that is used to convey proxy information in some VM's

Constructor Summary

Constructors

Constructor and Description
PluginProxyUtil()

Method Summary

Modifier and Type	Method and Description
static org.apache.http.HttpHost	detectProxy(java.net.URL sampleURL) Returns the Proxy Host information using settings from the java plugin.
private static org.apache.http.HttpHost	detectProxySettingsJDK13(java.net.URL sampleURL) Use Sun-specific internal plugin proxy classes for 1.3.X Look around for the 1.3.X plugin proxy detection class.
private static org.apache.http.HttpHost	detectProxySettingsJDK14_JDK15_JDK16(java.net.URL sampleURL) Returns the proxy information for the specified sampleURL using JRE 1.4+ specific plugin classes.
private static org.apache.http.HttpHost	getPluginProxyConfigSettings() Returns the proxy host information found by inspecting the system property "javaplugin.proxy.config.list".

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.apache.commons.logging.Log LOG

Log object for this class

NO_PROXY_HOST

private static final org.apache.http.HttpHost NO_PROXY_HOST

This is used internally to indicate that no proxy detection succeeded and no proxy setting is to be used - failover is unnecessary

PLUGIN_PROXY_CONFIG_PROP

private static final java.lang.String PLUGIN_PROXY_CONFIG_PROP

The system property that is used to convey proxy information in some VM's

See Also:

Constant Field Values

Constructor Detail

PluginProxyUtil

public PluginProxyUtil()

Method Detail

detectProxy

public static org.apache.http.HttpHost detectProxy(java.net.URL sampleURL)
                                            throws ProxyDetectionException

Returns the Proxy Host information using settings from the java plugin.

Parameters:

sampleURL - the url target for which proxy host information is required

Returns:

the proxy host info (name and port) or null if a direct connection is allowed to the target url.

Throws:

ProxyDetectionException - if detection failed

detectProxySettingsJDK13

private static org.apache.http.HttpHost detectProxySettingsJDK13(java.net.URL sampleURL)
                                                          throws ProxyDetectionException

Use Sun-specific internal plugin proxy classes for 1.3.X Look around for the 1.3.X plugin proxy detection class. Without it, cannot autodetect...

Parameters:

sampleURL - the URL to check proxy settings for

Returns:

ProxyHost the host and port of the proxy that should be used

Throws:

ProxyDetectionException - if detection failed

detectProxySettingsJDK14_JDK15_JDK16

private static org.apache.http.HttpHost detectProxySettingsJDK14_JDK15_JDK16(java.net.URL sampleURL)

Returns the proxy information for the specified sampleURL using JRE 1.4+ specific plugin classes. Notes: Plugin 1.4+ Final added com.sun.java.browser.net.* classes ProxyInfo & ProxyService... Use those with JREs => 1.4+

Parameters:

sampleURL - the URL to check proxy settings for

Returns:

ProxyHost the host and port of the proxy that should be used

getPluginProxyConfigSettings

private static org.apache.http.HttpHost getPluginProxyConfigSettings()
                                                              throws ProxyDetectionException

Returns the proxy host information found by inspecting the system property "javaplugin.proxy.config.list".

Returns:

ProxyHost the host and port of the proxy that should be used

Throws:

ProxyDetectionException - if an exception is encountered while parsing the value of PLUGIN_PROXY_CONFIG_PROP