com.esri.arcgis.server
Interface IGPServerHelper

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GPServerHelper, IGPServerHelperProxy

public interface IGPServerHelper
extends java.io.Serializable

COM Interface 'IGPServerHelper'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriServer.olb'

Description: 'Helper interface to process Geoprocessing requests.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDe5a9a155_937e_4025_8ce6_42690d964c42
static int	xxDummy Deprecated. Internal use only

Method Summary

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

Field Detail

IIDe5a9a155_937e_4025_8ce6_42690d964c42

static final int IIDe5a9a155_937e_4025_8ce6_42690d964c42

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

init

void init(java.lang.String jobRegistryPath,
          java.lang.String jobsDirectoryPath)
          throws java.io.IOException,
                 AutomationException

Initializes the helper with the job registery and jobs directory.

Parameters:

jobRegistryPath - The jobRegistryPath (in)

jobsDirectoryPath - The jobsDirectoryPath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeStringJobResult

void writeStringJobResult(java.lang.String jobID,
                          java.lang.String serviceName,
                          java.lang.String serviceType,
                          java.lang.String result)
                          throws java.io.IOException,
                                 AutomationException

Writes a SOAP job result to the job directory.

Parameters:

jobID - The jobID (in)

serviceName - The serviceName (in)

serviceType - The serviceType (in)

result - The result (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeBinaryJobResult

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

Writes a binary job result to the job directory.

Parameters:

jobID - The jobID (in)

serviceName - The serviceName (in)

serviceType - The serviceType (in)

result - An unsigned byte (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeRESTJobResult

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

Writes a REST job result to the job directory.

Parameters:

jobID - The jobID (in)

serviceName - The serviceName (in)

serviceType - The serviceType (in)

responseProperties - The responseProperties (in)

result - An unsigned byte (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStringRequestMessageType

java.lang.String getStringRequestMessageType(java.lang.String request)
                                             throws java.io.IOException,
                                                    AutomationException

Gets the type of the request from a string message.

Parameters:

request - The request (in)

Returns:

The pType

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBinaryRequestMessageType

java.lang.String getBinaryRequestMessageType(byte[] request)
                                             throws java.io.IOException,
                                                    AutomationException

Gets the type of the request from a binary message.

Parameters:

request - An unsigned byte (in)

Returns:

The pType

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobIDFromStringResponse

java.lang.String getJobIDFromStringResponse(java.lang.String response)
                                            throws java.io.IOException,
                                                   AutomationException

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

Parameters:

response - The response (in)

Returns:

The pJobID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobIDFromBinaryResponse

java.lang.String getJobIDFromBinaryResponse(byte[] response)
                                            throws java.io.IOException,
                                                   AutomationException

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

Parameters:

response - An unsigned byte (in)

Returns:

The pJobID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStringJobDefinition

java.lang.String getStringJobDefinition(java.lang.String jobID,
                                        java.lang.String serviceName,
                                        java.lang.String serviceType)
                                        throws java.io.IOException,
                                               AutomationException

Gets the string job definition for given a job ID.

Parameters:

jobID - The jobID (in)

serviceName - The serviceName (in)

serviceType - The serviceType (in)

Returns:

The pJobDefinition

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBinaryJobDefinition

byte[] getBinaryJobDefinition(java.lang.String jobID,
                              java.lang.String serviceName,
                              java.lang.String serviceType)
                              throws java.io.IOException,
                                     AutomationException

Gets the binary job definition for a given job ID.

Parameters:

jobID - The jobID (in)

serviceName - The serviceName (in)

serviceType - The serviceType (in)

Returns:

An unsigned byte

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRESTJobDefinition

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

Returns the REST job definition for a given job ID.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeJobStatusAndMessage

void writeJobStatusAndMessage(java.lang.String jobID,
                              java.lang.String serviceName,
                              java.lang.String serviceType,
                              int status,
                              java.lang.String message)
                              throws java.io.IOException,
                                     AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobStatus

int getJobStatus(java.lang.String jobID,
                 java.lang.String serviceName,
                 java.lang.String serviceType)
                 throws java.io.IOException,
                        AutomationException

Returns the status of a job.

Parameters:

jobID - The jobID (in)

serviceName - The serviceName (in)

serviceType - The serviceType (in)

Returns:

A com.esri.arcgis.system.esriJobStatus constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.