com.esri.arcgisws.runtime
Interface WebServiceProxy

All Known Subinterfaces:

FeatureServerPort, GeocodeServerPort, GeoDataServerPort, GeometryServerPort, GlobeServerPort, GPServerPort, ImageServerPort, MapServerPort, MobileServerPort, NAServerPort, ServiceCatalogServerPort

All Known Implementing Classes:

FeatureServerBindingStub, GeocodeServerBindingStub, GeoDataServerBindingStub, GeometryServerBindingStub, GlobeServerBindingStub, GPServerBindingStub, ImageServerBindingStub, MapServerBindingStub, MobileServerBindingStub, NAServerBindingStub, ServiceCatalogBindingStub, WebServiceProxyImpl

public interface WebServiceProxy

The Interface WebServiceProxy.

Method Summary

Object	_getProperty(String name) Deprecated.
void	_setProperty(String name, Object value) Deprecated.
void	addHTTPRequestHeaders(Map httpHeaders) Allows users to pass in additional HTTP headers to each service endpoint.
void	enableRequestResponseLogging(boolean enable) Enable request response logging.
Map	getHTTPResponseHeaders() Allows users to get access to HTTP headers returned by the service with the response.
String	getPassword() Deprecated.
Object	getProperty(String name) getProperty Allows users to get service level properties.
String	getUsername() Deprecated.
void	setArcGISVersion(String serverVersion) Sets the arcgis version.
void	setConnectionTimeout(int timeout) Sets the connection timeout in milliseconds.
void	setEndPointAddress(String endpointAddressURL) Sets the end point address.
void	setEndPointAddress(String endpointAddressURL, String userName, String password) Sets the end point address.
void	setHttpReferer(String referer) Sets the http referer the use can set when connecting to a arcgistoken based secured service.
void	setPassword(String password) Deprecated.
void	setProperties(Map serviceParams) Allows to set multiple service properties
void	setProperty(String key, Object value) Sets the property.
void	setSoapOverDCOM(Object serverobject) Deprecated.
void	setSoapOverDCOM(Object serverobject, String capablities) Deprecated.
void	setUsername(String username) Deprecated.

Method Detail

setEndPointAddress

void setEndPointAddress(String endpointAddressURL)

Sets the end point address. The arcgis http handler url where the service is available eg. http//merced.esri.com:80/arcgis/services/USA/MapServer

Parameters:

endpointAddressURL - the endpoint address url

setEndPointAddress

void setEndPointAddress(String endpointAddressURL,
                        String userName,
                        String password)

Sets the end point address. The arcgis http handler url where the secured service is running. These services can be secured using Http Basic or Digest Authentication and also Arcgis Token based security. In either cases the user needs to pass in the username and password eg. http//merced.esri.com:80/arcgis/services/private/USA_planner/MapServer

Parameters:

userName - the user name

password - the password

endpointAddressURL - the endpoint address url

setArcGISVersion

void setArcGISVersion(String serverVersion)

Sets the arcgis version. The Web Service stubs needs to work with multiple versions of ArcGIS Server (10.0, 9.3 and 9.2) The stubs will be generated from 10.0 wsdls, this means that the namespace in the stub will pertain to 10.0 and can only work with a 10.0 server. The clients will do a version check using the GetMessageVersion request with the server and set the server version. This will cause the proxies to change the message namespace in the SOAP messages.

Parameters:

serverVersion - the new arcgis version

enableRequestResponseLogging

void enableRequestResponseLogging(boolean enable)

Enable request response logging. This allows you to monitor the soap request and response messages. This will enable logging for both http and dcom transports. For http transports the http requst and response headers are also logged.

setSoapOverDCOM

@Deprecated
void setSoapOverDCOM(Object serverobject)

Deprecated.

This method is not public. This is only supported for internal usage only Sets the soap over dcom. Allows user to send and receive soap messages to Local ArcGIS Server using DCOM.

Parameters:

serverobject - the new soap over dcom

setSoapOverDCOM

@Deprecated
void setSoapOverDCOM(Object serverobject,
                                String capablities)

Deprecated.

This method is not public. This is only supported for internal usage only Sets the soap over dcom. Allows user to send and receive soap messages to Local ArcGIS Server using DCOM, which specified capabilities.

Parameters:

serverobject - the serverobject

capablities - the capablities

setProperties

void setProperties(Map serviceParams)

Allows to set multiple service properties

Parameters:

serviceParams - the Map

setHttpReferer

void setHttpReferer(String referer)

Sets the http referer the use can set when connecting to a arcgistoken based secured service. In the referer value is not set a random generated referer is used by the http transport when consuming token secured service.

Parameters:

referer - the new http Referer

setConnectionTimeout

void setConnectionTimeout(int timeout)

Sets the connection timeout in milliseconds. Allows the clients to control http connection timeouts. Connection timeouts are not available for local connection, which uses the default DCOM timeouts.

Parameters:

timeout - the new connection timeout in milliseconds

setProperty

void setProperty(String key,
                 Object value)

Sets the property. Sets the value for a named property. Allows users to set service level properties. Service level properties apply to each xxxBindingStub object that is created.

Parameters:

key - the key

value - the value as Object

getProperty

Object getProperty(String name)

getProperty Allows users to get service level properties. Service level properties apply to each xxxBindingStub object that is created.

Parameters:

name - the name as String

Returns:

the object

addHTTPRequestHeaders

void addHTTPRequestHeaders(Map httpHeaders)

Allows users to pass in additional HTTP headers to each service endpoint. These HTTP headers are send with every request.

Parameters:

httpHeaders - as Map

See Also:

com.esri.arcgisws.WebServiceProxy#addHTTPRequestHeaders(java.util.Map)

getHTTPResponseHeaders

Map getHTTPResponseHeaders()

Allows users to get access to HTTP headers returned by the service with the response.

Returns:

the httpHeaders as Map

_setProperty

@Deprecated
void _setProperty(String name,
                             Object value)

Deprecated.

_setProperty is deprecated use setProperty instead. This was provided for backing compatibility with Axis generated stubs

Parameters:

name - the name

value - the value

_getProperty

@Deprecated
Object _getProperty(String name)

Deprecated.

_getProperty is deprecated use getProperty instead. This was provided for backing compatibility with Axis generated stubs

Parameters:

name - the name

Returns:

the object

setUsername

@Deprecated
void setUsername(String username)

Deprecated.

setUsername is deprecated use xxxBindingStub(urlSting,username,password) instead. This was provided for backing compatibility with Axis generated stubs Sets the username.

Parameters:

username - the new username

getUsername

@Deprecated
String getUsername()

Deprecated.

getUsername is deprecated This was provided for backing compatibility with Axis generated stubs Gets the username.

Returns:

the username

setPassword

@Deprecated
void setPassword(String password)

Deprecated.

setPassword is deprecated use xxxBindingStub(urlSting,username,password) instead. This was provided for backing compatibility with Axis generated stubs Sets the password.

Parameters:

password - the new password

getPassword

@Deprecated
String getPassword()

Deprecated.

getPassword is deprecated This was provided for backing compatibility with Axis generated stubs Gets the password.

Returns:

the password