public interface IProxyData
IProxyData
contains the information that is required to connect to
a particular proxy server.Modifier and Type | Field and Description |
---|---|
static String |
HTTP_PROXY_TYPE
Type constant (value "HTTP") which identifies an HTTP proxy.
|
static String |
HTTPS_PROXY_TYPE
Type constant (value "HTTPS") which identifies an HTTPS proxy.
|
static String |
SOCKS_PROXY_TYPE
Type constant (value "SOCKS") which identifies an SOCKS proxy.
|
Modifier and Type | Method and Description |
---|---|
void |
disable()
Set the values of this data to represent a disabling of its type.
|
String |
getHost()
Return the host name for the proxy server or
null
if a proxy server of this type is not available. |
String |
getPassword()
Return the password that should be used when authenticating
for the proxy.
|
int |
getPort()
Return the port that should be used when connecting to the host or -1
if the default port for the proxy protocol should be used.
|
String |
getType()
Return the type of this proxy.
|
String |
getUserId()
Return the id of the user that should be used when authenticating
for the proxy.
|
boolean |
isRequiresAuthentication()
Returns whether the proxy requires authentication.
|
void |
setHost(String host)
Set the host name for the proxy server of this type.
|
void |
setPassword(String password)
Set the password that should be used when authenticating
for the proxy.
|
void |
setPort(int port)
Set the port that should be used when connecting to the host.
|
void |
setUserid(String userid)
Set the id of the user that should be used when authenticating
for the proxy.
|
static final String HTTP_PROXY_TYPE
getType()
,
Constant Field Valuesstatic final String HTTPS_PROXY_TYPE
getType()
,
Constant Field Valuesstatic final String SOCKS_PROXY_TYPE
getType()
,
Constant Field ValuesString getType()
HTTP_PROXY_TYPE
,
HTTPS_PROXY_TYPE
,
SOCKS_PROXY_TYPE
String getHost()
null
if a proxy server of this type is not available.null
void setHost(String host)
null
.
Setting this value will not affect the data returned from IProxyService.getProxyData()
.
Clients can change the global settings by changing the proxy data instances and then
by calling IProxyService.setProxyData(IProxyData[])
with the adjusted data.
host
- the host name for the proxy server or null
int getPort()
void setPort(int port)
Setting this value will not affect the data returned from IProxyService.getProxyData()
.
Clients can change the global settings by changing the proxy data instances and then
by calling IProxyService.setProxyData(IProxyData[])
with the adjusted data.
port
- the port that should be used when connecting to the host
or -1 if the default port is to be usedString getUserId()
null
is returned if there is no
authentication information.null
void setUserid(String userid)
null
should be used if there is no
authentication information.
Setting this value will not affect the data returned from IProxyService.getProxyData()
.
Clients can change the global settings by changing the proxy data instances and then
by calling IProxyService.setProxyData(IProxyData[])
with the adjusted data.
userid
- the id of the user that should be used when authenticating
for the proxy or null
String getPassword()
null
is returned if there is no
password or the password is not known.null
void setPassword(String password)
null
should be passed if there is no
password or the password is not known.
Setting this value will not affect the data returned from IProxyService.getProxyData()
.
Clients can change the global settings by changing the proxy data instances and then
by calling IProxyService.setProxyData(IProxyData[])
with the adjusted data.
password
- the password that should be used when authenticating
for the proxy or null
boolean isRequiresAuthentication()
void disable()
IProxyService.setProxyData(IProxyData[])
with the
disabled data as a parameter. A proxy data can be enabled by setting
the host.
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.