com.github.markusbernhardt.proxy.search.desktop.gnome

Class GnomeDConfProxySearchStrategy

java.lang.Object

com.github.markusbernhardt.proxy.search.desktop.gnome.GnomeDConfProxySearchStrategy

All Implemented Interfaces:

ProxySearchStrategy

public class GnomeDConfProxySearchStrategy
extends Object
implements ProxySearchStrategy

Loads the Gnome proxy settings from the Gnome GConf settings.

The following settings are extracted from the configuration that is stored in .gconf folder found in the user's home directory:

• org.gnome.system.proxy.http enabled -> bool used only by gnome-vfs
• org.gnome.system.proxy.http host -> string "my-proxy.example.com" without "http://"
• org.gnome.system.proxy.http port -> int
• org.gnome.system.proxy.http use-authentication -> bool
• org.gnome.system.proxy.http authentication-user -> string
• org.gnome.system.proxy.http authentication-password -> string
• org.gnome.system.proxy ignore-hosts -> list-of-string
• org.gnome.system.proxy mode -> string THIS IS THE CANONICAL KEY; SEE BELOW
• org.gnome.system.proxy use-same-proxy -> bool
• org.gnome.system.proxy.https host -> string "proxy-for-https.example.com"
• org.gnome.system.proxy.https port -> int
• org.gnome.system.proxy.ftp host -> string "proxy-for-ftp.example.com"
• org.gnome.system.proxy.ftp port -> int
• org.gnome.system.proxy.socks host -> string "proxy-for-socks.example.com"
• org.gnome.system.proxy.socks port -> int
• org.gnome.system.proxy autoconfig-url -> string "http://proxy-autoconfig.example.com"

org.gnome.system.proxy mode can be either:
"none" -> No proxy is used
"manual" -> The user's configuration values are used (org.gnome.system.http_proxy/{host,port,etc.})
"auto" -> The "org.gnome.system.proxy/autoconfig_url" key is used

GNOME Proxy_configuration settings are explained here in detail

Author:

Markus Bernhardt, Copyright 2016, Bernd Rosstauscher, Copyright 2009

Constructor Summary

Constructors

Constructor and Description
GnomeDConfProxySearchStrategy() ProxySelector

Method Summary

Modifier and Type	Method and Description
String	getName() Gets the printable name of the search strategy.
ProxySelector	getProxySelector() Loads the proxy settings and initializes a proxy selector for the Gnome proxy settings.
Properties	readSettings() Load the proxy settings from the gconf settings XML file.

Methods inherited from class java.lang.Object

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

Constructor Detail

GnomeDConfProxySearchStrategy

public GnomeDConfProxySearchStrategy()

ProxySelector

See Also:

ProxySelector.ProxySelector()

Method Detail

getProxySelector

public ProxySelector getProxySelector()
                               throws ProxyException

Loads the proxy settings and initializes a proxy selector for the Gnome proxy settings.

Specified by:

getProxySelector in interface ProxySearchStrategy

Returns:

a configured ProxySelector, null if none is found.

Throws:

ProxyException - on file reading error.

getName

public String getName()

Gets the printable name of the search strategy.

Specified by:

getName in interface ProxySearchStrategy

Returns:

the printable name of the search strategy

readSettings

public Properties readSettings()
                        throws ProxyException

Load the proxy settings from the gconf settings XML file.

Returns:

the loaded settings stored in a properties object.

Throws:

ProxyException - on processing error.