8.6 Resource Type <mefClientCmd>_

8.6.1 Introduction

A <mefClientCmd> resource shall represent a command to be indicated to a MEF client by a MEF, and a status report on the attempted parsing and execution of that command to be indicated to the MEF by a MEF Client. The retrieve procedure and update procedure are used for this purpose.

Table 8.6.1-1: Data Type Definition of <mefClientCmd>

Data Type ID	File Name	Note
mefClientCmd	SEC-mefClientCmd-v2_1_0.xsd

Table 8.6.1-2: Universal/Common Attributes of <mefClientCmd> resource

Attribute Name	Request Optionality
	Update
@resourceName	NP
resourceType	NP
resourceID	NP
parentID	NP
creationTime	NP
labels	O
expirationTime	NP

Table 8.6.1-3: Resource Specific Attributes of <mefClientCmd> resource

Attribute Name	Request Optionality	Data Type	Default Value and Constraints
	Update
cmdID	M	m2m:requestID	No default
cmdDescription	NP	sec:cmdDescription	No default
cmdStatusCode	M	sec:cmdStatusCode	No default

The <mefClientCmd> resource shall contain no child resources.

8.6.2 <mefClientCmd> resource specific procedures on CRUD operations

8.6.2.1 Create

Originator:

The <mefClientCmd> resource shall not be created via API. It is instantiated by a MEF when the parent <mefClientReg> resource is created as described in clause 8.4.2.1.

Receiver:

The primitive specific operation on Recv-1.0 "Check the syntax of received message" defined in TS-0004 [3] applies:

1. If the request is received, the Receiver CSE shall execute the following steps in order.
   • a) "Create an unsuccessful Response primitive" with the Response Status Code indicating "OPERATION_NOT_ALLOWED" error.
   • b) "Send the Response primitive".

8.6.2.2 Retrieve

This procedure is denoted MEF Client Command Retrieval in clause 8.3.9.2 of TS-0003 [2]. This procedure is used to retrieve the <mefClientCmd> resource.

Originator:

No change from the generic procedures in clause 7.2.2.1 of [3] with clarifications discussed in clauses 5.2.2 and 6.3, and with following difference:

In step Orig-6.0: "Process Response primitive", the Originator shall extract the cmdID, cmdDescription and cmdStatusCode from the response and pass these to the MEF Client Command processing as specified in clause 8.3.9.2 in oneM2M TS-0003 [2].

Receiver:

Same as the generic procedures in clause 7.2.2.2 of [3] with clarifications discussed in clauses 5.2.2 and 6.3, and with following differences:

The Receiver shall perform the following in the place of Recv-6.3: "Check authorization of the Originator":

1. The Receiver shall determine if the Originator is authorized by checking if the Originator is the creator of the parent <mefClientReg> resource.
   • a) If the Originator is not authorized, then the Receiver shall execute the following steps in order.
     • i) "Create an unsuccessful Response primitive" with the Response Status Code indicating "ACCESS_DENIED" error.
     • ii) "Send the Response primitive".
   • b) If the Originator is authorized, then the Receiver shall allow the request.

The Receiver shall perform the following step as part of "Create the resource" (clause 7.3.3.5 of [2]) during Step Recv-6.5: "Create/Update/Retrieve/Delete/Notify operation is performed":

1. If the Receiver has a pending MEF Client Command to be issued to the Originator, then the Receiver shall set the cmdID, cmdDescription and cmdStatusCode attributes as specified in clause 8.3.9.2 of oneM2M TS-0003 [2]. The values of these attributes should remain set to these values until the MEF Client performs an Update on the Resource (see clause 8.6.2.3). If the MEF Client takes too long to perform an Update (for example, if the Response is not received by the Originator) then the MEF may choose to replace the attributes with a new MEF Client Command.

Note

The cmdDescription includes the cmdClass attribute which can be set to "NO_MORE_COMMANDS" by the MEF to indicate that there are no further commands to be issued.

8.6.2.3 Update

This procedure is denoted MEF Client Command Update in clause 8.3.9.3 of TS-0003 [2]. This procedure is used by the MEF Client to report on the status of an issued MEF Client Command, and for an MEF to issue another MEF Client Command.

Originator:

No change from the generic procedures in clause 7.2.2.1 of [3] with clarifications discussed in clauses 5.2.2 and 6.3, and with following differences:

In step Orig-1.0: "Compose of a Request primitive", the Originator shall include the cmdID and cmdStatusCode attributes in the Content of the request, with attribute values assigned as described in clause 8.3.9.3 of oneM2M TS-0003 [2].

In step Orig-6.0: "Process Response primitive", the Originator shall extract the cmdID, cmdDescription and cmdStatusCode attributes from the response and pass these to the MEF Client Command processing specified in clause 8.3.9.3 in oneM2M TS-0003 [2].

Receiver:

Same as the generic procedures in clause 7.2.2.2 of [3] with clarifications discussed in clauses 5.2.2 and 6.3, and with the following differences:

The Receiver shall perform the following step in the place of Recv-6.3: "Check authorization of the Originator":

1. The Receiver shall determine if the Originator is authorized by checking if the Originator is the creator of the parent <mefClientReg> resource.
   • a) If the Originator is not authorized, then the Receiver shall execute the following steps in order.
     • i. "Create an unsuccessful Response primitive" with the Response Status Code indicating "ACCESS_DENIED" error.
     • ii. "Send the Response primitive".
   • b) If the Originator is authorized, then the Receiver shall allow the request.

The Receiver shall perform the following steps in order as part of "Update the resource" (clause 7.3.3.7) during Step Recv-6.5: "Create/Update/Retrieve/Delete/Notify operation is performed":

1. The Receiver shall extract the cmdID and cmdStatusCode attributes and pass these to the MEF Client Command processing in the MEF described in clause 8.3.9.3 of oneM2M TS-0003 [2].
2. If the Receiver has a pending MEF Client Command to be issued to the Originator, then the Receiver shall set the cmdID, cmdDescription and cmdStatusCode attributes as specified in clause 8.3.9.3 of oneM2M TS-0003 [2]. The values of these attributes should remain set to these values until the MEF Client performs a subsequent Update on the Resource. If the MEF Client takes too long to perform an Update (for example, if the Response is not received by the Originator) then the MEF may choose to replace the attributes with a new MEF Client Command.

Note

2: The cmdDescription includes the cmdClass attribute which can be set to "NO_MORE_COMMANDS" to indicate that there are no further commands to be issued.

8.6.2.4 Delete

Originator:

The <mefClientCmd> resource shall not be deleted via API. It is deleted by a MEF when the parent <mefClientReg> resource is deleted.

Receiver:

The primitive specific operation on Recv-1.0 "Check the syntax of received message" defined in TS-0004 [3] applies:

1. If the request is received, the Receiver CSE shall execute the following steps in order.
   • a) "Create an unsuccessful Response primitive" with the Response Status Code indicating "OPERATION_NOT_ALLOWED" error.
   • b) "Send the Response primitive".