eoxserver.services.ows.wps package¶
Subpackages¶
- eoxserver.services.ows.wps.parameters package
- Submodules
- eoxserver.services.ows.wps.parameters.allowed_values module
- eoxserver.services.ows.wps.parameters.base module
- eoxserver.services.ows.wps.parameters.bboxdata module
- eoxserver.services.ows.wps.parameters.codecs module
- eoxserver.services.ows.wps.parameters.complexdata module
- eoxserver.services.ows.wps.parameters.crs module
- eoxserver.services.ows.wps.parameters.data_types module
- eoxserver.services.ows.wps.parameters.formats module
- eoxserver.services.ows.wps.parameters.inputs module
- eoxserver.services.ows.wps.parameters.literaldata module
- eoxserver.services.ows.wps.parameters.response_form module
- eoxserver.services.ows.wps.parameters.units module
- Module contents
- eoxserver.services.ows.wps.processes package
- eoxserver.services.ows.wps.v10 package
- Subpackages
- eoxserver.services.ows.wps.v10.encoders package
- Submodules
- eoxserver.services.ows.wps.v10.encoders.base module
- eoxserver.services.ows.wps.v10.encoders.capabilities module
- eoxserver.services.ows.wps.v10.encoders.execute_response module
- eoxserver.services.ows.wps.v10.encoders.execute_response_raw module
- eoxserver.services.ows.wps.v10.encoders.parameters module
- eoxserver.services.ows.wps.v10.encoders.process_description module
- Module contents
- eoxserver.services.ows.wps.v10.encoders package
- Submodules
- eoxserver.services.ows.wps.v10.describeprocess module
- eoxserver.services.ows.wps.v10.exceptionhandler module
- eoxserver.services.ows.wps.v10.execute module
- eoxserver.services.ows.wps.v10.execute_decoder_kvp module
- eoxserver.services.ows.wps.v10.execute_decoder_xml module
- eoxserver.services.ows.wps.v10.getcapabilities module
- eoxserver.services.ows.wps.v10.util module
- Module contents
- Subpackages
Submodules¶
eoxserver.services.ows.wps.exceptions module¶
-
exception
eoxserver.services.ows.wps.exceptions.
ExecuteError
(message='', locator='process.execute()')¶ Bases:
eoxserver.services.ows.wps.exceptions.NoApplicableCode
-
exception
eoxserver.services.ows.wps.exceptions.
FileSizeExceeded
(message, locator)¶
-
exception
eoxserver.services.ows.wps.exceptions.
InvalidInputError
(input_id)¶ Bases:
eoxserver.services.ows.wps.exceptions.InvalidParameterValue
-
exception
eoxserver.services.ows.wps.exceptions.
InvalidInputReferenceError
(input_id, message='')¶ Bases:
eoxserver.services.ows.wps.exceptions.InvalidParameterValue
-
exception
eoxserver.services.ows.wps.exceptions.
InvalidInputValueError
(input_id, message='')¶ Bases:
eoxserver.services.ows.wps.exceptions.InvalidParameterValue
-
exception
eoxserver.services.ows.wps.exceptions.
InvalidOutputDefError
(output_id, message='')¶ Bases:
eoxserver.services.ows.wps.exceptions.InvalidParameterValue
-
exception
eoxserver.services.ows.wps.exceptions.
InvalidOutputError
(output_id)¶ Bases:
eoxserver.services.ows.wps.exceptions.InvalidParameterValue
-
exception
eoxserver.services.ows.wps.exceptions.
InvalidOutputValueError
(output_id, message='')¶ Bases:
eoxserver.services.ows.wps.exceptions.NoApplicableCode
-
exception
eoxserver.services.ows.wps.exceptions.
InvalidParameterValue
(message, locator)¶
-
exception
eoxserver.services.ows.wps.exceptions.
MissingParameterValue
(message, locator)¶
-
exception
eoxserver.services.ows.wps.exceptions.
MissingRequiredInputError
(input_id)¶ Bases:
eoxserver.services.ows.wps.exceptions.InvalidParameterValue
-
exception
eoxserver.services.ows.wps.exceptions.
NoApplicableCode
(message, locator=None)¶ Bases:
eoxserver.services.ows.wps.exceptions.OWS10Exception
-
http_status_code
= 500¶
-
-
exception
eoxserver.services.ows.wps.exceptions.
NoSuchProcessError
(identifier)¶ Bases:
eoxserver.services.ows.wps.exceptions.InvalidParameterValue
-
exception
eoxserver.services.ows.wps.exceptions.
NotEnoughStorage
(message)¶ Bases:
eoxserver.services.ows.wps.exceptions.OWS10Exception
-
http_status_code
= 507¶
-
-
exception
eoxserver.services.ows.wps.exceptions.
OWS10Exception
(code, locator, message)¶ Bases:
exceptions.Exception
Base OWS 1.0 exception of the WPS 1.0.0 exceptions
-
http_status_code
= 400¶
-
-
exception
eoxserver.services.ows.wps.exceptions.
ServerBusy
(message)¶ Bases:
eoxserver.services.ows.wps.exceptions.OWS10Exception
-
http_status_code
= 503¶
-
-
exception
eoxserver.services.ows.wps.exceptions.
StorageNotSupported
(message)¶
-
exception
eoxserver.services.ows.wps.exceptions.
VersionNegotiationFailed
(message, locator)¶
eoxserver.services.ows.wps.interfaces module¶
-
class
eoxserver.services.ows.wps.interfaces.
AsyncBackendInterface
¶ Bases:
object
Interface class for an asynchronous WPS back-end. NOTE: Only one asynchronous back-end at time is allowed to be configured.
-
cancel
(job_id, **kwargs)¶ Cancel the job execution.
-
execute
(process, raw_inputs, resp_form, extra_parts=None, job_id=None, version='1.0.0', **kwargs)¶ Execute process asynchronously. The request is defined by the process’s identifier
process_id
,raw_inputs
(before the decoding and resolution of the references), and theresp_form
(holding the outputs’ parameters). Theversion
of the WPS standard to be used. Optionally, the user definedjob_id
can be passed. If thejob_id
cannot be used the execute shall fail.The
extra_parts
should contain a dictionary of named request parts should the request contain multi-part/related CID references.On success, the method returns the
job_id
assigned to the executed job.
-
get_response_url
(job_id)¶ Get URL of the execute response for the given job id
-
get_status
(job_id)¶ Get status of a job. Allowed responses and their meanings are: ACCEPTED - job scheduled for execution STARTED - job in progress PAUSED - job is stopped and it can be resumed CANCELLED - job was terminated by the user FAILED - job ended with an error SUCCEEDED - job ended successfully
-
pause
(job_id, **kwargs)¶ Pause the job execution.
-
purge
(job_id, **kwargs)¶ Purge the job from the system by removing all the resources occupied by the job.
-
resume
(job_id, **kwargs)¶ Resume the job execution.
-
supported_versions
¶ A list of versions of the WPS standard supported by the back-end.
-
-
class
eoxserver.services.ows.wps.interfaces.
ProcessInterface
¶ Bases:
object
Interface class for processes offered, described and executed by the WPS.
-
asynchronous
¶ Optional boolean flag indicating whether the process can be executed asynchronously. If missing False is assumed.
-
description
¶ A human-readable detailed description of the process. Optional. (Content of the the abstract in the WPS process description.)
-
execute
(**kwargs)¶ The main execution function for the process. The
kwargs
are the parsed input inputs (using the keys as defined by theinputs
) and the Complex Data format requests (using the keys as defined by theoutputs
). The method is expected to return a dictionary of the output values (using the keys as defined by theoutputs
). In case of only one output item defined by theoutputs
, one output value is allowed to be returned directly.
-
identifier
¶ An identifier (URI) of the process. Optional. When omitted it defaults to the process’ class-name.
-
inputs
¶ A dict mapping the inputs’ identifiers to their respective types. The type can be either one of the supported native python types (automatically converted to a
LiteralData
object) or an instance of one of the data-specification classes (LiteralData
,BoundingBoxData
, orComplexData
). Mandatory.
-
metadata
¶ A dict of title/URL meta-data pairs associated with the process. Optional.
-
outputs
¶ A dict mapping the outputs’ identifiers to their respective types. The type can be either one of the supported native python types (automatically converted to a
LiteralData
object) or an instance of one of the data-specification classes (LiteralData
,BoundingBoxData
, orComplexData
). Mandatory.
-
profiles
¶ A iterable of URNs of WPS application profiles this process adheres to. Optional.
-
retention_period
¶ This optional property (datetime.timedelta) indicates the minimum time the process results shall be retained after the completion. If omitted the default server retention policy is applied.
-
synchronous
¶ Optional boolean flag indicating whether the process can be executed synchronously. If missing True is assumed.
-
title
¶ A human-readable title of the process. Optional. When omitted it defaults to the process identifier.
-
version
¶ The version of the process, if applicable. Optional. When omitted it defaults to ‘1.0.0’.
-
wsdl
¶ A URL of WSDL document describing this process. Optional.
-