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

Class GnomeProxySearchStrategy

java.lang.Object

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

All Implemented Interfaces:

ProxySearchStrategy

public class GnomeProxySearchStrategy
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:

• /system/http_proxy/use_http_proxy -> bool used only by gnome-vfs
• /system/http_proxy/host -> string "my-proxy.example.com" without "http://"
• /system/http_proxy/port -> int
• /system/http_proxy/use_authentication -> bool
• /system/http_proxy/authentication_user -> string
• /system/http_proxy/authentication_password -> string
• /system/http_proxy/ignore_hosts -> list-of-string
• /system/proxy/mode -> string THIS IS THE CANONICAL KEY; SEE BELOW
• /system/proxy/secure_host -> string "proxy-for-https.example.com"
• /system/proxy/secure_port -> int
• /system/proxy/ftp_host -> string "proxy-for-ftp.example.com"
• /system/proxy/ftp_port -> int
• /system/proxy/socks_host -> string "proxy-for-socks.example.com"
• /system/proxy/socks_port -> int
• /system/proxy/autoconfig_url -> string "http://proxy-autoconfig.example.com"

/system/proxy/mode can be either:
"none" -> No proxy is used
"manual" -> The user's configuration values are used (/system/http_proxy/{host,port,etc.})
"auto" -> The "/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
GnomeProxySearchStrategy() 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

GnomeProxySearchStrategy

public GnomeProxySearchStrategy()

ProxySelector

See Also:

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.