org.deegree.commons.utils
Class ProxyUtils

java.lang.Object
  org.deegree.commons.utils.ProxyUtils

public final class ProxyUtils
extends Object

Utility class for accessing and modifying the VM's proxy configuration and for opening URL connections that respect proxy configurations which require authentication.

Please note that Java's proxy configuration is VM-global: there is a set of system properties (proxyHost, proxyPort, etc.) that determines the behaviour of network-related classes (e.g. in java.net). This makes sense, as the proxy configuration is usually defined by the network environment of the physical machine.

Version:

$Revision: $, $Date: $

Author:

Markus Schneider, last edited by: $Author: schneider $

Constructor Summary

ProxyUtils()

Method Summary

static String	getFtpNonProxyHosts(boolean considerBaseConfig)
static String	getFtpProxyHost(boolean considerBaseConfig)
static String	getFtpProxyPassword(boolean considerBaseConfig)
static String	getFtpProxyPort(boolean considerBaseConfig)
static String	getFtpProxyUser(boolean considerBaseConfig)
static String	getHttpNonProxyHosts(boolean considerBaseConfig)
static String	getHttpProxyHost(boolean considerBaseConfig)
static String	getHttpProxyPassword(boolean considerBaseConfig)
static String	getHttpProxyPort(boolean considerBaseConfig)
static String	getHttpProxyUser(boolean considerBaseConfig)
static String	getNonProxyHosts()
static String	getProxyHost()
static String	getProxyPassword()
static String	getProxyPort()
static String	getProxyUser()
static void	logProxyConfiguration(org.slf4j.Logger log)
static URLConnection	openURLConnection(URL url, String user, String pass) This method should be used everywhere instead of URL.openConnection(), as it copes with proxies that require user authentication.
static void	setupProxyParameters(ProxyConfiguration config) Sets/augments the VM's proxy configuration.
static void	setupProxyParameters(String proxyHost, String httpProxyHost, String ftpProxyHost, int proxyPort, int httpProxyPort, int ftpProxyPort, String proxyUser, String httpProxyUser, String ftpProxyUser, String proxyPassword, String httpProxyPassword, String ftpProxyPassword, String nonProxyHosts, String httpNonProxyHosts, String ftpNonProxyHosts, boolean override) Sets/augments the VM's proxy configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyUtils

public ProxyUtils()

Method Detail

setupProxyParameters

public static void setupProxyParameters(ProxyConfiguration config)

Sets/augments the VM's proxy configuration.

Parameters:

config -

setupProxyParameters

public static void setupProxyParameters(String proxyHost,
                                        String httpProxyHost,
                                        String ftpProxyHost,
                                        int proxyPort,
                                        int httpProxyPort,
                                        int ftpProxyPort,
                                        String proxyUser,
                                        String httpProxyUser,
                                        String ftpProxyUser,
                                        String proxyPassword,
                                        String httpProxyPassword,
                                        String ftpProxyPassword,
                                        String nonProxyHosts,
                                        String httpNonProxyHosts,
                                        String ftpNonProxyHosts,
                                        boolean override)

Sets/augments the VM's proxy configuration.

Parameters:

proxyHost -

httpProxyHost -

ftpProxyHost -

proxyPort -

httpProxyPort -

ftpProxyPort -

proxyUser -

httpProxyUser -

ftpProxyUser -

proxyPassword -

httpProxyPassword -

ftpProxyPassword -

nonProxyHosts -

httpNonProxyHosts -

ftpNonProxyHosts -

override -

openURLConnection

public static URLConnection openURLConnection(URL url,
                                              String user,
                                              String pass)
                                       throws IOException

This method should be used everywhere instead of URL.openConnection(), as it copes with proxies that require user authentication.

Parameters:

url -

user -

pass -

Returns:

connection

Throws:

IOException

getProxyHost

public static String getProxyHost()

getHttpProxyHost

public static String getHttpProxyHost(boolean considerBaseConfig)

getFtpProxyHost

public static String getFtpProxyHost(boolean considerBaseConfig)

getProxyPort

public static String getProxyPort()

getHttpProxyPort

public static String getHttpProxyPort(boolean considerBaseConfig)

getFtpProxyPort

public static String getFtpProxyPort(boolean considerBaseConfig)

getProxyUser

public static String getProxyUser()

getHttpProxyUser

public static String getHttpProxyUser(boolean considerBaseConfig)

getFtpProxyUser

public static String getFtpProxyUser(boolean considerBaseConfig)

getProxyPassword

public static String getProxyPassword()

getHttpProxyPassword

public static String getHttpProxyPassword(boolean considerBaseConfig)

getFtpProxyPassword

public static String getFtpProxyPassword(boolean considerBaseConfig)

getNonProxyHosts

public static String getNonProxyHosts()

getHttpNonProxyHosts

public static String getHttpNonProxyHosts(boolean considerBaseConfig)

getFtpNonProxyHosts

public static String getFtpNonProxyHosts(boolean considerBaseConfig)

logProxyConfiguration

public static void logProxyConfiguration(org.slf4j.Logger log)