com.esri.arcgis.system
Class ProxyServerInfo

java.lang.Object
  com.esri.arcgis.system.ProxyServerInfo

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IProxyServerInfo, IProxyServerInfo2, Serializable

public class ProxyServerInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IProxyServerInfo, IProxyServerInfo2

A utility class for setting proxy server configuration information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

ProxyServerInfo()
Constructs a ProxyServerInfo using ArcGIS Engine.

ProxyServerInfo(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ProxyServerInfo theProxyServerInfo = (ProxyServerInfo) obj;

Method Summary

void	cacheProxyCredentials() Cache proxy credentials.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getPassword() Proxy server user password.
String	getProxyServer() Proxy server address.
String	getUserName() Proxy server user name.
int	hashCode() the hashcode for this object
boolean	isCredentialsCancelled() Indicates credentials cancel state.
boolean	isEnabled() Indicates whether a proxy server is required.
void	readProxyServerInfo() Read proxy server configuration from the registry.
void	setCredentialsCancelled(boolean value) Indicates credentials cancel state.
void	setEnabled(boolean enabled) Indicates whether a proxy server is required.
void	setPassword(String password) Proxy server user password.
void	setProxyServer(String proxyServer) Proxy server address.
void	setUserName(String userName) Proxy server user name.
void	writeProxyServerInfo() Write proxy server configuration to the registry.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ProxyServerInfo

public ProxyServerInfo()
                throws IOException,
                       UnknownHostException

Constructs a ProxyServerInfo using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ProxyServerInfo

public ProxyServerInfo(Object obj)
                throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ProxyServerInfo theProxyServerInfo = (ProxyServerInfo) obj;

Construct a ProxyServerInfo using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ProxyServerInfo.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getUserName

public String getUserName()
                   throws IOException,
                          AutomationException

Proxy server user name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getUserName in interface IProxyServerInfo

Returns:

The userName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserName

public void setUserName(String userName)
                 throws IOException,
                        AutomationException

Proxy server user name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setUserName in interface IProxyServerInfo

Parameters:

userName - The userName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPassword

public String getPassword()
                   throws IOException,
                          AutomationException

Proxy server user password.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getPassword in interface IProxyServerInfo

Returns:

The password

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPassword

public void setPassword(String password)
                 throws IOException,
                        AutomationException

Proxy server user password.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setPassword in interface IProxyServerInfo

Parameters:

password - The password (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProxyServer

public String getProxyServer()
                      throws IOException,
                             AutomationException

Proxy server address.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getProxyServer in interface IProxyServerInfo

Returns:

The proxyServer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProxyServer

public void setProxyServer(String proxyServer)
                    throws IOException,
                           AutomationException

Proxy server address.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setProxyServer in interface IProxyServerInfo

Parameters:

proxyServer - The proxyServer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled()
                  throws IOException,
                         AutomationException

Indicates whether a proxy server is required.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isEnabled in interface IProxyServerInfo

Returns:

The enabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnabled

public void setEnabled(boolean enabled)
                throws IOException,
                       AutomationException

Indicates whether a proxy server is required.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setEnabled in interface IProxyServerInfo

Parameters:

enabled - The enabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

readProxyServerInfo

public void readProxyServerInfo()
                         throws IOException,
                                AutomationException

Read proxy server configuration from the registry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

readProxyServerInfo in interface IProxyServerInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeProxyServerInfo

public void writeProxyServerInfo()
                          throws IOException,
                                 AutomationException

Write proxy server configuration to the registry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

writeProxyServerInfo in interface IProxyServerInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCredentialsCancelled

public boolean isCredentialsCancelled()
                               throws IOException,
                                      AutomationException

Indicates credentials cancel state.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isCredentialsCancelled in interface IProxyServerInfo2

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCredentialsCancelled

public void setCredentialsCancelled(boolean value)
                             throws IOException,
                                    AutomationException

Indicates credentials cancel state.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setCredentialsCancelled in interface IProxyServerInfo2

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cacheProxyCredentials

public void cacheProxyCredentials()
                           throws IOException,
                                  AutomationException

Cache proxy credentials.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

cacheProxyCredentials in interface IProxyServerInfo2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.