com.esri.arcgis.server
Interface IGPServerHelper

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPServerHelper

public interface IGPServerHelper
extends Serializable

Helper interface to process Geoprocessing requests.

Product Availability

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

Method Summary

byte[]	getBinaryJobDefinition(String jobID, String serviceName, String serviceType) Gets the binary job definition for a given job ID.
String	getBinaryRequestMessageType(byte[] request) Gets the type of the request from a binary message.
String	getJobIDFromBinaryResponse(byte[] response) Extracts the job ID from a binary message that contains this information.
String	getJobIDFromStringResponse(String response) Extracts the job ID from a Soap message that conatins this information.
int	getJobStatus(String jobID, String serviceName, String serviceType) Returns the status of a job.
void	getRESTJobDefinition(String jobID, String serviceName, String serviceType, String[] resourceName, String[] operationName, String[] operationInput, String[] outputFormat, String[] requestProperties) Returns the REST job definition for a given job ID.
String	getStringJobDefinition(String jobID, String serviceName, String serviceType) Gets the string job definition for given a job ID.
String	getStringRequestMessageType(String request) Gets the type of the request from a string message.
void	init(String jobRegistryPath, String jobsDirectoryPath) Initializes the helper with the job registery and jobs directory.
void	writeBinaryJobResult(String jobID, String serviceName, String serviceType, byte[] result) Writes a binary job result to the job directory.
void	writeJobStatusAndMessage(String jobID, String serviceName, String serviceType, int status, String message) Writes a specific job message and status for a given job ID.
void	writeRESTJobResult(String jobID, String serviceName, String serviceType, String responseProperties, byte[] result) Writes a REST job result to the job directory.
void	writeStringJobResult(String jobID, String serviceName, String serviceType, String result) Writes a SOAP job result to the job directory.

Method Detail

init

void init(String jobRegistryPath,
          String jobsDirectoryPath)
          throws IOException,
                 AutomationException

Initializes the helper with the job registery and jobs directory.

Product Availability

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

Parameters:

jobRegistryPath - The jobRegistryPath (in)

jobsDirectoryPath - The jobsDirectoryPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeStringJobResult

void writeStringJobResult(String jobID,
                          String serviceName,
                          String serviceType,
                          String result)
                          throws IOException,
                                 AutomationException

Writes a SOAP job result to the job directory.

Product Availability

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

Parameters:

jobID - The jobID (in)

serviceName - The serviceName (in)

serviceType - The serviceType (in)

result - The result (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeBinaryJobResult

void writeBinaryJobResult(String jobID,
                          String serviceName,
                          String serviceType,
                          byte[] result)
                          throws IOException,
                                 AutomationException

Writes a binary job result to the job directory.

Product Availability

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

Parameters:

jobID - The jobID (in)

serviceName - The serviceName (in)

serviceType - The serviceType (in)

result - An unsigned byte (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeRESTJobResult

void writeRESTJobResult(String jobID,
                        String serviceName,
                        String serviceType,
                        String responseProperties,
                        byte[] result)
                        throws IOException,
                               AutomationException

Writes a REST job result to the job directory.

Product Availability

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

Parameters:

jobID - The jobID (in)

serviceName - The serviceName (in)

serviceType - The serviceType (in)

responseProperties - The responseProperties (in)

result - An unsigned byte (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStringRequestMessageType

String getStringRequestMessageType(String request)
                                   throws IOException,
                                          AutomationException

Gets the type of the request from a string message.

Product Availability

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

Parameters:

request - The request (in)

Returns:

The pType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBinaryRequestMessageType

String getBinaryRequestMessageType(byte[] request)
                                   throws IOException,
                                          AutomationException

Gets the type of the request from a binary message.

Product Availability

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

Parameters:

request - An unsigned byte (in)

Returns:

The pType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobIDFromStringResponse

String getJobIDFromStringResponse(String response)
                                  throws IOException,
                                         AutomationException

Extracts the job ID from a Soap message that conatins this information.

Product Availability

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

Parameters:

response - The response (in)

Returns:

The pJobID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobIDFromBinaryResponse

String getJobIDFromBinaryResponse(byte[] response)
                                  throws IOException,
                                         AutomationException

Extracts the job ID from a binary message that contains this information.

Product Availability

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

Parameters:

response - An unsigned byte (in)

Returns:

The pJobID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStringJobDefinition

String getStringJobDefinition(String jobID,
                              String serviceName,
                              String serviceType)
                              throws IOException,
                                     AutomationException

Gets the string job definition for given a job ID.

Product Availability

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

Parameters:

jobID - The jobID (in)

serviceName - The serviceName (in)

serviceType - The serviceType (in)

Returns:

The pJobDefinition

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBinaryJobDefinition

byte[] getBinaryJobDefinition(String jobID,
                              String serviceName,
                              String serviceType)
                              throws IOException,
                                     AutomationException

Gets the binary job definition for a given job ID.

Product Availability

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

Parameters:

jobID - The jobID (in)

serviceName - The serviceName (in)

serviceType - The serviceType (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRESTJobDefinition

void getRESTJobDefinition(String jobID,
                          String serviceName,
                          String serviceType,
                          String[] resourceName,
                          String[] operationName,
                          String[] operationInput,
                          String[] outputFormat,
                          String[] requestProperties)
                          throws IOException,
                                 AutomationException

Returns the REST job definition for a given job ID.

Product Availability

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

Parameters:

jobID - The jobID (in)

serviceName - The serviceName (in)

serviceType - The serviceType (in)

resourceName - The resourceName (out: use single element array)

operationName - The operationName (out: use single element array)

operationInput - The operationInput (out: use single element array)

outputFormat - The outputFormat (out: use single element array)

requestProperties - The requestProperties (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeJobStatusAndMessage

void writeJobStatusAndMessage(String jobID,
                              String serviceName,
                              String serviceType,
                              int status,
                              String message)
                              throws IOException,
                                     AutomationException

Writes a specific job message and status for a given job ID.

Product Availability

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

Parameters:

jobID - The jobID (in)

serviceName - The serviceName (in)

serviceType - The serviceType (in)

status - A com.esri.arcgis.system.esriJobStatus constant (in)

message - The message (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobStatus

int getJobStatus(String jobID,
                 String serviceName,
                 String serviceType)
                 throws IOException,
                        AutomationException

Returns the status of a job.

Product Availability

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

Parameters:

jobID - The jobID (in)

serviceName - The serviceName (in)

serviceType - The serviceType (in)

Returns:

A com.esri.arcgis.system.esriJobStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.