com.esri.arcgis.geoprocessing
Class GPServerIP

java.lang.Object
  com.esri.arcgis.geoprocessing.GPServerIP

All Implemented Interfaces:

IGPServer, IGPServer2, IAGSServerObject, IAGSServerObject2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GPServerIP
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGSServerObject2, IAGSServerObject, IGPServer, IGPServer2

GP Server Message Proxy.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GPServerIP()
Constructs a GPServerIP using ArcGIS Engine.

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

Method Summary

void	cancelJob(String jobID) Cancels the specified job.
boolean	equals(Object o) Compare this object with another
IGPResult	execute(String toolName, IGPValues values, IGPResultOptions pOptions) Executes the specified tool with the supplied values and options and returns the results.
IGPResult	execute(String toolName, IGPValues values, IGPResultOptions options, IPropertySet envValues) Executes the specified tool with the supplied values and options and returns the results.
static String	getClsid() getClsid.
int	getExecutionType() Indicates if the geoprocessing server is synchronous or asynchronous.
IName	getFullName() The AGSServerConnectionName object associated with the server object.
int	getHttpTimeout() The maximum time in seconds to wait for a response from the server (Internet only).
IPropertySet	getJobEnvironmentValues(String jobID) Returns the enviornment values for the job.
IGPValues	getJobInputValues(String jobID, IStringArray parameterNames) Returns the input values for the job.
IJobMessages	getJobMessages(String jobID) Returns the messages of the specified job.
IGPResult	getJobResult(String jobID, IStringArray parameterNames, IGPResultOptions pOptions) Returns the results of the specified job.
IEnvelope	getJobResultMapExtent(String jobID) Returns the extent for the job.
IGPResultOptions	getJobResultOptions(String jobID) Returns the result options for the job.
int	getJobStatus(String jobID) Returns the status of the specified job.
String	getJobToolName(String jobID) Returns the tool name for the job.
String	getResultMapServerName() Indicates if there is an associated map server to draw the results and the name of the map server.
IGDSData	getResultWorkspace(String jobID, int transportType) Returns a zip file of the results workspace.
IGPToolInfos	getTaskInfos() Returns the tool information of the available tasks.
IStringArray	getTaskNames() Returns the names of the available tasks.
IGPToolInfo	getToolInfo(String toolName) Returns the tool information of the specified tool name.
IGPToolInfos	getToolInfos() Returns the tool information of the available tools.
IStringArray	getToolNames() Returns the names of the available tools.
int	hashCode() the hashcode for this object
void	setHttpTimeout(int secs) The maximum time in seconds to wait for a response from the server (Internet only).
String	submitJob(String toolName, IGPValues values) Submits the specified tool with the supplied values and options and returns the job id.
String	submitJob(String toolName, IGPValues values, IGPResultOptions options, IPropertySet envValues) Submits the specified tool with the supplied values and options and returns the job id.

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

GPServerIP

public GPServerIP()
           throws IOException,
                  UnknownHostException

Constructs a GPServerIP using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPServerIP

public GPServerIP(Object obj)
           throws IOException

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

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

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

getFullName

public IName getFullName()
                  throws IOException,
                         AutomationException

The AGSServerConnectionName object associated with the server object.

Product Availability

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

Specified by:

getFullName in interface IAGSServerObject2

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHttpTimeout

public void setHttpTimeout(int secs)
                    throws IOException,
                           AutomationException

The maximum time in seconds to wait for a response from the server (Internet only).

Product Availability

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

Specified by:

setHttpTimeout in interface IAGSServerObject2

Parameters:

