com.esri.arcgis.server
Class IGPServerHelperProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.server.IGPServerHelperProxy
All Implemented Interfaces:
IGPServerHelper, java.io.Externalizable, java.io.Serializable

Deprecated. Internal use only. Proxy for 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 =

public class IGPServerHelperProxy
extends com.esri.arcgis.interop.Dispatch
implements IGPServerHelper, java.io.Serializable

Internal use class

See Also:
Serialized Form

Field Summary
 boolean noncastable
          Deprecated.  
static java.lang.Class targetClass
          Deprecated.  
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Fields inherited from interface com.esri.arcgis.server.IGPServerHelper
IID, IIDe5a9a155_937e_4025_8ce6_42690d964c42
 
Constructor Summary
  IGPServerHelperProxy()
          Deprecated. For internal use only
  IGPServerHelperProxy(java.lang.Object obj)
          Deprecated.  
protected IGPServerHelperProxy(java.lang.Object obj, java.lang.String iid)
          Deprecated.  
  IGPServerHelperProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
protected IGPServerHelperProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
          Deprecated.  
 byte[] getBinaryJobDefinition(java.lang.String jobID, java.lang.String serviceName, java.lang.String serviceType)
          Deprecated. Gets the binary job definition for a given job ID.
 java.lang.String getBinaryRequestMessageType(byte[] request)
          Deprecated. Gets the type of the request from a binary message.
 java.lang.String getJobIDFromBinaryResponse(byte[] response)
          Deprecated. Extracts the job ID from a binary message that contains this information.
 java.lang.String getJobIDFromStringResponse(java.lang.String response)
          Deprecated. 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)
          Deprecated. 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)
          Deprecated. 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)
          Deprecated. Gets the string job definition for given a job ID.
 java.lang.String getStringRequestMessageType(java.lang.String request)
          Deprecated. Gets the type of the request from a string message.
 void init(java.lang.String jobRegistryPath, java.lang.String jobsDirectoryPath)
          Deprecated. Initializes the helper with the job registery and jobs directory.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Deprecated.  
 void writeBinaryJobResult(java.lang.String jobID, java.lang.String serviceName, java.lang.String serviceType, byte[] result)
          Deprecated. 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)
          Deprecated. 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)
          Deprecated. 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)
          Deprecated. Writes a SOAP job result to the job directory.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass
Deprecated. 

noncastable

public boolean noncastable
Deprecated. 
Constructor Detail

IGPServerHelperProxy

public IGPServerHelperProxy(java.lang.String CLSID,
                            java.lang.String host,
                            com.esri.arcgis.interop.AuthInfo authInfo)
                     throws java.net.UnknownHostException,
                            java.io.IOException
Deprecated. 
Throws:
java.net.UnknownHostException
java.io.IOException

IGPServerHelperProxy

public IGPServerHelperProxy()
Deprecated. 
For internal use only


IGPServerHelperProxy

public IGPServerHelperProxy(java.lang.Object obj)
                     throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException

IGPServerHelperProxy

protected IGPServerHelperProxy(java.lang.Object obj,
                               java.lang.String iid)
                        throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException

IGPServerHelperProxy

protected IGPServerHelperProxy(java.lang.String CLSID,
                               java.lang.String iid,
                               java.lang.String host,
                               com.esri.arcgis.interop.AuthInfo authInfo)
                        throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Deprecated. 
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Deprecated. 
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

init

public void init(java.lang.String jobRegistryPath,
                 java.lang.String jobsDirectoryPath)
          throws java.io.IOException,
                 AutomationException
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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.