hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.27 Authorization using <authorizationPolicy> | Each <authorizationPolicy> resource represents an entrance of a Policy Retrieval Point (PRP) that is responsible for retrieving access control policies. Multiple <authorizationPolicy> resources can be created under one <CSEBase> resource. The access control policies associated to an <authorizationPolicy> resource can be used to group access control policy requesters, i.e. which CSEs can retrieve access control policies from a given <authorizationPolicy> resource. The resource specific attributes of an <authorizationPolicy> resource can be classified into two categories according to their usages. One category is used for describing access control policies, e.g. policies and combiningAlgorithm attributes. The other category is used for describing access control policy requests, e.g. to attribute. An UPDATE operation on an <authorizationPolicy> resource may trigger an access control policy retrieving process. After obtaining the access control policies and policy combining algorithm, the access control policies and policy combining algorithm or error status is returned back to the policy requester via an UPDATE response. The details of distributed authorization procedures are described in ETSI TS 118 103 [2]. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.28 Create <authorizationPolicy> | This procedure shall be used for creating an <authorizationPolicy> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 307 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.3.28-1: <authorizationPolicy> CREATE <authorizationPolicy> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.42, and all the values of resource specific attributes shall be set to null. Processing at Originator before sending Request According to clause 10.1.2 Processing at Receiver According to clause 10.1.2 Information in Response message According to clause 10.1.2 Processing at Originator after receiving Response According to clause 10.1.2 Exceptions According to clause 10.1.2 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.29 Retrieve <authorizationPolicy> | This procedure shall be used for retrieving <authorizationPolicy> resource. Table 10.2.3.29-1: <authorizationPolicy> RETRIEVE <authorizationPolicy> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: void Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <authorizationPolicy> resource as defined in clause 9.6.38 Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.30 Update <authorizationPolicy> | This procedure shall be used for updating attributes of an <authorizationPolicy> resource. Originator: The Originator shall request to obtain access control policies by using UPDATE operation on an <authorizationPolicy> resource. The access control policy request shall be specified with resource specific attributes except the policies and combiningAlgorithm attributes. Receiver: The Receiver shall execute an access control policy retrieving process according to the access control policy request provided in the UPDATE request and return the access control policies and policy combining algorithm in the UPDATE response. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 308 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.3.30-1: <authorizationPolicy> UPDATE <authorizationPolicy> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply. Processing at Originator before sending Request According to clause 10.1.4 with the following additions: Content: The representation of an access control policy request constructed using updated attributes. See clause 7 in ETSI TS 118 103 [2] for the mandatory and optional parameters. Processing at Receiver According to clause 10.1.4 with the following additions: • Check the validity of the access control policy request constructed using updated attributes. See clause 7 in ETSI TS 118 103 [2] for the mandatory and optional parameters. • Obtain applicable access control policies and policy combining algorithm. See clause 7 in ETSI TS 118 103 [2] for more details. • Update the policies and combiningAlgorithm and status attributes with the access control policy retrieval result. See clause 7 in ETSI TS 118 103 [2] for possible policy combining algorithms. • After sending the response message, all the resource specific attributes shall be deleted. Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.31 Delete <authorizationPolicy> | This procedure shall be used for deleting an existing <authorizationPolicy> resource. Table 10.2.3.31-1: <authorizationPolicy> DELETE <authorizationPolicy> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.32 Authorization using <authorizationInformation> | Each <authorizationInformation> resource represents an entrance of a Policy Information Point (PIP) that is responsible for retrieving access control information, e.g. a role or token. Multiple <authorizationInformation> resources can be created under one <CSEBase> resource. The access control policies associated to an <authorizationInformation> resource can be used to group access control information requesters, i.e. which CSEs can retrieve access control information from a given <authorizationInformation> resource. The resource specific attributes or child resources of an <authorizationInformation> resource can be classified into two categories according to their usages. One category is used for describing access control information, e.g. <role> and <token> resources. The other category is used for describing access control Information requests, e.g. from, roleIDs and tokenIDs attributes. An UPDATE operation on an <authorizationInformation> resource may trigger an access control information retrieving process. After obtaining the access control information, the access control information or error status is returned back to the information requester via an UPDATE response. The details of distributed authorization procedures are described in ETSI TS 118 103 [2]. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 309 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.33 Create <authorizationInformation> | This procedure shall be used for creating an <authorizationInformation> resource. Table 10.2.3.33-1: <authorizationInformation> CREATE <authorizationInformation> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.43, and all the values of resource specific attributes shall be set to null, and any resource specific child resource shall not be created. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2. Information in Response message According to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.34 Retrieve <authorizationInformation> | This procedure shall be used for retrieving <authorizationInformation> resource. Table 10.2.3.34-1: <authorizationInformation> RETRIEVE <authorizationInformation> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: void. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <authorizationInformation> resource as defined in clause 9.6.38. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.35 Update <authorizationInformation> | This procedure shall be used for updating attributes and child resources of an <authorizationInformation> resource. Originator: The Originator shall request to obtain access control information by using UPDATE operation on an <authorizationInformation> resource. The access control information request shall be specified with resource specific attributes. Receiver: The Receiver shall execute an access control information retrieving process according to the access control information request provided in the UPDATE request, and return the access control information in the UPDATE response. The access control information shall be specified with <role> and/or <token> child resources. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 310 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.3.35-1: <authorizationInformation> UPDATE <authorizationInformation> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply. Processing at Originator before sending Request According to clause 10.1.4 with the following additions: Content: The representation of an access control information request constructed using updated attributes. See clause 7 in ETSI TS 118 103 [2] for the mandatory and optional parameters. Processing at Receiver According to clause 10.1.4 with the following additions: • Check the validity of the access control information request constructed using updated attributes. See clause 7 in ETSI TS 118 103 [2] for the mandatory and optional parameters. • Obtain applicable access control information. The details of this process are described in ETSI TS 118 103 [2]. • Create <role> and/or <token> child resources and update the status attributes according to the access control information retrieval result. • After sending the response message, all the resource specific attributes and <role> and/or <token> child resources shall be deleted. Information in Response message According to clause 10.1.4 with the following additions: The <role> and/or <token> child resources shall also be returned. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.36 Delete <authorizationInformation> | This procedure shall be used for deleting an existing <authorizationInformation> resource. Table 10.2.3.36-1: <authorizationInformation> DELETE <authorizationInformation> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4 Data management | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.1 Introduction | Data management is provided with different sets of Content Sharing Resources and those sets provide different functionalities that can be utilized depending on application services. The following lists each resource type set. • container, contentInstance, latest, oldest • flexContainer, flexContainerInstance, latest, oldest • timeSeries, timeSeriesInstance, latest, oldest |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.2 Data management using <container> and <contentInstance> | A <container> resource provides the data instance container for the children <contentInstance> resources. An AE can configure the container (e.g. maxNrOfInstances) and a CSE provides meta information (e.g. currentNrOfInstances) of the container. A <contentInstance> resource is immutable once created and it stores application data within a single attribute (i.e. the content) regardless the data structure and format. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 311 (oneM2M TS-0001 version 4.15.0 Release 4) The <latest> and <oldest> virtual resources are used to easily retrieve and delete the latest and oldest <contentInstance> resource in a <container> resource, respectively, without any knowledge of all the <contentInstance> resources in the container. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.3 Create <container> | This procedure shall be used for creating a <container> resource. Table 10.2.4.3-1: <container> CREATE <container> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.6 Processing at Originator before sending Request According to clause 10.1.2 Processing at Receiver According to clause 10.1.2 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: Address of the created <container> resource, according to clause 10.1.2 Processing at Originator after receiving Response According to clause 10.1.2 Exceptions According to clause 10.1.2 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.4 Retrieve <container> | This procedure shall be used for retrieving the attributes of a <container> resource. Table 10.2.4.4-1: <container> RETRIEVE <container> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: void. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver The Receiver shall verify the existence (including Filter Criteria checking, if it is given) of the target resource or the attribute and check if the Originator has appropriate privileges to retrieve information stored in the resource/attribute. When the child <contentInstance> resource has to be part of the response (ResultContent is child-resources or attributes+child-resources) and there is no <contentInstance> resource in the parent or if all existing ones are obsolete then 2 situations: a) There is a subscription on the <container> resource with the notificationEventType 'e)' set (table 9.6.8-3) so a notification is triggered, a timer shall be set and the Receiver shall delay the response until a <contentInstance> resource is available in the <container> resource, or until the timer expires; in that last case the Receiver shall respond with an error. If the Result Expiration Timestamp parameter is received from the Originator, the timer should be set to enforce this parameter, otherwise, the timer is set, based on the local policy configured at the Hosting CSE. b) There is no subscription on the <container> resource with the notificationEventType 'e)' set, then the Receiver shall respond with an error. Otherwise clause 10.1.3 applies. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <container> resource as defined in clause 9.6.6. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. In addition, a timer has expired. The Receiver responds with an error. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 312 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.5 Update <container> | This procedure shall be used for updating the attributes and the actual data of a <container> resource. Table 10.2.4.5-1: <container> UPDATE <container> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: attributes of the <container> resource as defined in clause 9.6.6 which need be updated Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.6 Delete <container> | This procedure shall be used for deleting a <container> resource. Table 10.2.4.6-1: <container> DELETE <container> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5. Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.7 Create <contentInstance> | This procedure shall be used for creating a <contentInstance> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 313 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.4.7-1: <contentInstance> CREATE <contentInstance> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: • Content: The resource content shall provide the information as defined in clause 9.6.7. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2. If the newly created <contentInstance> resource violates any of the policies defined in the parent <container> resource (e.g. maxNrOfInstances or maxByteSize), then the oldest <contentInstance> resources shall be removed from the <container> to enable the creation of the new <contentInstance> resource. If the hosting CSE has the capability to duplicate the actual data in semantic triples complying to an ontology that it supports, it may: 1) represent the actual data contained in the content attribute to semantic triples (e.g. RDF triples); 2) create a <semanticDescriptor> child resource for the <contentInstance> resource with its descriptor attribute set to these semantic triples generated in 1). • As an example to enable the hosting CSE to duplicate the actual data in semantic triples, the parent <container> resource contains sufficient semantic information in one of its <semanticDescriptor> child resources. Specifically, the descriptor attribute of the <container>/<semanticDescriptor> resource contains triples to describe semantic information about the actual data to be contained in any created <contentInstance>; as such, the hosting CSE is able to duplicate the actual data in semantic triples. For example, if the <container> is for storing readings from a temperature sensor (i.e. each <contentInstance> corresponds to a different reading), the descriptor attribute can contain triples to describe, for example, the type of actual data is temperature reading, the encoding of the actual data is a Base64-encoded string, and the unit of the actual data is Celsius. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: • Content: Address of the created <contentInstance> resource, according to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.8 Retrieve <contentInstance> | This procedure shall be used for retrieving the attributes of a <contentInstance> resource. Table 10.2.4.8-1: <contentInstance> RETRIEVE <contentInstance> RETRIEVE Information in Request message According to clause 10.1.3. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. If the disableRetrieval attribute of the parent <container> resource was set as 'TRUE', then the RETRIEVE request shall be rejected (see note). If the <contentInstance> resource has the deletionCnt attribute, the Hosting CSE decrements the attribute by 1. If the counter becomes 0, the resource shall be deleted by the Hosting CSE. Information in Response message All parameters defined in table 8.1.3-1 apply with specific details for: Content: Attributes of the <contentInstance> resources as defined in clause 9.6.7. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. NOTE: Notification regarding <subscription> on the parent <container> resource shall be. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 314 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.9 Update <contentInstance> | The Update operation shall not apply to <contentInstance> resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.10 Delete <contentInstance> | This procedure shall be used for deleting a <contentInstance> resource residing under a <container> resource. Table 10.2.4.10-1: <contentInstance> DELETE <contentInstance> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5. The Receiver shall delete the <contentInstance> resource. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.11 Retrieve <latest> | If locationID of <container> is configured, the procedure specified in clause 10.2.9.7 shall apply. If locationID of <container> is not configured, this procedure shall apply to the latest <contentInstance> resource among all existing <contentInstance> resources in the parent <container> resource. If there is no <contentInstance> resource in the parent, then the Receiver shall response with an error. This procedure is the same as the procedures in clause 10.2.4.8 <contentInstance> RETRIEVE. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.12 Delete <latest> | This procedure shall apply to the latest <contentInstance> resource among all existing <contentInstance> resources in the parent <container> resource. If there is no <contentInstance> resource in the parent, then the Receiver shall response with an error. After deletion, the <latest> contentInstance will point to the latest <contentlnstance> among all remaining <contentInstance> resources in the parent <container> resource. This procedure is the same as the procedures in clause 10.2.4.10 <contentInstance> DELETE. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.13 Retrieve <oldest> | This procedure shall apply to the oldest <contentInstance> resource among all existing <contentInstance> resources in the parent <container> resource. If there is no <contentInstance> resource in the parent, then the Receiver shall response with an error. This procedure is the same as the procedures in clause 10.2.4.8 <contentInstance> RETRIEVE. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.14 Delete <oldest> | This procedure shall apply to the oldest <contentInstance> resource among all existing <contentInstance> resources in the parent <container> resource. If there is no <contentInstance> resource in the parent, then the Receiver shall response with an error. After deletion, the <oldest> contentInstance will point to the oldest <contentlnstance> among all remaining <contentInstance> resources in the parent <container> resource. This procedure is the same as the procedure in as clause 10.2.4.10 <contentInstance> DELETE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 315 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.15 Data management using <flexContainer> | A <flexContainer> resource can store application data in custom attributes and provide limited meta information (e.g. contentSize) compared to a <container> resource. With the custom attributes, application data can be separately stored in different attributes that can be leveraged to discover the resource with the attribute value or subscribe to specific attribute(s). A <flexContainer> resource can have one or more child(ren) <flexContainers> resource(s) in multiple levels. A <flexContainer> resource can have one or more child(ren) <flexContainerInstance> resource(s) in order to keep track of the modification history of its custom attributes. The <latest> and <oldest> virtual resources are used to easily retrieve and delete the latest and oldest <flexContainerInstance> resource in a <flexContainer> resource, respectively, without any knowledge of all the <flexContainerInstance> resources in the <flexContainer> resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.16 Create <flexContainer> | This procedure shall be used for creating a <flexContainer> resource. Table 10.2.4.16-1: <flexContainer> CREATE <flexContainer> CREATE Information in Request message According to clause 10.1.2 Processing at Originator before sending Request According to clause 10.1.2 Processing at Receiver According to clause 10.1.2 A child <flexContainerInstance> resource shall be created by the Hosting CSE when the parent <flexContainer> is created and at least one of the maxNrOfInstances, maxByteSize or maxInstanceAge attributes is present. All the custom attributes and, if present, the label attribute from the <flexContainer> are copied to the new <flexContainerInstance> Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: Address of the created <flexContainer> resource, according to clause 10.1.2 Processing at Originator after receiving Response According to clause 10.1.2 Exceptions According to clause 10.1.2 with the following addition: - The parent resource type of this newly created <flexContainer> resource shall follow the definition in clause 9.6.1.2.2 (Specializations of <flexContainer>) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.17 Retrieve <flexContainer> | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.17.0 Overview | This procedure shall be used for retrieving the attributes of a <flexContainer> resource. Table 10.2.4.17.0-1: <flexContainer> RETRIEVE <flexContainer> RETRIEVE Information in Request message All parameters defined in table 8.1.2-2 apply with the specific details for: Content: void Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <flexContainer> resource as defined in clause 9.6.6 Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 316 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.17.1 Retrieve <latest> | This procedure shall apply to the latest <flexContainerInstance> resource among all existing <flexContainerInstance> resources in the parent <flexContainer> resource. If there is no <flexContainerInstance> resource in the parent, then the Receiver shall respond with an error. This procedure is the same as the procedures in clause 10.2.4.31 <flexContainerInstance> RETRIEVE. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.17.2 Retrieve <oldest> | This procedure shall apply to the oldest <flexContainerInstance> resource among all existing <flexContainerInstance> resources in the parent <flexContainer> resource. If there is no <flexContainerInstance> resource in the parent, then the Receiver shall respond with an error. This procedure is the same as the procedures in clause 10.2.4.31 <flexContainerInstance> RETRIEVE. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.18 Update <flexContainer> | This procedure shall be used for updating the attributes and the actual data of a <flexContainer> resource. Table 10.2.4.18-1: <flexContainer> UPDATE <flexContainer> UPDATE Information in Request message All parameters defined in table 8.1.2-2 apply with the specific details for: Content: attributes of the <flexContainer> resource as defined in clause 9.6.6 which need be updated Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 A child <flexContainerInstance> resource shall be created by the Hosting CSE at least one of the maxNrOfInstances, maxByteSize or maxInstanceAge attributes is present and the request contains either no attribute at all or at least one custom attribute of the <flexContainer> or if it is adding or updating the label attribute. All the custom attributes from the <flexContainer>, if any, and, if present, the label attribute are copied to the new <flexContainerInstance>. If at least one of maxNrOfInstances, maxByteSize or maxInstanceAge is created, modified or deleted in the <flexContainer> resource update request, then the set of <flexContainerInstances> children resources, the currentNrOfInstances and the currentByteSize attributes shall be updated accordingly. Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.19 Delete <flexContainer> | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.19.0 Overview | This procedure shall be used for deleting a <flexContainer> resource. Table 10.2.4.19.0-1: <flexContainer> DELETE <flexContainer> DELETE Information in Request message All parameters defined in table 8.1.2-2 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 317 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.19.1 Delete <latest> | This procedure shall apply to the latest <flexContainerInstance> resource among all existing <flexContainerInstance> resources in the parent <flexContainer> resource. If there is no <flexContainerInstance> resource in the parent, then the Receiver shall respond with an error. After deletion, the <latest> flexContainerInstance will point to the latest <flexContainerInstance> resource among all remaining <flexContainerInstance> resources in the parent <flexContainer> resource. This procedure is the same as the procedures in clause 10.2.4.33 <flexContainerInstance> DELETE. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.19.2 Delete <oldest> | This procedure shall apply to the oldest <flexContainerInstance> resource among all existing <flexContainerInstance> resources in the parent <flexContainer> resource. If there is no <flexContainerInstance> resource in the parent, then the Receiver shall respond with an error. After deletion, the <oldest> flexContainerInstance will point to the oldest <flexContainerInstance> among all remaining <flexContainerInstance> resources in the parent <flexContainer> resource. This procedure is the same as the procedures in clause 10.2.4.33 <flexContainerInstance> DELETE. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.20 Data management using <timeSeries> and <timeSeriesInstance> | <timeSeries> and <timeSeriesInstance> resources are similar in function to <container> and <contentInstance> resources, however a <timeSeries> provides missing data detection while monitoring the dataGenerationTime attribute of a <timeSeriesInstance> resource. If a <timeSeries> resource is subscribed to, a missing data detection event results in a notification to the subscriber. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.21 Create <timeSeries> | This procedure shall be used for creating a <timeSeries> resource. Table 10.2.4.21-1: <timeSeries> CREATE <timeSeries> CREATE Information in Request message All parameters defined in table 8.1.2-2 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.36 Processing at Originator before sending Request According to clause 10.1.2 Processing at Receiver According to clause 10.1.2: • If the periodicInterval attribute is set and the missingDataDetect attribute is TRUE, the Hosting CSE shall begin the procedure defined in clause 10.2.4.29. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: Address of the created <timeSeries> resource, according to clause 10.1.2 Processing at Originator after receiving Response According to clause 10.1.2 Exceptions According to clause 10.1.2 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 318 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.22 Retrieve <timeSeries> | This procedure shall be used for retrieving the attributes of a <timeSeries> resource. Table 10.2.4.22-1: <timeSeries> RETRIEVE <timeSeries> RETRIEVE Information in Request message All parameters defined in table 8.1.2-2 apply with the specific details for: Content: void Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <timeSeries> resource as defined in clause 9.6.36. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.23 Update <timeSeries> | This procedure shall be used for updating the attributes in a <timeSeries> resource. Table 10.2.4.23-1: <timeSeries> UPDATE < timeSeries> UPDATE Information in Request message All parameters defined in table 8.1.2-2 apply with the specific details for: Content: attributes of the <timeSeries> resource as defined in clause 9.6.36 which need be updated. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4 with the following additions: If missingDataDetect is modified to false the Hosting CSE will pause the missing data detection process. If missingDataDetect is modified to true the Hosting CSE will clear the missingDataList and missingDataCurrentNr and restart the missing data detection process. If any parameters related to the missing data detection process (missingDataDetectTimer, missingDataMaxNr, periodicIntervalDelta, periodicInterval) are updated while the data detection process is paused the Hosting CSE will clear the missingDataList and missingDataCurrentNr. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4 with these following additions. An error will be generated if any of the following attributes are modified while the value of missingDataDetect is true: missingDataDetectTimer, missingDataMaxNr, periodicIntervalDelta, periodicInterval. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 319 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.24 Delete <timeSeries> | This procedure shall be used for deleting a <timeSeries> resource residing under a <timeSeries> resource. Table 10.2.4.24-1: <timeSeries> DELETE <timeSeries> DELETE Information in Request message All parameters defined in table 8.1.2-2 apply. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. The Hosting CSE shall terminate timers related to the missing data detection process. Exceptions According to clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.25 Create <timeSeriesInstance> | This procedure shall be used for creating a <timeSeriesInstance> resource. Table 10.2.4.25-1: <timeSeriesInstance> CREATE <timeSeriesInstance> CREATE Information in Request message All parameters defined in table 8.1.2-2 apply with the specific details for: • Content: The resource content shall provide the information as defined in clause 9.6.37. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2. If the newly created <timeSeriesInstance> resource violates any of the policies defined in the parent <timeSeries> resource (i.e. maxInstanceAge,maxNrOfInstances or maxByteSize), then the <timeSeriesInstance> resource with the oldest dataGenerationTime attribute shall be removed to enable the creation of the new <timeSeriesInstance> resource. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: Address of the created <timeSeriesInstance> resource, according to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.26 Retrieve <timeSeriesInstance> | This procedure shall be used for retrieving the attributes of a <timeSeriesInstance> resource. Table 10.2.4.26-1: <timeSeriesInstance> RETRIEVE <timeSeriesInstance> RETRIEVE Information in Request message According to clause 10.1.3. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message According to clause 10.1.3. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 320 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.27 Update <timeSeriesInstance> | The Update operation shall not apply to <timeSeriesInstance> resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.28 Delete <timeSeriesInstance> | This procedure shall be used for deleting a <timeSeriesInstance> resource residing under a <timeSeries> resource. Table 10.2.4.28-1: <timeSeriesInstance> DELETE <timeSeriesInstance> DELETE Information in Request message All parameters defined in table 8.1.2-2 apply. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.29 Procedure for Time Series Data Detecting and Reporting | In the case that the periodicInterval is set and the missingDataDetect is TRUE, the Hosting CSE shall monitor the Time Series Data based on its periodicInterval. When the Hosting CSE detects a missing data point, the dataGenerationTime of the missing data point is inserted into the missingDataList attribute and the missingDataCurrentNr shall be increased by one. When the missingDataCurrentNr exceeds the missingDataMaxNr, the oldest dataGenerationTime shall be removed from missingDataList to enable the insertion of the new missing data point information and missingDataCurrentNr shall be set to the value of missingDataMaxNr. When an AE wants to be informed of the number of missing data points in a given renewable time duration, the AE shall send a create <subscription> request and set the missingData condition tag in the eventNotificationCriteria conditions to specify the reporting policy. The notificationEventType element in the eventNotificationCriteria shall have a value of "Report on missing data points".This enables the AE to keep track of the number of missing data points and the corresponding timestamps over a predefined but renewable duration (i.e. the "window duration" of the missingData condition). When the Hosting CSE reports missing data points, it shall check the missingData condition in the subscription resources created for that purpose. A missing data point is detected if a <timeSeriesInstance> with a dataGenerationTime value within the expected dataGenerationTimeRange is not present in the Hosting CSE at the missing data detection time: • Expected dataGenerationTime is defined as the dataGenerationTime of the first received <timeSeriesInstance> resource plus (N * periodicInterval). • Expected dataGenerationTimeRange is defined as the expected dataGenerationTime +/- periodicIntervalDelta. • Missing data detection time is defined as expected dataGenerationTime + missingDataDetectTimer. When the first missing data point is detected following the creation of a subscription i.e. at its missing data detection time, the Hosting CSE shall start a timer associated with that subscription and start counting the number of missing data points. This timer starts at the missing data detection time and its duration is set to the "window duration" in the subscription's missingData condition. The reporting policy is governed by the rules below: • If the total number of missing data points becomes equal to the "minimum specified missing number of the Time Series Data" specified in the subscription's missingData condition before the timer expires, a NOTIFY request shall be sent including the number of missing data points that have been detected since the start of the subscription's timer, along with their expected dataGenerationTime. The missing data points counter shall continue counting while the "window duration" timer continues to run. A similar NOTIFY request shall be sent for each subsequent missing data point detected until the timer expires (see next bullet for behavior when the timer expires). The "window duration" timer does not stop before it expires. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 321 (oneM2M TS-0001 version 4.15.0 Release 4) • When the timer expires, the missing data points counter is reset back to 0. This "window duration" timer is restarted only upon detection of next missing data point at its missing data detection time. • The reset of the timer and the missing data points counter upon timer expiry shall continue until such time as the subscription is cancelled or terminated. • If no missing data points have been detected at all during the lifetime of a subscription, then no timer shall be started at all. But once a timer is started triggered by the first missing data point, then the above rules in the previous bullets shall apply. Figure 10.2.4.29-1 depicts the above rules. t “window duration” in missingData Missing data point1 T1 T4 “window duration” in missingData T2 T3 Missing data point2 Missing data point5 The “minimum specified missing number of the Time Series Data” in missingData is 5. Missing data point1 Missing data point4 The NOTIFY Request is not sent. Internal handling of the events in Hosting CSE Data point received Data point received T5 T1: When the first missing data point is detected, the timer is started and the missing data points counter is set to a value of 1. T2: The NOTIFY Request is sent when the value of the missing data points counter becomes equal to the value in the missingData attribute. T3: The NOTIFY Request is sent again because the missing data points counter is greater than the value in the missingData attribute. T4: At the end of the "window duration" the missing data points counter is reset back to 0. T5: The "window duration" timer is restarted since a missing data point is detected and the missing data points counter is set to a value of 1. Figure 10.2.4.29-1: Time Series Data Detecting and Reporting Mechanism The missing data detection process can be paused by updating missingDataDetect to false. The Hosting CSE will keep the current state of missingDataList and missingDataCurrentNr of the <timeSeries> resource. The missing data detection process can be restarted by updating the missingDataDetect to true. When the missingDataDetect is updated from false to true the Hosting CSE will clear the missingDataList and missingDataCurrentNr. While the missing data detection process is paused the timers associated with a <subscriptions>'s window duration and counter continue to run. While this process is paused the parameters of the <timeSeries> resource can be updated. If any of the parameters (missingDataDetectTimer, missingDataMaxNr, periodicIntervalDelta, periodicInterval) related to the missing data detection process is updated while the data detection process is paused the Hosting CSE will clear the missingDataList and missingDataCurrentNr. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.30 Create <flexContainerInstance> | Creation of <flexContainerInstance> resource is only performed by the Hosting CSE. The Hosting CSE shall create a <flexContainerInstance> resource in case the parent <flexContainer> is created or updated with either no attribute at all or with at least one custom attribute, and when at least one of the maxNrOfInstances, maxByteSize or maxInstanceAge attributes is present with a positive and non-zero value. When a child <flexContainerInstance> resource is created by the Hosting CSE, the Hosting CSE shall: • Copy values of all custom attributes of parent <flexContainer> resource, if any, to the created child <flexContainerInstance> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 322 (oneM2M TS-0001 version 4.15.0 Release 4) • Generate values of all non-custom attributes of <flexContainerInstance> resource (e.g. resourceType, resourceID, resourceName, parentID, labels, creationTime, expirationTime, contentSize, originator). The resourceName attribute of the <flexContainerInstance> resource shall be assigned by the Hosting CSE. It can for instance be configured with the resourceName of the parent <flexContainer> resource appended with the stateTag value of the parent <flexContainer> resource separated by an underscore "_" (the value of the stateTag is taken after it has been incremented e.g. "LightBulb_3" for a <flexContainer> with resourceName "LightBulb" and stateTag=3). The originator attribute shall be configured with the identifier of the originator of the CREATE or UPDATE request of the parent <flexContainer> resource that caused the creation of this <flexContainerInstance> resource by the Hosting CSE. • Adjust accordingly the attributes of parent <flexContainer> resource related to the instance creation (currentNrOfInstances and currentByteSize). If the newly created <flexContainerInstance> resource violates any of the defined maxNrOfInstances, maxByteSize or maxInstanceAge attributes, then the oldest <flexContainerInstance> resource(s) shall be removed by the Hosting CSE to enable the creation of this new <flexContainerInstance> resource, and the currentNrOfInstances and currentByteSize attributes shall be re-calculated. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.31 Retrieve <flexContainerInstance> | This procedure shall be used for retrieving the attributes of a <flexContainerInstance> resource. Table 10.2.4.31-1: <flexContainerInstance> RETRIEVE <flexContainerInstance> RETRIEVE Information in Request message According to clause 10.1.3. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message According to clause 10.1.3. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.32 Update <flexContainerInstance> | The Update operation shall not apply to <flexContainerInstance> resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.4.33 Delete <flexContainerInstance> | This procedure shall be used for deleting a <flexContainerInstance> resource residing under a <flexContainer> resource. Table 10.2.4.33-1: <flexContainerInstance> DELETE <flexContainerInstance> DELETE Information in Request message All parameters defined in table 8.1.2-2 apply. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5 Request message handling | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.1 Introduction | A request can be processed in blocking, non-blocking synchronous or non-blocking asynchronous mode as illustrated in clauses 8.2.1 and 8.2.2. Sometimes, more than one request can be batched together by an intermediate CSE and delivered to another CSE via the implicit creation of <delivery> resources. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 323 (oneM2M TS-0001 version 4.15.0 Release 4) For deployment scenarios where requests cannot be directly forwarded to a targeted AE or CSE (e.g. the AE or CSE is deployed behind NAT/Firewall), the targeted AE or CSE can perform long polling to retrieve requests from its Registrar CSE. To support end-to-end secure communications, a request can be secured and encapsulated within a notify message to prevent tampering of the request. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.2 Non-blocking communication management | Unlike blocking request handling, non-blocking request handling involves the implicit creation and use of <request> resources by a Receiver CSE to process the request. The following clauses illustrate <request> resource handling procedures. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.3 Create <request> | As specified in clause 9.6.12, creation of a <request> resource shall only be done on a Receiver CSE implicitly when a Registree AE or a Registree/Registrar CSE of the Receiver CSE issues a request to the Receiver CSE for targeting any other resource type or requesting a notification in non-blocking mode. Therefore, the creation procedure of a <request> resource cannot be initiated explicitly by an Originator. The specific conditions to create a <request> resource are as follows: When an AE or CSE issues a request for targeting any other resource type or requesting a notification in non-blocking mode, i.e. the Response Type parameter of the request is set to either 'nonBlockingRequestSynch' or 'nonBlockingRequestAsynch', and the Receiver CSE supports the <request> resource type as indicated by the supportedResourceType attribute of the <CSEBase> resource representing the Receiver CSE. The Receiver CSE of a non-blocking Request that was issued by either: • a Registrar AE of the Receiver CSE; or • a Registree/Registrar CSE of the Receiver CSE; is the Hosing CSE for the <request> resource that shall be associated with the non-blocking request. The Hosting CSE shall follow the procedure outlined in this clause. Step 001: The Receiver shall: 1) Assign values to the resourceID and resourceName attributes of the <request> resource to be created. 2) Assign a value to the following common attributes specified in clause 9.6.1.3: a) parentID; b) creationTime; c) expirationTime: The Receiver shall assign a value that is consistent with the Request Expiration Timestamp, Result Expiration Timestamp and Result Persistence parameters effective for the associated non-blocking request that implied the creation of this <request> resource (within the restriction of the Receiver policies). If a value consistent with the Request Expiration Timestamp, Result Expiration Timestamp and Result Persistence parameters effective for the associated non- blocking request that implied the creation of this <request> resource cannot be supported, due to either policy or subscription restrictions, the Receiver will assign a new value; d) lastModifiedTime: which is equals to the creationTime; e) stateTag; f) accessControlPolicyIDs: Populate with the resource identifier of an <accessControlPolicy> that contains the following: i) In the privileges attribute: 1) Allow RETRIEVE, UPDATE and DELETE operations for the Hosting CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 324 (oneM2M TS-0001 version 4.15.0 Release 4) 2) Allow RETRIEVE and DELETE operations for the Originator, i.e. the value of the From parameter. ii) In the selfPrivileges attribute: 1) Allow UPDATE operations for the Originator, i.e. the value of the From parameter. 3) Assign any other RO (Read Only) attributes of <request> resource type within the restriction of the Receiver policies: a) Operation: Value of the parameter Operation in the associated non-blocking request that implied the creation of this <request> resource; b) Target: Value of the parameter To in the associated non-blocking request that implied the creation of this <request> resource; c) Originator: Value of the parameter From in the associated non-blocking request that implied the creation of this <request> resource; d) requestIdentifier: Value of the parameter Request Identifier in the associated non-blocking request that implied the creation of this <request> resource; e) metaInformation: The content of this attribute is set to information in any other optional parameters described in clause 8.1. given in the associated non-blocking request that implied the creation of this <request> resource; f) content: Value of the parameter Content - if any - in the associated non-blocking request that implied the creation of this <request> resource; g) requestStatus: Information on the initial status of the associated non-blocking request that implied the creation of this <request> resource. The initial value of this attribute shall be identical to the status that is contained in the Acknowledgement response message of the associated non-blocking request. Possible values for status information contained in this attribute are specified in ETSI TS 118 104 [3]. The value of this attribute is subject to changes according to the progress in processing of the non-blocking request that implied the creation of this <request> resource; h) operationResult: Initially empty. This attribute will be used for representing the result of the originally requested operation - if any - in line with the Result Content parameter and the Primitive Profile Identifier parameter in the associated non-blocking request that implied the creation of this <request> resource. Step 002: The Receiver shall create the <request> resource. Table 10.2.5.3-1: <request> CREATE <request> CREATE Information in Request message Not applicable. For <request> resources, explicit creation via a Request message shall not be supported Pre-Processing at Originator Not applicable. There is no Originator. <request> resources are only created implicitly Processing at Receiver Different to the non-registration CREATE procedure described in clause 10.1.2, see outlined steps described in the present clause above Information in Response message Not applicable. Since <request> resources shall not be created explicitly, no response messages will be sent after creation. However, the address of a <request> resource will be passed back as a reference to the Originator of an associated non- blocking request that implied the creation of this <request> resource Post-Processing at Originator None Exceptions None ETSI ETSI TS 118 101 V4.15.0 (2022-09) 325 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.4 Retrieve <request> | This procedure shall be used for retrieving the attributes of a <request> resource. Table 10.2.5.4-1: <request> RETRIEVE <request> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: Void Pre-Processing at Originator According to clause 10.1.3 with the following specific processing: Originator needs to retrieve information about an associated previously issued non- blocking request Processing at Receiver According to clause 10.1.3 with the following specific processing: The Receiver shall provide the content of the addressed <request> resource or the addressed attributes thereof Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: Attributes of the <request> resource as defined in clause 9.6.12 Post-Processing at Originator According to clause 10.1.3 Exceptions According to clause 10.1.3 and clause 10.1.2 with the following: • The Originator CSE is not authorized to retrieve the <request> resource or the addressed parts of it • The addressed <request> resource does not exist |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.5 Update <request> | For a <request> resource explicit update requests shall not be supported. Changes in the attributes of a <request> resource can only be done by the Hosting CSE due to changes of the status of the associated non-blocking request that implied the creation of this <request> resource or due to reception of an operation result in response to the associated non-blocking request that implied the creation of this <request> resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.6 Delete <request> | This procedure shall be used for deleting an existing <request> resource. Deletion of an existing <request> resource shall terminate any further processing of an associated pending non-blocking request that implied the creation of this <request> resource if the pending request was not already completed or forwarded. Table 10.2.5.6-1: <request> DELETE <request> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Pre-Processing at Originator According to clause 10.1.5 with the following: Originator needs to cancel a previously issued non-blocking request that is still pending, i.e. it has not yet been completed or Originator needs to remove the <request> resource representing the context of an already completed non-blocking request Processing at Receiver According to clause 10.1.5: • Receiver CSE checks if the associated non-blocking request process is still pending. If so, it stops that request process • Receiver CSE removes the addressed <request> resource Information in Response message According to clause 10.1.5 with the following specific information: Successful Response message indicating that the associated non-blocking request process was stopped as requested or the context of an already completed associated non-blocking request was deleted Post-Processing at Originator According to clause 10.1.5 Exceptions According to clause 10.1.5 with the following: • The Originator CSE is not authorized to delete the <request> resource • The addressed <request> resource does not exist ETSI ETSI TS 118 101 V4.15.0 (2022-09) 326 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.7 Request delivery aggregation | In this introduction an example for delivering information from a source CSE to a target CSE via the use of the <delivery> resource is explained. The information flow depicted in figure 10.2.5.7-1 defines the exchange of Requests/Responses for processing an original request targeting a resource that is not hosted on the Registrar CSE of the request Originator. The following assumptions hold: • Originator is AE1. • AE1 is registered with CSE1, i.e. CSE1 is the Registrar CSE for AE1. • The original Request is an UPDATE to a remote resource hosted on CSE3, i.e. CSE3 is the Hosting CSE for the target resource. • UPDATE options in the original Request are selected such that no feedback after completion of the update operation was requested, i.e. AE1 decided that it does not need to hear back from CSE3; this is expressed by setting the Result Content information to "nothing", see clause 8.1.2. • Delivery related parameters included in the original UPDATE request (may be set via CMDH policies): Request Expiration Timestamp, Event Category, Delivery Aggregation and Result Persistence: - Request Expiration Timestamp indicates how long the forwarding of the request can last. - Event Category indicates the event category that should be used by CMDH to handle this request. - Result Persistence indicates how long after the request has expired, the local request context should still be available for retrieving status or result information. - Delivery Aggregation would be set to ON indicating that <delivery> resource shall be used for forwarding the request. • CSE1 is the CSE of an Application Service Node. • CSE1 is registered with CSE2 and interacts with CSE2 via the reference point Mcc(1). • CSE2 is the CSE of a Middle Node. • CSE2 is registered with CSE3 and interacts with CSE3 via the reference point Mcc(2) • CSE3 is the CSE of an Infrastructure Node. The Originator AE1 shall get a confirmation from CSE1 when the original Request is accepted. The response informs AE1 that CSE1 has accepted the Request and has accepted responsibility to execute on the requested operation. Furthermore, AE1 has expressed by setting Result Content to "nothing" that no result of the requested operation is expected to come back from CSE3. With the provided reference (Req-Ref in figure 10.2.5.7-1. AE1 can retrieve the status of the issued request at a later time, for instance to find out if the request was already forwarded to CSE2 or if it is still waiting for being forwarded on CSE1. Before accepting the request from AE1, CSE1 has also verified if the delivery related parameters expressed by AE1 (settings of Request Expiration Timestamp and Event Category) are in line with provisioned CMDH policies. AE1 may not be authorized to use certain values for Request Expiration Timestamp or Event Category. In line with the delivery related parameters, CSE1 is generating a local <delivery> resource on CSE1 and attempts to forward the content of it in line with provisioned CMDH policies at a suitable time and via a suitable connection to CSE2 by requesting the creation of a <delivery> resource on CSE2. In this example case, the lifespan attribute of this delivery resource is set to the same value as the Request Expiration Timestamp parameter expressed by AE1. In general - i.e. also in cases where more than one original request is aggregated into a single create request for a <delivery> resource - the lifespan and eventCat attributes of the created <delivery> resource shall be set consistent with the Request Expiration Timestamp and Event Category parameters in the set of original requests. See the attribute definitions in clause 9.6.11. CSE1 shall use a blocking request for requesting creation of a <delivery> resource on CSE2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 327 (oneM2M TS-0001 version 4.15.0 Release 4) When CSE2 has accepted the incoming request from CSE1, CSE1 may delete the aggregatedRequest attribute of the local <delivery> resource. Furthermore - if the expiration time of the local <delivery> resource is not exhausted - the Registrar CSE shall update deliveryMetaData attribute of the local <delivery> resource to indicate that it has been forwarded to CSE2. When CSE2 has accepted the request to create a local <delivery> resource, it shall attempt to forward it to CSE3. In line with the delivery related parameters, CSE2 shall create a local <delivery> resource on CSE2 and shall attempt to forward it in line with provisioned CMDH policies at a suitable time and via a suitable connection to CSE3 by requesting the creation of a <delivery> resource on CSE3. CSE2 shall use a blocking request for requesting creation of a <delivery> resource on CSE3. When CSE3 has accepted the incoming request from CSE2, CSE2 may delete the aggregatedRequestattribute of the local <delivery> resource. Furthermore - if the expiration time of the local <delivery> resource is not exhausted - the Registrar CSE shall update deliveryMetaData attribute of the local <delivery> resource to indicate that it has been forwarded to CSE3. When CSE3 has accepted the request to create a local <delivery> resource, it shall determine that the target of the delivery was CSE3 itself. Therefore it shall forward internally the original request contained in the aggregatedRequest attribute of the <delivery> resource. Within CSE3, functions that are responsible for checking and executing local access to resources in CSE3 will execute the originally requested UPDATE operation. If successful, the targeted resource will be updated with the content provided by the Originator. Since in the depicted case no result needed to be sent back to the Originator, the processing for the requested operation is then completed. Figure 10.2.5.7-1: CMDH information flow for 2 hops - no result needs to be returned after operation completes ETSI ETSI TS 118 101 V4.15.0 (2022-09) 328 (oneM2M TS-0001 version 4.15.0 Release 4) The following procedures shall be triggered by requesting the corresponding operations on a <delivery> resource: • Initiate the delivery of one or more original request(s) stored for later forwarding from one CSE to another CSE: - Request a CREATE operation for a <delivery> resource from an issuing CSE to a receiving CSE. - The original request(s) need to be contained in the "aggregatedRequest" attribute of the <delivery> resource. - If successful, the receiving CSE takes the responsibility to further execute on the delivery process for the original Request. - If not successful, the issuing CSE cannot assume that the receiving CSE will carry out the delivery of the original request. • Get information about the status of a pending delivery process for an original request: - Request a RETRIEVE operation of the content of a <delivery> resource representing a pending delivery or part of it. - The status of the pending forwarding process is reflected the "deliveryMetaData" attribute defined in the <delivery> resource. • Change parameters of pending delivery process: - Request an UPDATE operation on applicable attributes of the <delivery> resource representing the pending delivery. - For instance the time allowed for completion of a delivery process could be modified by updating the "lifespan" attribute of an existing <delivery> resource. • Cancel a pending delivery request: - Request a DELETE operation of a <delivery> resource that represents a pending delivery process. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.8 Create <delivery> | This procedure shall be used for requesting a CSE to take responsibility to deliver the provided data to a target CSE in line with CMDH parameters and provisioned CMDH policies in case <delivery> resource based CMDH processing is used. If indicated by the Originator, the Receiver shall confirm the acceptance of delivery responsibility by a successful Response. Originator: The Originator of a Create request for a <delivery> resource can only be a CSE. The Originator needs to provide the content of a <delivery> resource type together with the Create request or can Update it after a successful creation of the <delivery> resource with empty aggregatedRequest attribute. Otherwise the Receiver cannot accept the Create Request. The Originator shall use a blocking request for issuing the Create request to the Receiver. Receiver: The receiver of a Create request for a <delivery> resource is a Registrar or Registree CSE of the Originator and it shall check the access control policies to assure the Originator is authorized to request a delivery procedure. The Receiver of the Create Request shall further check whether the provided attributes of the <delivery> resource that is requested to be created represents a valid request for forwarding data to a target CSE. If the Originator of the Create request is authorized and the Request is valid, the Receiver shall check whether it can actually satisfy the requested delivery in line with provisioned CMDH policies and requested eventCat and lifespan attributes of the <delivery> resource. If all these checks are positive, the Receiver shall create the requested <delivery> resource and assumes responsibility for delivering the requested data to the target CSE as soon as the content of the aggregatedRequest attribute is available. In case an operation result is expected by the Originator, the Receiver shall confirm acceptance of the responsibility by indicating a successful creation of the <delivery> resource. If the Receiver CSE is the target CSE of the requested delivery, it shall forward the content of the delivered data - which represents one or more forwarded original request(s) - to the internal functions that handle incoming requests and continue processing of the forwarded request(s). ETSI ETSI TS 118 101 V4.15.0 (2022-09) 329 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.5.8-1: <delivery> CREATE <delivery> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: From: CSE only Content: The resource content shall provide the information as defined in clause 9.6.11 Response Type: Shall be set to "blockingRequest" which means a blocking request is issued Processing at Originator before sending Request According to clause 10.1.2 with the following specific processing: The Originator needs to provide the content of a <delivery> resource type together with the Create request or can Update it after a successful creation of the <delivery> resource with empty aggregatedRequestattribute. Otherwise the Receiver cannot accept the Create Request. The Originator shall use a blocking request for issuing the Create request to the Receiver Processing at Receiver According to clause 10.1.2 with the following specific processing: • Check whether the provided attributes of the <delivery> resource that is requested to be created represents a valid request for delivering data to a target CSE • Check whether Receiver CSE can actually satisfy the requested delivery in line with provisioned policies and requested delivery parameters • If all checks are positive, the receiver shall create the requested <delivery> resource and assumes responsibility for delivering the provided data to the target CSE • If the Receiver CSE is the target CSE of the requested delivery, it shall forward the content of the delivered data to the internal CSFs that will interpret the delivered data as a forwarded request(s) from a remote Originator Information in Response message All parameters defined in table 8.1.3-1 apply, with the following specific information: In case the Originator CSE has not asked for a Result of the requested Operation (Result Content set to "nothing"), the Response only contains an Acknowledgement indicator. This only indicates that the Receiver CSE received the Request. It does NOT indicate whether the Receiver CSE was able to take on responsibility for delivery of the data In case the Originator CSE asked for the status of the requested Operation to be contained in the Result of the requested Operation (Result Content not set to "nothing"), the Receiver CSE shall respond with a Success or Failure indicator In case the Originator CSE asked for the status of the requested Operation and the address of the created Resource to be contained in the Result of the Request, the Receiver CSE shall respond with a Success indicator including the address of the created <delivery> resource in case it has taken on responsibility to deliver the data to the target CSE or with Failure indicator including an error indication otherwise Processing at Originator after receiving Response According to clause 10.1.2 with the following specific processing: The Originator CSE shall update the local <delivery> resource to reflect the new status of the delivery process (e.g. '{Receiver-CSE-ID} accepted delivery responsibility') In case the Originator CSE got a Success indicator as a Response, it shall stop any further delivery attempts. In that case or if there was no indication of a need to provide a result of the operation, the Originator CSE may delete the content of the 'aggregatedRequest' attribute of the local <delivery> resource In case the Originator CSE got a Failure indicator as a response, it may initiate further delivery attempts in line with CMDH policies and delivery parameters and depending on the reason for Failure In case the Receiver CSE is the target CSE of the delivery, the Receiver CSE needs to execute on the forwarded request contained in the delivered data Exceptions According to clause 10.1.2 with the following: • The Originator CSE is not authorized to request a delivery procedure on the Receiver CSE • The provided content of the <delivery> resource is not in line with the specified structure • The provided content of the <delivery> resource represents a request for delivery that is not consistent (e.g. lifespan attribute already expired) • The provided content of the <delivery> resource represents a request for delivery that cannot be met by the Receiver CSE within the limits of the provided delivery parameters and the provisioned CMDH policies on the Receiver CSE ETSI ETSI TS 118 101 V4.15.0 (2022-09) 330 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.9 Retrieve <delivery> | This procedure shall be used for requesting a CSE to provide information on a previously created <delivery> resource which represents delivery of data to a target CSE. Table 10.2.5.9-1: <delivery> RETRIEVE <delivery> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: void Processing at Originator before sending Request According to clause 10.1.3 with the following specific processing: Originator needs to retrieve information about a previously issued delivery Processing at Receiver According to clause 10.1.3 with the following specific processing: The Receiver shall provide the content of the addressed <delivery> resource or the addressed attributes thereof Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <delivery> resource as defined in clause 9.6.11 Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 with the following: • The Originator CSE is not authorized to retrieve the <delivery> resource or the addressed parts of it • The addressed <delivery> resource does not exist |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.10 Update <delivery> | This procedure shall be used for requesting a CSE to update information on a previously created <delivery> resource which represents a pending delivery of data to a target CSE. The update may have impact on further processing of the delivery. Table 10.2.5.10-1: <delivery> UPDATE <delivery> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: • Address of the <delivery> resource • Content of a <delivery> resource in line with the definition in clause 9.6.11 representing a valid request for delivery of data to a target CSE Processing at Originator before sending Request According to clause 10.1.4 with the following specific processing: • Originator needs to modify information about a previously issued delivery that is still pending, i.e. it has not yet been forwarded to another CSE Processing at Receiver According to clause 10.1.4 with the following specific processing: • Receiver CSE checks if the requested changes to the delivery process can actually be accomplished • If possible, the Receiver CSE modifies the previously established delivery process and changes the respective content of the <delivery> resource Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 with the following: • The Originator CSE is not authorized to modify the <delivery> resource or the addressed parts of it • The addressed <delivery> resource does not exist • The responsibility for the further processing of the delivery process represented by the addressed <delivery> process was already forwarded to another CSE ETSI ETSI TS 118 101 V4.15.0 (2022-09) 331 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.11 Delete <delivery> | This procedure shall be used for requesting a CSE to cancel a pending delivery of data to a target CSE or to delete the <delivery> resource of an already executed delivery. Table 10.2.5.11-1: <delivery> DELETE <delivery> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.5 with the following: • Originator needs to cancel a previously issued delivery that is still pending, i.e. it has not yet been forwarded to another CSE or Originator needs to remove the <delivery> resource representing an already executed delivery Processing at Receiver According to clause 10.1.5: • Receiver CSE checks if the corresponding delivery process is still pending. If so, it stops that delivery process • Receiver CSE removes the addressed <delivery> resource and stop the corresponding delivery process if it is still pending Information in Response message According to clause 10.1.5 with the following specific information: • Successful Response messages indicate that the delivery process was stopped as requested Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 with the following: • The Originator CSE is not authorized to delete the <delivery> • The addressed <delivery> resource does not exist |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.12 Request message polling | An AE or a CSE that is request unreachable cannot receive a request from other entities directly. Instead this AE/CSE can retrieve requests that others sent to this AE/CSE once it created <pollingChannel> resource on a request reachable CSE. This clause consists of manipulation procedures of <pollingChannel> resource (clauses 10.2.5.13 to 10.2.5.16), re-targeting request to <pollingChannel> resource (clause 10.2.5.17), the long polling procedure to retrieve requests from <pollingChannel> resource (clause 10.2.5.18) and the responding to the request received by long polling (clause 10.2.5.19). This is depicted in figure 10.2.5.12-1. Figure 10.2.5.12-1 depicts the case when the Originator sent a request("req2") to the Target as a blocking request. The request can be any of the requests defined in clause 10.2 (e.g. <container> resource creation on the Target CSE). As defined in clause 10.2.5.18, polling response contains the "req2" in step 0004. Also as per clause 10.2.5.19, in step 005 the "req3" contains the "resp2", which is the response to the "req2" in step 002 and step 004, in the "req3". Finally the "resp2" is forwarded to the Originator in step 006. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 332 (oneM2M TS-0001 version 4.15.0 Release 4) Target (AE/CSE) <pollingChannelURI> Hosting CSE (Registrar CSE of the Target) Originator which initiates a request to the Target 001: Retrieve request (req1) to <pollingChannelURI> resource 006: Response to "req2" (resp2) 002: A request (req2) to the Target 004: polling response (resp1) carrying "req2" in Content param. clause 10.2.5.18 long polling clause 10.2.5.19 response delivery 005: Notify request (req3) to <polingChannelURI> resource carrying "resp2" in Content param. any procedu res in 10.2 007: Response to "req3" 003: Internal processing for polling channel (clause 10.2.5.17) Figure 10.2.5.12-1: Request/response delivery via polling channel |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.13 Create <pollingChannel> | Table 10.2.5.13-1: <pollingChannel> CREATE <pollingChannel> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: Address of <AE> or <remoteCSE> resource Content: attributes of the <pollingChannel> resource as defined in clause 9.6.21 Processing at Originator before sending Request According to clause 10.1.2 with the following additions: • If an AE is the Originator, it shall address the <AE> resource that it already created. Otherwise, if a CSE is the Originator, it shall address the <remoteCSE> resource that it already created Processing at Receiver According to clause 10.1.2 with the replacement for sub-step 1) of step 002 as follows: • The Hosting CSE shall check if the Originator ID is the same as the CSE-ID or AE-ID of the parent resource which is the <remoteCSE> or <AE> resource If the check fails, the request shall be rejected Information in Response message According to clause 10.1.2 Processing at Originator after receiving Response The Originator should send a retrieve request to the <pollingChannelURI> resource Exceptions According to clause 10.1.2 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.14 Retrieve <pollingChannel> | This procedure is used to retrieve a <pollingChannel> resource and an AE/CSE can be an Originator. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 333 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.5.14-1: <pollingChannel> RETRIEVE <pollingChannel> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: void Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 with the following for step 002: • For access privilege checking, the Hosting CSE shall check if the Originator ID is the same as the CSE-ID or AE-ID of the parent resource which is the <remoteCSE> or <AE> resource, respectively. If the check fails, the request shall be rejected Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <pollingChannel> resource as defined in clause 9.6.21 Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.15 Update <pollingChannel> | This procedure is used to update a <pollingChannel> resource and an AE/CSE can be an Originator. Table 10.2.5.15-1: <pollingChannel> UPDATE <pollingChannel> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: attributes of the <pollingChannel> resource as defined in clause 9.6.21 Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 with the following for step 002: • For access privilege checking, the Hosting CSE shall check if the Originator ID is the same as the CSE-ID or AE-ID of the parent resource which is the <remoteCSE> or <AE> resource, respectively. If the check fails, the request shall be rejected Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.16 Delete <pollingChannel> | This procedure is used to delete a <pollingChannel> resource and an AE/CSE can be an Originator. Table 10.2.5.16-1: <pollingChannel> DELETE <pollingChannel> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 for step 002: • For access privilege checking, the Hosting CSE shall check if the Originator ID is the same as the CSE-ID or AE-ID of the parent resource which is the <remoteCSE> or <AE> resource, respectively. If the check fails, the request shall be rejected Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 334 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.17 Internal Processing for Polling Channel | This procedure is used to forward a request to a request-unreachable AE or CSE(i.e. requestReachability attribute of its <AE> or <remoteCSE> resource is set to FALSE) which has created a <pollingChannel> resource as a child of its <AE> or <remoteCSE> resource. When a <pollingChannel> Hosting CSE receives a request towards the AE or CSE, it shall forward the request to the AE or CSE in the Content parameter of the response to polling response (see clause 10.2.5.18). If there is no pending polling request from the AE or CSE, then the <pollingChannel> Hosting CSE shall store the request and forward it when it receives the polling request. When the stored request expires according to its Request Expiration Timestamp parameter the Hosting CSE shall return an error to the entity that initiated the request. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.18 Long Polling on Polling Channel | This procedure is originated by a request-unreachable entity to poll requests from a polling channel. Once the Originator starts long polling on a polling channel by sending a RETRIEVE request, the Receiver who is the <pollingChannel> Hosting CSE holds the request until it has any requests to return to the Originator. If the request expires and there is no available request to return, the Receiver shall send the response with a status indicating a timeout has occurred to inform the Originator that a new polling request should be generated again. Table 10.2.5.18-1: <pollingChannelURI>RETRIEVE Long Polling RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: Address of <pollingChannelURI> child resource of the <pollingChannel> resource. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3 with the following privilege check for step 002: • The Hosting CSE shall check if the Originator ID is the same as the CSE-ID or AE-ID of the grant parent <remoteCSE> or <AE> resource, respectively. • The Hosting CSE shall check if there is any request to be returned to the Originator. If none, the Hosting CSE shall wait for any request for the Originator to be reached at the polling channel until the Request Expiration Time. If there are any requests, the Hosting CSE shall send a response containing the request(s) for the Originator. If requestAggregation is TRUE all available requests are sent in a single response, otherwise a single request is sent in the response. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: request message(s) targeting the Originator. Processing at Originator after receiving Response The Originator may send a new long polling request. Exceptions If the long polling request is expired at the Receiver, the Receiver shall send an unsuccessful response to the Originator. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.19 Delivering the response to the request sent over polling channel | When a Registree AE or CSE receives a response from a long polling request (clause 10.2.5.18), the Registree AE or CSE shall generate a response to each request primitive contained in the Content of the long polling response. The Registree AE or CSE shall send each of the responses to the received requests in in the Content parameter of a new Notify request to the <pollingChannelURI> Hosting CSE (one Notify request for each primitive received in the long polling response). When the Hosting CSE receives a Notify request targeting the <pollingChannelURI> resource (figure 10.2.5.12-1, req3), the Hosting CSE shall send the response, contained in the Content parameter of the Notify request, to the entity that sent the associated request (figure 10.2.5.12-1, req2) to the Hosting CSE. The associated request is the request that the Hosting CSE received (figure 10.2.5.12-1, step 002) and forwarded to the Registree AE or CSE (figure 10.2.5.12-1, step 004) over the polling channel. The association shall be done by matching the Request Identifier parameter of the request delivered in <pollingChannelURI> Retrieve response and the Request Identifier parameter of the response delivered in the Content parameter in a <pollingChannelURI> Notify request. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 335 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.5.19-1: <pollingChannelURI> NOTIFY <pollingChannelURI> NOTIFY Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: Address of <pollingChannelURI> resource Content: The response to the request contained in <pollingChannelURI> Retrieve response Processing at Originator before sending Request Originator shall handle and generate the response to each of the requests contained in the <pollingChannelURI> Retrieve response Processing at Receiver The Hosting CSE shall send the response contained in the Content parameter of Notify request to the entity that sent the associated request to the Hosting CSE Information in Response message All parameters defined in table 8.1.3-1 apply Processing at Originator after receiving Response According to clause 10.1.6 Exceptions If the Originator of the <pollingChannelURI> Notify is not the AE-ID of the <AE> resource or CSE-ID of the <remoteCSE> resource which is the grandparent resource of the <pollingChannelURI> resource, then the Hosting CSE shall reject the request with access privilege error information |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.20 End-to-End secure communication | Multi-hop end-to-end secure communication is supported by encapsulating an end-to-end secured request within a notify message. Depending on the Receiver entity, a notification target can be an <AE> or <CSEBase> resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.21 End-to-AE communication | This procedure shall be used for sending a Notify request to an <AE> resource for the case when the AE represented as the <AE> resource is the final target of the request contained in the notification. When a notification is received at the <AE> resource Hosting CSE, the Hosting CSE shall perform a notify re-targeting (clause 10.2.5.23). In this description, the Receiver is the CSE hosting the <AE> resource. Table 10.2.5.21-1: <AE> NOTIFY <AE> NOTIFY Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.6 Processing at Receiver The Hosting CSE shall re-target the Notify request to the AE according to clause 10.2.5.23 Information in Response message According to clause 10.1.6 Processing at Originator after receiving Response According to clause 10.1.6 Exceptions According to clause 10.1.6 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.22 End-to-CSE communication | This procedure shall be used for sending a Notify request to a <CSEBase> resource for the case when the CSE represented as the <CSEBase> resource is the final target of the request contained in the notification. In this description, the Receiver is the Hosting CSE of the <CSEBase> resource. Table 10.2.5.22-1: <CSEBase> NOTIFY <CSEBase> NOTIFY Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.6 Processing at Receiver According to clause 10.1.6 Information in Response message According to clause 10.1.6 Processing at Originator after receiving Response According to clause 10.1.6 Exceptions According to clause 10.1.6 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 336 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.5.23 Notification Re-targeting | A Notify request to an AE is sent by targeting <AE> resource on a Hosting CSE. If the Hosting CSE verifies access control privilege of the Originator, the Hosting CSE shall re-target the request to the address specified as AE-PoA (i.e. pointOfAccess attribute of <AE> resource). The AE-PoA may be initially configured in the <AE> resource when the AE registers to the Registrar CSE. If the <AE> resource does not contain an AE-PoA, an active communication link, if available, can be used for re-targeting. If neither of them is available, the request cannot be re-targeted to the AE. Figure 10.2.5.23-1: Re-targeting a notification request to an AE |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.6 Discovery-related Procedures | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.6.1 Introduction | This clause details the use of various Filter Criteria which may be provided by an Originator with a request for discovery or filtering purposes. The procedures using Filter Criteria for discovery or filtering purposes are generally termed Discovery-related procedures. Filter criteria are provided by an Originator using the optional request parameter Filter Criteria and are described in table 8.1.2-2. The Filter Criteria set includes matching conditions and filter handling conditions. Matching conditions are evaluated against resources and, when true, determine the matching result. When the Hosting CSE receives the geo-query having the geoQuery Filter Criteria condition, the Hosting CSE shall check whether the location attribute of a target resource matches the geo-Query filter condition that consists of the geometry type, the geo-coordinates and the geo-spatial function type. The Hosting CSE shall compare the geospatial relationship between the geometries (i.e. geometry type and geo-coordinates) in the Filter Criteria and the location attribute. When the two geometries have the relationship as specified in the geo-spatial function, the Hosting CSE shall consider the resource a match to the geoQuery filter conditions. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 337 (oneM2M TS-0001 version 4.15.0 Release 4) For example, there is a container resource having the location attribute configured with a longitude and latitude. When a geo-query requests for descendant resource identifiers of a targeted resource that are "within" (geo-spatial function) a specified "polygon" (geometry type) defined by longitude and latitude pairs (geo-coordinates), the Hosting CSE checks if the longitude and latitude of descendant resources is within the polygon. If yes, the Hosting CSE considers the resource a match to the filter conditions. Filter handling conditions provide additional input used to determine the filtering result. The filter handling condition filterUsage governs the use of Filter Criteria for either Filtering, Discovery/Discovery-based Operations or IPE On- Demand Discovery purposes as follows: Filtering: Filter Criteria are used for filtering purposes when the filterUsage condition is absent and other Filter Criteria are present, or when filterUsage is set to 'conditionalOperation'. The other Filter Criteria conditions are used to evaluate if the operation target resource (i.e. indicated by the To request attribute) meets the specified criteria. The operation is performed only if the criteria is met, therefore such operations are also termed "conditional operations", and are defined by the following characteristics: • The operation is performed subject to access control privileges of the Originator if and only if the target resource meets the matching conditions of the Filter Criteria. • The operation is performed on the specific resource specified by the To request parameter, • The composition and format of the response primitive content is governed by the Result Content request parameter. Discovery: When used for discovery purposes, filterUsage is set to 'discovery', and it applies to Retrieve (R) operations. The other Filter Criteria conditions are used to find one or more target resources in the target resource tree (i.e. descendant resources from the resource indicated by the To request parameter) which meet the specified criteria. Discovery operations are defined by the following characteristics: • A procedure for identification of the target resource set meeting the matching conditions of the Filter Criteria in the resource tree descendants from the resource specified by the To request parameter is performed. More detail about the procedure for identification of target resources is provided in clause 10.2.6.3. The target resources are subject to Discovery access control privileges for the Originator. • The composition and format of the response primitive content is governed by both the Result Content and Desired Identifier Result Type request parameters. Discovery-based Operations: In this case filterUsage is set to 'discoveryBasedOperation', and it applies to Create, Update and Delete (CUD) operations. The other Filter Criteria conditions are used to find one or more target resources in the target resource tree (i.e. descendant resources from the resource indicated by the To request parameter), such that the target resources meet the specified criteria. The operation indicated by the Operation request parameter is performed on all the resources identified as part of the resource target set. Discovery-based operations are defined by the following characteristics: • A procedure for identification of the target resource set meeting the matching conditions of the Filter Criteria in the resource tree descendants from the resource specified by the To request parameter is performed. More detail about the procedure for identification of target resources is provided in clause 10.2.6.4. The target resources are subject to Discovery access control privileges for the Originator. • The operation indicated by the Operation request parameter is performed on all identified target resources, subject to access control privileges for the Originator for the specific operation on each target resource. • The composition and format of the response primitive content is governed by both the Result Content and Desired Identifier Result Type request parameters. IPE On-Demand Discovery: Filtering Criteria are used for IPE-On-Demand Discovery when filterUsage is set to 'IPEOnDemandDiscovery'. This case applies only for Retrieve operations targeting an <AE> resource that represents the IPE and is further detailed in clause 10.2.6.5. The Hosting CSE first processes the request locally as a regular discovery and if no target resources have been discovered, the request is sent to the IPE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 338 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.6.2 Conditional Operations (Filtering) | Conditional operations are all operations where the FilterUsage parameter is 'conditionalOperation'. The Filter Criteria parameters are used for a filtering process before the requested operation is performed. The operation is performed only if the criteria are met. The only procedural difference between regular and conditional operations is that the Hosting CSE verifies that the target resource meets the matching conditions before performing the operation for the target resource, i.e. the resource indicated by the To request attribute. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.6.3 Discovery | Discovery operations are all operations where the FilterUsage parameter is 'discovery' and use of Filter Criteria parameter results in identification of zero or more resources. The following steps describe the procedure of identification of the target resource set: • The Hosting CSE starts the procedure by including in scope all the child/descendant resources of the resource addressed by the To request parameter. The matching resource set shall be identified based on resources meeting the matching filter criteria conditions. • Target resources shall be identified after the filter handling conditions have been applied to the matching resource set, as detailed in clause 8.1.2. The filter handling conditions can contain the parameters for specifying the maximum number of discovered resources included in the target resource set, the maximum number of levels in the resource tree (starting from the root resource), an offset for specifying the number of discovered resources the Hosting CSE shall skip over and exclude from the target resource set and a relative path to be applied after all the matching conditions have been used. Table 8.1.2-2 describes the Filter Criteria parameters. • In addition, the Hosting CSE shall restrict the set of target resources according to the Originator's access control privileges for the Discovery operation. The Hosting CSE shall skip over resources that cannot be discovered due to a lack of discovery privileges but shall include their descendants, if the Originator has discovery privileges on them. The Hosting CSE shall also exclude any <AE> resources whose status is marked as "INACTIVE", as well as any child/descendant resources of these "INACTIVE" <AE> resources. • The Hosting CSE may also implement a configured upper limit on the number of resources in the content. In such a case when the Originator and the Hosting CSE have different upper limits, the smaller of the two shall apply. If no target resources are identified the Hosting CSE shall respond with successful response with an empty content parameter. If one or more target resources are identified the Hosting CSE shall respond with a successful response with the response content based on the Result Content and the Desired Identifier Result Type request parameters. Procedural information, including operation-specific details, is further provided in table 10.2.6.3-1. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 339 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.6.3-1: Discovery (R with filterUsage = 'discovery') Discovery <resource> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: Address of the resource where the target resource identification begins. Filter Criteria: Filter criteria for searching. The filterUsage parameter shall be set to 'discovery' in this case. Result Content: Optional, for the allowed options see clause 8.1.2. Desired Identifier Result Type: optional, format of discovery results returned (see clause 8.1.2 for options applicable to Discovery, and how results shall be displayed). Processing at Originator before sending Request According to clause 10.1.3 with the following: • Setup the RETRIEVE operation in the Request. • Set the filterUsage condition to "discovery". • Include additional filter criteria as desired. Processing at Receiver According to clause 10.1.3 with the following specific processing: • Checks the validity of the Request (e.g. format of Filter Criteria). If Semantic Query Indicator is set the request is considered not valid, since the filterUsage condition is set to 'discoveryBasedOperation'. • May change the filter criteria according to local policies. In addition, the Hosting CSE performs the following steps: • Identification of target resources: The Hosting CSE uses the matching Filter Criteria provided in the request for identifying the target resources (as described in clause 8.1.2). The Hosting CSE then uses the filter handling conditions provided in the request to modify the target resources as described in clause 8.1.2. The Hosting CSE then excludes from the target set any resources that the Originator does not have discovery privileges for. The Hosting CSE skips over resources that cannot be discovered due to a lack of discovery privileges but includes their descendants, if the Originator has discovery privileges on them. The target resource set may be restricted by applying upper limits based on the local policies, in addition to those provided by the Originator. In cases when the Originator and the Hosting CSE have different upper limits, the smaller of the two shall apply. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for Content as follows: • If Result Content is not present or is "discovery-result-references", the response message returns the resource identifiers of the target resources. • If Result Content is present and is set to "child-resource-references", the response message returns the address(es) of the child resources of the filtered resources. • If the target resource set is empty, the response is successful with empty content. The addressing method (see clause 9.3.1) shall be based on the Desired Identifier Result Type parameter in the incoming request for all elements included. • The Content Status and Content Offset parameters provides an indication that the content is partial if the result set is incomplete. The General Exceptions in clause 10.1.3 apply as follows: • If the resource in To parameter does not exist the Receiver responds with an error. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3, with the following: • The request contains invalid parameters. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 340 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.6.4 Discovery-based Operations | Discovery-based operations are all operations where the FilterUsage parameter is 'discoveryBasedOperation'. Discovery-based operations allow the execution of an operation on multiple resources residing on a CSE identified by applying the Filter Criteria parameter rules. The Filter Criteria parameter also provides means for limiting the scope of the filtering results for determination of the target resources for the operation. The following steps describe the procedure of identification of the target resource set: • The Hosting CSE starts the procedure by including in scope all the child/descendant resources under the root of where the discovery begins, as determined by the To request parameter. The matching resource set shall be identified based on resources meeting the matching filter criteria conditions. • Target resources shall be identified after the filter handling conditions have been applied to the matching resource set, as detailed in clause 8.1.2. The filter handling condition can contain the parameters for specifying the maximum number of discovered resources included in the target resource set and a relative path to be applied after all the matching conditions have been used. Table 8.1.2-2 describes the Filter Criteria parameter. • In addition, the Hosting CSE shall restrict the set of target resources according to the Originator's access control privileges for the Discovery operation. The Hosting CSE shall skip over resources that cannot be discovered due to a lack of discovery privileges but shall include their descendants, if the Originator has discovery privileges on them. The Hosting CSE shall also exclude any resources whose status is marked as "INACTIVE", as well as any child/descendant resources of these "INACTIVE" resources. • The Hosting CSE may also implement a configured upper limit on the number of resources in the content. In such a case when the Originator and the Hosting CSE have different upper limits, the smaller of the two shall apply. If no target resources are identified the Hosting CSE shall respond with successful response with a list of requested type, with no entries. If one or more target resources are identified, the Hosting CSE shall verify that performing the operation on the target resource set complies with the service subscription limits of the Originator defined within the Originator's service subscription profile resources (i.e. <m2mServiceSubscriptionProfile>, <serviceSubscribedNode>, <serviceSubscribedAppRules> and <serviceSubscribedUserProfile> resources). Further details for checking the service subscription limits of the Originator are defined in ETSI TS 118 104 [3]. If performing the operation on the target resource set does not comply with the service subscription limits of the Originator, the Hosting CSE shall return an error indicating that the operation cannot be performed on the targeted set of resources due to service subscription limits. If performing the operation on the target resource set does comply with the service subscription limits of the Originator, the Hosting CSE shall perform the requested C, U or D operation on each of the resources included in the target resource set. If errors are encountered in performing the operation on the various targets identified, the Hosting CSE shall track the errors and continue to perform the operation until the resource target list is exhausted. The result of the Discovery-based operation shall be returned to the Originator using a successful Response message. The composition and format of the response primitive is governed by both the Result Content and Desired Identifier Result Type request parameters, as follows: • When the Result Content request parameter is set to "discovery-result-references", the response message returns the resource identifiers of the filtered resources, i.e. target resource set. • When the Result Content request parameter is not present or present and set to a value different than "discovery-result-references", the response message returns an aggregation of all the response primitives (both successful and unsuccessful) generated after execution of the C, U or D operation on all the target resources. Desired Identifier Result Type request parameter applies as follows: • When the Result Content request parameter is set to "discovery-result-references", the addressing method applies to the resource identifiers of the filtered resources, i.e. target resource set. • When the Result Content parameter is set to "attributes+child-resource-references", "child-resource- references", the addressing method applies to the child resource references which are child resource identifiers. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 341 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.6.4-1: Discovery-based CREATE (C with filterUsage = 'discoveryBasedOperation') Discovery-based <resource> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: For the allowed Result Content parameter options see clause 8.1.2. To: Address of the resource where the discovery begins. Filter Criteria: Filter criteria for searching. The filterUsage parameter shall be set to 'discoveryBasedOperation' in this case. Processing at Originator before sending Request According to clause 10.1.2 with the following: • Setup the CREATE operation in the Request. • Include the conditions in the Filter Criteria to determine the resource target set. • Specify the desired format of returned operation results. Processing at Receiver According to clause 10.1.2 with the following specific processing: Checks the validity of the Request (e.g. Content, format of Filter Criteria). May change the Filter Criteria according to local policies. In addition, the Hosting CSE performs the following steps: • Identification of target resources: The Hosting CSE uses the Filter Criteria provided in the request to identify the target resources as described in clause 8.1.2. The Hosting CSE then uses the filter handling conditions provided in the request to modify or restrict the target resources as described in clause 8.1.2. The Hosting CSE then excludes from the target set any resources that the Originator does not have discovery privileges for. The Hosting CSE skips over resources that cannot be discovered due to a lack of discovery privileges but includes their descendants, if the Originator has discovery privileges on them. If the number of resources in the target resource set exceeds policy limits of the Hosting CSE the operation shall be rejected. • Performing the CREATE operation: The Hosting CSE performs the CREATE operation on all the resources included in the target resource set. If errors are encountered in the process the Hosting CSE stores the response and continues the process until the resource target list is exhausted. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for Content as follows: • If Result Content is set to "discovery-result-references", the response message returns the resource identifiers of the target resources. The addressing method (see clause 9.3.1) shall be based on the Desired Identifier Result Type parameter • If Result Content is not present or is present and different than 'discovery- result-references', the Hosting CSE creates a response primitive for each CREATE operation performed and stores them until the resource target list is exhausted. The response contains an aggregate of all the individual response primitives for each CREATE operation performed, both successful and unsuccessful. • If the target resource set is empty, the response is successful with empty content. The General Exceptions in clause 10.1.2 apply as follows: • If the resource in To parameter does not exist, the Receiver responds with an error. • If the provided information in Content is not accepted by the Receiver (e.g. missing mandatory parameter), the Receiver responds with an error. • If the number of resources in the target resource set exceeds policy limits of the Hosting CSE the operation shall be rejected. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2, with the following: • The request contains invalid parameters. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 342 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.6.4-2: Discovery-based UPDATE (U with filterUsage = 'discoveryBasedOperation') Discovery-based <resource> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: Address of the root of where the discovery begins. Filter Criteria: Filter criteria for searching. The filterUsage parameter shall be set to 'discoveryBasedOperation' in this case. Result Content: Optional, for the allowed options see clause 8.1.2. Processing at Originator before sending Request According to clause 10.1.4 with the following: • Setup the UPDATE operation in the Request. • Include the conditions in the Filter Criteria to determine the resource target set. • Specify the desired format of returned operation results. Processing at Receiver According to clause 10.1.4 with the following specific processing: Checks the validity of the Request (e.g. Content, format of Filter Criteria). May change the Filter Criteria according to local policies. In addition, the Hosting CSE performs the following steps: • Identification of target resources: The Hosting CSE uses the Filter Criteria provided in the request to identify the target resources as described in clause 8.1.2. The Hosting CSE then uses the filter handling conditions provided in the request to modify or restrict the target resources as described in clause 8.1.2. The Hosting CSE then excludes from the target set any resources that the Originator does not have discovery privileges for. If the number of resources in the target resource set exceeds policy limits of the Hosting CSE the operation shall be rejected. • Performing the UPDATE operation: The Hosting CSE performs the UPDATE operation on all the resources included in the target resource set. If errors are encountered in the process the Hosting CSE stores the response and continues the process until the resource target list is exhausted. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for Content as follows: • If Result Content is set to "discovery-result-references", the response message returns the resource identifiers of the target resources. The addressing method (see clause 9.3.1) shall be based on the Desired Identifier Result Type parameter. • If Result Content is not present or is present and different than 'discovery- result-references', the Hosting CSE creates a response primitive for each UPDATE operation performed and stores them until the resource target list is exhausted. The response contains an aggregate of all the individual response primitives for each UPDATE operation performed, both successful and unsuccessful. • If the target resource set is empty, the response is successful with empty content. The General Exceptions in clause 10.1.4 apply as follows: • If the resource in To parameter does not exist, the Receiver responds with an error. • If the provided information in Content is not accepted by the Receiver (e.g. missing mandatory parameter), the Receiver responds with an error. • If the number of resources in the target resource set exceeds policy limits of the Hosting CSE the operation shall be rejected. Processing at Originator after receiving Response According to clause 10.1.4. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 343 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.6.4-3: Discovery-based DELETE (D with filterUsage = 'discoveryBasedOperation') Discovery-based <resource> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: Address of the resource where the discovery begins. Filter Criteria: Filter criteria for searching. The filterUsage parameter shall be set to 'discoveryBasedOperation' in this case. Processing at Originator before sending Request According to clause 10.1.5 with the following: • Setup the DELETE operation in the Request. • Include the conditions in the Filter Criteria to determine the resource target set. • Specify the desired format of returned operation results. Processing at Receiver According to clause 10.1.5 with the following specific processing: Checks the validity of the Request (e.g. format of Filter Criteria). May change the Filter Criteria according to local policies. In addition, the Hosting CSE performs the following steps: • Identification of target resources: The Hosting CSE uses the Filter Criteria provided in the request to identify the target resources as described in clause 8.1.2. The Hosting CSE then uses the filter handling conditions provided in the request to modify or restrict the target resources as described in clause 8.1.2. The Hosting CSE then excludes from the target set any resources that the Originator does not have discovery privileges for. If the number of resources in the target resource set exceeds policy limits of the Hosting CSE the operation shall be rejected. • Performing the DELETE operation: The Hosting CSE performs the DELETE operation on all the resources included in the target resource set. If errors are encountered in the process the Hosting CSE tracks stores the response and continues the process until the resource target list is exhausted. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for Content as follows: • If Result Content is set to "discovery-result-references", the response message returns the resource identifiers of the target resources. The addressing method (see clause 9.3.1) shall be based on the Desired Identifier Result Type parameter. • If Result Content is not present or is present and different than 'discovery- result-references', the Hosting CSE creates a response primitive for each DELETE operation performed and stores them until the resource target list is exhausted. The response contains an aggregate of all the individual response primitives for each DELETE operation performed, both successful and unsuccessful. • If the target resource set is empty, the response is successful with empty content. The General Exceptions in clause 10.1.5 apply as follows: • If the resource in To parameter does not exist, the Receiver responds with an error. • If the number of resources in the target resource set exceeds policy limits of the Hosting CSE the operation shall be rejected. Processing at Originator after receiving Response According to clause 10.1.5. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 344 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.6.5 IPE On-Demand Discovery | IPE On-Demand Discovery is an operation where filterUsage is 'IPEOnDemandDiscovery' and applies only for the Retrieve requests targeting an <AE> resource that represents an IPE. It is assumed that the Hosting CSE determines if an <AE> resource represents an IPE from its labels. The Hosting CSE first processes the Retrieve request locally as a regular Discovery operation, as detailed in clause 10.2.6.3. If no target resources have been discovered, the Hosting CSE shall send a NOTIFY request containing the Filter Criteria and the Originator ID of this discovery request to the IPE (i.e. pointOfAccess of the <AE> resource). It is assumed that the IPE has the capability to successfully return resources matching the Filter Criteria conditions, similar to the results of the discovery procedure executed by a Hosting CSE, as detailed in clause 10.2.6.3. If the Hosting CSE receives a successful Notify response from the IPE, the Hosting CSE checks the Originator's "Discover" privilege for the resources listed in the Notify response and composes the request response. If the size of the result list is bigger than the upper limit for the response, the full list is not returned. Instead, an incomplete list is returned and the Content Status provides an indication to the requestor. NOTE: It is assumed that Result Content and Desired Identifier Result Type request parameters are not valid for IPE On Demand Discovery. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7 Group management | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.1 Introduction | This clause describes different procedures for managing membership verification, creation, retrieval, update and deletion of the information associated with a <group> resource. Bulk management of all group member resources by invoking the corresponding operations upon the virtual resource <fanOutPoint> of a <group> resource is detailed. This clause also describes the use of the virtual resource <semanticFanOutPoint> which is supported only if the group hosting CSE supports semantic discovery functionality. This virtual resource, shall be the target of RETRIEVE requests only. Figure 10.2.7.1-1 illustrates in a generic way how addressing a request to the <fanOutPoint> virtual resource on the group Hosting CSE results in a fanning out of the request to the group member resources. The procedures in the figure apply to clauses 10.2.7.6 to 10.2.7.9. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 345 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 10.2.7.1-1: Group content management procedures In step 002, if the group resource, whose fanOutPoint virtual sub-resource is addressed by the request contains a <group> resource suffixed with /fopt as a member resource, the Group Hosting CSE shall address the <fanOutPoint> virtual sub-resource of the member <group> resource in step 3 so that the member <group> resource Hosting CSE can fan out the request to its members correspondingly. In step 004, the CSE hosting the member resource shall check to see if the request has a Group Request Identifier. If it does, this CSE shall check this identifier against the list of Group Request Identifiers that it has stored locally. If a match is found, it shall ignore the current request and respond with an error. If no match is found, it shall proceed with the request and store the Group Request Identifier locally until the expiration of the request expiration time or local policy. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.2 Create <group> | This procedure shall be used for creating a <group> resource. 007: response 001: access resource Local CSE/Hosting CSE Member Hosting CSEs Originator 002: Local processing (CSE checks access right of group resource. A aAnd appends a group request identifier if sub- group is contained. If permitted, the CSE access the group resource and fan out the requests to the member resources of the group) For each member resource 003: access resource 004: Local Processing (Member resource compares the group request identifier with the locally stored identifiers to determine the following operations. Member resource checks access right If permitted, the member resource is accessed by the originator and responds with a success, otherwise shall respond with an error) 005: response 006: CSE converged the responses and respond to issuer AE or CSE Mca / Mcc Mcc Group Hosting CSE member resources ETSI ETSI TS 118 101 V4.15.0 (2022-09) 346 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.7.2-1: <group> CREATE <group> CREATE Information in Request message From: Identifier of the AE or the CSE that initiates the Request. To: The address of the <CSEBase>, <AE>, or <remoteCSE> where the <group> resource is intended to be Created. Content: The representation of the <group> resource for which the attributes are described in clause 9.6.13. Processing at Originator before sending Request The Originator shall request to Create a <group> resource by using the CREATE operation. The request shall address <CSEBase>, <remoteCSE> or <AE> resource of a Hosting CSE. The Request shall also provide memberIDs and may provide expirationTime attributes. For members which are of type <group>, the originator shall suffix the '/fopt' to that 'memberID' during group creation if the originator wants to fan-out the group request to each member of that sub-<group>, else originator shall not suffix the '/fopt' to that 'memberID'. The Originator may be an AE or a CSE. Processing at Receiver For the CREATE procedure, the Receiver shall: • Check if the Originator has CREATE permissions on the target resource. • Check the validity of the provided attributes. • Validate that there are no duplicate members present in the memberIDs attribute. • Validate that the resource type of every member on each member Hosting CSE conforms to the memberType attribute in the request, if the memberType attribute of the <group> resource is not 'mixed'. Set the memberTypeValidated attribute to TRUE upon successful validation. • If specializationType attribute is set and the memberType attribute of the <group> resource is not 'mixed', then validate that the resource type of every member on each member Hosting CSE conforms to the specialized resource type set in specializationType attribute. Set the memberTypeValidated attribute to TRUE upon successful validation. • Upon successful validation of the provided attributes, create a new group resource in the Hosting CSE. If the CSE supports semantic discovery functionality, the Hosting CSE shall also create and set the semanticSupportIndicator attribute to TRUE. • If the registree Member Hosting CSEs and the Group Hosting CSE supports the same type of multicast communication, the Group Hosting CSE shall perform the procedures as specified in clause 10.2.7.13.1. • Conditionally, in the case that the group resource contains temporarily. unreachable Hosting CSE of sub-group resources as member resource, set the memberTypeValidated attribute of the <group> resource to FALSE. • Respond to the Originator with the appropriate generic Response with the representation of the <group> resource if the memberTypeValidated attribute is FALSE, and the address of the created <group> resource if the CREATE was successful. • As soon as any Hosting CSE that hosts the unreachable resource becomes reachable, the memberType validation procedure shall be performed. If the memberType validation fails, the Hosting CSE shall deal with the <group> resource according to the policy defined by the consistencyStrategy attribute of the <group> resource provided in the request. or by default if the attribute is not provided. Information in Response message The representation of the <group> resource if the memberTypeValidated attribute is FALSE. Processing at Originator after receiving Response None. Exceptions No change from the basic procedure in clause 10.1.2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 347 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.3 Retrieve <group> | This procedure shall be used for retrieving <group> resource. Table 10.2.7.3-1: <group> RETRIEVE <group> RETRIEVE Information in Request message From: Identifier of the AE or the CSE that initiates the Request. To: The address of the <group> resource. Processing at Originator before sending Request The Originator shall request to obtain <group> resource information by using the RETRIEVE operation. The request shall address the specific <group> resource of a Hosting CSE. The Originator may be an AE or a CSE. Processing at Receiver No change from the basic procedure in clause 10.1.3. Information in Response message No change from the basic procedure in clause 10.1.3. Processing at Originator after receiving Response None. Exceptions No change from the basic procedure in clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.4 Update <group> | This procedure shall be used for updating an existing <group> resource. Table 10.2.7.4-1: <group> UPDATE <group> UPDATE Information in Request message From: Identifier of the AE or the CSE that initiates the Request. To: The address of the <group> resource. Processing at Originator before sending Request The Originator shall request to update attributes of an existing <group> resource by using an UPDATE operation. The Request shall address the specific <group> resource of a CSE. If originator intends to update memberIDs attribute, for members which are of type <group>, originator shall suffix the '/fopt' to that 'memberID' during group update if the originator wants to fan-out the group request to each member of that sub- <group>, else originator shall not suffix the '/fopt' to that 'memberID'. The Originator may be an AE or a CSE. Processing at Receiver The UPDATE procedure shall be: • Check if the Originator has UPDATE permissions on the <group> resource. • Check the validity of provided attributes. • Validate that there are no duplicated members present in the memberIDs attribute. • Validate that the resource type of every member on each member Hosting CSE conforms to the memberType attribute in the request, if the memberType attribute of the <group> resource is not 'mixed'. Set the memberTypeValidated attribute to TRUE upon successful validation. • Validate that the resource type of every member on each member Hosting CSE conforms to the specialized resource type set in specializationType attribute, if the memberType attribute of the <group> resource is not 'mixed'. Set the memberTypeValidated attribute to TRUE upon successful validation. • Upon successful validation of the provided attributes, update the <group> resource in the Hosting CSE. • Conditionally, if the memberIDs attribute changes and the group includes Multicast Group Information, Group Hosting CSE shall update or delete the Multicast Group Information according to the new group members and trigger the update or delete of <localMulticastGroup> on each member Hosting CSEs. The procedure is specified in clause 10.2.7.15 or 10.2.7.16 correspondingly. • Conditionally, in the case that the <group> resource contains temporarily unreachable Hosting CSE of sub-group resources as members resource set the memberTypeValidated attribute of the <group> resource to FALSE • Respond to the Originator with the appropriate generic response with the representation of the <group> resource if the memberTypeValidated attribute is FALSE, and the address of the created <group> resource if the UPDATE is successful. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 348 (oneM2M TS-0001 version 4.15.0 Release 4) <group> UPDATE • As soon as any Hosting CSE that hosts unreachable resource becomes reachable, the memberType validation procedure shall be performed. If the memberType validation fails, the Hosting CSE shall deal with the <group> resource according to the policy defined by the consistencyStrategy attribute of the <group> resource provided in the request, or by default if the attribute is not provided. Information in Response message The representation of the <group> resource if the memberTypeValidated attribute is FALSE. Processing at Originator after receiving Response None. Exceptions No change from the basic procedure in clause 10.1.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.5 Delete <group> | This procedure shall be used for deleting an existing <group> resource. Table 10.2.7.5-1: <group> DELETE <group> DELETE Information in Request message From: Identifier of the AE or the CSE that initiates the Request. To: The address of the <group> resource. Processing at Originator before sending Request The Originator shall request to delete an existing <group> resource by using the DELETE operation. The request shall address the specific <group> resource of a Hosting CSE. The Originator may be an AE or a CSE This operation shall also delete the child virtual resources <fanOutPoint> and <semanticFanOutPoint>. Processing at Receiver Besides the basic procedure in clause 10.1.5, the receiver shall: • Check if the group includes Multicast Group information, and perform the multicast message fan out procedure to delete the <localMulticastGroup> of member hosting CSEs as specified in clause 10.2.7.16. Information in Response message No change from the basic procedure in clause 10.1.5. Processing at Originator after receiving Response None. Exceptions No change from the basic procedure in clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.6 Create <fanOutPoint> | This procedure does not create a new <fanOutPoint> resource. It is targeted at a <fanOutPoint> itself, and is used to create a new child resource under each member of the <group> that corresponds to that <fanOutPoint>. Table 10.2.7.6-1: <fanOutPoint> CREATE <fanOutPoint> CREATE Information in Request message From: Identifier of the AE or the CSE that initiates the Request. To: The address of the <fanOutPoint> virtual resource. Content: The representation of the resource the Originator intends to create. Group Request Identifier: The group request identifier (present if the request has been forwarded from another <group>). Response Type: If the parameter is set to BlockingSynch, it indicates that the group hosting CSE shall return the aggregated response once. Otherwise if the parameter is set to nonBlockingRequestSynch, nonBlockingRequestAsynch or flexBlocking, it indicates that the Group Hosting CSE shall return the aggregated response in a batched mode. Result Expiration Time: Indicates the maximum time limit in which the Group Hosting CSE has to respond the aggregated response. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 349 (oneM2M TS-0001 version 4.15.0 Release 4) <fanOutPoint> CREATE Processing at Originator before sending Request The Originator shall request to create the resource that have the same content in all member resources belonging to an existing <group> resource by using a CREATE operation. The Request may address the virtual child resource <fanOutPoint> of the specific <group> resource of a group Hosting CSE. The request may also address the address that results from appending a relative address to the <fanOutPoint> address in order to create the resources that have the same content under the corresponding child resources represented by the relative address with respect to all member resources. The Originator may be an AE or CSE. Processing at Group Hosting CSE For the CREATE procedure, the Group Hosting CSE shall: • Check if the Originator has CREATE privilege in the <accessControlPolicy> resource referenced by the membersAccessControlPolicyIDs in the <group> resource. In the case members membersAccessControlPolicyIDs is not provided the access control policy defined for the <group> resource shall be used. • Upon successful validation, obtain the IDs of all member resources from the attribute membersIDs of the addressed <group> resource. • If the group includes Multicast Group Information, the group Hosting CSE shall perform the procedure as described in clause 10.2.7.13.2. • If the request contains a Group Request Target Members parameter, it shall check whether all members contained in this parameter are a subset of the memberIDs attribute of the addressed <group> resource. If true, the request shall be fanned out to the members contained in this parameter only. • If the request contains a Group Somecast Target Number parameter (e.g. having a value of X), it shall check: 1) whether X satisfies 1 ≤ X < the total number of group members; 2) that the Group Somecast Target Number parameter does not co-exist with the Group Request Target Members in the request; 3) whether the somecastEnable attribute is set to true. If so, it shall decide which specific X group members are selected for the fanout operation based on the algorithm defined in the somecastAlgorithm attribute of the parent <group> resource and the request shall be fanned out to those selected X members only. • Generate fan out requests addressing the obtained address (appended with the relative address if any) to the member hosting CSEs as indicated in figure 10.2.7.1-1 which are not in the multicast group. The From parameter in the fanout request is set to the ID of the Originator from the request from the original Originator. The Response Type parameter in the fanout request may be set by the group hosting CSE differently according to its local policy. • In the case that any of these target addresses involve a further <fanOutPoint> and the request to be fanned out does not contain a Group Request Identifier already, generate a unique group request identifier, include it in all the requests to be fanned out and store this group request identifier locally. • If the group Hosting CSE determines that multiple member resources belong to one CSE according to the IDs of the member resources and no multicast group exists for these members, it may converge the requests accordingly before sending out. This may be accomplished by the group Hosting CSE creating a <group> resource on the member hosting CSE to collect all the members on that member hosting CSE. • After receiving the responses from the member hosting CSEs, respond to the Originator with the aggregated results and the associated members list. Depending on the Response Type, the Group Hosting CSE shall: - blockingRequest: respond with the aggregated responses before the Result Expiration Time reaches and discard the member responses received after. - nonBlockingRequestSynch: prepare the operationResult of the <request> resource and indicate that if all the member responses have been aggregated by setting the requestStatus of the <request> resource before the Result Expiration Time reaches. There may be multiple updates of the operationResult attribute. - nonBlockingRequestAsynch: notify with the aggregated response from all or part of the members before the Result Expiration Time reaches. There may be more than one notification. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 350 (oneM2M TS-0001 version 4.15.0 Release 4) <fanOutPoint> CREATE - flexBlocking: continue aggregate the member response until the group hosting CSE determines to send the aggregated responses, if all member responses have been aggregated, respond the aggregated response as in the blockingRequest case. Otherwise, respond an acknowledgement together with the current aggregated member responses and the reference to the created <request> resource. Then continue aggregate and deliver the remaining member response to the Originator as defined in the nonBlockingRequestSynch or the nonBlockingRequestAsynch case. - After the Result Expiration Time, there shall not be any further updates to the aggregated responses. (See note). Processing at Member Hosting CSE For the CREATE procedure, the Member Hosting CSE shall: • Check if the request has a Group Request Identifier and if so, process it as described in step 004 of clause 10.2.7.1. • Check if the original Originator has the CREATE permission on the addressed resource. Upon successful validation, perform the create procedures for the corresponding type of addressed resource as described in other sub-clauses of clause 10.2. • Send the corresponding response to the Group Hosting CSE. Information in Response message Converged responses from member hosting CSEs. Processing at Originator after receiving Response None. Exceptions • Same request with identical Group Request Identifier received. • Originator does not have the CREATE permission to access the <fanOutPoint> resource. • Members in the Group Request Target Members request parameter are not present in the memberIDs attribute of the addressed <group> resource. NOTE: If Result Expiration Time is not provided in the original request from the Originator, the group hosting CSE may decide the timer based on its local policy. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.7 Retrieve <fanOutPoint> | This procedure shall be used for retrieving the content of all member resources belonging to an existing <group> resource. Table 10.2.7.7-1: <fanOutPoint> RETRIEVE <fanOutPoint> RETRIEVE Information in Request message From: Identifier of the AE or the CSE that initiates the Request. To: The address of the <fanOutPoint> virtual resource. Content: The representation of the resource the Originator intends to retrieve. Group Request Identifier: The group request identifier (present if the request has been forwarded from another <group>). Response Type: If the parameter is set to BlockingSynch, it indicates that the group hosting CSE shall return the aggregated response once. Otherwise if the parameter is set to nonBlockingRequestSynch or nonBlockingRequestAsynch, it indicates that the Group Hosting CSE shall return the aggregated response in a batched mode. Result Expiration Time: Indicates the maximum time limit in which the Group Hosting CSE has to respond the aggregated response. Processing at Originator before sending Request The Originator shall request to obtain the resource or specific attributes of all member resources belonging to an existing <group> resource by using a RETRIEVE operation. The request may address the virtual child resource <fanOutPoint> of the specific <group> resource of a group Hosting CSE. The request may also address the address that results from appending a relative address to the <fanOutPoint> address in order to retrieve the corresponding attributes or child resources represented by the relative address with respect to all member resources. The Originator may be an AE or CSE. Processing at Group Hosting CSE For the RETRIEVE procedure, the Group Hosting CSE shall: • Check if the Originator has RETRIEVE permission in the <accessControlPolicy> resource referenced by the membersAccessControlPolicyIDs in the addressed <group> resource. In the case membersAccessControlPolicyIDs is not provided, the access control policy defined for the group resource shall be used. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 351 (oneM2M TS-0001 version 4.15.0 Release 4) <fanOutPoint> RETRIEVE • Upon successful validation, obtain the IDs of all member resources from the membersIDs attribute of the addressed <group> resource. • If the group includes Multicast Group information, the group Hosting CSE shall perform the procedure as described in clause 10.2.7.13.2. • If the request contains a Group Request Target Members parameter, it shall check whether all members contained in this parameter are a subset of the memberIDs attribute of the addressed <group> resource. If true, the request shall be fanned out to the members contained in this parameter only. • If the request contains a Group Somecast Target Number parameter (e.g. having a value of X), it shall check: 1) whether X satisfies 1 ≤ X < the total number of group members; 2) that the Group Somecast Target Number parameter does not co-exist with the Group Request Target Members in the request; 3) whether the somecastEnable attribute is set to true. If so, it shall decide which specific X group members are selected for the fanout operation based on the algorithm defined in the somecastAlgorithm attribute of the parent <group> resource and the request shall be fanned out to those selected X members only. • Generate fan out requests addressing the obtained address (appended with the relative address if any) to the member hosting CSEs as indicated in figure 10.2.7.1-1.The From parameter in the fanout request is set to the ID of the Originator from the request from the original Originator. The Response Type parameter in the fanout request may be set by the group hosting CSE differently according to its local policy. • In the case that any of these target addresses involves a further <fanOutPoint> and the request to be fanned out does not contain a Group Request Identifier already, generate a unique group request identifier, include it in all the requests to be fanned out and store this group request identifier locally. • If the group hosting CSE determines that multiple member resources belong to one CSE according to the IDs of the member resources and no multicast group exists for these members, it may converge the requests accordingly before sending out. This may be accomplished by the group Hosting CSE creating a <group> resource on the member hosting CSE to collect all the members on that member hosting CSE. • After receiving the responses from the member hosting CSEs, respond to the Originator with the aggregated results and the associated members list. Depending on the Response Type, the Group Hosting CSE shall: - BlockingRequest: respond with the aggregated responses before the Result Expiration Time reaches and discard the member responses received after. - nonBlockingRequestSynch: prepare the operationResult of the <request> resource and indicate that if all the member responses have been aggregated by setting the requestStatus of the <request> resource before the Result Expiration Time reaches. There may be multiple updates of the operationResult attribute. - nonBlockingRequestAsynch: notify with the aggregated response from all or part of the members before the Result Expiration Time reaches. There may be more than one notification. - flexBlocking: continue aggregate the member response until the group hosting CSE determines to send the aggregated responses. If all member responses have been aggregated, respond the aggregated response as in the blockingRequest case. Otherwise, respond an acknowledgement together with the current aggregated member responses and the reference to the created <request> resource. Then continue aggregate and deliver the remaining member response to the Originator as defined in the nonBlockingRequestSynch or the nonBlockingRequestAsynch case. - After the Result Expiration Time, there shall not be any further updates to the aggregated responses. (See note) Processing at Member Hosting CSE For the RETRIEVE procedure, the Member Hosting CSE shall: • Check if the request has a Group Request Identifier and if so, process it as described in step 004 of clause 10.2.7.1. • Check if the original Originator has the RETRIEVE permission on the addressed resource. Upon successful validation, perform the retrieve procedures for the corresponding type of addressed resource as described in other sub-clauses of clause 10.2. • Send the corresponding response to the group Hosting CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 352 (oneM2M TS-0001 version 4.15.0 Release 4) <fanOutPoint> RETRIEVE Information in Response message Converged responses from member hosting CSEs. Processing at Originator after receiving Response None. Exceptions • Same request with identical Group Request Identifier received. • Originator does not have RETRIEVE permission to access the <fanOutPoint> resource. • Members in the Group Request Target Members request parameter are not present in the memberIDs attribute of the addressed <group> resource. NOTE: If Result Expiration Time is not provided in the original request from the Originator, the group hosting CSE may decide the timer based on its local policy. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.8 Update <fanOutPoint> | This procedure shall be used for updating the content of all member resources belonging to an existing <group> resource. Table 10.2.7.8-1: <fanOutPoint> UPDATE <fanOutPoint> UPDATE Information in Request message From: Identifier of the AE or the CSE that initiates the Request. To: The address of the <group> resource. Content: The representation of the resource the Originator intend to Update. Group Request Identifier: The group request identifier (present if the request has been forwarded from another <group>). Response Type: If the parameter is set to BlockingSynch, it indicates that the group hosting CSE shall return the aggregated response once. Otherwise if the parameter is set to nonBlockingRequestSynch or nonBlockingRequestAsynch, it indicates that the Group Hosting CSE shall return the aggregated response in a batched mode Result Expiration Time: Indicates the maximum time limit in which the Group Hosting CSE has to respond the aggregated response. Processing at Originator before sending Request The Originator shall request to update all member resources belonging to an existing <group> resource with the same data by using a UPDATE operation. The request may address the virtual child resource <fanOutPoint> of the specific <group> resource of a group Hosting CSE. The request may also address the address that results from appending a relative address to the <fanOutPoint> in order to update the corresponding child resources represented by the relative address with respect to all <members> resources. The Originator may be an AE or CSE. Processing at Group Hosting CSE For the UPDATE procedure, the Group Hosting CSE shall: • Check if the Originator has UPDATE permission in the <accessControlPolicy> resource referenced by the membersAccessControlPolicyIDs in the group resource. In the case members membersAccessControlPolicyIDs is not provided the access control policy defined for the group resource shall be used. • Upon successful validation, obtain the IDs of all member resources from the attribute membersIDs of the addressed <group> resource. • If the group includes Multicast Group information, the group Hosting CSE shall perform the procedure as described in clause 10.2.7.13.2. • If the request contains a Group Request Target Members parameter, it shall check whether all members contained in this parameter are a subset of the memberIDs attribute of the addressed <group> resource. If true, the request shall be fanned out to the members contained in this parameter only. • If the request contains a Group Somecast Target Number parameter (e.g. having a value of X), it shall check: 1) whether X satisfies 1 ≤ X < the total number of group members; 2) that the Group Somecast Target Number parameter does not co-exist with the Group Request Target Members in the request; 3) whether the somecastEnable attribute is set to true. If so, it shall decide which specific X group members are selected for the fanout operation based on the algorithm defined in the somecastAlgorithm attribute of the parent <group> resource and the request shall be fanned out to those selected X members only. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 353 (oneM2M TS-0001 version 4.15.0 Release 4) <fanOutPoint> UPDATE • Generate fan out requests addressing the obtained address (appended with the relative address if any) to the member hosting CSEs as indicated in figure10.2.7.1-1 which are not in the multicast group. The From parameter in the fanout request is set to the ID of the Originator from the request from the original Originator. The Response Type parameter in the fanout request may be set by the group hosting CSE differently according to its local policy • In the case that any of these target addresses involves a further <fanOutPoint> and the request to be fanned out does not contain a Group Request Identifier already, generate a unique group request identifier, include it in all the requests to be fanned out and store this group request identifier locally. • If the group Hosting CSE determines that multiple member resources belong to one CSE according to the IDs of the member resources and no multicast group exists for these members, it may converge the requests accordingly before sending out. This may be accomplished by the group Hosting CSE creating a <group> resource on the member hosting CSE to collect all the members on that member hosting CSE • After receiving the responses from the member hosting CSEs, respond to the Originator with the aggregated results and the associated members list. Depending on the Response Type, the Group Hosting CSE shall: - BlockingRequest: respond with the aggregated responses before the Result Expiration Time reaches and discard the member responses received after. - nonBlockingRequestSynch: prepare the operationResult of the <request> resource and indicate that if all the member responses have been aggregated by setting the requestStatus of the <request> resource before the Result Expiration Time reaches. There may be multiple updates of the operationResult attribute. - nonBlockingRequestAsynch: notify with the aggregated response from all or part of the members before the Result Expiration Time reaches. There may be more than one notification. - flexBlocking: continue aggregate the member response until the group hosting CSE determines to send the aggregated responses, if all member responses have been aggregated, respond the aggregated response as in the blockingRequest case. Otherwise, respond an acknowledgement together with the current aggregated member responses and the reference to the created <request> resource. Then continue aggregate and deliver the remaining member response to the Originator defined in the nonBlockingRequestSynch or the nonBlockingRequestAsynch case. - After the Result Expiration Time, there shall not be any further updates to the aggregated responses. (See note) Processing at Member Hosting CSE For the UPDATE procedure, the Member Hosting CSE shall: • Check if the request has a Group Request Identifier and if so, process it as described in step 004 of clause 10.2.7.1. • Check if the original Originator has the UPDATE permission on the addressed resource. Upon successful validation, perform the update procedures for the corresponding type of addressed resource as described in other sub-clauses of clause 10.2. • Send the corresponding response to the group Hosting CSE. Information in Response message Converged responses from member hosting CSEs. Processing at Originator after receiving Response None. Exceptions • Same request with identical Group Request Identifier received. • Originator does not have UPDATE permission to access the <fanOutPoint> resource. • Members in the Group Request Target Members request parameter are not present in the memberIDs attribute of the addressed <group> resource. NOTE: If Result Expiration Time is not provided in the original request from the Originator, the group hosting CSE may decide the timer based on its local policy. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 354 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.9 Delete <fanOutPoint> | This procedure shall be used for deleting the content of all member resources belonging to an existing <group> resource. Table 10.2.7.9-1: <fanOutPoint> DELETE <fanOutPoint> DELETE Information in Request message From: Identifier of the AE or the CSE that initiates the Request. To: The address of the <fanOutPoint> virtual resource. Content: The representation of the resource the Originator intends to delete. Group Request Identifier: The group request identifier (present if the request has been forwarded from another <group>). Response Type: If the parameter is set to BlockingSynch, it indicates that the group hosting CSE shall return the aggregated response once. Otherwise if the parameter is set to nonBlockingRequestSynch or nonBlockingRequestAsynch, it indicates that the Group Hosting CSE shall return the aggregated response in a batched mode. Result Expiration Time: Indicates the maximum time limit in which the Group Hosting CSE has to respond the aggregated response. Processing at Originator before sending Request The Originator shall request to delete all member resources belonging to an existing <group> resource by using a DELETE operation. The request may address the virtual child resource <fanOutPoint> of the specific <group> resource of a group Hosting CSE. The request may also address the address that results from appending a relative address to the <fanOutPoint> in order to delete the corresponding child resources represented by the relative address with respect to all member resources. The Originator may be an AE or a CSE. Processing at Group Hosting CSE For the DELETE procedure, the <group> Hosting CSE shall: • Check if the Originator has DELETE permission in the <accessControlPolicy> resource referenced by the membersAccessControlPolicyIDs in the <group> resource. In the case membersAccessControlPolicyIDs is not provided the access control policy defined for the group resource shall be used. • Upon successful validation, obtain the IDs of all member resources from the attribute membersIDs of the addressed <group> resource. • If the group includes Multicast Group information, the group Hosting CSE shall perform the procedure as described in clause 10.2.7.13.2. • If the request contains a Group Request Target Members parameter, it shall check whether all members contained in this parameter are a subset of the memberIDs attribute of the addressed <group> resource. If true, the request shall be fanned out to the members contained in this parameter only. • If the request contains a Group Somecast Target Number parameter (e.g. having a value of X), it shall check: 1) whether X satisfies 1 ≤ X < the total number of group members; 2) that the Group Somecast Target Number parameter does not co-exist with the Group Request Target Members in the request; 3) whether the somecastEnable attribute is set to true. If so, it shall decide which specific X group members are selected for the fanout operation based on the algorithm defined in the somecastAlgorithm attribute of the parent <group> resource and the request shall be fanned out to those selected X members only. • Generate fan out requests addressing the obtained address (appended with the relative address if any) to the member hosting CSEs as indicated in figure 10.2.7.1-1 which are not in the multicast group. The From parameter in the fanout request is set to the ID of the Originator from the request from the original Originator. The Response Type parameter in the fanout request may be set by the group hosting CSE differently according to its local policy. • In the case that any of these target addresses involves a further <fanOutPoint> and the request to be fanned out does not contain a Group Request Identifier already, generate a unique group request identifier, include it in all the requests to be fanned out and store this group request identifier locally. • If the <group> Hosting CSE determines that multiple member resources belong to one CSE according to the IDs of the member resources and no multicast group exists for these members, it may converge the requests accordingly before sending out. This may be accomplished by the group Hosting CSE creating a <group> resource on the member hosting CSE to collect all the members on that member hosting CSE. • After receiving the responses from the member hosting CSEs, respond to the Originator with the aggregated results and the associated members list. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 355 (oneM2M TS-0001 version 4.15.0 Release 4) Depending on the Response Type, the Group Hosting CSE shall: - BlockingRequest: respond with the aggregated responses before the Result Expiration Time reaches and discard the member responses received after. - nonBlockingRequestSynch: prepare the operationResult of the <request> resource and indicate that if all the member responses have been aggregated by setting the requestStatus of the <request> resource before the Result Expiration Time reaches. There may be multiple updates of the operationResult attribute. - nonBlockingRequestAsynch: notify with the aggregated response from all or part of the members before the Result Expiration Time reaches. There may be more than one notification. - flexBlocking: continue aggregate the member response until the group hosting CSE determines to send the aggregated responses, if all member responses have been aggregated, respond the aggregated response as in the blockingRequest case. Otherwise, respond an acknowledgement together with the current aggregated member responses and the reference to the created <request> resource. Then continue aggregate and deliver the remaining member response to the Originator as defined in the nonBlockingRequestSynch or the nonBlockingRequestAsynch case. - After the Result Expiration Time, there shall not be any further updates to the aggregated responses. (See note) Processing at Member Hosting CSE For the DELETE procedure, the member hosting CSE shall: • Check if the request has a Group Request Identifier and if so, process it as described in step 004 of clause 10.2.7.1. • Check if the original Originator has the DELETE permission on the addressed resource. Upon successful validation, perform the delete procedures for the corresponding type of addressed resource as described in other sub-clauses of clause 10.2. • Send the corresponding response to the Group Hosting CSE. Information in Response message Converged responses from member hosting CSEs. Processing at Originator after receiving Response None. Exceptions • Same request with identical Group Request Identifier received. • Originator does not have DELETE permission to access the <fanOutPoint> resource. • Members in the Group Request Target Members request parameter are not present in the memberIDs attribute of the addressed <group> resource. NOTE: If Result Expiration Time is not provided in the original request from the Originator, the group hosting CSE may decide the timer based on its local policy. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.10 Subscribe and Un-Subscribe <fanOutPoint> of a group | The following procedure shall be used for receiving information about modifications of all member resources belonging to an existing <group> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 356 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.7.10-1: <fanOutPoint> Subscribe <fanOutPoint> Subscribe Information in Request message From: Identifier of the AE or CSE that initiates the request. To: The address of the <fanOutPoint> resource appended with the ID of the <subscription> resource to be created. Group Request Identifier: The group request identifier (present if the request has been forwarded from another <group>). Processing at Originator before sending Request The Originator shall request to create a subscription resource under all member resources belonging to an existing <group> resource by using a CREATE operation. The request may address the virtual child resource <fanOutPoint> of the specific <group> resource of a group Hosting CSE. The request may also address the address that results from appending a relative address to the <fanOutPoint> in order to create the corresponding subscription to the resource represented by the relative address with respect to all member resources. In both cases the targeted resource(s) shall be the parents of the newly created <subscription> resource(s). The request shall include notificationForwardingURI attribute if the Originator wants the group Hosting CSE to aggregate the notifications. The request shall include the required information and may include the optional information as described in subscription management clause 10.2.10. The Originator may be an AE or a CSE. Processing at Group Hosting CSE The <group> Hosting CSE shall: • Check if the Originator has CREATE privilege in the <accessControlPolicy> resource referenced by the membersAccessControlPolicyIDs in the group resource. In the case membersAccessControlPolicyIDs is not provided the access control policy defined for the group resource shall be used. • If the subscription resource in the request contains a notificationForwardingURI attribute, assign a URI to replace the notificationURI of the subscription resource which will be used to receive notifications from member hosting CSEs. The ID of the <group> resource shall be set to the groupID attribute of the <subscription> resource. The group Hosting CSE shall maintain the mapping of the generated notificationURI and the former notificationURI. • Upon successful validation, obtain the IDs of all member resources from the attribute membersIDs of the addressed <group> resource. • If the group includes Multicast Group Information, the group Hosting CSE shall perform the procedure as described in clause 10.2.7.13.2. • If the request contains a Group Request Target Members parameter, it shall check whether all members contained in this parameter are a subset of the memberIDs attribute of the addressed <group> resource. If true, the request shall be fanned out to the members contained in this parameter only. • If the request contains a Group Somecast Target Number parameter (e.g. having a value of X), it shall check: 1) whether X satisfies 1 ≤ X < the total number of group members; 2) that the Group Somecast Target Number parameter does not co-exist with the Group Request Target Members in the request; 3) whether the somecastEnable attribute is set to true. If so, it shall decide which specific X group members are selected for the fanout operation based on the algorithm defined in the somecastAlgorithm attribute of the parent <group> resource and the request shall be fanned out to those selected X members only. • Generate fan out requests addressing the obtained address (appended with the relative address if any) to the member hosting CSEs as indicated in figure 10.2.7.1-1 which are not in the multicast group. The From parameter in the fanout request is set to the ID of the Originator from the request from the original Originator. The Response Type parameter in the fanout request may be set by the group hosting CSE differently according to its local policy. • In the case that any of these target addresses involves a further <fanOutPoint> and the request to be fanned out does not contain a Group Request Identifier already, generate a unique group request identifier, include it in all the requests to be fanned out and store this group request identifier locally. • If the group Hosting CSE determines that multiple members resources belong to one CSE according to the IDs of the member resources, it may converge the requests accordingly before sending out. This may be accomplished by the <group> Hosting CSE creating a <group> resource on the member hosting CSE to collect all the members on that member hosting CSE. • After receiving the responses from the member hosting CSEs, respond to the Originator with the aggregated results and the associated members list. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 357 (oneM2M TS-0001 version 4.15.0 Release 4) <fanOutPoint> Subscribe Processing at Member Hosting CSE For the subscribe/un-subscribe procedure, the member hosting CSE shall treat the request received from the group Hosting CSE as a normal SUBSCRIBE request on the addressed member resource as if it comes from the original Originator. Therefore the member hosting CSE shall: • Check if the request has a Group Request Identifier and if so, process it as described in step 004 of clause 10.2.7.1. • Check if the original Originator has the READ permission on the members resource. • Upon successful validation, perform the subscribe procedures for the corresponding type of member resource as described in clause 10.2.10. • Send the corresponding response to the group Hosting CSE. Information in Response message Converged responses from member hosting CSEs. Processing at Originator after receiving Response None. Exceptions • Same request with identical Group Request Identifier received. • Originator does not have CREATE permission to access the <fanOutPoint> resource. • Members in the Group Request Target Members request parameter are not present in the memberIDs attribute of the addressed <group> resource. Un-subscribing to the members of a <group> resource uses the "Delete <fanOutPoint>" procedure defined in clause 10.2.7.9. A typical example of how the subscription is established is as follows. The Originator is creating subscription resource on Member-1 resource, Member-2 resource and Member-3 resource. Member-2 resource and Member-3 resource are members of Group-2 resource. Member-1 resource and Group-2 resource are members of Group-1 resource. In this case, Group-2 resource is the sub-group of Group-1 resource. Figure 10.2.7.10-1: Example of subscription through group Originator sends the <subscription> resource creation request to <fanOutPoint> of Group-1 resource. The Originator intends the Group-1 Hosting CSE to aggregate the notifications, thus, the Originator sets the notificationForwardingURI identical with notificationURI which is address-1 which is the address where the notification is supposed to be sent. On receiving the request, the Group-1 Hosting CSE fans out the <subscription> creation request to address Member-1 resource and <fanOutPoint> resource of Group-2 resource. As notificationForwardingURI is set by the Originator, the Group-1 Hosting CSE allocates address-2 to receive aggregated notifications and put address-2 in the notificationURI of <subscription> resource to be fanned out. Originator Group-1 Member-1 Group-2 Member-2 Member-3 <subscription> notificationURI = address-1 notificationForwardingURI = address-1 <subscription> notificationURI = address-2 notificationForwardingURI = address-1 <subscription> notificationURI = address-3 notificationForwardingURI = address-1 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 358 (oneM2M TS-0001 version 4.15.0 Release 4) On receiving the request, the Group-2 Hosting CSE fans out the <subscription> creation request to address Member-2 resource and Member-3 resource. As notificationForwardingURI is set, the Group-2 Hosting CSE allocates address-3 to receive aggregated notifications and put address-3 in the notificationURI of <subscription> resource to be fanned out. The mapping between address-2 and address-3 is maintained by the Group-2 Hosting CSE. On receiving the request by any of the Member Hosting CSE, <subscription> resource is created. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.11 Aggregate the Notifications by group | This procedure shall be used for the group Hosting CSE to aggregate the notifications from member hosting CSEs and forward the aggregated notification to the subscriber. Table 10.2.7.11-1: Aggregation of Notifications by group Aggregate Notifications by group Information in Request message The same as table 10.2.10.7-1. Processing at Originator before sending Request (Member Hosting CSE) Whenever the resource that is subscribed-to is modified in a way that matches the policies as is specified in clause 9.6.8, notification needs to be sent to the subscriber, the Members Hosting CSE shall: • Notify the subscriber at the notificationURI and include the notificationForwardingURI in the notification, if it exists. Processing at Group Hosting CSE For the notification procedure, the Group Hosting CSE shall: • On receiving the notifications from the member hosting CSEs at the notificationURI generated by the group Hosting CSE during fanning out the <subscription> creation request, validate if the notification is sent from its member resource and contains a notificationForwardingURI attribute. • Upon successful validation, aggregate the notifications which have the same notificationForwardingURI for the duration specified in notifyAggregation or until the number of notifications specified in notifyAggregation are received, whichever occurs first. • Send the aggregated notification to the subscriber according to the notificationForwardingURI in the notification. In the case the addressed group is the member of another group through which the subscription is created the notification shall be sent to the notificationURI assigned by the group hosting CSE which contains the addressed group as the sub-group according to the mapping of the notificationURI maintained by the addressed group. • Wait for the response. After receiving the response, split the response and respond to the members hosting CSEs separately. • The group Hosting CSE may stop aggregating the notifications when the expirationTime of the corresponding subscription expires. Processing at Member Hosting CSE The subscriber shall treat every notification extracted from the aggregated notification as a separate notification received from the subscribed resource and generate corresponding responses. The subscriber shall aggregate the responses to these notifications and send the aggregated response to the group Hosting CSE. Information in Response message According to clause 10.1.6. Processing at Originator after receiving Response According to clause 10.1.6. Exceptions According to clause 10.1.6. The example of aggregating notification following example in clause 10.2.7.10 is as follows. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 359 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 10.2.7.11-1: Example of aggregating notifications Member Hosting CSEs sends notifications to their corresponding Group Hosting CSEs. In this example, Member-2 Hosting CSE and Member-3 Hosting CSE send notifications to address-3 which is the address allocated by the Group-2 Hosting CSE. Member-1 Hosting CSE sends notifications to address-2 which is the address allocated by the Group-1 Hosting CSE. On receiving notifications by the Group-2 Hosting CSE at address-3, Group-2 Hosting CSE aggregates the notification that has notificationForwardingURI as address-1, as Group-2 Hosting CSE maintains the mapping of address-3 and address-2, and sends the aggregated notification to address-2. On receiving notifications by the Group-1 Hosting CSE at address-2, Group-1 Hosting CSE aggregates the notification that has notificationForwardingURI as address-1, as Group-1 Hosting CSE receives <subscription> resource with notificationURI address-1, Group-1 Hosting CSE send the aggregated notification to address-1. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.12 Retrieve <semanticFanOutPoint> | This procedure shall be used for performing semantic discovery or semantic query procedure using the descriptor content of all member <semanticDescriptor> resources belonging to an existing <group> resource. The Hosting CSE support of semantic discovery functionality via <semanticFanOutPoint> virtual resource is indicated by the semanticSupportIndicator attribute set to TRUE. For detailed descriptions of the semantic discovery procedure see oneM2M TS-0034 [14], clause 6.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.13 Multicast Group Management Procedures | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.13.0 Introduction | In case the multicasting is used to fan-out group operations to members of a <group> resource, the Group Hosting CSE shall maintain information specified in table 10.2.7.13.0-1 pertaining to the multicast group(s) that are applicable to a <group> resource, such as the mapping relationship between the member resources and the multicast address(es) and the target URI(s) in the fan out requests. For each multicast group of a <group> resource, there may be multiple records of Multicast Group Information. The Group Hosting CSE should manage and index the multiple records by internal identifier for each Multicast Group Information. The definition of the internal identifier is out of scope of the present document. Originator Group-1 Member-1 Group-2 Member-2 Member-3 Notification to address-1 Notification to address-2 Notification to address-3 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 360 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.7.13.0-1: Multicast Group Information managed by Group Hosting CSE Information Multiplicity Description groupID 1 Indicates the <group> resource identifier which the Multicast Group Information belongs to. multicastType 1 Indicates the underlying networks multicast capability of the group members, the value is the same as the attribute multicastCapability of the <remoteCSE>. See clause 9.6.4. externalGroupID 0..1 See table 9.6.44-2. multicastAddress 1 See table 9.6.44-2. multicastGroupFanoutTarget 1 See table 9.6.44-2. memberList 1(L) See table 9.6.44-2. groupServiceServerAddress 0..1 It shall be present only when the multicastType is 3GPP_MBMS_group, and it is the address of 3GPP group service server (e.g. SCEF). TMGI 0..1 The Temporary Mobile Group Identity is allocated to identify the MBMS bearer service as specified in ETSI TS 123 246 [i.32]. It is used to communicate with 3GPP networking with externalGroupID together. TMGIExpiration 0..1 Indicates the duration of the TMGI expiration time as specified in ETSI TS 123 468 [i.33]. responseTimeWindow 0..1 Defines the upper bound on the amount of delay the Member Hosting CSE shall wait before sending a response message. The Member Hosting CSE shall wait a randomized time that is less than the value of this attribute. This randomized delay helps prevent network congestion caused by multiple Member Hosting CSEs responding at the same time as one another. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 361 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.13.1 Multicast Group Information and <localMulticastGroup> Creation Procedures | Originator Group Hosting CSE Member Hosting CSE1 001 Create <group> Request 005 Create <localMulticastGroup> Request Member Hosting CSE2 005 Create <localMulticastGroup> 007 Create <localMulticastGroup> Response 007 Create <localMulticastGroup> Response 003 Create <group> Response 002 Create <group> Resource 004 Create Multicast Group Information 006 Join in the multicast group, and then create <localMulticastGroup> 006 Join in the multicast group, and then create <localMulticastGroup> 008 Checks the response messages from members Figure 10.2.7.13.1-1: Multicast Group Information and <localMulticastGroup> creation procedures Figure 10.2.7.13.1-1 illustrates how the Multicast Group Information and <localMulticastGroup> resource works on the Group Hosting CSE and the group members Hosting CSEs. Step 001: The Originator sends a group resource creation request to the Group Hosting CSE which includes member resource identifier list consisting of multiple resources hosted on Member Hosting CSEs. For example, different member resources identifiers are: • /CSExx1/aa • /CSExx1/bb • /CSExx2/cc • /CSExx2/dd Step 002: The Group Hosting CSE shall create the group resource as requested. Step 003: The Group Hosting CSE shall return the group creation response to the Originator. Step 004: The Group Hosting CSE shall check the multicastCapability attribute of each Member Hosting CSE's <remoteCSE> resource to determine whether it could create a multicast group. If no member hosting CSEs support multicast capability or no more than one Member Hosting CSE supports the same multicast capability, then the Group Hosting CSE shall not create a multicast group. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 362 (oneM2M TS-0001 version 4.15.0 Release 4) If at least two Member Hosting CSEs support the same multicast capability, the Group Hosting CSE determines to create multicast group, and performs all the actions: assign the multicast type based on the multicast capability, and allocate multicast address and multicast address type to the member resources of the multicast group. For a guide to an allocation scheme of IPv4 and IPv6 multicast address spaces, reference the specification documents such as IETF RFC 3171 [i.34] and IETF RFC 4291 [i.35]. • If the multicastType is 3GPP_MBMS_group, and the Member Hosting CSEs have the same externalGroupID, the Group Hosting CSE shall set the externalGroupID to the same value as the externalGroupID of the Member Hosting CSEs, set the responseTarget to the CSE-ID of the <CSEBase> resource of the Group Hosting CSE, set the memberList to the members defined in the request, allocate a virtual fan out target for multicastGroupFanoutTarget according to the member resource identifiers, and establish the mapping relationship between the fanout target and the member resource identifiers. NOTE 1: Additional details for creating a 3GPP MBMS group are specified in clause 7.7.3.1 of ETSI TS 118 126 [15]. • If the multicastType is IP_multicast_group, the Group Hosting CSE shall set the memberList to the members defined in the request, allocate a virtual fan out target for multicastGroupFanoutTarget according to the member resource identifiers, establish the mapping relationship between the fanout target and the member resource identifiers and set the Group Hosting CSE resourceID as the responseTarget. NOTE 2: The current group based multicast can only be used when Member Hosting CSE and Group Hosting CSE have a registration relationship. For example, the Group Hosting IN-CSE can create a multicast group for Member Hosting MN/ASN-CSEs, and cannot create a multicast group for Member Hosting CSEs which are not registered to the IN-CSE. NOTE 3: The current group based multicast can only be applied between CSEs. NOTE 4: The externalGroupID is pre-provisioned in the operator's network. The service provider and the operator need ensure that the externalGroupID assigned by the operator matches the externalGroupID attribute of each Member Hosting CSE's <CSEBase> resource. The Group Hosting CSE shall create Multicast Group Information locally and establish a mapping relationship between the multicast address and the fanout target according to the member resource identifiers on the Member Hosting CSE. The multicastGroupFanoutTarget should be set to / {groupHostingCSE-ID}/ {fanout-segment}. The multicastGroupFanoutTarget should be uniquely assigned by the Group Hosting CSE. {fanout-segment} is a string assigned by the Group Hosting CSE. In this example, the Multicast Group Information is illustrated in figure 10.2.7.13.1-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 363 (oneM2M TS-0001 version 4.15.0 Release 4) <CSEBase> <group> ResourceID /CSE090112 Group-for-service1 CSE-ID Group Hosting CSE Multicast Group Information groupID: /CSE090112/grp1 multicastType: IP_multicast_group multicastAddress: [FF32:30:3FFE:FFFF:1::1234] multicastGroupFanoutTarget:/ CSE090112/froIPmulticast1 memberList: /CSExx1/aa /CSExx1/bb /CSExx2/cc /CSExx2/dd Figure 10.2.7.13.1-2: Multicast Group Information Step 005: The Group Hosting CSE shall send <localMulticastGroup> creation request which carries a mapping relationship between the multicastGroupFanoutTarget and the member resources to the Member Hosting CSEs to advertise them to join the multicast group corresponding to the multicast address in unicast mode. If the Group Hosting CSE determines that multiple members resources belong to one Member Hosting CSE according to the IDs of the members resources, it may converge the requests accordingly before sending out. In this example, the Group Hosting CSE should send two group advertisement messages to the two Member Hosting CSEs respectively. Step 006: The Member Hosting CSEs receive the creation request and shall use a multicast management protocol such as MLD or IGMP to join the multicast group corresponding to the multicast address indicated in the multicast group advertisement. The Member Hosting CSEs shall create the < localMulticastGroup > after successfully joining the multicast group and store a mapping relationship between the multicastGroupFanoutTarget and the multicast address, and a mapping relationship between the member list and the multicast address. In this example, both the ASN-CSE1 and ASN-CSE2 create each <localMulticastGroup> resource to record to which multicast group its local member resources have joined. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 364 (oneM2M TS-0001 version 4.15.0 Release 4) <CSEBase> <localMulticast Group> memberList /CSExx1 /CSExx1/aa /CSExx1/bb CSE-ID ASN-CSE1 multicastGroupFano utTarget /CSE090112/ forIPMulticast1 parentGroupID /CSE090112/grp1 multicastAddress [FF32:30:3FFE:FFFF:1::1234] responseTarget /CSE090112 <CSEBase> <localMulticast Group> memberList /CSExx2 /CSExx2/cc /CSExx2/dd CSE-ID ASN-CSE2 multicastGroupFano utTarget /CSE090112/ forIPMulticast1 parentGroupID /CSE090112/grp1 multicastAddress [FF32:30:3FFE:FFFF:1::1234] responseTarget /CSE090112 Figure 10.2.7.13.1-3: <localMulticastGroup> resource in Member Hosting CSE Step 007: The members Hosting CSEs shall send the response to the Group Hosting CSE. Step 008: The Group Hosting CSE shall check the response messages from Member Hosting CSEs, if at least two members respond successfully, the Group Hosting CSE shall keep Multicast Group Information locally. Otherwise, the Group Hosting CSE shall delete the information. NOTE 5: The Group Hosting CSE may create one or more sets of Multicast Group Information according to the member resources of the group resource created by the Originator. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 365 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.13.2 Multicast Group member Fan out Procedures | Originator Group Hosting CSE Member Hosting CSE1 001 Access the <fanOutPoint> Request Member Hosting CSE2 006 Send response Message 008 Access the <fanOutPoint> Response 006 Send response Message 002 Fanout procedure according to the multicast type Case A: multicastType = 3GPP_MBMS_group 003a Group message delivery using MBMS CaseB: multicastType = IP_mulicast_group 003b Group message delivery using IP multicast 004 Request Process. 005 Compose rsponse for Group hosting CSE about the result 007 Aggregate access results Figure 10.2.7.13.2-1: Multicast Group Information fan out procedures Step 001: The Originator sends an access <fanOutPoint> request carrying the group resource identifier for accessing member resources to the Group Hosting CSE. Step 002: The Group Hosting CSE shall check whether there is Multicast Group Information, according to the group resource identifier. If the group has Multicast Group Information, check the multicast type: Case A): The multicast type is 3GPP_MBMS_group. Step 003a: The Group Hosting CSE shall get the externalGroupID based on the groupID in the Multicast Group Information, then send request message to the group service Server (e.g. SCEF) to perform TMGI allocation and Group Message request of the 3GPP MBMS group message procedure, as specified in the ETSI TS 118 126 [15]. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 366 (oneM2M TS-0001 version 4.15.0 Release 4) Case B): The multicast type is IP_multicast_group. Step 003b: The Group Hosting CSE shall send the member resource access request to the Member Hosting CSEs in multicast mode according to the multicast address of the multicast group, which includes the multicastGroupFanoutTarget as the fan out target address corresponding to the member resource in the group resource. If Request Expiration Timestamp is not in the request from the Originator, the Group Hosting CSE shall set the Request Expiration Timestamp in the multicast request according to the local policy. Step 004: The Member Hosting CSE receives from the multicast address a member resource access request, which carries the fan out target matching the multicastGroupFanoutTarget of a <localMulticastGroup> resource that contains the same multicast address. It shall determine that the local member resource identifiers as the final targets of the request by the mapping relationship between the memberList and multicastGroupFanoutTarget in the <localMulticastGroup> resource, then replaces the multicastGroupFanoutTarget with the determined member resource identifiers and executes the operation indicated by the resource access request. The Member Hosting CSEs shall not return any Acknowledgement when receiving the message from the multicast address. Step 005: The Member Hosting CSEs shall compose the response message for Group Hosting CSE about the access result: set To parameter value to the responseTarget of <localMulticastGroup> resource according to the Response Type in the request; and set From parameter value to CSE-ID of Member Hosting CSE. Step 006: The Member Hosting CSEs shall send the response message including the access results to the Group Hosting CSE. Step 007: The Group Hosting CSE shall determine a multicast response message according to the From and the Request Identifier in message, then aggregate the group member resource access results in the response messages from Member Hosting CSEs. The Group Hosting CSE shall not return any response after parsing the Notification message content which is response message to the multicast request. Step 008: The Group Hosting CSE returns the aggregated group member resource access result to the Originator. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.14 Create <localMulticastGroup> | This procedure shall be used for creating <localMulticastGroup> resource. Table 10.2.7.14-1: <localMulticastGroup> CREATE <localMulticastGroup> CREATE Information in Request message From: Identifier of the group Hosting CSE that initiates the Request. To: The address of the <localMulticastGroup> resource. Content: The representation of the <localMulticastGroup> resource for which the attributes are described in clause 9.6.44. Processing at Originator before sending Request Besides the basic procedures described in clause 10.1.2, the Multicast Group Information shall be created and maintained by the group Hosting CSE. The group Hosting CSE shall configure the group Hosting CSE as the only entity who has the CRUD privileges to the <localMulticastGroup> by configuring the corresponding <accessControlPolicy> resource. Processing at Receiver Besides the basic procedures described in clause 10.1.2, the receiver shall also comply with the multicast management protocol such as MLD or IGMP to join the multicast group and create the <localMulticastGroup> resource as specified in clause 10.2.7.13.1. Information in Response message According to clause 10.1.2. Processing at Originator after receiving Response None. Exceptions If the Receiver responds with an error, the group Hosting CSE shall delete the receiver's information from the Multicast Group Information maintained locally. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 367 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.15 Retrieve <localMulticastGroup> | This procedure shall be used for retrieving <localMulticastGroup> resource. Table 10.2.7.15-1: <group> RETRIEVE <group> RETRIEVE Information in Request message From: Identifier of the CSE that initiates the Request. To: The address of the <localMulticastGroup> resource. Processing at Originator before sending Request The Originator shall request to obtain <localMulticastGroup> resource information by using the RETRIEVE operation. The request shall address the specific <localMulticastGroup> resource of a Hosting CSE. Processing at Receiver No change from the basic procedure in clause 10.1.3. Information in Response message No change from the basic procedure in clause 10.1.3. Processing at Originator after receiving Response None. Exceptions No change from the basic procedure in clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.16 Update <localMulticastGroup> | This procedure shall be used for updating <localMulticastGroup> resource. Table 10.2.7.16-1: <localMulticastGroup> UPDATE <localMulticastGroup> UPDATE Information in Request message From: Identifier of the CSE that initiates the Request. To: The address the <localMulticastGroup> resource. Content: The representation of the <localMulticastGroup> resource for which the attributes are described in clause 9.6.44. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response None. Exceptions None. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.