|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Manages the proxy data and related information. The proxy service is registered as an OSGi service. Clients can obtain an instance of the service from their bundle context or from a service tracker.
Clients that wish to make a connection and need to determine whether to use a
proxy or not should call either getProxyDataForHost(String)
or
getProxyDataForHost(String, String)
.
This interface is not intended to be implemented by clients.
Method Summary | |
void |
addProxyChangeListener(IProxyChangeListener listener)
Registers a listener that will be notified when proxy related information changes. |
String[] |
getNonProxiedHosts()
Returns the list of hosts for which non proxy should be used. |
IProxyData[] |
getProxyData()
Returns the list of know proxy types and their settings. |
IProxyData |
getProxyData(String type)
Returns the proxy data for the proxy of the given type or null if the proxy type is not known by this service.
|
IProxyData[] |
getProxyDataForHost(String host)
Returns the list of known proxy types and their settings for the given host. |
IProxyData |
getProxyDataForHost(String host,
String type)
Returns the proxy data for the proxy of the given type or null if the proxy type is not known by this service, the
proxy data is empty for that type or the host is in the non-proxied host
list.
|
boolean |
hasSystemProxies()
Returns whether system proxy support is available. |
boolean |
isProxiesEnabled()
Returns whether proxy support should be enabled. |
boolean |
isSystemProxiesEnabled()
Returns whether system proxy should be used when the proxy support is enabled. |
void |
removeProxyChangeListener(IProxyChangeListener listener)
Removes a listener. |
void |
setNonProxiedHosts(String[] hosts)
Sets the list of hosts for which non proxy should be used. |
void |
setProxiesEnabled(boolean enabled)
Sets whether proxy support should be enabled. |
void |
setProxyData(IProxyData[] proxies)
Sets the information associated with known proxy types. |
void |
setSystemProxiesEnabled(boolean enabled)
Sets whether system proxies should be used, when the proxy support is enabled. |
Method Detail |
public void setProxiesEnabled(boolean enabled)
isProxiesEnabled()
before calling the getProxyData()
or
getProxyData(String)
method. However, the
getProxyDataForHost(String)
and
getProxyDataForHost(String, String)
method will check the
enablement and only return data if the service is enabled.
enabled
- whether proxy support should be enabledpublic boolean isProxiesEnabled()
Returns false
, when the system proxies support is
enabled but hasSystemProxies()
returns false
.
public boolean hasSystemProxies()
public void setSystemProxiesEnabled(boolean enabled)
enabled
- public boolean isSystemProxiesEnabled()
public IProxyData[] getProxyData()
null
.
Clients that wish to make a connection and need to determine whether to
use a proxy or not should call either
getProxyDataForHost(String)
or
getProxyDataForHost(String, String)
.
This method returns the proxies set via setProxyData(IProxyData[])
public IProxyData[] getProxyDataForHost(String host)
Clients that wish to make a connection and need to determine whether to use a proxy should use this method.
host
- the host for which a connection is desired
public IProxyData getProxyData(String type)
null
if the proxy type is not known by this service.
Clients that wish to make a connection and need to determine whether to
use a proxy or not should call either
getProxyDataForHost(String)
or
getProxyDataForHost(String, String)
.
This method returns the proxies set via setProxyData(IProxyData[])
type
- the proxy type
null
IProxyData.HTTP_PROXY_TYPE
,
IProxyData.HTTPS_PROXY_TYPE
,
IProxyData.SOCKS_PROXY_TYPE
public IProxyData getProxyDataForHost(String host, String type)
null
if the proxy type is not known by this service, the
proxy data is empty for that type or the host is in the non-proxied host
list.
Clients that wish to make a connection and need to determine whether to use a proxy should use this method.
host
- the host for which a connection is desiredtype
- the proxy type
null
IProxyData.HTTP_PROXY_TYPE
,
IProxyData.HTTPS_PROXY_TYPE
,
IProxyData.SOCKS_PROXY_TYPE
public void setProxyData(IProxyData[] proxies) throws CoreException
This method affects only proxies defined in Eclipse by user and doesn't affect settings of the system proxies (being used when the system support is enabled).
proxies
- the proxy data whose information is to be set.
CoreException
- if the proxy could not be setpublic String[] getNonProxiedHosts()
Clients that wish to make a connection and need to determine whether to
use a proxy or not should call either
getProxyDataForHost(String)
or
getProxyDataForHost(String, String)
.
This method returns the hosts set via
setNonProxiedHosts(String[])
getProxyDataForHost(String)
,
getProxyDataForHost(String, String)
public void setNonProxiedHosts(String[] hosts) throws CoreException
This method affects only non-proxied hosts defined in Eclipse by user and doesn't affect settings of the system proxies (being used when the system support is enabled).
hosts
- the list of hosts for which non proxy should be used
CoreException
- if the non-proxied host list could not be setpublic void addProxyChangeListener(IProxyChangeListener listener)
listener
- a change listenerpublic void removeProxyChangeListener(IProxyChangeListener listener)
listener
- a change listener
|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.