|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.server.GPServerHelper
public class GPServerHelper
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 =
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 |
---|
public GPServerHelper() throws java.io.IOException, java.net.UnknownHostException
java.io.IOException
- if there are interop problems
java.net.UnknownHostException
- if there are interop problemspublic GPServerHelper(java.lang.Object obj) throws java.io.IOException
GPServerHelper theGPServerHelper = (GPServerHelper) obj;
obj
to GPServerHelper
.
obj
- an object returned from ArcGIS Engine or Server
java.io.IOException
- if there are interop problemsMethod Detail |
---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public void interfaceSupportsErrorInfo(GUID riid) throws java.io.IOException, AutomationException
interfaceSupportsErrorInfo
in interface ISupportErrorInfo
riid
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void init(java.lang.String jobRegistryPath, java.lang.String jobsDirectoryPath) throws java.io.IOException, AutomationException
init
in interface IGPServerHelper
jobRegistryPath
- The jobRegistryPath (in)jobsDirectoryPath
- The jobsDirectoryPath (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeStringJobResult(java.lang.String jobID, java.lang.String serviceName, java.lang.String serviceType, java.lang.String result) throws java.io.IOException, AutomationException
writeStringJobResult
in interface IGPServerHelper
jobID
- The jobID (in)serviceName
- The serviceName (in)serviceType
- The serviceType (in)result
- The result (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeBinaryJobResult(java.lang.String jobID, java.lang.String serviceName, java.lang.String serviceType, byte[] result) throws java.io.IOException, AutomationException
writeBinaryJobResult
in interface IGPServerHelper
jobID
- The jobID (in)serviceName
- The serviceName (in)serviceType
- The serviceType (in)result
- An unsigned byte (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.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
writeRESTJobResult
in interface IGPServerHelper
jobID
- The jobID (in)serviceName
- The serviceName (in)serviceType
- The serviceType (in)responseProperties
- The responseProperties (in)result
- An unsigned byte (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getStringRequestMessageType(java.lang.String request) throws java.io.IOException, AutomationException
getStringRequestMessageType
in interface IGPServerHelper
request
- The request (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getBinaryRequestMessageType(byte[] request) throws java.io.IOException, AutomationException
getBinaryRequestMessageType
in interface IGPServerHelper
request
- An unsigned byte (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getJobIDFromStringResponse(java.lang.String response) throws java.io.IOException, AutomationException
getJobIDFromStringResponse
in interface IGPServerHelper
response
- The response (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getJobIDFromBinaryResponse(byte[] response) throws java.io.IOException, AutomationException
getJobIDFromBinaryResponse
in interface IGPServerHelper
response
- An unsigned byte (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getStringJobDefinition(java.lang.String jobID, java.lang.String serviceName, java.lang.String serviceType) throws java.io.IOException, AutomationException
getStringJobDefinition
in interface IGPServerHelper
jobID
- The jobID (in)serviceName
- The serviceName (in)serviceType
- The serviceType (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public byte[] getBinaryJobDefinition(java.lang.String jobID, java.lang.String serviceName, java.lang.String serviceType) throws java.io.IOException, AutomationException
getBinaryJobDefinition
in interface IGPServerHelper
jobID
- The jobID (in)serviceName
- The serviceName (in)serviceType
- The serviceType (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.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
getRESTJobDefinition
in interface IGPServerHelper
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.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
writeJobStatusAndMessage
in interface IGPServerHelper
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getJobStatus(java.lang.String jobID, java.lang.String serviceName, java.lang.String serviceType) throws java.io.IOException, AutomationException
getJobStatus
in interface IGPServerHelper
jobID
- The jobID (in)serviceName
- The serviceName (in)serviceType
- The serviceType (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |