com.esri.arcgis.server
Class GPServerHelper

java.lang.Object
  extended by com.esri.arcgis.server.GPServerHelper
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IGPServerHelper, ISupportErrorInfo, java.io.Serializable

public class GPServerHelper
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, IGPServerHelper

COM Class 'GPServerHelper'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriServer.olb'

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 =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Fields inherited from interface com.esri.arcgis.server.IGPServerHelper
IID, IIDe5a9a155_937e_4025_8ce6_42690d964c42, xxDummy
 
Constructor Summary
GPServerHelper()
          Constructs a GPServerHelper using ArcGIS Engine.
GPServerHelper(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPServerHelper theGPServerHelper = (GPServerHelper) obj;
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 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.
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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.
 int hashCode()
          the hashcode for this object
 void init(java.lang.String jobRegistryPath, java.lang.String jobsDirectoryPath)
          Initializes the helper with the job registery and jobs directory.
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void release()
          Release a GPServerHelper.
 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GPServerHelper

public GPServerHelper()
               throws java.io.IOException,
                      java.net.UnknownHostException
Constructs a GPServerHelper using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

GPServerHelper

public GPServerHelper(java.lang.Object obj)
               throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPServerHelper theGPServerHelper = (GPServerHelper) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a GPServerHelper.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

init

public 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.

Specified by:
init in interface IGPServerHelper
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

public 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.

Specified by:
writeStringJobResult in interface IGPServerHelper
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

public 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.

Specified by:
writeBinaryJobResult in interface IGPServerHelper
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

public 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.

Specified by:
writeRESTJobResult in interface IGPServerHelper
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

public java.lang.String getStringRequestMessageType(java.lang.String request)
                                             throws java.io.IOException,
                                                    AutomationException
Gets the type of the request from a string message.

Specified by:
getStringRequestMessageType in interface IGPServerHelper
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

public java.lang.String getBinaryRequestMessageType(byte[] request)
                                             throws java.io.IOException,
                                                    AutomationException
Gets the type of the request from a binary message.

Specified by:
getBinaryRequestMessageType in interface IGPServerHelper
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

public 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.

Specified by:
getJobIDFromStringResponse in interface IGPServerHelper
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

public java.lang.String getJobIDFromBinaryResponse(byte[] response)
                                            throws java.io.IOException,
                                                   AutomationException
Extracts the job ID from a binary message that contains this information.

Specified by:
getJobIDFromBinaryResponse in interface IGPServerHelper
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

public 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.

Specified by:
getStringJobDefinition in interface IGPServerHelper
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

public 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.

Specified by:
getBinaryJobDefinition in interface IGPServerHelper
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

public 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.

Specified by:
getRESTJobDefinition in interface IGPServerHelper
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

public 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.

Specified by:
writeJobStatusAndMessage in interface IGPServerHelper
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

public 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.

Specified by:
getJobStatus in interface IGPServerHelper
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.