secs - The secs (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHttpTimeout

public int getHttpTimeout()
                   throws IOException,
                          AutomationException

The maximum time in seconds to wait for a response from the server (Internet only).

Product Availability

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

Specified by:

getHttpTimeout in interface IAGSServerObject2

Returns:

The secs

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolNames

public IStringArray getToolNames()
                          throws IOException,
                                 AutomationException

Returns the names of the available tools.

Product Availability

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

Specified by:

getToolNames in interface IGPServer

Specified by:

getToolNames in interface IGPServer2

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolInfos

public IGPToolInfos getToolInfos()
                          throws IOException,
                                 AutomationException

Returns the tool information of the available tools.

Product Availability

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

Specified by:

getToolInfos in interface IGPServer

Specified by:

getToolInfos in interface IGPServer2

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPToolInfos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolInfo

public IGPToolInfo getToolInfo(String toolName)
                        throws IOException,
                               AutomationException

Returns the tool information of the specified tool name.

Product Availability

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

Specified by:

getToolInfo in interface IGPServer

Specified by:

getToolInfo in interface IGPServer2

Parameters:

toolName - The toolName (in)

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPToolInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTaskNames

public IStringArray getTaskNames()
                          throws IOException,
                                 AutomationException

Returns the names of the available tasks.

Product Availability

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

Specified by:

getTaskNames in interface IGPServer

Specified by:

getTaskNames in interface IGPServer2

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTaskInfos

public IGPToolInfos getTaskInfos()
                          throws IOException,
                                 AutomationException

Returns the tool information of the available tasks.

Product Availability

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

Specified by:

getTaskInfos in interface IGPServer

Specified by:

getTaskInfos in interface IGPServer2

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPToolInfos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResultMapServerName

public String getResultMapServerName()
                              throws IOException,
                                     AutomationException

Indicates if there is an associated map server to draw the results and the name of the map server.

Product Availability

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

Specified by:

getResultMapServerName in interface IGPServer

Specified by:

getResultMapServerName in interface IGPServer2

Returns:

The mapServerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

public IGPResult execute(String toolName,
                         IGPValues values,
                         IGPResultOptions pOptions)
                  throws IOException,
                         AutomationException

Executes the specified tool with the supplied values and options and returns the results.

Product Availability

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

Specified by:

execute in interface IGPServer

Parameters:

toolName - The toolName (in)

values - A reference to a com.esri.arcgis.geoprocessing.IGPValues (in)

pOptions - A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

submitJob

public String submitJob(String toolName,
                        IGPValues values)
                 throws IOException,
                        AutomationException

Submits the specified tool with the supplied values and options and returns the job id.

Product Availability

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

Specified by:

submitJob in interface IGPServer

Parameters:

toolName - The toolName (in)

values - A reference to a com.esri.arcgis.geoprocessing.IGPValues (in)

Returns:

The jobID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobStatus

public int getJobStatus(String jobID)
                 throws IOException,
                        AutomationException

Returns the status of the specified job.

Product Availability

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

Specified by:

getJobStatus in interface IGPServer

Specified by:

getJobStatus in interface IGPServer2

Parameters:

jobID - The jobID (in)

Returns:

A com.esri.arcgis.system.esriJobStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobMessages

public IJobMessages getJobMessages(String jobID)
                            throws IOException,
                                   AutomationException

Returns the messages of the specified job.

Product Availability

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

Specified by:

getJobMessages in interface IGPServer

Specified by:

getJobMessages in interface IGPServer2

Parameters:

jobID - The jobID (in)

Returns:

A reference to a com.esri.arcgis.system.IJobMessages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobResult

public IGPResult getJobResult(String jobID,
                              IStringArray parameterNames,
                              IGPResultOptions pOptions)
                       throws IOException,
                              AutomationException

Returns the results of the specified job.

Product Availability

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

Specified by:

getJobResult in interface IGPServer

Specified by:

getJobResult in interface IGPServer2

Parameters:

jobID - The jobID (in)

parameterNames - A reference to a com.esri.arcgis.system.IStringArray (in)

pOptions - A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancelJob

public void cancelJob(String jobID)
               throws IOException,
                      AutomationException

Cancels the specified job.

Product Availability

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

Specified by:

cancelJob in interface IGPServer

Specified by:

cancelJob in interface IGPServer2

Parameters:

jobID - The jobID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExecutionType

public int getExecutionType()
                     throws IOException,
                            AutomationException

Indicates if the geoprocessing server is synchronous or asynchronous.

Product Availability

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

Specified by:

getExecutionType in interface IGPServer

Specified by:

getExecutionType in interface IGPServer2

Returns:

A com.esri.arcgis.geoprocessing.esriExecutionType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResultWorkspace

public IGDSData getResultWorkspace(String jobID,
                                   int transportType)
                            throws IOException,
                                   AutomationException

Returns a zip file of the results workspace.

Product Availability

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

Specified by:

getResultWorkspace in interface IGPServer

Specified by:

getResultWorkspace in interface IGPServer2

Parameters:

jobID - The jobID (in)

transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

public IGPResult execute(String toolName,
                         IGPValues values,
                         IGPResultOptions options,
                         IPropertySet envValues)
                  throws IOException,
                         AutomationException

Executes the specified tool with the supplied values and options and returns the results.

Product Availability

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

Specified by:

execute in interface IGPServer2

Parameters:

toolName - The toolName (in)

values - A reference to a com.esri.arcgis.geoprocessing.IGPValues (in)

options - A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)

envValues - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

submitJob

public String submitJob(String toolName,
                        IGPValues values,
                        IGPResultOptions options,
                        IPropertySet envValues)
                 throws IOException,
                        AutomationException

Submits the specified tool with the supplied values and options and returns the job id.

Product Availability

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

Specified by:

submitJob in interface IGPServer2

Parameters:

toolName - The toolName (in)

values - A reference to a com.esri.arcgis.geoprocessing.IGPValues (in)

options - A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)

envValues - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

The jobID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobToolName

public String getJobToolName(String jobID)
                      throws IOException,
                             AutomationException

Returns the tool name for the job.

Product Availability

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

Specified by:

getJobToolName in interface IGPServer2

Parameters:

jobID - The jobID (in)

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobInputValues

public IGPValues getJobInputValues(String jobID,
                                   IStringArray parameterNames)
                            throws IOException,
                                   AutomationException

Returns the input values for the job.

Product Availability

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

Specified by:

getJobInputValues in interface IGPServer2

Parameters:

jobID - The jobID (in)

parameterNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPValues

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobResultOptions

public IGPResultOptions getJobResultOptions(String jobID)
                                     throws IOException,
                                            AutomationException

Returns the result options for the job.

Product Availability

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

Specified by:

getJobResultOptions in interface IGPServer2

Parameters:

jobID - The jobID (in)

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobEnvironmentValues

public IPropertySet getJobEnvironmentValues(String jobID)
                                     throws IOException,
                                            AutomationException

Returns the enviornment values for the job.

Product Availability

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

Specified by:

getJobEnvironmentValues in interface IGPServer2

Parameters:

jobID - The jobID (in)

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobResultMapExtent

public IEnvelope getJobResultMapExtent(String jobID)
                                throws IOException,
                                       AutomationException

Returns the extent for the job.

Product Availability

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

Specified by:

getJobResultMapExtent in interface IGPServer2

Parameters:

jobID - The jobID (in)

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.