com.teamdev.xpcom
Interface ProxyConfiguration


public interface ProxyConfiguration

Proxy configuration interface. Global proxy settings to the Mozilla engine that is running in a given application. Please note that some combinations of parameters don't make sense.


Field Summary
static int DIRECT
           
static int MANUAL
           
static int PAC
           
static int WPAD
           
 
Method Summary
 PoxyAuthenticationHandler getAuthenticationHandler(ProxyServerType type)
          Returns registered authentication handler for a given server type or null when there's no registered handler.
 java.lang.String getAutoconfigUrl()
           
 java.lang.String getFtpHost()
           
 int getFtpPort()
           
 java.lang.String getGopherHost()
           
 int getGopherPort()
           
 java.lang.String getHttpHost()
           
 int getHttpPort()
           
 boolean getShareProxySettings()
           
 java.lang.String getSkipProxyFor()
          Gets a whitelist of sites or domains that should not be accessed via the proxy server.
 java.lang.String getSocksHost()
           
 int getSocksPort()
           
 int getSocksVersion()
           
 java.lang.String getSslHost()
           
 int getSslPort()
           
 int getType()
           
 void setAutoconfigUrl(java.lang.String autoconfigUrl)
          Sets proxy server auto-configuration URL
 void setFtpHost(java.lang.String ftpHost)
          Set host of ftpServer
 void setFtpPort(int ftpPort)
          sets the port for ftp proxy
 void setGopherHost(java.lang.String gopherHost)
          Sets Gopher proxy server host
 void setGopherPort(int gopherPort)
          Sets Gopher proxy server port
 void setHttpHost(java.lang.String httpHost)
          Sets HTTP proxy server host
 void setHttpPort(int httpPort)
          Sets HTTP proxy server port
 void setPoxyAuthenticationHandler(ProxyServerType type, PoxyAuthenticationHandler handler)
          Registers an authentication handler for a specified server type that will receive notification when a user name and password for the server is required.
 void setShareProxySettings(boolean shareProxySettings)
          Make proxy server sharing available
 void setSkipProxyFor(java.lang.String noProxyFor)
          Sets a whitelist of sites or domains that should not be accessed via the proxy server.
 void setSocksHost(java.lang.String socksHost)
          Sets Socks proxy server host
 void setSocksPort(int socksPort)
          Set Socks proxy server port
 void setSocksVersion(int socksVersion)
           
 void setSslHost(java.lang.String sslHost)
          Sets SSL proxy server host
 void setSslPort(int sslPort)
          Set SSL proxy server hport
 void setType(int type)
           
 

Field Detail

DIRECT

static final int DIRECT
See Also:
Constant Field Values

MANUAL

static final int MANUAL
See Also:
Constant Field Values

PAC

static final int PAC
See Also:
Constant Field Values

WPAD

static final int WPAD
See Also:
Constant Field Values
Method Detail

setPoxyAuthenticationHandler

void setPoxyAuthenticationHandler(ProxyServerType type,
                                  PoxyAuthenticationHandler handler)
Registers an authentication handler for a specified server type that will receive notification when a user name and password for the server is required.

Parameters:
type - the proxy server type.
handler - authentication handler for receiving notification.

getAuthenticationHandler

PoxyAuthenticationHandler getAuthenticationHandler(ProxyServerType type)
Returns registered authentication handler for a given server type or null when there's no registered handler.

Parameters:
type - the proxy server type.
Returns:
an authentication handler for the specified server type.

getAutoconfigUrl

java.lang.String getAutoconfigUrl()
Returns:
current proxy server auto-configuration URL

setAutoconfigUrl

void setAutoconfigUrl(java.lang.String autoconfigUrl)
Sets proxy server auto-configuration URL


getFtpHost

java.lang.String getFtpHost()
Returns:
current value of ftp proxy server host

setFtpHost

void setFtpHost(java.lang.String ftpHost)
Set host of ftpServer


getFtpPort

int getFtpPort()
Returns:
current port of ftp proxy server

setFtpPort

void setFtpPort(int ftpPort)
sets the port for ftp proxy

Parameters:
ftpPort -

getGopherHost

java.lang.String getGopherHost()
Returns:
current Gopher proxy server host

setGopherHost

void setGopherHost(java.lang.String gopherHost)
Sets Gopher proxy server host


getGopherPort

int getGopherPort()
Returns:
current Gopher proxy server port

setGopherPort

void setGopherPort(int gopherPort)
Sets Gopher proxy server port


getHttpHost

java.lang.String getHttpHost()
Returns:
current HTTP proxy server host

setHttpHost

void setHttpHost(java.lang.String httpHost)
Sets HTTP proxy server host


getHttpPort

int getHttpPort()
Returns:
current HTTP proxy server port

setHttpPort

void setHttpPort(int httpPort)
Sets HTTP proxy server port


getSkipProxyFor

java.lang.String getSkipProxyFor()
Gets a whitelist of sites or domains that should not be accessed via the proxy server.

Returns:
string of comma delimited fqdn's, hostnames, IPv4 addresses and CDIR blocks

setSkipProxyFor

void setSkipProxyFor(java.lang.String noProxyFor)
Sets a whitelist of sites or domains that should not be accessed via the proxy server. See "No Proxy for".

Parameters:
noProxyFor - string of comma delimited fqdn's, hostnames, IPv4 addresses and CDIR blocks

getSocksHost

java.lang.String getSocksHost()
Returns:
current Socks proxy server host

setSocksHost

void setSocksHost(java.lang.String socksHost)
Sets Socks proxy server host


getSocksPort

int getSocksPort()
Returns:
current Socks proxy server port

setSocksPort

void setSocksPort(int socksPort)
Set Socks proxy server port


getSocksVersion

int getSocksVersion()
Returns:
version of Socks protocol that proxy server use

setSocksVersion

void setSocksVersion(int socksVersion)

getSslHost

java.lang.String getSslHost()
Returns:
current SSL proxy server host

setSslHost

void setSslHost(java.lang.String sslHost)
Sets SSL proxy server host


getSslPort

int getSslPort()
Returns:
current SSL proxy server port

setSslPort

void setSslPort(int sslPort)
Set SSL proxy server hport


getType

int getType()
Returns:
proxy configuration type
See Also:
DIRECT, MANUAL, PAC, WPAD

setType

void setType(int type)
Parameters:
type - proxy configuration type
See Also:
DIRECT, MANUAL, PAC, WPAD

getShareProxySettings

boolean getShareProxySettings()
Returns:
true if proxy settings sharing is available

setShareProxySettings

void setShareProxySettings(boolean shareProxySettings)
Make proxy server sharing available

Parameters:
shareProxySettings - whether proxy server sharing is available