|
Eclipse Platform Release 3.3 |
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||
An IProxyData contains the information that is required to connect
to a particular proxy server.
This interface is not intended to be implemented by clients.
| Field Summary | |
|---|---|
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. |
| Method Summary | |
|---|---|
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. |
| Field Detail |
public static final String HTTP_PROXY_TYPE
getType(),
Constant Field Valuespublic static final String HTTPS_PROXY_TYPE
getType(),
Constant Field Valuespublic static final String SOCKS_PROXY_TYPE
getType(),
Constant Field Values| Method Detail |
public String getType()
HTTP_PROXY_TYPE,
HTTPS_PROXY_TYPE,
SOCKS_PROXY_TYPEpublic String getHost()
null
if a proxy server of this type is not available.
nullpublic 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 nullpublic int getPort()
public 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 usedpublic String getUserId()
null is returned if there is no
authentication information.
nullpublic 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 nullpublic String getPassword()
null is returned if there is no
password or the password is not known.
nullpublic 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 nullpublic boolean isRequiresAuthentication()
public 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.3 |
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.