|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IProxyData
An IProxyData contains the information that is required to connect to
a particular proxy server.
| Field Summary | |
|---|---|
static java.lang.String |
HTTP_PROXY_TYPE
Type constant (value "HTTP") which identifies an HTTP proxy. |
static java.lang.String |
HTTPS_PROXY_TYPE
Type constant (value "HTTPS") which identifies an HTTPS proxy. |
static java.lang.String |
SOCKS_PROXY_TYPE
Type constant (value "SOCKS") which identifies an SOCKS proxy. |
| Method Summary | |
|---|---|
void |
disable()
Set the values of this data to represent a disabling of its type. |
java.lang.String |
getHost()
Return the host name for the proxy server or null
if a proxy server of this type is not available. |
java.lang.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. |
java.lang.String |
getType()
Return the type of this proxy. |
java.lang.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(java.lang.String host)
Set the host name for the proxy server of this type. |
void |
setPassword(java.lang.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(java.lang.String userid)
Set the id of the user that should be used when authenticating for the proxy. |
| Field Detail |
|---|
static final java.lang.String HTTP_PROXY_TYPE
getType(),
Constant Field Valuesstatic final java.lang.String HTTPS_PROXY_TYPE
getType(),
Constant Field Valuesstatic final java.lang.String SOCKS_PROXY_TYPE
getType(),
Constant Field Values| Method Detail |
|---|
java.lang.String getType()
HTTP_PROXY_TYPE,
HTTPS_PROXY_TYPE,
SOCKS_PROXY_TYPEjava.lang.String getHost()
null
if a proxy server of this type is not available.
nullvoid setHost(java.lang.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 nullint 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 usedjava.lang.String getUserId()
null is returned if there is no
authentication information.
nullvoid setUserid(java.lang.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 nulljava.lang.String getPassword()
null is returned if there is no
password or the password is not known.
nullvoid setPassword(java.lang.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 nullboolean isRequiresAuthentication()
void disable()
IProxyService.setProxyData(IProxyData[]) with the
disabled data as a parameter. A proxy data can be enabled by setting
the host.
|
Eclipse Platform Release 3.6 |
|||||||||
| 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, 2010. All rights reserved.