IoT Data Management (IoTDM) Supported onem2m functionalities This Document describes the list of onem2m functionalities the IoTDM project supports as part of the release (June 2015). Contacts lflorit@cisco.com, iotdm-dev@lists.opendaylight.org Table of Contents 1 Overview... 2 2 Detailed list of supported functions... 2 2.1 Southbound protocols... 2 2.2 Resources... 2 2.2.1 CSEBase... 2 2.2.2 AE... 3 2.2.3 Container... 4 2.2.4 ContentInstance... 6 2.2.5 Subscription... 7 2.3 CRUDs... 11 2.3.1 Request messages... 11 2.3.2 Response messages... 13 2.4 Discovery... 13 2.5 Resource Addressing... 14
1 Overview IoT Data Management is an IoT middleware providing data collection facility for IoT things. It is implemented on open daylight. It follows as closely as possible the latest onem2m specifications. Version 1 is publicly available at http://www.onem2m.org/technical/published-documents onem2m has a large scope. We don t intend to implement all of it. The subset we have selected is described in details in this document. We have reused tables from the specification so it is very easy to make the link between what we support in IoTDM and what is defined in the specification. The intent is to have a minimal functional system capable of supporting CRUD ( create retrieve update delete notify) operations on a limited set of resources namely CSEBase, AE, container, contentinstance, subscription. Other resources will be supported in subsequent phases. We support CoAP and HTTP as south bound protocols. Also in phase 1, we will focus on a single system operation. We may add support for distributed systems in later phases. If you see our implementation doesn t match the specification, please let us know. 2 Detailed list of supported functions 2.1 Southbound protocols JSO over CoAP and HTTP will be supported in release 1. MQTT bindings is defined by onem2m so its implementation should be straightforward. We are hoping to leverage contributions for that protocol. 2.2 Resources In phase 1, we will support the minimum amount of resources needed to enable data collection. These resources are CSEBase, AE, container, contentinstance, subscription. We will add support for other resources in phase 2. ote that some attributes may not be supported as indicated below 2.2.1 CSEBase The table below shows which attribute will be supported in phase 1 ( lithium)
Attributes of <CSEBase> Multiplicity RW/ RO/ WO Description Phase 1 resourcetype 1 RO See clause 9.6.1.3 where this common resourceid 1 RO See clause 9.6.1.3 where this common resourceame 1 WO See clause 9.6.1.3 where this common creationtime 1 RO See clause 9.6.1.3 where this common lastmodifiedtime 1 RO See clause 9.6.1.3 where this common accesscontrolpolicyids 0..1 (L) RO See clause 9.6.1.3 where this common labels 0..1 (L) RO See clause 9.6.1.3 where this common csetype 0..1 RO Indicates the type of CSE represented by the created resource. Mandatory for an I-CSE, hence multiplicity (1). Its presence is subject to SP configuration in case of an AS- CSE or a M-CSE. CSE-ID 1 RO The CSE identifier in SP-relative CSE-ID format (clause 7.2). supportedresourcetype 1 (L) RO List of the resource types which are supported in the CSE. This attribute contains subset of resource types listed in clause 9.2. This also includes the supported optional attributes for each supported resource type. pointofaccess 1 (L) RO Represents the list of physical addresses to be used by remote CSEs to connect to this CSE (e.g. IP address, FQD). This attribute is exposed to its Registree. nodelink 0..1 RO The resourceid of a <node> resource that represents the node specific information. notificationcongestionpo 0..1 RO This attribute applies to CSEs generating subscription licy notifications. It specifies the rule which is applied when the storage of notifications for each subscriber (an AE or CSE) reaches the maximum storage limit for notifications for that subscriber. E.g. Delete stored notifications of lower notificationstoragepriority to make space for new notifications of higher notificationstoragepriority, or delete stored notifications of older creationtime to make space for new notifications when all notifications are of the same notificationstoragepriority. OTE: All the attributes of this resource type can be changed by an offline configuration mechanism, but not over the reference points (all attributes are "RO"). 2.2.2 AE The table below shows which attribute will be supported in phase 1 ( lithium)
Attributes of <AE> Multiplicity RW/ RO/ WO Description resourcetype 1 RO See clause 9.6.1.3 where this common resourceid 1 RO See clause 9.6.1.3 where this common resourceame 1 WO See clause 9.6.1.3 where this common parentid 1 RO See clause 9.6.1.3 where this common expirationtime 1 RW See clause 9.6.1.3 where this common accesscontrolpolicyids 0..1 (L) RW See clause 9.6.1.3 where this common creationtime 1 RW See clause 9.6.1.3 where this common lastmodifiedtime 1 RO See clause 9.6.1.3 where this common labels 0..1 (L) RO See clause 9.6.1.3 where this common announceto 0..1 (L) RW See clause 9.6.1.3 where this common announcedattribute 0..1 (L) RW See clause 9.6.1.3 where this common appame 0..1 RW The name of the application, as declared by the application developer(e.g. "HeatingMonitoring"). Several sibling resources may share the appame. App-ID 1 WO The identifier of the Application (see clause 7.1.2). AE-ID 1 RO The identifier of the Application Entity (see clause 7.1.2). pointofaccess 0..1 (L) RW The list of addresses for communicating with the registered Application Entity over Mca reference point via the transport services provided by Underlying etwork (e.g. IP address, FQD, URI). This attribute shall be accessible only by the AE and the Hosting CSE. If this information is not provided, the AE should use <pollingchannel> resource. Then the Hosting CSE can forward a request to the AE without using the PoA. ontologyref 0..1 RW A URI of the ontology used to represent the information that is managed and understood by the AE. nodelink 0..1 RO The resourceid of a <node> resource that stores the node specific information where the AE resides. Release 1: 2.2.3 Container The table below shows which attribute will be supported in phase 1 ( lithium)
Attributes of <container> Multiplicity RW/ RO/ WO Description resourcetype 1 RO See clause 9.6.1.3 where this common resourceid 1 RO See clause 9.6.1.3 where this common resourceame 1 WO See clause 9.6.1.3 where this common parentid 1 RO See clause 9.6.1.3 where this common expirationtime 1 RW See clause 9.6.1.3 where this common accesscontrolpolicyids 0..1 (L) RW See clause 9.6.1.3 where this common If no accesscontrolpolicyids are provided at the time of creation, the accesscontrolpolicyids of the parent resource is linked to this attribute labels 0..1 (L) RO See clause 9.6.1 where this common creationtime 1 RW See clause 9.6.1.3 where this common lastmodifiedtime 1 RO See clause 9.6.1.3 where this common statetag 1 RO See clause 9.6.1.3 where this common announceto 0..1 (L) RW See clause 9.6.1.3 where this common announcedattribute 0..1 (L) RW See clause 9.6.1.3 where this common creator 1 RW The AE-ID or CSE-ID of the entity which created the resource. maxrofinstances 0..1 RW Maximum number of instances of <contentinstance> child resources. maxbytesize 0..1 RW Maximum number of bytes that are allocated for a <container> resource for all instances in the <container> resource. maxinstanceage 0..1 RW Maximum age of the instances of <contentinstance> resources within the <container>. The value is expressed in seconds. currentrofinstances 1 RO Current number of instances in a <container> resource. It is limited by the maxrofinstances. currentbytesize 1 RO Current size in bytes of data stored in total using child <contentinstance> resources of a <container> resource. It is limited by the maxrofbytes. locationid 0..1 RW An ID of the resource where the attributes/policies that define how location information are obtained and managed. This attribute is defined only when the <container> resource is used for containing location information. ontologyref 0..1 RW A reference (URI) of the ontology used to represent the information that is stored in the child <contentinstance> resources of the present <container> resource (see note). OTE: The access to this URI is out of scope of onem2m. Release 1: Phase 2
2.2.4 ContentInstance The table below shows which attribute will be supported in phase 1 ( lithium)
Attributes of <contentinstance> Multiplicity RW/ RO/ WO Description resourcetype 1 RO See clause 9.6.1.3 where this common resourceid 1 RO See clause 9.6.1.3 where this common resourceame 1 WO See clause 9.6.1.3 where this common parentid 1 RO See clause 9.6.1.3 where this common labels 0..1 (L) WO See clause 9.6.1.3 where this common creator 0..1 WO See clause 9.6.1.3 where this common expirationtime 1 RW See clause 9.6.1.3 where this common creationtime 1 RO See clause 9.6.1.3 where this common lastmodifiedtime 1 RO See clause 9.6.1.3 where this common announceto 0..1 (L) RW See clause 9.6.1.3 where this common announcedattribute 0..1 (L) RW See clause 9.6.1.3 where this common contentinfo 0..1 WO Information on the content that is needed to understand the content. This attribute is a composite attribute. It is composed first of an Internet Media Type (as defined in the IETF RFC 6838) describing the type of the data, and second of an encoding information that specifies how to first decode the received content. Both elements of information are separated by a separator defined in onem2m TS-0004 [Error! Reference source not found.]. Release 1: Phase 2 contentsize 1 RO Size in bytes of the content attribute. ontologyref 0..1 WO A reference (URI) of the ontology used to represent the information that is stored in the contentinstances resources of the <container> resource. If this attribute is not present, the contentinstance resource inherits the ontologyref from the parent <container> resource if present OTE: Access to this URI is out of scope of onem2m. content 1 WO Actual content of a contentinstance. This content may be opaque data for understandable with the help of the contentinfo. This may, for example, be an image taken by a security camera, or a temperature measurement taken by a temperature sensor. 2.2.5 Subscription
The table below shows which attribute will be supported in phase 1 ( lithium)
Attributes of <subscription> Multiplicity RW/ RO/ WO Description Release 1: resourcetype 1 WO See clause 9.6.1.3 where this common resourceid 1 RO See clause 9.6.1.3 where this common resourceame 1 WO See clause 9.6.1.3 where this common parentid 1 RO See clause 9.6.1.3 where this common expirationtime 1 RW See clause 9.6.1.3 where this common Phase 2 creationtime 1 RO See clause 9.6.1.3 where this common lastmodifiedtime 1 RO See clause 9.6.1.3 where this common labels 1 (L) RW See clause 9.6.1.3 where this common accesscontrolpolicyids 0..1 (L) RW See clause 9.6.1.3 where this common If no accesscontrolpolicyids is given at the time of creation, the accescontrolpolicies of the parent resource is linked to this attribute. eventotificationcriteria 0..1 (L) RW This attribute (notification policy) indicates the event criteria for which a notification is to be generated. expirationcounter 0..1 RW This attribute (notification policy) indicates that the subscriber wants to set the life of this subscription to a limit of a maximum number of notifications. When the number of notifications sent reaches the count of this counter, the <subscription> resource shall be deleted, regardless of any other policy. notificationuri 1 (L) RW List of URI(s) and/or address(es) where the resource subscriber will receive notifications. URI(s) in the list may not represent the resource subscriber entity. For a group-related subscription, the notificationuri shall be the URI that is generated by the group Hosting CSE to receive notifications. In this case, the resource subscriber notification URI shall be included in the notificationforwardinguri. groupid 0..1 RW The ID of a <group> resource in case the subscription is made through a group. notificationforwardinguri 0..1 RW The attribute is a forwarding attribute that shall be present only for group related subscriptions. It represents the resource subscriber notification URI. It shall be used by group Hosting CSE for forwarding aggregated notifications. See clauses 10.2.7.11 and 10.2.7.12. batchotify 0..1 RW This attribute (notification policy) indicates that the subscriber wants to receive batches of notifications rather than receiving them one at a time. This attribute expresses the subscriber's notification policy and may include two values: the number of notifications to be batched for delivery and a duration. When either value is set, notification events are temporarily stored until either the specified number of notifications have been batched, or, until a duration which starts after the first notification was generated has expired. Following which the batched notifications are sent. If batchotify is used simultaneously with latestotify, only the latest notification shall be sent and have the Event Category set to "latest". ratelimit 0..1 RW This attribute (notification policy) indicates that the subscriber wants to limit the rate at which it receives notifications. This attribute expresses the subscriber's notification policy and includes two values: a maximum number of events that may be sent within some duration, and the ratelimit window duration. When the number of generated notifications within the ratelimit window duration exceeds the maximum number, notification events are temporarily stored, until the end of the window duration, when the sending of notification events restarts in the next window duration. The sending of notification events continues as long as the maximum Partial (see below)
Attributes of <subscription> Multiplicity RW/ RO/ WO Description number of notification events is not exceeded during the window duration. The ratelimit policy may be used simultaneously with other notification policies. presubscriptionotify 0..1 WO This attribute (notification policy) indicates that the subscriber wants to be sent notifications for events that were generated prior to the creation of this subscription. This attribute has a value of the number of prior notification events requested. If up-to-date caching of retained events is supported on the Hosting CSE and contains the subscribed events then prior notification events will be sent up to the number requested. The presubscriptionotify policy may be used simultaneously with any other notification policy. pendingotification 0..1 RW This attribute (notification policy), if set, indicates how missed notifications due to a period of connectivity (according to the reachability and notification schedules). The possible values for pendingotification are: "sendlatest" "sendallpending" This policy depends upon caching of retained notifications on the hosted CSE. When this attribute is set to "sendlater", only the last notification shall be sent and it shall have the Event Category set to "latest". If this attribute is not present, the Hosting CSE sends no missed notifications. This policy applies to all notifications regardless of the selected delivery policy (batchotify, latestotify, etc.) ote that unreachability due to reasons other than scheduling is not covered by this policy. notificationstoragepriority 0..1 RW Indicates that the subscriber wants to set a priority for this subscription relative to other subscriptions belonging to this same subscriber. This attribute sets a number within the priority range. When storage of notifications exceeds the allocated size, this policy is used as an input with the storage congestion policy (notificationcongestionpolicy) specified in clause 9.6.3 to determine which stored and generated notifications to drop and which ones to retain. latestotify 0..1 RW This attribute (notification policy) indicates if the subscriber wants only the latest notification. If multiple notifications of this subscription are buffered, and if the value of this attribute is set to true, then only the last notification shall be sent and it shall have the Event Category value set to "latest". notificationcontenttype 1 RW Indicates a notification content type that shall be contained in notifications. The allowed values are: modified attributes only whole resource optionally the reference to this subscription resource. notificationeventcat 0..1 RW This attribute (notification policy) indicates the subscriber's requested Event Category to be used for notification messages generated by this subscription. creator 0..1 WO AE-ID or CSE-ID which created the <subscription> resource. subscriberuri 0..1 WO URI that is sent a notification when this <subscription> is deleted. Release 1: eventotificationcriteria supported in phase 1 is described in the table below
Condition tag Multiplicity Matching condition createdbefore 0..1 The creationtime attribute of the resource is chronologically before the specified value. createdafter 0..1 The creationtime attribute of the resource is chronologically after the specified value. modifiedsince 0..1 The lastmodifiedtime attribute of the resource is chronologically after the specified value. unmodifiedsince 0..1 The lastmodifiedtime attribute of the resource is chronologically before the specified value. statetagsmaller 0..1 The statetag attribute of the resource is smaller than the specified value. statetagbigger 0..1 The statetag attribute of the resource is bigger than the specified value. expirebefore 0..1 The expirationtime attribute of the resource is chronologically before the specified value. expireafter 0..1 The expirationtime attribute of the resource is chronologically after the specified value. sizeabove 0..1 The contentsize attribute of the <contentinstance> resource is equal to or greater than the specified value. sizebelow 0..1 The contentsize attribute of the <contentinstance> resource is smaller than the specified value. resourcestatus 0..n When the subscribed-to resource is changed by the operations or expiration, the resource status is the same as the specified value. Possible values are: child created, updated, child deleted, deleted. If child created or child deleted is configured, other eventotificationcriteria conditions shall be applied to the created or deleted child resource. otification contains the contents for a created child resource or deleted child resource based on value of notificationcontenttype attribute. If this condition is not specified, the default value is updated. operationmonitor 0..n The operations accessing the subscribed-to resource matches with the specified value. It allows monitoring which operation is attempted to the subscribed-to resource regardless of whether the operation is performed. This feature is useful when to find malicious AEs. Possible string arguments are: create, retrieve, update, delete. attribute 0..n This is an attribute name of resource types (clause 9.6). E.g. creator of container resource type can be used as "creator=sam". When multiple attributes are set then the result is based upon the AD of all attributes. Release 1: 2.3 CRUDs CRUD operations can be expressed in various ways. The tables below show which message fields will be supported in phase 1. 2.3.1 Request messages
Request message parameter\operation Create Retrieve Update Delete otify Release 1: Operation - operation to be executed M M M M M To - the address of the target resource on M M M M M the target CSE From - the identifier of the message M M M M M Originator Request Identifier - uniquely identifies a M M M M M Request message Resource Type - of resource to be created M /A /A /A /A ame - of resource to be created O /A /A /A /A Content - to be transferred M O M /A M Originating Timestamp - when the message was built Request Expiration Timestamp - when the request message expires Result Expiration Timestamp - when the result message expires Operational Execution Time - the time when the specified operation is to be executed by the target CSE Response Type - type of response that shall be sent to the Originator Result Persistence - the duration for which the reference containing the responses is to persist Result Content - the expected components of the result Event Category - indicates how and when the system should deliver the message Delivery Aggregation - aggregation of requests to the same target CSE is to be used Group Request Identifier - Identifier added to the group request that is to be fanned out to each member of the group Filter Criteria - conditions for filtered retrieve operation Discovery Result Type - format of information returned for Discovery operation O O O O /A O O O O /A /A O /A /A /A /A O /A /A /A ( blockingrequ est only) (see below details) Result Content - the expected components of the result. Value Interpretation Release 1: 0 nothing 1 attributes 2 hierarchical address 3 hierarchical address and attributes 4 attributes and child resources 5 attributes and child resource references 6 child resource references 7 original resource OTE: See clause Error! Reference source not found. Request message parameter data types
Response message parameter/success or not Response Code - successful, unsuccessful, ack Request Identifier - uniquely identifies a Request message Content - to be transferred To - the identifier of the Originator or the Transit CSE that sent the corresponding nonblocking request From - the identifier of the Receiver Originating Timestamp - when the message was built Result Expiration Timestamp - when the message expires Event Category - what event category shall be used for the response message Status Code - (e.g. authorization timeout, etc.) 2.3.2 Response messages Response Code = Ack Response Code = successful: Operation = Create Response Code = successful: Operation = Retrieve Response Code = successful. Operation = Update Response Code = successful. Operation = Delete Response Code = successful Operation = otify Response Code = unsuccessful Operation = C,R,U,D or Release 1: M M M M M M M M M M M M M M O (address of <request> resource if response is ACK of a nonblocking request) O (The address and/or the content of the created resource) M (the retrieved resource content or aggregated contents of discovered resources) O (The content replaced in an existing resource. The content of the new attributes created. The name of the attributes deleted.) O (The content actually deleted) /A O (Additional error info) O O O O O O /A O O O O O 2.4 Discovery Allows tree discovery below a given resource such as: GET /root?label=one&label=two&createdbefore=2014-01-01t00:00:00&limit=128&filterusage=discovery. The example discovers a maximum of 128 resources matching the following logical condition: createdbefore < 2014-01-01T00:00:00 AD (label = one OR label = two). Support for the table below is on-going ;-)
Condition tag Multiplicity Matching condition createdbefore 0..1 The creationtime attribute of the resource is chronologically before the specified value. createdafter 0..1 The creationtime attribute of the resource is chronologically after the specified value. modifiedsince 0..1 The lastmodifiedtime attribute of the resource is chronologically after the specified value. unmodifiedsince 0..1 The lastmodifiedtime attribute of the resource is chronologically before the specified value. statetagsmaller 0..1 The statetag attribute of the resource is smaller than the specified value. statetagbigger 0..1 The statetag attribute of the resource is bigger than the specified value. expirebefore 0..1 The expirationtime attribute of the resource is chronologically before the specified value. expireafter 0..1 The expirationtime attribute of the resource is chronologically after the specified value. labels 0..n The labels attributes of the resource matches the specified value. resourcetype 0..n The resourcetype attribute of the resource is the same as the specified value. It also allows differentiating between normal and announced resources. sizeabove 0..1 The contentsize attribute of the <contentinstance> resource is equal to or greater than the specified value. sizebelow 0..1 The contentsize attribute of the <contentinstance> resource is smaller than the specified value. contenttype 0..n The contentinfo attribute of the <contentinstance> resource matches the specified value. limit 0..1 Limitation the number of matching resources to the specified value. attribute 0..n This is an attribute of resource types (clause 9.6). Therefore, a real tag name is variable and depends on its usage. E.g. creator of container resource type can be used as a filter criteria tag as "creator=sam". filterusage 0..1 Indicates how the filter criteria is used. E.g. if this parameter is not provided, the Retrieve operation is for generic retrieve operation. If filterusage is provided, the Retrieve operation is for resource <discovery> (clause 10.2.6). Release 1: for discovery 2.5 Resource Addressing on-hierarchical and Hierarchical CSE-relative addressing are supported in Release 1: