Interface Overview OGC® Sensor Planning Service Implementation Standard

26 Co Figure 11 — SPS interfaces UML diagram NOTE In this UML diagram, the request and response for each operation is shown as a single parameter that is a data structure containing multiple lower-level parameters. These structures are discussed in subsequent clauses. The UML classes modeling these data structures are included in the following clauses. pyright © 2011 Open Geospatial Consortium Copyright © 2011 Open Geospatial Consortium 27 The SPS interfaces are: a BasicSensorPlanner mandatory – This interface represents the core functionality of an SPS. It contains the following operations: a. GetCapabilities – This operation allows a client to request and receive service metadata documents that describe the capabilities of the specific server implementation. This operation also supports negotiation of the specification version being used for client-server interactions. b. DescribeTasking – This operation allows a client to request the information that is needed in order to prepare a tasking request targeted at the assets that are supported by the SPS and that are selected by the client. The server will return information about all parameters that have to be set by the client in order to create a task. c. Submit – This operation submits a task. Depending on the façaded asset, it may perform a simple modification of the asset or start a complex mission. d. GetStatus – This operation allows a client to receive information about the current status of the requested task. e. GetTask – This operation returns complete information about the requested task. f. DescribeResultAccess – This operation allows a client to retrieve information, which enables access to the data produced by the asset. The server response may contain references to any kind of data accessing OGC Web services such as SOS, WMS, WCS or WFS. b SensorProvider mandatory – It specifies the following operation: a. DescribeSensor – This operation allows a client to request a detailed description of a sensor. The request can be targeted at a description that was valid at a certain point in or during a certain period of time in the past [OGC 09-001 clause 11]. c ReservationManager optional – This optional interface enables clients to reserve a task instead of directly submitting it. This facilitates tasking of a group of SPSs. Reserved tasks have a finite lifetime before they expire. During this lifetime such a task can be confirmed so that the service starts execution. The interface contains the following operations: a. Reserve – This operation reserves a task. A reservation lasts for a certain amount of time and can be confirmed during this timeframe b. Confirm – This operation is used to confirm a reserved task. By confirming a reserved task the SPS executes the task. 28 Copyright © 2011 Open Geospatial Consortium d FeasibilityController optional – SPS implementing this interface are capable of evaluating the feasibility of a task. This allows clients to pre-check their tasking request. The interface contains the following operation: a. GetFeasibility – This operation checks whether a tasking request is feasible based on the current state of the service and façaded assets. It can be used to provide alternative tasking requests to the client. Depending on the asset type façaded by the SPS, the SPS server action may be as simple as checking that the request parameters are valid, and are consistent with certain business rules, or it may be a complex operation that calculates the utilizability of the asset to perform a specific task at the defined location, time, orientation, calibration etc. e TaskUpdater optional – A service that implements this interface allows clients to update a reserved or accepted task. The interface contains the following operation: a. Update – This operation is used to request a modification of a reserved or accepted task. f TaskCanceller optional – This interface, if implemented, enables clients to cancel a reserved or accepted task. The interface contains the following operation: a. Cancel – This operation allows a client to cancel a previously reserved or accepted task. g SensorDescriptionManager optional. It specifies the following operation: a. UpdateSensorDescription - This operation allows clients to update the description of a sensor [OGC 09-001 clause 12]. The operations of those interfaces decribed above have many similarities with other OGC Web Services operationsinterfaces. Aspects that are common with other OWS specifications are thus specified in the OpenGIS® Web Services Common Implementation Specification [OGC 06-121r3]. Many of these common aspects are normatively referenced herein, instead of being repeated in this specification. The operations in each of the SPS interfaces will be described in subsequent clauses. Requirement http:www.opengis.netspecSPS2.0reqinterfaces REQ 1. Each SPS instance shall implement the interfaces BasicSensorPlanner and SensorProvider. Copyright © 2011 Open Geospatial Consortium 29

7.2 SPS Exceptions

Requirement http:www.opengis.netspecSPS2.0reqexceptions REQ 2. Whenever an SPS server encounters an error while performing one of its operations, it shall return an exception message according to the modelschema defined in chapter 8 of [OGC 06-121r3]. Requirement http:www.opengis.netspecSPS2.0reqexceptionscodes REQ 3. The allowed standard exception codes shall include those defined in clause 15 of [OGC 09-001] and those defined in Table 6 in this standard. They shall be used according to Figure 12. Only, the OperationNotSupported exception shall not apply for the DescribeSensor operation implemented by an SPS, because that operation is mandatory for an SPS implementation. Table 6 — Exception code defined by SPS exceptionCode value Meaning of code “locator” value StatusInformationExpi red The service already discarded status information for the requested task tasking request. None, omit “locator” parameter ModificationOfFinaliz edTask The client attempted to modify e.g. cancel, update or confirm a task that was already finalized. None, omit “locator” parameter NOTE: Each SPS operation may define additional requirements with respect to exception handling for that operation. 30 Co exceptionCode Operation Op er at io nNo tS upp ort ed M iss in gP ar am ete rV al ue In va lid P ara m ete rV al ue Ve rs io nN eg ot ia tio nF ai le d In va lid Up da te S eq ue nc e Op tio nN ot Su pp ort ed No Ap pl ic ab le Co de In va lid Re que st R eq uest E xt en si on No tS up po rt ed S ta tu sI nfo rm at ion E xp ir ed Mo di fic at io nO fF ina liz edT as k exceptionCode Operation defined by Name Cancel x x x x x x x x Confirm x x x x x x x x DescribeResultAccess x x x x x x DescribeTasking x x x x x x GetCapabilities x x x x x x x x GetFeasibility x x x x x x x GetStatus x x x x x x x GetTask x x x x x x x Reserve x x x x x x x Submit x x x x x x Update x x x x x x x x DescribeSensor x x x x x x UpdateSensorDescription x x x x x x x exception code defined by: OGC 09-000 OGC 06-121r3 this standard [OGC 09-000] [OGC 09-001] OGC 09-001 Figure 12 — SPS operations with applicable exceptionCodes Requirement http:www.opengis.netspecSPS2.0reqexceptionsUnknownIdentifier REQ 4. If the value of an identifier used in a request is unknown to the service, it shall return an InvalidParameterValue exception, with the exception locator naming the property of the request that contained the unknown value “task”, “procedure” etc. – lookup the actual name in the UML modeltable describing the properties of the request type. SPS may drop all information about a finalized task after the minimum storage time for that information has passed see documentation on minStatusTime provided in clause 7.3.3.3. In consequence, a previously valid task identifier in a GetStatus request can cause an InvalidParameterValue exception once the task information is no longer available at SPS. pyright © 2011 Open Geospatial Consortium