|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.GPServer
public class GPServer
GP Server Class.
Field Summary |
---|
Fields inherited from interface com.esri.arcgis.system.IRequestHandler |
---|
IID, IID46a0e2ea_3b64_4a46_bd78_88a1660f35bb, xxDummy |
Fields inherited from interface com.esri.arcgis.system.IObjectActivate |
---|
IID, IIDe3b78022_143e_4e61_9099_ed319ec061e7, xxDummy |
Fields inherited from interface com.esri.arcgis.system.IRESTRequestHandler |
---|
IID, IID9d66a418_d54a_48ed_88bd_043a25fa9c83, xxDummy |
Constructor Summary | |
---|---|
GPServer()
Constructs a GPServer using ArcGIS Engine. |
|
GPServer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. GPServer theGPServer = (GPServer) obj; |
Method Summary | |
---|---|
void |
activate()
Activates the object. |
void |
cancelJob(String jobID)
Cancels the specified job. |
void |
construct(IPropertySet props)
Two phase object construction. |
void |
deactivate()
Deactivates the object. |
boolean |
equals(Object o)
Compare this object with another |
IGPResult |
execute(String toolName,
IGPValues values,
IGPResultOptions pOptions)
Executes the specified tool with the supplied values and options and returns the results. |
IGPResult |
execute(String toolName,
IGPValues values,
IGPResultOptions options,
IPropertySet envValues)
Executes the specified tool with the supplied values and options and returns the results. |
IServerObjectExtension |
findExtensionByCLSID(String cLSID)
Returns a server object extension found using a string representation of its class ID. |
IServerObjectExtension |
findExtensionByTypeName(String name)
Returns a server object extension found using its type name. |
static String |
getClsid()
getClsid. |
String |
getConfigurationName()
Name of the server object configuration that defines the server object. |
int |
getExecutionType()
Indicates if the geoprocessing server is synchronous or asynchronous. |
IPropertySet |
getJobEnvironmentValues(String jobID)
Returns the enviornment values for the job. |
IGPValues |
getJobInputValues(String jobID,
IStringArray parameterNames)
Returns the input values for the job. |
IJobMessages |
getJobMessages(String jobID)
Returns the messages of the specified job. |
IGPResult |
getJobResult(String jobID,
IStringArray parameterNames,
IGPResultOptions pOptions)
Returns the results of the specified job. |
IEnvelope |
getJobResultMapExtent(String jobID)
Returns the extent for the job. |
IGPResultOptions |
getJobResultOptions(String jobID)
Returns the result options for the job. |
int |
getJobStatus(String jobID)
Returns the status of the specified job. |
String |
getJobToolName(String jobID)
Returns the tool name for the job. |
String |
getResultMapServerName()
Indicates if there is an associated map server to draw the results and the name of the map server. |
IGDSData |
getResultWorkspace(String jobID,
int transportType)
Returns a zip file of the results workspace. |
String |
getSchema()
This method returns the resource hierarchy of a REST based SOE. |
IGPToolInfos |
getTaskInfos()
Returns the tool information of the available tasks. |
IStringArray |
getTaskNames()
Returns the names of the available tasks. |
IGPToolInfo |
getToolInfo(String toolName)
Returns the tool information of the specified tool name. |
IGPToolInfos |
getToolInfos()
Returns the tool information of the available tools. |
IStringArray |
getToolNames()
Returns the names of the available tools. |
String |
getTypeName()
Type of the server object (MapServer or GeocodeServer). |
byte[] |
handleBinaryRequest(byte[] request)
Handles a binary request. |
byte[] |
handleBinaryRequest2(String capabilities,
byte[] request)
Handles a binary request with explicit capabilities. |
byte[] |
handleRESTRequest(String capabilities,
String resourceName,
String operationName,
String operationInput,
String outputFormat,
String requestProperties,
String[] responseProperties)
Handles REST requests for SOE. |
String |
handleStringRequest(String capabilities,
String request)
Handles a SOAP string request. |
int |
hashCode()
the hashcode for this object |
void |
initLogging(ILog log)
Initializes an object with a log. |
void |
interfaceSupportsErrorInfo(GUID riid)
interfaceSupportsErrorInfo |
String |
submitJob(String toolName,
IGPValues values)
Submits the specified tool with the supplied values and options and returns the job id. |
String |
submitJob(String toolName,
IGPValues values,
IGPResultOptions options,
IPropertySet envValues)
Submits the specified tool with the supplied values and options and returns the job id. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public GPServer() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic GPServer(Object obj) throws IOException
GPServer theGPServer = (GPServer) obj;
obj
to GPServer
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public IStringArray getToolNames() throws IOException, AutomationException
getToolNames
in interface IGPServer
getToolNames
in interface IGPServer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGPToolInfos getToolInfos() throws IOException, AutomationException
getToolInfos
in interface IGPServer
getToolInfos
in interface IGPServer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGPToolInfo getToolInfo(String toolName) throws IOException, AutomationException
getToolInfo
in interface IGPServer
getToolInfo
in interface IGPServer2
toolName
- The toolName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IStringArray getTaskNames() throws IOException, AutomationException
getTaskNames
in interface IGPServer
getTaskNames
in interface IGPServer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGPToolInfos getTaskInfos() throws IOException, AutomationException
getTaskInfos
in interface IGPServer
getTaskInfos
in interface IGPServer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getResultMapServerName() throws IOException, AutomationException
getResultMapServerName
in interface IGPServer
getResultMapServerName
in interface IGPServer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGPResult execute(String toolName, IGPValues values, IGPResultOptions pOptions) throws IOException, AutomationException
execute
in interface IGPServer
toolName
- The toolName (in)values
- A reference to a com.esri.arcgis.geoprocessing.IGPValues (in)pOptions
- A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String submitJob(String toolName, IGPValues values) throws IOException, AutomationException
submitJob
in interface IGPServer
toolName
- The toolName (in)values
- A reference to a com.esri.arcgis.geoprocessing.IGPValues (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getJobStatus(String jobID) throws IOException, AutomationException
getJobStatus
in interface IGPServer
getJobStatus
in interface IGPServer2
jobID
- The jobID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IJobMessages getJobMessages(String jobID) throws IOException, AutomationException
getJobMessages
in interface IGPServer
getJobMessages
in interface IGPServer2
jobID
- The jobID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGPResult getJobResult(String jobID, IStringArray parameterNames, IGPResultOptions pOptions) throws IOException, AutomationException
getJobResult
in interface IGPServer
getJobResult
in interface IGPServer2
jobID
- The jobID (in)parameterNames
- A reference to a com.esri.arcgis.system.IStringArray (in)pOptions
- A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void cancelJob(String jobID) throws IOException, AutomationException
cancelJob
in interface IGPServer
cancelJob
in interface IGPServer2
jobID
- The jobID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getExecutionType() throws IOException, AutomationException
getExecutionType
in interface IGPServer
getExecutionType
in interface IGPServer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGDSData getResultWorkspace(String jobID, int transportType) throws IOException, AutomationException
getResultWorkspace
in interface IGPServer
getResultWorkspace
in interface IGPServer2
jobID
- The jobID (in)transportType
- A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void construct(IPropertySet props) throws IOException, AutomationException
construct
in interface IObjectConstruct
props
- A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public byte[] handleBinaryRequest(byte[] request) throws IOException, AutomationException
handleBinaryRequest
in interface IRequestHandler
request
- An unsigned byte (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String handleStringRequest(String capabilities, String request) throws IOException, AutomationException
handleStringRequest
in interface IRequestHandler
capabilities
- The capabilities (in)request
- The request (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public byte[] handleBinaryRequest2(String capabilities, byte[] request) throws IOException, AutomationException
handleBinaryRequest2
in interface IRequestHandler2
capabilities
- The capabilities (in)request
- An unsigned byte (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void activate() throws IOException, AutomationException
activate
in interface IObjectActivate
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deactivate() throws IOException, AutomationException
deactivate
in interface IObjectActivate
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void initLogging(ILog log) throws IOException, AutomationException
initLogging
in interface ILogSupport
log
- A reference to a com.esri.arcgis.system.ILog (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void interfaceSupportsErrorInfo(GUID riid) throws IOException, AutomationException
Indicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo
in interface ISupportErrorInfo
riid
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getConfigurationName() throws IOException, AutomationException
getConfigurationName
in interface IServerObject
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTypeName() throws IOException, AutomationException
getTypeName
in interface IServerObject
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IServerObjectExtension findExtensionByCLSID(String cLSID) throws IOException, AutomationException
findExtensionByCLSID
in interface IServerObjectExtensionManager
cLSID
- The cLSID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IServerObjectExtension findExtensionByTypeName(String name) throws IOException, AutomationException
findExtensionByTypeName
in interface IServerObjectExtensionManager
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGPResult execute(String toolName, IGPValues values, IGPResultOptions options, IPropertySet envValues) throws IOException, AutomationException
execute
in interface IGPServer2
toolName
- The toolName (in)values
- A reference to a com.esri.arcgis.geoprocessing.IGPValues (in)options
- A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)envValues
- A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String submitJob(String toolName, IGPValues values, IGPResultOptions options, IPropertySet envValues) throws IOException, AutomationException
submitJob
in interface IGPServer2
toolName
- The toolName (in)values
- A reference to a com.esri.arcgis.geoprocessing.IGPValues (in)options
- A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)envValues
- A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getJobToolName(String jobID) throws IOException, AutomationException
getJobToolName
in interface IGPServer2
jobID
- The jobID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGPValues getJobInputValues(String jobID, IStringArray parameterNames) throws IOException, AutomationException
getJobInputValues
in interface IGPServer2
jobID
- The jobID (in)parameterNames
- A reference to a com.esri.arcgis.system.IStringArray (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGPResultOptions getJobResultOptions(String jobID) throws IOException, AutomationException
getJobResultOptions
in interface IGPServer2
jobID
- The jobID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getJobEnvironmentValues(String jobID) throws IOException, AutomationException
getJobEnvironmentValues
in interface IGPServer2
jobID
- The jobID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getJobResultMapExtent(String jobID) throws IOException, AutomationException
getJobResultMapExtent
in interface IGPServer2
jobID
- The jobID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public byte[] handleRESTRequest(String capabilities, String resourceName, String operationName, String operationInput, String outputFormat, String requestProperties, String[] responseProperties) throws IOException, AutomationException
This method is invoked by ArcGIS Server's REST handler, which intercepts client's request (in URL form), parses it and passes it on to this method in form of parameter values.
The REST SOE developer must add logic to use these parameter values to determine which resource/operation is being requested and accordingly handle these requests and generate responses in the output format indicated by the "outputFormat" parameter. For more information on developing REST SOEs, please consult the Java ArcObjects Developer Guide.
Developer doc: Developing extensions > Server Object Extensions > SOE Web Services > REST Web Services > Developing SOE REST Web Services
Samples: Samples > Server Object Extensions section
handleRESTRequest
in interface IRESTRequestHandler
capabilities
- The capabilities supported by the SOE. An admin can choose which
capabilities are enabled on a particular SOE (in ArcGIS Manager or ArcCatalog), based on certain criteria such as security roles.
This list of allowed capabilities is then sent to this method, at runtime, as a comma separated list. (in)resourceName
- Name of the resource being addressed. If empty, its assumed
that root resource is being addressed. (in)operationName
- Name of the operation being invoked. If empty, description of
resource is returned. (in)operationInput
- Input parameters, in form of comma separated list, to the operation specified by operationName parameter. (in)outputFormat
- OutputFormat of operation. Possible formats are JSON, HTML, AMF, etc. (in)requestProperties
- The requestProperties (in)responseProperties
- The responseProperties (out)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getSchema() throws IOException, AutomationException
For an SOE that has a root resource (called "root") with one operation ("operation0"), and 2 sub-resources with one operation each ("operation1" and "operation2" respectively), the schema would look like:
{
"name": "MyRESTSOE",
"description": "My REST SOE with 3 resources and 1 operation each.",
"isCollection": false,
"operations": [
{
"name": "operation0",
"parameters": ["param01"],
"supportedOutputFormats": ["json"]
}
],
"resources": [
{
"name": "subresource1",
"description": "Sub Resource 1",
"isCollection": true,
"operations": [
{
"name": "operation1",
"parameters": ["param10", "param11"],
"supportedOutputFormats": ["json"]
}
]
},
{
"name": "subresource2",
"description": "Sub Resource 2",
"isCollection": true,
"operations": [
{
"name": "operation2",
"parameters": ["param20", "param21"],
"supportedOutputFormats": ["json"]
}
]
}
]
}
getSchema
in interface IRESTRequestHandler
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 |