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:
NoApplicableCode
- exception eoxserver.services.ows.wps.exceptions.FileSizeExceeded(message, locator)¶
Bases:
OWS10Exception
- exception eoxserver.services.ows.wps.exceptions.InvalidInputError(input_id)¶
Bases:
InvalidParameterValue
- exception eoxserver.services.ows.wps.exceptions.InvalidInputReferenceError(input_id, message='')¶
Bases:
InvalidParameterValue
- exception eoxserver.services.ows.wps.exceptions.InvalidInputValueError(input_id, message='')¶
Bases:
InvalidParameterValue
- exception eoxserver.services.ows.wps.exceptions.InvalidOutputDefError(output_id, message='')¶
Bases:
InvalidParameterValue
- exception eoxserver.services.ows.wps.exceptions.InvalidOutputError(output_id)¶
Bases:
InvalidParameterValue
- exception eoxserver.services.ows.wps.exceptions.InvalidOutputValueError(output_id, message='')¶
Bases:
NoApplicableCode
- exception eoxserver.services.ows.wps.exceptions.InvalidParameterValue(message, locator)¶
Bases:
OWS10Exception
- exception eoxserver.services.ows.wps.exceptions.MissingParameterValue(message, locator)¶
Bases:
OWS10Exception
- exception eoxserver.services.ows.wps.exceptions.MissingRequiredInputError(input_id)¶
Bases:
InvalidParameterValue
- exception eoxserver.services.ows.wps.exceptions.NoApplicableCode(message, locator=None)¶
Bases:
OWS10Exception
- http_status_code = 500¶
- exception eoxserver.services.ows.wps.exceptions.NoSuchProcessError(identifier)¶
Bases:
InvalidParameterValue
- exception eoxserver.services.ows.wps.exceptions.NotEnoughStorage(message)¶
Bases:
OWS10Exception
- http_status_code = 507¶
- exception eoxserver.services.ows.wps.exceptions.OWS10Exception(code, locator, message)¶
Bases:
Exception
Base OWS 1.0 exception of the WPS 1.0.0 exceptions
- http_status_code = 400¶
- exception eoxserver.services.ows.wps.exceptions.OperationNotSupportedError(message, locator=None)¶
Bases:
OWS10Exception
- exception eoxserver.services.ows.wps.exceptions.ServerBusy(message)¶
Bases:
OWS10Exception
- http_status_code = 503¶
- exception eoxserver.services.ows.wps.exceptions.StorageNotSupported(message)¶
Bases:
OWS10Exception
- exception eoxserver.services.ows.wps.exceptions.VersionNegotiationFailed(message, locator)¶
Bases:
OWS10Exception
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.
- property 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.
- property asynchronous¶
Optional boolean flag indicating whether the process can be executed asynchronously. If missing False is assumed.
- property 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.
- property identifier¶
An identifier (URI) of the process. Optional. When omitted it defaults to the process’ class-name.
- property 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.
- property metadata¶
A dict of title/URL meta-data pairs associated with the process. Optional.
- property 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.
- property profiles¶
A iterable of URNs of WPS application profiles this process adheres to. Optional.
- property 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.
- property synchronous¶
Optional boolean flag indicating whether the process can be executed synchronously. If missing True is assumed.
- property title¶
A human-readable title of the process. Optional. When omitted it defaults to the process identifier.
- property version¶
The version of the process, if applicable. Optional. When omitted it defaults to ‘1.0.0’.
- property wsdl¶
A URL of WSDL document describing this process. Optional.
eoxserver.services.ows.wps.test_allowed_values module¶
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedAny(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumDate(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumDate2(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumDateTime(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumDateTime2(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumDuration(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumDuration2(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumFloat(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumFloat2(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumFloat3(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumInt(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumInt2(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumString(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumString2(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumString3(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumTime(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedEnumTime2(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeCollectionFloat(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeDateClosed(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeDateClosedOpen(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeDateOpen(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeDateOpenClosed(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeDateTime(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeDiscrDate(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeDiscrDateTime(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeDiscrDuration(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeDiscrFloat(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeDiscrInt(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeDiscrTime(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeDuration(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeFloat(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeFloat2(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeFloat3(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeFloatClosed(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeFloatClosedOpen(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeFloatOpen(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeFloatOpenClosed(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeInt(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeIntClosed(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeUnboundMax(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_allowed_values.TestAllowedRangeUnboundMin(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
eoxserver.services.ows.wps.test_data_types module¶
- class eoxserver.services.ows.wps.test_data_types.BaseTestMixin¶
Bases:
object
- testEncodeFail()¶
- testEncodeOK()¶
- testGeneral()¶
- testParseFail()¶
- testParseOK()¶
- class eoxserver.services.ows.wps.test_data_types.TestDataTypeBool(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_data_types.TestDataTypeCRS(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_data_types.TestDataTypeDate(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_data_types.TestDataTypeDateTime(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
,TimeZoneTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_data_types.TestDataTypeDateTimeTZAware(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
,TimeZoneTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_data_types.TestDataTypeDateTimeTZAwareWithTZConversion(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
,TimeZoneTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_data_types.TestDataTypeDuration(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_data_types.TestDataTypeFloat(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_data_types.TestDataTypeInt(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_data_types.TestDataTypeString(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.
- class eoxserver.services.ows.wps.test_data_types.TestDataTypeTime(methodName='runTest')¶
Bases:
TestCase
,BaseTestMixin
- setUp()¶
Hook method for setting up the test fixture before exercising it.