hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.7.2.3 UE Communication Failure | Interoperability Test Description Identifier: TD_M2M_SH_32 Objective: UE Communication Failure scenario Configuration: M2M_CFG_11 References: oneM2M TS-0026 [15], clause 7.4.3 Pre-test conditions: • UE, SCEF and IN-CSE are attached to the underlying 3GPP network • IN-AE has created an Application Entity resource <AE> on IN-CSE • ADN-AE has created an Application Entity resource <AE> on IN-CSE • ADN-AE has created a Node resource <node> on IN-CSE representing UE • ADN-AE has created a Schedule resource <schedule> on IN-CSE under <node> resource. The networkCoordinated attribute is set to TRUE • IN-AE has subscribed to the <schedule> resource by creating a child <subscription> resource. • IN-CSE has subscribed to to the SCEF to receive notifications (monitoringType = COMMUNICATION_FAILURE) Test Sequence Step RP Type Description 1 Stimulus UE communication failure occurs 2 IOP Check Check if possible SCEF has received a Monitoring Event Report 3 (T8) Mcn PRO Check HTTP SCEF receives the report and sends Monitoring Notification Report for COMMUNICATION_FAILURE to IN-CSE: • Method = POST • URI = {notification_uri} • Payload shall include MonitoringNotification data structure with the following attributes included in the request: subscription, configResults, cancelInd, monitoringEventReports (externalIDs, monitoringType, failureCause). 4 (T8) Mcn PRO Check HTTP IN-CSE responds to the Monitoring Notification Report request: Status code = 204 (NO CONTENT) 5 IOP Check Check if possible that IN-CSE has updated the <schedule> resource to indicate that UE is available and created new scheduleElement 6 (T8) Mcn PRO Check HTTP SCEF sends a UE Communication Failure Monitoring Event Notification Request to IN- CSE: • Method = POST • URI = {notification_uri} • Payload shall include MonitoringNotification data structure with the following attributes included in the request: subscription, configResults, cancelInd, monitoringEventReports (externalIDs, monitoringType, failureCause) 7 (T8) Mcn PRO Check HTTP IN-CSE responds to the UE Communication Failure Monitoring Notification: Status code = 204 (NO CONTENT) 8 IOP Check Check if possible that IN-CSE has updated the scheduleElement of the <schedule> resource to indicate that no communications are currently available Check if possible that notification has been sent to the <schedule> resource subscribed entities IOP Verdict PRO Verdict ETSI ETSI TS 118 113 V3.3.1 (2021-09) 155 oneM2M TS-0013 version 3.3.1 Release 3 |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.7.2.4 Roaming Status | Interoperability Test Description Identifier: TD_M2M_SH_33 Objective: Roaming status scenario Configuration: M2M_CFG_09 References: oneM2M TS-0026 [15], clause 7.4.6 Pre-test conditions: • UE, SCEF and IN-CSE are attached to the underlying 3GPP network • IN-CSE can make Roaming Status Reports requests • ADN-AE has created an Application Entity resource <AE> on IN-CSE • ADN-AE has created a Node resource <node> on IN-CSE representing UE. roamingStatus and networkID attributes of <node> resource are configured. • IN-CSE has subscribed to to the SCEF to receive notifications (monitoringType = ROAMING_STATUS) Test Sequence Step RP Type Description 1 Stimulus Roaming status of UE has changed 2 IOP Check Check if possible SCEF has received a Monitoring Event Report 3 (T8) Mcn PRO Check HTTP SCEF receives the report and sends Monitoring Notification Report for ROAMING_STATUS to IN-CSE: • Method = POST • URI = {notification_uri} • Payload shall include MonitoringNotification data structure with the following attributes included in the request: subscription, configResults, cancelInd, monitoringEventReports (externalIDs, monitoringType, plmnId, roamingStatus) 4 (T8) Mcn PRO Check HTTP IN-CSE responds to the DDN Failure Monitoring Notification: Status code = 204 (NO CONTENT) 5 IOP Check Check if possible that IN-CSE has updated roamingStatus and networkID attributes the <node> resource IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.7.2.5 Location updating triggered by retrieval | Interoperability Test Description Identifier: TD_M2M_SH_34 Objective: Location Reporting scenario Configuration: M2M_CFG_09 References: oneM2M TS-0026 [15], clause 7.4.7.2 Pre-test conditions: • UE, SCEF and IN-CSE are attached to the underlying 3GPP network • ADN-AE has created an Application Entity resource <AE> on IN-CSE • IN-CSE has subscribed to to the SCEF to receive notifications (monitoringType = LOCATION_REPORTING) Test Sequence Step RP Type Description 1 Stimulus IN-AE sends a < locationPolicy> CREATE request 2 (T8) Mcn PRO Check Primitive • op = 1 (Create) • to = {CSEBaseName} • fr = IN-AE-ID • rqi = (token-string) • ty = 10 (LocationPolicy) • pc = Serialized representation of <locationPolicy> resource o locationSource = Netwrork based o locationUpdatePeriod = 0 o locationTargetID = M2M-Ext-ID of the UE o locationInformationType = position fix o retrieveLastKnownLocation = TRUE/FALSE 3 IOP Check Check if possible that IN-CSE has created <locationPolicy> resource 4 Stimulus AE is requested to send a Retrieve Request for a <latest> content instance ETSI ETSI TS 118 113 V3.3.1 (2021-09) 156 oneM2M TS-0013 version 3.3.1 Release 3 Interoperability Test Description 5 (T8) Mcn PRO Check Primitive • op = 2 (Retrieve) • to = {CSEBaseName}/URI of <container> resource/la • fr = IN-AE-ID • rqi = (token-string) • pc = empty 6 (T8) Mcn PRO Check HTTP IN-CSE makes Monitoring Event Subscription request to retrieve current location of UE • Method = POST • URI = {apiRoot}/3gpp-monitoring-event/v1/{scsAsId}/subscriptions/ • Payload shall include MonitoringEventSubscription data structure with the following attributes included in the request: externalId, notificationDestination, monitoringType, supportedFeatures, maximumNumberOfReports, monitorExpireTime, accuracy. • locationType = CURRENT_KNOWNLOCATION 7 (T8) Mcn PRO Check HTTP SCEF sends a Monitoring Event Subscription Response message to the IN-CSE • Status code = 201 (CREATED) • Location header = {apiRoot}/3gpp-monitoring- event/v1/{scsAsId}/subscriptions/{subscriptionId} • Payload shall include NiddConfiguration data structure with the following attributes included in the request: monitoringEventReport, self 8 IOP Check Check if possible that SCEF detected and retrieved location of UE 9 (T8) Mcn PRO Check HTTP SCEF sends a Monitoring Event Report message to the IN-CSE: • Method = POST • URI = {notification_uri} • Payload shall include MonitoringEventSubscription data structure with the following attributes included in the request: subscription, configResults, cancelid,monitoring, EventReports (externalID, monitoringType, locatonInfo) 10 (T8) Mcn PRO Check HTTP IN-CSE responds to the DDN Failure Monitoring Notification: Status code = 204 (NO CONTENT) 11 IOP Check Check if possible that IN-CSE has created a new <contentInstance> child resource of the <container>. The <contentInstance> contains the UE's current location 12 (T8) Mcn PRO Check HTTP IN-CSE sends a Monitoring Event Subscription message to the SCEF: • Method = POST • URI = {apiRoot}/3gpp-monitoring-event/v1/{scsAsId}/subscriptions/ • Payload shall include MonitoringEventSubscription with the following attributes included in the request: subscription, configResults, cancelid,monitoringEventReports (externalID, monitoringType, locatonInfo) • locationType = LAST_KNOWNLOCATION 13 (T8) Mcn PRO Check HTTP SCEF sends a Monitoring Event Report message to the IN-CSE: • Method = POST • Response code = 201 (CREATED) • URI = {apiRoot}/3gpp-monitoring-vent/v1/{scsAsId}/subscriptions/{subscriptionId} • Payload shall include MonitoringEventSubscription data structure with the following attributes included in the request: self, monitoringEnentReport 14 IOP Check Check if possible that SCEF receives a last known location information of UE 15 (T8) Mcn PRO Check HTTP SCEF sends a Monitoring Notification Report message to the IN-CSE for LOCATION_REPORTING: • Method = POST • URI = {notification_uri} • Payload shall include MonitoringEventSubscription data structure with the following attributes included in the request: subscription, configResults, cancelid,monitoringEventReports 16 (T8) Mcn PRO Check HTTP IN-CSE responds to the Monitoring Notification: Status code = 204 (NO CONTENT) 17 IOP Check Check if possible that IN-CSE has created a new <contentInstance> child resource of the <container> containing the UE's last known location in this <contentInstance> 18 (T8) Mcn PRO Check HTTP • rsc = 2000 (OK) • rqi = (token-string) same as received in request message pc = Serialized representation of latest <contentInstance> resource, created after acquiring location info from SCEF 19 IOP Check AE indicates successful operation NOTE: Steps: 12-17 are only applicable, if retrieveLastKnownLocation is set to TRUE. PRO Verdict ETSI ETSI TS 118 113 V3.3.1 (2021-09) 157 oneM2M TS-0013 version 3.3.1 Release 3 |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.7.3 3GPP Based Device triggering | |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.7.3.1 General Procedure for 3GPP Based Device Triggering | Interoperability Test Description Identifier: TD_M2M_SH_35 Objective: IN-AE triggers ADN-AE hosted on UE Configuration: M2M_CFG_09 References: oneM2M TS-0026 [15], clause 7.5.1 Pre-test conditions: • UE, SCEF and IN-CSE are attached to the underlying 3GPP network • ADN-AE has created an Application Entity resource <AE> on IN-CSE • ADN-AE is available to receive the Device Trigger Requests (triggerEnable = "TRUE") Test Sequence Step RP Type Description 1 Stimulus IN-AE sends a request to create a <triggerRequest> 2 Mca PRO Check Primitive • op = 1 (Create) • to = {CSEBaseName}/{AE-ID}/ • fr = AE-ID • rqi = (token-string) • ty = 47 (triggerRequest) • pc = Serialized representation of < triggerRequest > resource 3 IOP Check Check if possible that IN-CSE has created <triggerRequest> resource 4 (T8) Mcn PRO Check HTTP IN-CSE sends a Device Triggering request to the SCEF • Method = POST • URI = {apiRoot}/3gpp-device-triggering/v1/{scsAsId}/transactions • Payload shall include DeviceTriggering data structure with the following attributes included in the request: supportedFeatures, validityPeriod, triggerPayload, externalId, applicationPortID, notificationDestination, priority 5 IOP Check Check that SCEF has responded to IN-CSE for Device Triggering request Check that SCEF has delivered the device trigger message to the UE hosting ADN-AE Check that SCEF has delivered the Device Triggering Delivery Report Notification request to IN-CSE 6 IOP Check Check that IN-CSE has responded to SCEF the Device Triggering Delivery Report Notification request Check if possible that IN-CSE has updated triggerStatus attribute of <triggerRequest> resource Check that IN-CSE has responded to IN-AE for <triggerRequest> Create request 7 IOP Check Check that ADN-AE has performed the trigger actions IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.7.3.2 3GPP Based Device Trigger Recall/Replace Procedure | Interoperability Test Description Identifier: TD_M2M_SH_36 Objective: IN-AE recalls/replaces a trigger request targeting ADN-AE hosted on UE that has been already created in IN-CSE Configuration: M2M_CFG_09 References: oneM2M TS-0026 [15], clause 7.5.2 Pre-test conditions: • UE, SCEF and IN-CSE are attached to the underlying 3GPP network • ADN-AE has created an Application Entity resource <AE> on IN-CSE • ADN-AE is available to receive the Device Trigger Requests (triggerEnable = "TRUE") • <triggerRequest> resource targeting ADN-AE has been created in IN-CSE • IN-CSE has already sent a device trigger request to the underlying 3GPP network Test Sequence Step RP Type Description 1 Stimulus IN-AE sends a request to UPDATE/DELETE a <triggerRequest> ETSI ETSI TS 118 113 V3.3.1 (2021-09) 158 oneM2M TS-0013 version 3.3.1 Release 3 Interoperability Test Description 2 Mca PRO Check Primitive • op = 3 (Update) / 4 (Delete) • to = {CSEBaseName}/{AE-ID}/{URI of <triggerRequest> resource} • fr = AE-ID • rqi = (token-string) • pc = Serialized representation of < triggerRequest > resource (for UPDATE only) 3 IOP Check Check if possible that IN-CSE has created <triggerRequest> resource 4 (T8) Mcn PRO Check HTTP IN-CSE sends a Trigger UPDATE (Replace) / DELETE (Recall) Request to the SCEF • Method = PUT/DELETE • URI = {apiRoot}/3gpp-device-triggering/v1/{scsAsId}/transactions • (For Trigger UPDATE only) Payload shall include DeviceTriggering data structure with the following attributes included in the request: supportedFeatures, validityPeriod, triggerPayload, externalId, applicationPortID, notificationDestination, priority 5 IOP Check Check that SCEF has recalled/replaced the trigger Check that SCEF responded to IN-CSE for Device Trigger Recall/Replace Check that SCEF has delivered the device trigger message to the UE hosting ADN-AE Check that SCEF has delivered the Device Triggering Delivery Report Notification request to IN-CSE 6 IOP Check Check if possible that IN-CSE has updated triggerStatus attribute of <triggerRequest> resource / deleted <triggerRequest> resource Check that IN-CSE has responded to IN-AE for <triggerRequest> UPDATE/DELETE request IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.7.4 Configuration of traffic patterns | Interoperability Test Description Identifier: TD_M2M_SH_37 Objective: IN-CSE translates the oneM2M Node Traffic Pattern (TP) into a 3GPP Device Communication Pattern Configuration: M2M_CFG_09 References: oneM2M TS-0026 [15], clause 7.6 Pre-test conditions: • UE, SCEF and IN-CSE are attached to the underlying 3GPP network • ADN-AE hosted on UE has created an Application Entity resource <AE> on IN- CSE • IN-CSE has established relationship with MNO and is allowed to request Configuration of Device Communication Patterns. Test Sequence Step RP Type Description 1 Stimulus ADN-AE sends a request to create an activityPatternElements attribute in <AE> resource 2 Mca PRO Check Primitive • op = 3 (Update) • to = {CSEBaseName}/{AE-ID} • fr = AE-ID • rqi = (token-string) • pc = Serialized representation of <AE> resource 3 IOP Check Check if possible that IN-CSE has updated <AE > resource 4 (T8) Mcn PRO Check HTTP IN-CSE sends a Communication Patterns Configuration creation request to the SCEF • Method = POST • URI = {apiRoot}/3gpp-cp-parameter-provisioning/v1/{scsAsId}/subscriptions • Payload shall include DeviceTriggering data structure with the following attributes included in the request: externalId, supportedFeatures, cpParameterSets 5 IOP Check Check if possible that underlying 3GPP network elements has stored the new/updated CP parameter Check that SCEF has responded to IN-CSE for Communication Patterns Configuration request IOP Verdict PRO Verdict ETSI ETSI TS 118 113 V3.3.1 (2021-09) 159 oneM2M TS-0013 version 3.3.1 Release 3 |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.7.5 Group message delivery using MBMS | |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.7.5.1 Create MBMS Group | Interoperability Test Description Identifier: TD_M2M_SH_38 Objective: IN-AE creates a MBMS Group for handling group related requests Configuration: M2M_CFG_12 References: oneM2M TS-0026 [15], clause 7.7.3.1 Pre-test conditions: • Member Hosting CSE, SCEF and Group Hosting CSE are attached to the underlying 3GPP network • Member Hosting CSE on UE has created a <RemoteCSE> resource on Group Hosting CSE • IN-AE has created an Application Entity resource <AE> on Group Hosting CSE • The MBMS service area information provided by the MNO is configured in the oneM2M System • External Group Identifiers for the devices have been pre-provisioned in the oneM2M System Test Sequence Step RP Type Description 1 Stimulus IN-AE is requested to send a group Create Request 2 Mca PRO Check Primitive • op = 1 (Create) • to = {CSEBaseName} • fr = AE-ID • rqi = (token-string) • ty = 9 (group) • pc = Serialized representation of <group> resource 3 IOP Check Check if possible that the <group> resource is created in Registrar CSE Check if possible that multicastType attribute of the Multicast Group Information is set to 3GPP_MBMS_group 4 Mca PRO Check Primitive Group Hosting CSE responds to IN-AE: • rsc = 2001 (CREATED) • rqi = (token-string) same as received in request message • pc = Serialized representation of <group> resource 5 (T8) Mcn PRO Check HTTP Group Hosting CSE sends a Allocate TMGI Request to the SCEF • Method = POST • URI = {apiRoot}/3gpp-group-message-delivery-mb2 /v1/{scsAsId}/tmgi-allocation • Payload shall include TMGIAllocation data structure with the following attributes included in the request: externalGroupId, mbmsLocArea, supportedFeatures 6 IOP Check Check that SCEF has delivered Allocate TMGI Response to Group Hosting CSE 7 IOP Check Check if possible that the Group Hosting CSE has stored the tmgi and tmgiExpiration in the local Multicast Group Information Check that Group Hosting CSE has sent <localMulticastGroup> creation requests to the Member Hosting CSE Check that Member Hosting CSE has created <localMulticastGroup> resource IOP Verdict PRO Verdict ETSI ETSI TS 118 113 V3.3.1 (2021-09) 160 oneM2M TS-0013 version 3.3.1 Release 3 |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.7.5.2 Group message delivery using MBMS | Interoperability Test Description Identifier: TD_M2M_SH_39 Objective: IN-AE sends a request for accessing member resources to the Group Hosting CSE Configuration: M2M_CFG_12 References: oneM2M TS-0026 [15], clause 7.7.3.1 Pre-test conditions: • Member Hosting CSE, SCEF and Group Hosting CSE are attached to the underlying 3GPP network • Member Hosting CSE on UE has created a <RemoteCSE> resource on Group Hosting CSE • <node> resource representing UE has been created on Group Hosting CSE • <schedule> resource has been created as a child of the <node> resource on Group Hosting CSE • IN-AE has created a <group> resource in Group Hosting CSE • <node> resource is the member of the <group> • Group Hosting CSE has created a <localMulticastGroup> in the Member Hosting CSE • Group Hosting CSE stores tmgi and tmgiExpiration in the local Multicast Group Information Test Sequence Step RP Type Description 1 Stimulus IN-AE is requested to send a Retrieve Request to the fanoutPoint of <group> resource 2 Mca PRO Check Primitive • op = 2 (Retrieve) • to = {CSEBaseName}/{group}/fopt • fr = AE-ID • rqi = (token-string) 3 (T8) Mcn PRO Check HTTP Group Hosting CSE sends a Group Message Delivery Request to the SCEF: • Method = POST • URI = to {apiRoot}/3gpp-group-message-delivery-mb2 /v1/{scsAsId}/tmgi- allocation{tmgi}/delivery-via-mbms • Payload shall include GMDViaMBMSByMb2data structure with the following attributes included in the request: externalGroupId, mbmsLocArea, messageDeliveryStartTime, notificationDestination 4 IOP Check Check that SCEF has responded to the Group Message Check that SCEF has sent Group Message Delivery Notification to Group Hosting CSE 5 IOP Check Check that Group Hosting CSE has responded to the Group Message Delivery Notification 6 IOP Check Check that Member Hosting CSE has sent response message within the scope of responseTimeWindow 7 IOP Check Check that Group Hosting CSE has received the response messages from Member Hosting CSEs until responseTimeWindow expires and returned the aggregated group member responses to the IN-AE/CSE IOP Verdict PRO Verdict ETSI ETSI TS 118 113 V3.3.1 (2021-09) 161 oneM2M TS-0013 version 3.3.1 Release 3 |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8 Advanced Subscriptions & Notifications management | |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.1 Notification Target removal procedure | Interoperability Test Description Identifier: TD_M2M_NH_137 Objective: AE removes notificationTargetMgmtPolicyRef via a notificationTargetMgmtPolicyRef Delete Request Configuration: M2M_CFG_10 References: ETSI TS 118 101 [1], clause 10.2.10.8 oneM2M TS-0004 [2], clause 7.4.33.2.4 Pre-test conditions: • AE1 has created an Application Entity resource <AE> on Registrar CSE • AE1 has created a <subscription> resource on Registrar CSE • AE1 has created a <notificationTargetPolicy> resource on Registrar CSE, where policyLabel = "default", action = "accept" • AE2 has created an Application Entity resource <AE> on Registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE2 is requested to send a notificationTargetSelfReference Delete Request 2 Mca PRO Check Primitive • op = 4 (Delete) • to = {CSEBaseName}/URI of <subscription> resource/ntsr • fr = AE-ID • rqi = (token-string) • pc = empty 3 Mca PRO Check Primitive • rsc = 2002 (DELETED) • rqi = (token-string) same as received in request message • pc = empty 4 IOP Check Check if possible that the registrar CSE has removed the AE2 in the notificationURI attribute in the <subscription> resource 5 IOP Check AE2 indicates successful operation IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.2 NotificationTargetMgmtPolicyRef management | |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.2.1 NotificationTargetMgmtPolicyRef Create | Interoperability Test Description Identifier: TD_M2M_NH_138 Objective: AE creates a notificationTargetMgmtPolicyRef resource in registrar CSE via a notificationTargetMgmtPolicyRef Create Request Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.10 oneM2M TS-0004 [2], clause 7.4.30.2.1 Pre-test conditions: • AE has created an application resource <AE> on registrar CSE • AE has created a <subscription> resource on registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE sends a request to create a notificationTargetMgmtPolicyRef> 2 Mca PRO Check Primitive • op = 1 (Create) • to = {CSEBaseName}/URI of <subscription> resource • fr = AE-ID • rqi = (token-string) • ty = 25 (notificationTargetMgmtPolicyRef) • pc = Serialized representation of <notificationTargetMgmtPolicyRef> resource 3 IOP Check Check if possible that the <notificationTargetMgmtPolicyRef> resource is created in registrar CSE 4 Mca PRO Check Primitive • rsc = 2001 (CREATED) • rqi = (token-string) same as received in request message • pc = Serialized representation of <notificationTargetMgmtPolicyRef> resource 5 IOP Check AE indicates successful operation ETSI ETSI TS 118 113 V3.3.1 (2021-09) 162 oneM2M TS-0013 version 3.3.1 Release 3 Interoperability Test Description IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.2.2 NotificationTargetMgmtPolicyRef Retrieve | Interoperability Test Description Identifier: TD_M2M_NH_139 Objective: AE retrieves notificationTargetMgmtPolicyRef resource from Registrar CSE Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.11 oneM2M TS-0004 [2], clause 7.4.30.2.2 Pre-test conditions: • AE has created an Application Entity resource <AE> on Registrar CSE • AE has created a subscription resource <subscription> on Registrar CSE • AE has created a <notificationTargetMgmtPolicyRef> on Registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE is requested to send a Retrieve Request for a <notificationTargetMgmtPolicyRef> 2 Mca PRO Check Primitive • op = 2 (Retrieve) • to = {CSEBaseName}/URI of <notificationTargetMgmtPolicyRef> resource • fr = AE-ID • rqi = (token-string) • pc = empty 3 Mca PRO Check Primitive • rsc = 2000 (OK) • rqi = (token-string) same as received in request message • pc = Serialized representation of <notificationTargetMgmtPolicyRef> resource 4 IOP Check AE indicates successful operation IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.2.3 NotificationTargetMgmtPolicyRef Update | Interoperability Test Description Identifier: TD_M2M_NH_140 Objective: AE updates information about a notificationTargetMgmtPolicyRef via notificationTargetMgmtPolicyRef>Update Request Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.12 oneM2M TS-0004 [2], clause 7.4.30.2.3 Pre-test conditions: • AE has created an Application Entity resource <AE> on Registrar CSE • AE has created a subscription resource <subscription> on Registrar CSE • AE has created a subscription resource <notificationTargetMgmtPolicyRef> on Registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE is requested to send a notificationTargetMgmtPolicyRef Update Request to update the notificationlPolicyID attribute of the resource 2 Mca PRO Check Primitive • op = 3 (Update) • to = {CSEBaseName}/URI of <notificationTargetMgmtPolicyRef> resource • fr = AE-ID • rqi = (token-string) • pc = Serialized representation of updated <notificationTargetMgmtPolicyRef> resource 3 IOP Check Check if possible that the <notificationTargetMgmtPolicyRef> resource is updated in Registrar CSE 4 Mca PRO Check Primitive • rsc = 2004 (Updated) • rqi = (token-string) same as received in request message • pc = Serialized representation of <notificationTargetMgmtPolicyRef> resource 5 IOP Check AE indicates successful operation ETSI ETSI TS 118 113 V3.3.1 (2021-09) 163 oneM2M TS-0013 version 3.3.1 Release 3 Interoperability Test Description IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.2.4 NotificationTargetMgmtPolicyRef Delete | Interoperability Test Description Identifier: TD_M2M_NH_141 Objective: AE removes notificationTargetMgmtPolicyRef via a notificationTargetMgmtPolicyRef Delete Request Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.12 oneM2M TS-0004 [2], clause 7.4.30.2.4 Pre-test conditions: • AE has created an Application Entity resource <AE> on Registrar CSE • AE has created a notificationTargetMgmtPolicyRef resource <notificationTargetMgmtPolicyRef> on Registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE is requested to send a notificationTargetMgmtPolicyRef Delete Request 2 Mca PRO Check Primitive • op = 4 (Delete) • to = {CSEBaseName}/URI of <notificationTargetMgmtPolicyRef> resource • fr = AE-ID • rqi = (token-string) • pc = empty 3 Mca PRO Check Primitive • rsc = 2002 (DELETED) • rqi = (token-string) same as received in request message • pc = empty 4 IOP Check Check if possible that the <notificationTargetMgmtPolicyRef> resource has been removed in registrar CSE 5 IOP Check AE indicates successful operation IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.3 NotificationTargetPolicy management | |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.3.1 NotificationTargetPolicy Create | Interoperability Test Description Identifier: TD_M2M_NH_142 Objective: AE creates a notificationTargetPolicy resource in registrar CSE via a notificationTargetPolicy Create Request Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.14 oneM2M TS-0004 [2], clause 7.4.31.2.1 Pre-test conditions: • AE has created an application resource <AE> on registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE sends a request to create a <notificationTargetPolicy> 2 Mca PRO Check Primitive • op = 1 (Create) • to = {CSEBaseName} • fr = AE-ID • rqi = (token-string) • ty = 26 (notificationTargetPolicy) • pc = Serialized representation of <notificationTargetPolicy> resource 3 IOP Check Check if possible that the <notificationTargetPolicy> resource is created in registrar CSE 4 Mca PRO Check Primitive • rsc = 2001 (CREATED) • rqi = (token-string) same as received in request message • pc = Serialized representation of <notificationTargetPolicy> resource 5 IOP Check AE indicates successful operation ETSI ETSI TS 118 113 V3.3.1 (2021-09) 164 oneM2M TS-0013 version 3.3.1 Release 3 Interoperability Test Description IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.3.2 NotificationTargetPolicy Retrieve | Interoperability Test Description Identifier: TD_M2M_NH_143 Objective: AE retrieves notificationTargetPolicy resource from Registrar CSE Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.15 oneM2M TS-0004 [2], clause 7.4.31.2.2 Pre-test conditions: • AE has created an Application Entity resource <AE> on Registrar CSE • AE has created a <notificationTargetPolicy> on Registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE is requested to send a Retrieve Request for a <notificationTargetPolicy> 2 Mca PRO Check Primitive • op = 2 (Retrieve) • to = {CSEBaseName}/URI of <notificationTargetPolicy> resource • fr = AE-ID • rqi = (token-string) • pc = empty 3 Mca PRO Check Primitive • rsc = 2000 (OK) • rqi = (token-string) same as received in request message • pc = Serialized representation of <notificationTargetPolicy> resource 4 IOP Check AE indicates successful operation IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.3.3 NotificationTargetPolicy Update | Interoperability Test Description Identifier: TD_M2M_NH_144 Objective: AE updates information about a notificationTargetPolicy via <notificationTargetPolicy> Update Request Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.16 oneM2M TS-0004 [2], clause 7.4.31.2.3 Pre-test conditions: • AE has created an Application Entity resource <AE> on Registrar CSE • AE has created a notificationTargetPolicy resource <notificationTargetPolicy> on Registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE is requested to send a notificationTargetPolicy Update Request to update the policyLabel attribute of the resource 2 Mca PRO Check Primitive • op = 3 (Update) • to = {CSEBaseName}/URI of <notificationTargetPolicy> resource • fr = AE-ID • rqi = (token-string) • pc = Serialized representation of updated <Subscription> resource 3 IOP Check Check if possible that the <notificationTargetPolicy> resource is updated in Registrar CSE 4 Mca PRO Check Primitive • rsc = 2004 (Updated) • rqi = (token-string) same as received in request message • pc = Serialized representation of <notificationTargetPolicy> resource 5 IOP Check AE indicates successful operation IOP Verdict PRO Verdict ETSI ETSI TS 118 113 V3.3.1 (2021-09) 165 oneM2M TS-0013 version 3.3.1 Release 3 |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.3.4 NotificationTargetPolicy Delete | Interoperability Test Description Identifier: TD_M2M_NH_145 Objective: AE removes notificationTargetPolicy via a <notificationTargetPolicy> Delete Request Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.17 oneM2M TS-0004 [2], clause 7.4.31.2.4 Pre-test conditions: • AE has created an Application Entity resource <AE> on Registrar CSE • AE has created a notificationTargetPolicy resource <notificationTargetPolicy> on Registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE is requested to send a notificationTargetPolicy Delete Request 2 Mca PRO Check Primitive • op = 4 (Delete) • to = {CSEBaseName}/URI of <notificationTargetPolicy> resource • fr = AE-ID • rqi = (token-string) • pc = empty 3 Mca PRO Check Primitive • rsc = 2002 (DELETED) • rqi = (token-string) same as received in request message • pc = empty 4 IOP Check Check if possible that the <notificationTargetPolicy> resource is deleted in registrar CSE 5 IOP Check AE indicates successful operation IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.4 PolicyDeletionRules management | |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.4.1 PolicyDeletionRules Create | Interoperability Test Description Identifier: TD_M2M_NH_146 Objective: AE creates a policyDeletionRules resource in registrar CSE via a policyDeletionRules Create Request Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.18 oneM2M TS-0004 [2], clause 7.4.32.2.1 Pre-test conditions: • AE has created an application resource <AE> on registrar CSE • AE has created a <notificationTargetPolicy> on Registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE sends a request to create a <policyDeletionRules> 2 Mca PRO Check Primitive • op = 1 (Create) • to = {CSEBaseName}/ URI of <notificationTargetPolicy> • fr = AE-ID • rqi = (token-string) • ty = 27 (policyDeletionRules) • pc = Serialized representation of <policyDeletionRules> resource 3 IOP Check Check if possible that the <policyDeletionRules> resource is created in registrar CSE 4 Mca PRO Check Primitive • rsc = 2001 (CREATED) • rqi = (token-string) same as received in request message • pc = Serialized representation of <policyDeletionRules> resource 5 IOP Check AE indicates successful operation IOP Verdict PRO Verdict ETSI ETSI TS 118 113 V3.3.1 (2021-09) 166 oneM2M TS-0013 version 3.3.1 Release 3 |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.4.2 PolicyDeletionRules Retrieve | Interoperability Test Description Identifier: TD_M2M_NH_147 Objective: AE retrieves policyDeletionRules resource from Registrar CSE Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.19 oneM2M TS-0004 [2], clause 7.4.32.2.2 Pre-test conditions: • AE has created an Application Entity resource <AE> on Registrar CSE • AE has created a <notificationTargetPolicy> on Registrar CSE • AE has created a <policyDeletionRules> as a child of <notificationTargetPolicy> on Registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE is requested to send a Retrieve Request for a <policyDeletionRules> 2 Mca PRO Check Primitive • op = 2 (Retrieve) • to = {CSEBaseName}/URI of <policyDeletionRules> resource • fr = AE-ID • rqi = (token-string) • pc = empty 3 Mca PRO Check Primitive • rsc = 2000 (OK) • rqi = (token-string) same as received in request message • pc = Serialized representation of <policyDeletionRules> resource 4 IOP Check AE indicates successful operation IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.4.3 PolicyDeletionRules Update | Interoperability Test Description Identifier: TD_M2M_NH_148 Objective: AE updates information about a policyDeletionRules via <policyDeletionRules> Update Request Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.20 oneM2M TS-0004 [2], clause 7.4.32.2.3 Pre-test conditions: • AE has created an Application Entity resource <AE> on Registrar CSE • AE has created a <notificationTargetPolicy> on Registrar CSE • AE has created a <policyDeletionRules> as a child of <notificationTargetPolicy> on Registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE is requested to send a policyDeletionRules Update Request to update the deletionRulesRelation attribute of the resource 2 Mca PRO Check Primitive • op = 3 (Update) • to = {CSEBaseName}/URI of <policyDeletionRules> resource • fr = AE-ID • rqi = (token-string) • pc = Serialized representation of updated <policyDeletionRules> resource 3 IOP Check Check if possible that the <policyDeletionRules> resource is updated in Registrar CSE 4 Mca PRO Check Primitive • rsc = 2004 (Updated) • rqi = (token-string) same as received in request message • pc = Serialized representation of <policyDeletionRules> resource 5 IOP Check AE indicates successful operation IOP Verdict PRO Verdict ETSI ETSI TS 118 113 V3.3.1 (2021-09) 167 oneM2M TS-0013 version 3.3.1 Release 3 |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.4.4 PolicyDeletionRules Delete | Interoperability Test Description Identifier: TD_M2M_NH_149 Objective: AE removes policyDeletionRules via a <policyDeletionRules> Delete Request Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.21 oneM2M TS-0004 [2], clause 7.4.32.2.4 Pre-test conditions: • AE has created an Application Entity resource <AE> on Registrar CSE • AE has created a <notificationTargetPolicy> on Registrar CSE • AE has created a <policyDeletionRules> as a child of <notificationTargetPolicy> on Registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE is requested to send a policyDeletionRules Delete Request 2 Mca PRO Check Primitive • op = 4 (Delete) • to = {CSEBaseName}/URI of <policyDeletionRules> resource • fr = AE-ID • rqi = (token-string) • pc = empty 3 Mca PRO Check Primitive • rsc = 2002 (DELETED) • rqi = (token-string) same as received in request message • pc = empty 4 IOP Check Check if possible that the <notificationTargetPolicy> resource has been removed in registrar CSE 5 IOP Check AE indicates successful operation IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.5 CrossResourceSubscription management | |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.5.1 CrossResourceSubscription Create | Interoperability Test Description Identifier: TD_M2M_NH_150 Objective: AE creates a crossResourceSubscription resource in registrar CSE via a crossResourceSubscription Create Request Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.22 oneM2M TS-0004 [2], clause 7.4.58.2.1 Pre-test conditions: • AE has created an application resource <AE> on registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE sends a request to create a <crossResourceSubscription> where regularResourcesAsTarget = AE-ID 2 Mca PRO Check Primitive • op = 1 (Create) • to = {CSEBaseName} • fr = AE-ID • rqi = (token-string) • ty = 48 (crossResourceSubscription) • pc = Serialized representation of <crossResourceSubscription> resource 3 IOP Check Check if possible that the <crossResourceSubscription> resource is created in registrar CSE Check if possible that the <subscribtion> resource is created as a child of <AE> resource in registrar CSE 4 Mca PRO Check Primitive • rsc = 2001 (CREATED) • rqi = (token-string) same as received in request message • pc = Serialized representation of <crossResourceSubscription> resource 5 IOP Check AE indicates successful operation IOP Verdict PRO Verdict ETSI ETSI TS 118 113 V3.3.1 (2021-09) 168 oneM2M TS-0013 version 3.3.1 Release 3 |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.5.2 CrossResourceSubscription Retrieve | Interoperability Test Description Identifier: TD_M2M_NH_151 Objective: AE retrieves crossResourceSubscription resource from Registrar CSE Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.23 oneM2M TS-0004 [2], clause 7.4.58.2.2 Pre-test conditions: • AE has created an Application Entity resource <AE> on Registrar CSE • AE has created a <crossResourceSubscription> on Registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE is requested to send a Retrieve Request for a <crossResourceSubscription> 2 Mca PRO Check Primitive • op = 2 (Retrieve) • to = {CSEBaseName}/URI of <crossResourceSubscription> resource • fr = AE-ID • rqi = (token-string) • pc = empty 3 Mca PRO Check Primitive • rsc = 2000 (OK) • rqi = (token-string) same as received in request message • pc = Serialized representation of <crossResourceSubscription> resource 4 IOP Check AE indicates successful operation IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.5.3 CrossResourceSubscription Update | Interoperability Test Description Identifier: TD_M2M_NH_152 Objective: AE updates information about a crossResourceSubscription via <crossResourceSubscription> Update Request Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.24 oneM2M TS-0004 [2], clause 7.4.58.2.3 Pre-test conditions: • AE has created an Application Entity resource <AE> on Registrar CSE • AE has created a <crossResourceSubscription> on Registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE is requested to send a crossResourceSubscription Update Request to update the regularResourcesAsTarget attribute of the resource 2 Mca PRO Check Primitive • op = 3 (Update) • to = {CSEBaseName}/URI of <crossResourceSubscription> resource • fr = AE-ID • rqi = (token-string) • pc = Serialized representation of updated <crossResourceSubscription> resource 3 IOP Check Check if possible that the <crossResourceSubscription> resource is updated in Registrar CSE If regularResourcesAsTarget contains new target resources, check if possible that <subscription> resources are created to each new target resource 4 Mca PRO Check Primitive • rsc = 2004 (Updated) • rqi = (token-string) same as received in request message • pc = Serialized representation of <crossResourceSubscription> resource 5 IOP Check AE indicates successful operation IOP Verdict PRO Verdict ETSI ETSI TS 118 113 V3.3.1 (2021-09) 169 oneM2M TS-0013 version 3.3.1 Release 3 |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.5.4 CrossResourceSubscription Delete | Interoperability Test Description Identifier: TD_M2M_NH_153 Objective: AE removes crossResourceSubscription via a <crossResourceSubscription> Delete Request Configuration: M2M_CFG_01 References: ETSI TS 118 101 [1], clause 10.2.10.21 oneM2M TS-0004 [2], clause 7.4.32.2.4 Pre-test conditions: • AE has created an Application Entity resource <AE> on Registrar CSE • AE has created a <crossResourceSubscription> on Registrar CSE • Registrar CSE has created <subscription> resources as targets of <crossResourceSubscription> Test Sequence Step RP Type Description 1 Stimulus AE is requested to send a crossResourceSubscription Delete Request 2 Mca PRO Check Primitive • op = 4 (Delete) • to = {CSEBaseName}/URI of <crossResourceSubscription> resource • fr = AE-ID • rqi = (token-string) • pc = empty 3 Mca PRO Check Primitive • rsc = 2002 (DELETED) • rqi = (token-string) same as received in request message • pc = empty 4 IOP Check Check if possible that the <crossResourceSubscription> resource is deleted in registrar CSE Check if possible that the target <subscription> resources are deleted in registrar CSE 5 IOP Check AE indicates successful operation IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.8.5.5 Cross-Resource Notification | Interoperability Test Description Identifier: TD_M2M_NH_154 Objective: AE receives a notification request from the HOST CSE Configuration: M2M_CFG_10 References: ETSI TS 118 101 [1], clause 10.2.10.26 Pre-test conditions: • AE1 has created an application resource <AE> on registrar CSE • AE1 has created <crossResourceSubscription> on registrar CSE • AE1 has created a container1 resource <container> on registrar CSE • AE1 has created a container2 resource <container> on registrar CSE • AE2 has permissions to UPDATE the container1 and container2 created by AE1 • Registrar CSE has created <subscription> resources as a child resource of a container1 and container2 as a target of <crossResourceSubscription> resource Test Sequence Step RP Type Description 1 Stimulus AE2 is requested to send an Update request to the container1 created by AE1. This triggers the timer as indicated in timeWindowSize attribute of <crossResourceSubscription> 2 Stimulus AE2 is requested to send an Update request to the container2 created by AE1 within the time frame indicated in timeWindowSize after the 1st request. This triggers or causes the Registrar CSE to send a notification to AE1 3 Check Mca PRO Check Primitive • op = 5 (Notify) • to = notificationURI of subscription resource • from = Registrar CSE-ID • rqi = (token-string) • pc = Serialized representation of Notification data object 3 IOP Check Check if the notification representation 4 Check Mca PRO Check Primitive Sent response contains: • rsc = 2000 (OK) • rqi = (token-string) same as received in request message ETSI ETSI TS 118 113 V3.3.1 (2021-09) 170 oneM2M TS-0013 version 3.3.1 Release 3 Interoperability Test Description 5 IOP Check AE1 indicates notification received IOP Verdict PRO Verdict |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.9 Modbus Interworking | |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.9.1 Modbus Thermometer Device Create | Interoperability Test Description Identifier: TD_M2M_NH_163 Objective: AE1 creates Device Model for Modbus device Configuration: M2M_CFG_10 References: oneM2M TS-0040 [16], clause 6.3 Pre-test conditions: • AE1 is running in Modbus IPE • AE1 has created an application resource <AE> on registrar CSE Test Sequence Step RP Type Description 1 Stimulus AE1 sends a request to create a <flexContainer> resource for Modbus deviceThermometer 2 Mca PRO Check Primitive • op = 1 (Create) • to = {CSEBaseName}/URI of <AE1> resource • fr = AE1-ID • rqi = (token-string) • ty = 28 (flexContainer) • pc = Serialized representation of <flexContainer> resource with proper containerDefinition 3 IOP Check Check if possible that the <flexContainer> resource is created in registrar CSE 4 Mca PRO Check Primitive • rsc = 2001 (CREATED) • rqi = (token-string) same as received in request message • pc = Serialized representation of <flexContainer> resource 5 IOP Check AE indicates successful operation 6 Stimulus AE1 sends a request to create a <flexContainer> for temperature 7 Mca PRO Check Primitive • op = 1 (Create) • to = {CSEBaseName}/URI of <AE1> resource/resource name of Modbus deviceLight • fr = AE1-ID • rqi = (token-string) • ty = 28 (flexContainer) • pc = Serialized representation of <flexContainer> resource with proper containerDefinition and nodnProperties 8 IOP Check Check if possible that the <flexContainer> resource is created in registrar CSE 9 Mca PRO Check Primitive • rsc = 2001 (CREATED) • rqi = (token-string) same as received in request message • pc = Serialized representation of <flexContainer> resource 10 IOP Check AE indicates successful operation Note Optional: Repeat steps 5-10 for battery Module IOP Verdict PRO Verdict ETSI ETSI TS 118 113 V3.3.1 (2021-09) 171 oneM2M TS-0013 version 3.3.1 Release 3 |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.9.2 Retrieve data from a Modbus Thermometer device | Interoperability Test Description Identifier: TD_M2M_NH_164 Objective: Modbus IPE reads data from Modbus device and updates Registrar CSE with the read data Configuration: M2M_CFG_10 References: oneM2M TS-0040 [16], clause 6.5.1 Pre-test conditions: • AE1 is running in Modbus IPE • AE1 has created an application resource <AE> on registrar CSE • AE1 has created a <flexContainer> for deviceThermometer • AE1 has created a <flexContainer> for temperature as a child of deviceThermometer • AE2 has created an application resource <AE> on registrar CSE • AE2 has created a <subscription> resource as a child of temperature Test Sequence Step RP Type Description 1 Stimulus AE1 sends a request to retrieve a <flexContainer> resource for temperature 2 Mca PRO Check Primitive • op = 2 (Retrieve) • to = {CSEBaseName}/URI of <deviceThermometer> resource/ temperature • fr = AE1-ID • rqi = (token-string) 3 Mca PRO Check Primitive • pc = Serialized representation of <flexContainer> resource • rsc = 2000 (OK) 4 IOP Check AE1 indicates successful operation 5 Stimulus Modbus IPE sends a request(s) to retrieve data from Modbus Thermometer device 6 IOP Check Check if possible that Modbus IPE has successfully retrieved data from Modbus device 7 Stimulus AE1 sends a request to update a <flexContainer> resource for deviceThermometer 8 Mca PRO Check Primitive • op = 3 (Update) • to = {CSEBaseName}/URI of deviceThermometer/temperature • fr = AE1-ID • rqi = (token-string) • pc = Serialized representation of updated <flexContainer> resource 9 Mca PRO Check Primitive • rsc = 2004 (Updated) • rqi = (token-string) same as received in request message • pc = Serialized representation of <flexContainer> resource 10 IOP Check Check if possible that the < flexContainer > resource for temperature is updated in Registrar CSE. Registrar CSE sends a notification to AE2 11 Mca PRO Check Primitive • op = 5 (Notify) • to = AE2-ID • from = Registrar CSE-ID • rqi = (token-string) • pc = Serialized representation of Notification data object 12 Mca PRO Check Primitive AE2 responds to notification • rsc = 2000 (OK) • rqi = (token-string) same as received in request message 13 IOP Check AE2 indicates notification received IOP Verdict PRO Verdict ETSI ETSI TS 118 113 V3.3.1 (2021-09) 172 oneM2M TS-0013 version 3.3.1 Release 3 |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.9.3 Write data to a Modbus Thermometer device | Interoperability Test Description Identifier: TD_M2M_NH_165 Objective: AE writes data into a Modbus device by updating <flexContainer> resource in Registrar CSE Configuration: M2M_CFG_10 References: oneM2M TS-0040 [16], clause 6.5.2 Pre-test conditions: • AE1 is running in Modbus IPE • AE1 has created an application resource <AE> on registrar CSE • AE1 has created a <flexContainer> for deviceThermometer • AE1 has created a <flexContainer> for temperature as a child of deviceThermometer • AE2 has created an application resource <AE> on registrar CSE • AE2 has created a <subscription> resource as a child of temperature (notificationEventType = Blocking_Update) Test Sequence Step RP Type Description 1 Stimulus AE2 is requested to send a flexContainer Update Request to update the any customAttribute of the resource 2 Mca PRO Check Primitive • op = 3 (Update) • to = {CSEBaseName}/URI of <flexContainer> resource • fr = AE-ID • rqi = (token-string) • pc = Serialized representation of updated <flexContainer> resource 3 IOP Check Check that Registrar CSE sent a notification to AE1 4 Mca PRO Check Primitive • op = 5 (Notify) • to = AE1-ID • from = Registrar CSE-ID • rqi = (token-string) • pc = Serialized representation of Notification data object 5 Stimulus Modbus IPE sends a request(s) to write data to Modbus Thermometer device 6 IOP Check Check if possible that Modbus IPE has successfully written data to Modbus device 7 Stimulus AE1 sends a response to notification to Registrar CSE 8 Mca PRO Check Primitive Sent response contains: • rsc = 2000 (OK) • rqi = (token-string) same as received in request message 9 Mca PRO Check Primitive Registrar CSE sends a response to AE2 • rsc = 2004 (Updated) • rqi = (token-string) same as received in request message • pc = Serialized representation of <flexContainer> resource 10 IOP Check AE2 indicates successful operation IOP Verdict PRO Verdict ETSI ETSI TS 118 113 V3.3.1 (2021-09) 173 oneM2M TS-0013 version 3.3.1 Release 3 |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.10 NoDN Interworking | |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.10.1 Retrieve data from a NoDN device | Interoperability Test Description Identifier: TD_M2M_NH_166 Objective: NoDN IPE reads data from a NoDN device and updates Registrar CSE with the read data Configuration: M2M_CFG_10 References: Pre-test conditions: • AE1 is running in NoDN IPE • AE1 has created an application resource <AE> on registrar CSE • AE1 has created a <flexContainer> representing NoDN DeviceClass • AE1 has created a <flexContainer> for the ModuleClass as a child of the DeviceClass representing the NoDN device • AE2 has created an application resource <AE> on registrar CSE • AE2 has created a <subscription> resource as a child of the ModuleClass Test Sequence Step RP Type Description 1 Stimulus AE1 sends a request to retrieve a <flexContainer> resource for the ModuleClass 2 Mca PRO Check Primitive • op = 2 (Retrieve) • to = {CSEBaseName}/URI of ModuleClass • fr = AE1-ID • rqi = (token-string) 3 Mca PRO Check Primitive • pc = Serialized representation of <flexContainer> resource • rsc = 2000 (OK) 4 IOP Check AE1 indicates successful operation 5 Stimulus NoDN IPE retrieves data from NoDN device 6 IOP Check Check if possible that NoDN IPE has successfully retrieved data from NoDN device 7 Stimulus AE1 sends a request to update a <flexContainer> resource for the ModuleClass 8 Mca PRO Check Primitive • op = 3 (Update) • to = {CSEBaseName}/URI of the ModuleClass • fr = AE1-ID • rqi = (token-string) • pc = Serialized representation of the updated ModuleClass 9 Mca PRO Check Primitive • rsc = 2004 (Updated) • rqi = (token-string) same as received in request message • pc = Serialized representation of <flexContainer> resource 10 IOP Check Check if possible that the <flexContainer> resource for the ModuleClass is updated in Registrar CSE. Registrar CSE sends a notification to AE2 11 Mca PRO Check Primitive • op = 5 (Notify) • to = AE2-ID • from = Registrar CSE-ID • rqi = (token-string) • pc = Serialized representation of Notification data object 12 Mca PRO Check Primitive AE2 responds to notification • rsc = 2000 (OK) • rqi = (token-string) same as received in request message 13 IOP Check AE2 indicates notification received IOP Verdict PRO Verdict ETSI ETSI TS 118 113 V3.3.1 (2021-09) 174 oneM2M TS-0013 version 3.3.1 Release 3 |
e80b5da6c14ed17fdbf5d0fb9b8ebe31 | 118 113 | 8.10.2 Write data to a NoDN device | Interoperability Test Description Identifier: TD_M2M_NH_167 Objective: AE writes data into a NoDN device by updating <flexContainer> resource in Registrar CSE Configuration: M2M_CFG_10 References: Pre-test conditions: • AE1 is running in NoDN IPE • AE1 has created an application resource <AE> on registrar CSE • AE1 has created a <flexContainer> representing the NoDN DeviceClass • AE1 has created a <flexContainer> for the ModuleClass as a child of the DeviceClass representing the NoDN device • AE2 has created an application resource <AE> on registrar CSE • AE2 has created a <subscription> resource as a child of the ModuleClass (notificationEventType = Blocking_Update) Test Sequence Step RP Type Description 1 Stimulus AE2 is requested to send a flexContainer Update Request to update any customAttribute of the ModuleClass 2 Mca PRO Check Primitive • op = 3 (Update) • to = {CSEBaseName}/URI of the ModuleClass • fr = AE-ID • rqi = (token-string) • pc = Serialized representation of the updated ModuleClass 3 IOP Check Check that Registrar CSE sent a notification to AE1 4 Mca PRO Check Primitive • op = 5 (Notify) • to = AE1-ID • from = Registrar CSE-ID • rqi = (token-string) • pc = Serialized representation of Notification data object 5 Stimulus NoDN IPE sends a request(s) to write data to NoDN device 6 IOP Check Check if possible that NoDN IPE has successfully written data to NoDN device 7 Stimulus AE1 sends a response to notification to Registrar CSE 8 Mca PRO Check Primitive Sent response contains: • rsc = 2000 (OK) • rqi = (token-string) same as received in request message 9 Mca PRO Check Primitive Registrar CSE sends a response to AE2 • rsc = 2004 (Updated) • rqi = (token-string) same as received in request message • pc = Serialized representation of the ModuleClass 10 IOP Check AE2 indicates successful operation IOP Verdict PRO Verdict ETSI ETSI TS 118 113 V3.3.1 (2021-09) 175 oneM2M TS-0013 version 3.3.1 Release 3 History Document history V3.3.1 September 2021 Publication |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 1 Scope | The present document specifies the oneM2M and AllJoyn interworking technologies that enable AllJoyn Applications and oneM2M entities produce/consume services. Clause 5 defines the interworking architecture model that describes where the AllJoyn IPE is hosted and how the IPE is composed with. Clause 6 defines the architecture aspects that mainly describes AllJoyn services to oneM2M resource mapping structure and rules. Furthermore, this explains the IPE registration and AllJoyn service discovery by the IPE. Clause 7 defines the IPE interworking procedures that consists of the initial setup and the service interworking procedures. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 2 References | |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 2.1 Normative references | References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the referenced document (including any amendments) applies. Referenced documents which are not found to be publicly available in the expected location might be found at https://docbox.etsi.org/Reference/. NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee their long term validity. The following referenced documents are necessary for the application of the present document. [1] ETSI TS 118 101: "oneM2M; Functional Architecture (oneM2M TS-0001)". [2] ETSI TS 118 104: "oneM2M; Service Layer Core Protocol Specification (oneM2M TS-0004)". |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 2.2 Informative references | References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the referenced document (including any amendments) applies. NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee their long term validity. The following referenced documents are not necessary for the application of the present document but they assist the user with regard to a particular subject area. [i.1] oneM2M Drafting Rules. NOTE: Available at http://www.onem2m.org/images/files/oneM2M-Drafting-Rules.pdf. [i.2] AllJoyn System Description. [i.3] oneM2M TR-0014: "oneM2M and AllJoyn Interworking". [i.4] D-Bus Tutorial. NOTE: Available at http://dbus.freedesktop.org/doc/dbus-tutorial.html#objects. [i.5] AllJoyn Gateway Agent High Level Description(HLD). ETSI ETSI TS 118 121 V2.0.1 (2020-03) 7 oneM2M TS-0021 version 2.0.1 Release 2A |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 3 Definition of terms, symbols and abbreviations | |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 3.1 Terms | For the purposes of the present document, the following terms apply: AllJoyn application: application that either produces an AllJoyn service or consumes an AllJoyn service AllJoyn consumer application: role of an AllJoyn application that consumes AllJoyn services provided by other AllJoyn applications AllJoyn producer application: role of an AllJoyn application that produces AllJoyn services consumed by other AllJoyn applications AllJoyn service resources: resources created as children of an <AE> resource representing an AllJoyn IPE for the purpose of exposing services between AllJoyn Consumer/Producer Applications and AE/CSE entities |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 3.2 Symbols | Void. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 3.3 Abbreviations | Void. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 4 Conventions | The key words "Shall", "Shall not", "May", "Need not", "Should", "Should not" in the present document are to be interpreted as described in the oneM2M Drafting Rules [i.1]. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 5 Architecture Model | |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 5.1 Reference model | The architecture model followed in the present document is based on the architecture model in annex F of ETSI TS 118 101 [1] that describes how interworking between oneM2M CSEs and non-oneM2M systems using specialized Interworking Proxy application Entities (IPE). The present document describes the AllJoyn IPE that supports the following reference model. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 8 oneM2M TS-0021 version 2.0.1 Release 2A Figure 5.1-1: AllJoyn interworking reference model This reference model describes how the oneM2M AEs can interwork with AllJoyn applications. By the IPE, AllJoyn services are exposed as oneM2M resources and stored in a CSE. AEs access the exposed AllJoyn service resources by the oneM2M APIs. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 5.2 Composition of the IPE | The AllJoyn IPE consists of AE and AllJoyn application. To provide the interworking functions to other oneM2M entities, the IPE registers to a CSE and communicate with other AllJoyn applications using AllJoyn protocols. The IPE registration is mandatory in oneM2M systems which is not defined in AllJoyn system. AllJoyn discovery and session establishment are needed for the IPE to communicate with other AllJoyn applications. In figure 5.2-1, AllJoyn Application on the AllJoyn device and AllJoyn IPE is either AllJoyn Consumer or Producer Application. Depending on the interworking service scenario, AllJoyn Consumer and/or Producer Application is hosted on AllJoyn devices and AllJoyn IPEs. For example, when a AllJoyn service is consumed by oneM2M entities, an AllJoyn devices hosts AllJoyn Producer Application and AllJoyn IPE hosts AllJoyn Consumer Application. In other case, if a oneM2M entity provides data to be consumed by AllJoyn Consumer Application on an AllJoyn device, then the AllJoyn IPE hosts AllJoyn Producer Application and the AllJoyn device hosts AllJoyn Consumer Application. AllJoyn Application CSE AllJoyn Protocol AllJoyn IPE Mca AE Mca ASN/MN/IN CSE Mcc/Mcc’ MN/IN ETSI ETSI TS 118 121 V2.0.1 (2020-03) 9 oneM2M TS-0021 version 2.0.1 Release 2A AllJoyn IPE AE AllJoyn Device CSE Mca AllJoyn Protocol AllJoyn Application AllJoyn Application Figure 5.2-1: Composition of the AllJoyn IPE |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 6 Architecture Aspect | |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 6.1 Introduction | oneM2M and AllJoyn have different architecture aspects (annex A oneM2M and AllJoyn technical comparison). The present document specifies the interworking functions for those differences in the following aspects: • oneM2M resource mapping structure; • AllJoyn IPE registration; • AllJoyn service discovery; • AllJoyn service mapping; • AllJoyn access control mapping. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 6.2 oneM2M resource mapping structure | In this clause, the overall resource mapping structure for exposing service between AllJoyn Applications(either Producer or Consumer) and oneM2M entities is introduced. Since it is difficult to put the resource tree into a single figure that remains well-readable, the description is split up in multiple figures, In this description, not all specified attributes of the used resource types and not all possible child resources are depicted to keep the figures readable, For example <subscription> resources which may be used to subscribe to some of the depicted resources are not shown. The resource mapping structure uses some specializations of the <flexContainer> resource. Each of this specialization is detailed in annex B. The use of each of the resources within the resource mapping structure for consuming or producing services is defined in detail in clause 7. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 10 oneM2M TS-0021 version 2.0.1 Release 2A 1 1 Naming Resource Type / Specialization value of labels svcObjects fixed <flexContainer> [svcObjWrapper] “Iwked-Technology:AllJoyn”, “Iwked-Entity-Type:SvcObjects svcFrameWorks fixed <flexContainer> [svcFwWrapper] “Iwked-Technology:AllJoyn”, “Iwked-Entity-Type:SvcFrameWorks” <AE> variable <AE> “AllJoyn-IPE” 1..n <CSEBase> variable <CSEBase> <AE> variable <AE> Not including “AllJoyn-IPE” 0..n Figure 6.2-1: AllJoyn interworking resource mapping, part 1 In figure 6.2-1, the first part of the resource mapping structure for AllJoyn interworking is depicted. The <CSEBase> resource of a CSE that is used for connecting to an AllJoyn proximal network is the root of the resource mapping structure. The IPE responsible for AllJoyn interworking - see the reference model described in clause 5 - will register with that CSE and will create an <AE> resource which represents the IPE. This <AE> resource shall include the string "AllJoyn- IPE" in the labels attribute. All other relevant AllJoyn interworking resources will be hosted as children or descendants of this <AE> resource. For convenience, this <AE> is termed "IPE" in what follows. In figure 6.2-1 the multiplicity of the <AE> resource is defined to be equal to 1..n. Since it is assumed that the CSE represented by the <CSEBase> resource depicted in figure 6.2-1 supports AllJoyn interworking, at least one <AE> resource representing an AllJyon IPE shall exist. When the IPE registers with an ASN-CSE or an MN-CSE, the multiplicity shall be 1. This does not imply that no other application can register with that CSE. It is only meant to define that only one <AE> will act as an IPE for AllJoyn interworking on this CSE. As depicted in figure 6.2-1, other <AE> resources - not including the string "AllJoyn-IPE" in the value of the labels attribute can occur with multiplicity 0..n. On the other hand, when the IPE registers with IN-CSE, the multiplicity shall be 1..n to allow interworking with multiple different AllJoyn proximal networks. In figure 6.2-1, and in the following figures two specializations of <flexContainer> called "svcObjWrapper" and "svcFwWrapper" are used. These specializations of <flexContainer> do not contain any custom attributes. They serve only as wrappers for other resources in order to structure the resource tree allowing subscriptions to be made to that part of the tree. See annex B for further details on the [svcObjwrapper] and [svcFwWrapper] specialization of <flexContainer>. Two child resources of the <AE> resource representing the IPE are depicted in figure 6.2-1: • A resource with a fixed name "svcObjects": It serves as a wrapper for hosting resources that are used to expose services based on the AllJoyn service object model, see also oneM2M TR-0014 [i.3] for details on AllJoyn service objects. Service Objects in AllJoyn contain one or more AllJoyn interfaces that are used to interact with services. The resource structure under this [svcObjWrapper] resource called "svcObjects" allows for direct interaction with AllJoyn interfaces via corresponding resources. • A resource with a fixed name "svcFrameWorks": It serves as a wrapper for hosting resources that are used to expose services based on some higher level AllJoyn service frameworks, see also oneM2M TR-0014 [i.3] for details on AllJoyn service frameworks. AllJoyn service frameworks typically offer a simpler API to programmers for making use of services compared to operating directly on the AllJoyn interfaces within AllJoyn service objects. An example for such a service framework is the Lighting Services Framework (LSF) in AllJoyn. The resource structure under this [svcFwWrapper] resource called "svcFrameWorks" allows use of functions in selected AllJoyn service frameworks via corresponding resources. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 11 oneM2M TS-0021 version 2.0.1 Release 2A Naming Resource Type value of labels [allJoynApp] fixed <flexContainer> [svcObjWrapper] “Iwked-Technology:AllJoyn”, “Iwked-Entity-Type:SvcObjects” [allJoynSvcObject] variable <flexContainer> [allJoynSvcObject] “Iwked-Technology:AllJoyn”, “Iwked-Entity-Type: ServiceObject” 1..n objectPath 1 [allJoynInterface] 1..n variable <flexContainer> [allJoynInterface] “Iwked-Technology:AllJoyn”, “Iwked-Entity-Type:Interface” svcObjects 0..n variable <flexContainer> [allJoynApp] “Iwked-Technology:AllJoyn”, “Iwked-Entity-Type:App” direction 1 enabled 1 Figure 6.2-2: AllJoyn interworking resource mapping, part 2 In figure 6.2-2, the second part of the AllJoyn interworking resource mapping is depicted. It describes the structure of resources hosted under the [svcObjWrapper] resource named "svcObjects". For each AllJoyn application providing a service that is supposed to be exposed by the IPE via resources under the "svcObjects" [svcObjWrapper] resource and for all external services that shall be injected into the AllJoyn proximal network by the IPE, a separate child resource is created which is a [allJoynApp] specialization of <flexContainer>. The details of this [allJoynApp] specialization of <flexContainer> are defined in annex B. The [allJoynApp] specialization of <flexContainer> contains a custom attribute direction, which indicates whether the service is exposed from the AllJoyn side to the oneM2M side (value equal to "allJoynToOneM2m") or vice versa (value equal to "oneM2mToAllJoyn"). At most one of the [allJoynApp] child resources under the "svcObjects" [svcObjWrapper] resource can have a direction set to "oneM2mToAllJoyn". For that particular [allJoynApp] - if present - the IPE acts as a service producer application at the AllJoyn side. It is the IPE's responsibility to create the [allJoynApp] resources under the "svcObjects" [svcObjWrapper] resource including: • One [allJoynApp] specialization of <flexContainer> resource for each AllJoyn application providing a service that is supposed to be exposed by the IPE towards oneM2M entities. The name of each of these [allJoynApp] specialization shall be set to the unique Well-Known-Name (WKN) [i.2] of the corresponding AllJoyn application. The value for the direction attribute shall be set to "allJoynToOneM2m". • One [allJoynApp] specialization of <flexContainer> resource representing the IPE itself as an AllJoyn Producer Application hosted by the IPE - in case the IPE supports exposure of services provided by oneM2M AEs to AllJoyn applications. The name of this [allJoynApp] specialization of <flexContainer> shall be set to the Well-Known-Name (WKN) of the IPE on the AllJoyn bus. The value for the direction attribute shall be set to "oneM2mToAllJoyn". Each [allJoynApp] resource will contain one or more [allJoynSvcObject] child resources, which are specializations of <flexContainer> resources representing AllJoyn service objects. Details of the [allJoynSvcObject] specialization of <flexContainer> are defined in annex B. The [allJoynSvcObject] specialization of <flexContainer> contain two custom attributes: • objectPath: This is a string equal to the AllJoyn object path for the represented AllJoyn service object. • enabled: This is a flag indicating whether the resource representing the corresponding AllJoyn service object is currently enabled for service exposure. This is needed since the structure in this resource needs to be created in multiple steps (creation of children and children of children in this resource structure). During initialization of the resource structure under a specific [allJoynSvcObject] resource, the attribute enabled shall be set to False as it is not ready for use. Once the initialization is complete and the resource structure can be used for service interactions, the enabled flag shall be set to True. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 12 oneM2M TS-0021 version 2.0.1 Release 2A The naming of [allJoynSvcObject] is up to the IPE. It would seem logical to derive names from the object path of the corresponding AllJoyn service object, but due to characters like a slash "/" appearing in object paths, it is not possible to use the exact same string as a name for the corresponding [allJoynSvcObject] resource. Each AllJoyn service object contains one or more interfaces. This is reflected in the AllJoyn interworking resource structure by the presence of one or more [allJoynInterface] specializations of <flexContainer> under each [allJoynSvcObject] resource. Details of the [allJoynInterface] specializations of <flexContainer> resources are defined in annex B. The basic structure under each [allJoynInterface] resource is depicted in figure 6.2-3. Naming Resource Type value of “labels” [allJoynInterface] variable <flexContainer> allJoynInterface “Iwked-Technology:AllJoyn”, “Iwked-Entity-Type:Interface” interfaceIntrospectXmlRef 1 [allJoynMethod] 0..n variable <flexContainer> allJoynMethod “Iwked-Technology:AllJoyn”, “Iwked-Entity-Type:Method” [allJoynProperty] variable <flexContainer> allJoynProperty “Iwked-Technology:AllJoyn”, “Iwked-Entity-Type:Property” 0..n <container> variable <container> “Iwked-Technology:AllJoyn”, “Iwked-Entity-Type:Signal Name” 0..n input 0..1 callStatus 0..1 output 0..1 currentValue 1 requestedValue 0..1 <contentInstance> 0..n [allJoynMethodCall] variable <flexContainer> allJoynMethodCall “Iwked-Technology:AllJoyn”, “Iwked-Entity-Type:MetodCall” 0..n Figure 6.2-3: AllJoyn interworking resource mapping, part 3 [allJoynInterface] specializations of <flexContainer> contain one custom attribute interfaceIntrospectXmlRef which refers to the AllJoyn interface definition in XML. AllJoyn interfaces consist of methods, properties and signals. In the AllJoyn interworking resource structure, methods are represented by [allJoynMethod] resources which are a specialization of <flexContainer>. Properties are represented by [allJoynProperty] resources which are a specialization of <flexContainer>. Signals are represented by regular <container> resources. All specializations of <flexContainer> resources are defined in annex B. [allJoynMethod] resources shall be named with the same string as the method is named in the AllJoyn interface definition. [allJoynProperty] resources shall be named with the same string as the property is named in the AllJoyn interface definition. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 13 oneM2M TS-0021 version 2.0.1 Release 2A Since different calling instances of AllJoyn interface methods need to be distinguishable in terms of input, output and call status, the interworking resource structure for methods includes zero or more [allJoynMethodCall] resources used to represent individual calling instances of a method. For each call of a method, the consumer of the service needs to create a new instance of a [allJoynMethodCall] resource. In cases where the corresponding AllJoyn method requires inputs, the input attribute needs to be present and contain a valid serialization of input parameters to the method call. The entity which acts on creation of a new [allJoynMethodCall] resource - i.e. the IPE in case of a service exposed from AllJoyn to oneM2M or another AE in case of exposing a service from oneM2M to AllJoyn - needs to perform the requested method call and populate the callStatus attribute with corresponding status information. Upon completion of the action taken, the ouput attribute shall get populated with the corresponding output of the method call - if any. Note that some AllJoyn methods do not return an output upon completion of a call. AllJoyn properties are represented by [allJoynProperty] resources. The attribute currentValue is representing the current value of the property. When the property is capable of being changed, the attribute requestedValue shall be used to request a change to a new value. Upon completion of such a change request, the IPE or the service providing AE will update the new value of the property in the attribute currentValue. Naming Resource Type value of labels <flexContainer> fixed <flexContainer> [svcFwWrapper] “Iwked-Technology:AllJoyn”, “Iwked-Entity-Type:SvcFrameWorks” svcFrameWorks 0..n variable <flexContainer> specific to service FW [name of specific AllJoyn service frame work] Figure 6.2-4: AllJoyn interworking resource mapping, part 4 For exposure of AllJoyn service frameworks using higher level APIs that are not directly interacting with AllJoyn service objects and interfaces, separate resources are used under the [svcFwWrapper] resource named "svcFrameWorks". For each supported service framework with a higher level API, a separate specialization of a <flexContainer> resource shall be created as a child resource under "svcFrameWorks" in which the labels attribute includes a string equal to the name of the service framework. An example for an AllJoyn service framework that could be exposed in this part of the resource structure is the "Lighting Services Framework" (LSF). Since each service framework will have different services and methods associated with it, a separate definition of the resource structure for that service framework is needed. Supported service frameworks are FFS. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 6.3 AllJoyn IPE registration | To start oneM2M-AllJoyn interworking, the IPE shall perform AE registration procedure to the a CSE specified in ETSI TS 118 101 [1]. To stop using the interworking function, IPE shall perform AE de-registration procedure. The IPE shall be represented as the <AE> resource as follows. Table 6.3-1: Attribute values of IPE resource Attribute Value Description resourceType "2" Enumeration value for the AE resource type labels "AllJoyn-IPE" IPE for AllJoyn interworking For each AllJoyn proximal network, only one IPE handles interworking between oneM2M entities and AllJoyn Applications. An ASN-CSE or MN-CSE shall accept at most one AllJoyn IPE. However, an IN-CSE may accept more than one AllJoyn IPE registration(s) to allow multiple AllJoyn proximity network interworking. After the registration, the IPE may perform AllJoyn service discovery. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 14 oneM2M TS-0021 version 2.0.1 Release 2A |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 6.4 AllJoyn service discovery | After the IPE registration, the IPE performs AllJoyn service discovery. The IPE may provide the following AllJoyn service discovery modes: • Advertisement-based discovery mode: This modes utilizes AllJoyn multicast service advertisement. When the IPE gets service advertisements from AllJoyn service provider applications in an AllJoyn proximal network, the IPE can expose those services in oneM2M system without oneM2M AE's request. • Pre-configured (IPE initiated) discovery mode: This mode utilizes AllJoyn multicast service discovery. Interested AllJoyn services are pre-configured in the IPE (e.g. by M2M Service Provider), so the discovery is performed automatically once the IPE registration is complete. • On-demand (AE initiated) discovery mode: This mode utilizes AllJoyn multicast service discovery. Interested Alljoyn services are requested by oneM2M AEs, so the discovery is performed upon AE's service discovery request. Selection of supported mode(s) is implementation specific. After the successful AllJoyn service discovery, the discovered services - if and only if allowed by the AllJoyn side (e.g. in line with provisioned policies on an AllJoyn Gateway Agent) - shall be exposed as oneM2M resources. When new services are discovered on the AllJoyn side after initial service discovery has already been completed by the IPE, the IPE can add those additional services to the set of exposed services by means of dynamically creating the corresponding resources on the CSE at which the IPE is registered. See clause 7 for more details. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 6.5 AllJoyn service mapping | |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 6.5.1 AllJoyn service categorization | AllJoyn services can be categorized into: • AllJoyn framework services (pre-defined by AllJoyn service framework). • App-specific services (implemented using application developer defined AllJoyn interfaces). AllJoyn framework services are pre-defined and can be sub-categorized into two: base services (e.g. Notification, Control Panel) and the other framework services (e.g. Lighting service framework). The base services have relatively simple interface member composition so they can be easily mapped with the resource structure defined in clause 6.2 under the [svcObjWrapper] specialization of <flecContainer>. For a subset of the AllJoyn base services, a normative resource mapping is specified in annex C. Selected other AllJoyn framework services - i.e. not the base services - shall be exposed using separate resource structures and this is FFS. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 6.5.2 AllJoyn base service mapping | The list of AllJoyn base services [i.2]: • OnBoarding. • Configuration. • Notification. • ControlPanel. • Audio Streaming. The present document specifies base services mapping for Configuration, Notification, ControlPanel. See annex C for the AllJoyn base services mapping. For Configuration, Notification or ControlPanel services which are discovered on the AllJoyn side and are intended to be exposed to the oneM2M side, the mapping specified in annex C is normative. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 15 oneM2M TS-0021 version 2.0.1 Release 2A OnBoarding service is intended to support AllJoyn network onboarding (Wi-Fi connection support) for the device that does not have user interface. This is out of scope for oneM2M interworking. Audio Streaming is also out of scope since oneM2M system does not support in-band streaming feature. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 6.5.3 Other framework service mapping | For example, AllJoyn Lighting Services Framework mapping can be specified as described in the figure 6.2-4. However, this is not specified in the present document. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 6.5.4 AllJoyn app-specific service mapping | App-specific services implement AllJoyn interface(s) defined by 3rd party developers. In the AllJoyn system, the introspection feature can be used to deliver interface information of an AllJoyn Producer Application to AllJoyn Consumer Applications. Mapping for AllJoyn app-specific services shall follow the resource mapping structure in clause 6.2 and the <flexContainer> resource specializations in annex B. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 6.6 AllJoyn access control mapping | AllJoyn security 1.0 feature supports authentication and encryption, but not authorization. AllJoyn security 2.0 feature supports permission management (authorization), which is similar to oneM2M access control mechanism, as well as authentication and encryption. NOTE: The present document does not specify AllJoyn security 2.0 interworking. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 7 Interworking Procedures | |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 7.1 Introduction | The interworking procedures describe the following: • how does the IPE initially creates necessary resources for oneM2M-AllJoyn interworking (clause 7.2); • how does the IPE performs interworking between the oneM2M system and AllJoyn networks depending on the service exposure direction (clause 7.3). |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 7.2 IPE initial configuration | |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 7.2.1 Introduction | The initial configuration of the IPE consists of registration with its Registrar CSE and resource creation procedures. As part of registration, an <AE> resource is created to represent the AE part of the IPE. After that, AllJoyn-specific resources to support interaction between oneM2M AE/CSE(s) and AllJoyn Consumer and/or Producer Applications as well as necessary <subscription> resources are created by the IPE. The IPE shall process incoming notifications from the oneM2M CSEs which have been triggered by the created <subscription> resources and react to them by executing the appropriate actions to the interworked AllJoyn Consumer and/or Producer Applications. Accordingly, the IPE shall react to messages received from interworked AllJoyn Consumer and/or Producer Applications that are relevant to the exposed services and do any necessary changes to the resources defined for AllJoyn interworking within the oneM2M CSE. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 7.2.2 IPE registration and AllJoyn service discovery | For the interworking, firstly the IPE shall perform IPE registration (see clause 6.3). The 'labels' attribute shall include the string "AllJoyn-IPE". ETSI ETSI TS 118 121 V2.0.1 (2020-03) 16 oneM2M TS-0021 version 2.0.1 Release 2A If the IPE is set to advertisement-based or pre-configured discovery mode (see clause 6.4), the AE in the IPE shall create and expose resources corresponding to the exposed services (see clause 6.2) once the AllJoyn Application in the IPE completes AllJoyn service discovery and session establishment with AllJoyn Producer Applications referring its AllJoyn service objects. If the IPE is set to on-demand discovery mode (see clause 6.4), the IPE shall perform the same procedure above (i.e. advertisement-based or pre-configured discovery mode) when it receives a Notify request for on-demand discovery (see clause 10.2.6.2 of ETSI TS 118 101 [1]) by its Registrar CSE and then create and expose resources corresponding to the exposed services. Which resources are created for service exposure from AllJoyn Producer Application to oneM2M AE/CSE(s) is described in more detail in the clauses 7.2.3 and 7.2.4. If the IPE supports exposure of services provided by other oneM2M AE/CSE(s) to AllJoyn Consumer Applications, the IPE shall create one instance of an [allJoynApp] specialization of the <flexContainer> resource representing the AllJoyn Producer Application inside the IPE itself (see clause 6.2). Other AE/CSE(s) providing services that are meant to be exposed to AllJoyn Consumer Applications on AllJoyn devices shall use that [allJoynApp] resource representing the AllJoyn Producer Application part inside the IPE itself as the parent of any [allJoynInterface] resources they may create for offering a service(s) to the AllJoyn Consumer Applications. The particular [allJoynApp] resource representing the AllJoyn Producer Application inside the IPE itself shall be identified by the value of the direction attribute which is set to 'oneM2MToAllJoyn'. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 7.2.3 AllJoyn Service Resource creation | The AllJoyn Service Resources listed in table 7.2.3-1 shall only be created by the AllJoyn IPE. The listed resources are created as children of the <AE> resource instance representing the AllJoyn IPE according to the tree structure and resource attribute values defined in clause 6.2. Table 7.2.3-1: Resources created by IPE only AllJoyn Service Aspect Resource Type Specialization Resource Type Grouping together service objects for exposure [svcObjWrapper] flexContainer Grouping together service frameworks for exposure [svcFwWrapper] flexContainer Representation of an individual AllJoyn Consumer or Producer Application [allJoynApp] flexContainer The parent/child-relationship of these resources and their multiplicity are summarized in figure 7.2.3-1. After registration and service advertisement/discovery (see clause 7.2.2), an AllJoyn IPE shall create two children for the <AE> resource that represents this AllJoyn IPE: • One resource instance named "svcOjects" of type <flexContainer> with specialization [svcObjWrapper] and including "Iwked-Technology:AllJoyn" and "Iwked-Entity-Type:SvcObjects" in the labels attribute. • One resource instance named "svcFrameworks" of type <flexContainer> with specialization [svcFwWrapper] and including "Iwked-Technology:AllJoyn" and "Iwked-Entity-Type:SvcFrameWorks" in the labels attribute. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 17 oneM2M TS-0021 version 2.0.1 Release 2A Figure 7.2.3-1: AllJoyn interworking resource top level For each discovered AllJoyn Producer Application that is supposed to be exposed to other oneM2M AE/CSE(s), the AllJoyn IPE shall create one instance of an [allJoynApp] specialization of a <flexContainer> resource with the direction attribute indicating "allJoynToOneM2M". The name of of each of these [allJoynApp] specialization instances shall be set to the unique Well-Known-Name (WKN) [i.2] of the corresponding AllJoyn Producer Application, see clause 6.2. All resources related to service exposure from AllJoyn Producer Applications toward AE/CSE(s) shall be children of these [allJoynApp] instances. If the AllJoyn IPE supports exposure of services provided by other oneM2M AE/CSE(s) to AllJoyn Consumer Applications, it shall create one instance of an [allJoynApp] specialization of a <flexContainer> resource with the direction attribute indicating "oneM2MToAllJoyn" and named with the Well-Known-Name (WKN) [i.2] of the AllJoyn Producer Application part of the IPE. The AllJoyn Service Resources listed in table 7.2.3-2 shall be created either: • by the AllJoyn IPE for providing services from AllJoyn Producer Applications to other AE/CSE(s); or • by other oneM2M AE/CSE(s) for providing services to AllJoyn Consumer Applications. The listed resources are created as children of the instance of [allJoynApp] resources representing the corresponding AllJoyn Producer Applications inside the AllJoyn proximal network or the AllJoyn Producer Application part of the IPE in case it supports exposure of services provided by other oneM2M AE/CSE(s) into the AllJoyn proximal network. Table 7.2.3-2: Resources created by AllJoyn IPE or by other oneM2M AE/CSE(s) AllJoyn Service Aspect Resource Type Comments Specialization Resource Type Representation of an individual service object for exposure [allJoynSvcObject] <flexContainer> Representation of an individual AllJoyn interface within an AllJoyn service Object [allJoynInterface] <flexContainer> Representation of an individual AllJoyn method within an AllJoyn interface [allJoynMethod] <flexContainer> Representation of an individual instance of calling a specific AllJoyn method [allJoynMethodCall] <flexContainer> Instances of this <flexContainer> specialization are only created when a method call is attempted. Initially no instances of this <flexContainer> specializations are present in any instance of [allJoynMethod] specializations of <flexContainers> ETSI ETSI TS 118 121 V2.0.1 (2020-03) 18 oneM2M TS-0021 version 2.0.1 Release 2A AllJoyn Service Aspect Resource Type Comments Specialization Resource Type Representation of an individual property within an AllJoyn interface [allJoynProperty] <flexContainer> Representation of an signal within an Alljoyn interface N/A <container> Individual signal instances are represented by instances of <contentInstance> child resources within the <container> resource Within each instance of an [allJoynApp] specialization of a <flexContainer> resource, the AllJoyn IPE (in case the direction attribute indicates "allJoynToOneM2M") or an oneM2M AE/CSE exposing a service to AllJoyn Consumer Applications (in case direction attribute indicates "oneM2MToAllJoyn") shall create one instance of an [allJoynSvcObject] specialization of a <flexContainer> resource for each service to be exposed. The resource name of an [allJoynSvcObject] specialization of a <flexContainer> may be suggested by the Originator. It is recommended to derive it from the AllJoyn object path for the represented AllJoyn service object by properly replacing characters that are not allowed in resource names with adequate literals. Initially, when such an instance of an [allJoynSvcObject] specialization of a <flexContainer> is created, the attribute enabled shall be set to indicate "False" in order to make sure the resource is not used for interworking procedures until all other needed child resources have been created. The attribute objectPath of an [allJoynSvcObject] specialization of a <flexContainer> shall be set to a string equal to the AllJoyn object path for the represented AllJoyn service object. Once all needed child resources of an instance of an [allJoynSvcObject] specialization of a <flexContainer> are in place - see the following paragraphs and clause 7.2.4 - the enabled attribute shall be set to indicate "True". After that, the procedures for interworking between AllJoyn and oneM2M are supported for the exposed service as defined in clause 7.3. The creator of an instance of an [allJoynSvcObject] resource - i.e. the AllJoyn IPE for cases of service exposure from AllJoyn to oneM2M or some other oneM2M AE/CSE for cases of service exposure from oneM2M to AllJoyn - is responsible for creating an instance of an [allJoynInterface] resource for each interface that the service is using, see also clause 6.2. Since interfaces in AllJoyn are comprised of methods, properties and signals, the creator of an [allJoynInterface] resource is also responsible for creating the necessary children: • One instance of an [allJoynMethod] resource for each method of the respective AllJoyn interface. Instances of an [allJoynMethod] resource shall be named with the same string as the corresponding method is named in the AllJoyn interface definition. Instances of an [allJoynMethod] resource shall not contain any instances of an [allJoynMethodCall] resource before the enabled attribute of the [allJoynSvcObject] resource becomes "True". • One instance of an [allJoynProperty] resource for each property of the respective AllJoyn interface. Instances of an [allJoynProperty] resource shall be named with the same string as the property is named in the AllJoyn interface definition. Instances of an [allJoynProperty] resource shall not contain the attribute 'requestedValue' before the enabled attribute of the [allJoynSvcObject] resource becomes "True". • One instance of a <container> resource for each signal defined in the AllJoyn interface definition. An instance of <container> which represents an AllJoyn signal shall be named with the same string as the signal is named in the AllJoyn interface definition. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 7.2.4 Subscription creation | |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 7.2.4.1 Subscription creation by AE/CSE(s) acting as service producers | In the context of AllJoyn interworking, the AllJoyn IPE and other AE/CSE(s) providing services to AllJoyn Consumer Applications are acting as producers of services to other entities: • The AllJoyn IPE acts as a service producer towards other oneM2M AE/CSE(s) consuming the service. At the same time, the AllJoyn IPE acts as an AllJoyn Consumer Application inside the AllJoyn proximal network for the exposed service. • Optional: Other oneM2M AE/CSE(s) providing services indirectly to AllJoyn Consumer Applications act as a service producer towards the AllJoyn IPE which is consuming the respective service. At the same time, the AllJoyn IPE acts as an AllJoyn Producer Application within the AllJoyn proximal network towards AllJoyn Consumer Applications. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 19 oneM2M TS-0021 version 2.0.1 Release 2A Since these entities are acting as service producers on the oneM2M side, they need to monitor certain parts of the AllJoyn Service Resources in order to react to manipulation requests on these resources. After the creation of AllJoyn Service Resources to expose a specific service, but before setting the enable attribute of the respective [allJoynSvcObject] resource to indicate "True" , the IPE and any AE/CSE(s) which are exposing services to AllJoyn Consumer Applications shall either create <subscription> resources to monitor attempts for AllJoyn service method call(s), property value change requests, signal generation by the IPE or other AE/CSE(s) manipulating the service resources or use frequent retrievals of those resource for the same purpose. Regarding signal generation the following subscription rules shall apply: • A subscription to monitor signal generation by other oneM2M AE/CSE(s) within a <container> representing AllJoyn signals - i.e. to monitor the creation of instances of <contentInstance> resources - shall be created by the IPE if and only if the signal <container> resource is the great-grand child resource of [allJoynApp] resource with the direction attribute set to "oneM2MToAllJoyn". • A subscription to monitor signal generation within a <container> representing AllJoyn signals - i.e. to monitor the creation of instances of <contentInstance> resources - shall be created by the AE/CSE providing the specific service to AllJoyn Consumer Applications if and only if the signal <container> resource is the great- grand child resource of [allJoynApp] resource with the direction attribute set to "allJoynToOneM2M". When the IPE or an AE/CSE providing services to AllJoyn Consumer Applications create <subscription> resources, the <subscription> resources shall have the following attributes. Table 7.2.4.1-1: Subscription for method call Subscribed-to resource <subscription> resource resourceType Specialization eventType of eventNotificationCriteria <flexContainer> [allJoynMethod] Creation of a direct child of the subscribed-to resource Table 7.2.4.1-2: Subscription for property change Subscribed-to resource <subscription> resource resourceType Specialization eventType of eventNotificationCriteria <flexContainer> [allJoynProperty] Creation of a direct child of the subscribed-to resource Table 7.2.4.1-3: Subscription for signal generation Subscribed-to resource <subscription> resource resourceType labels attribute include eventType of eventNotificationCriteria <container> "Iwked- Technology:AllJoyn", "Iwked-Entity-Type:Signal Name" Creation of a direct child of the subscribed-to resource When all required subscriptions for specific service represented by a specific [allJoynSvcObject] resource are created, the creator of the respective [allJoynSvcObject] resource shall set the enabled attribute to indicate "True". After that, the creator of the respective [allJoynSvcObject] resource shall act on reception of notifications triggered by the created subscriptions according to the procedures defined in clause 7.3. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 7.2.4.2 Subscription creation by entities acting as service consumers | In the context of AllJoyn interworking, the AllJoyn IPE and other oneM2M AE/CSE(s) can act as consumers of services to other entities: • In general, oneM2M AE/CSE(s) can act as service consumers towards the AllJoyn IPE which is producing services on the oneM2M side for services exposed from AllJoyn to oneM2M. At the same time the AllJoyn IPE acts as an AllJoyn Consumer Application for that service within the AllJoyn proximal network. • The AllJoyn IPE acts as a service consumer towards other oneM2M AE/CSE(s) in case those other oneM2M AE/CSE(s) are providing services indirectly to AllJoyn Consumer Applications. At the same time the AllJoyn IPE acts as an AllJoyn Producer Application for these services on the AllJoyn proximal network. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 20 oneM2M TS-0021 version 2.0.1 Release 2A For consuming services based on the AllJoyn service object model - which is represented by the structure of AllJoyn Service Resources in [allJoynSvcObject] resources - an oneM2M entity may need to subscribe to specific resources within the set of AllJoyn Service Resources instances in order to properly consume the respective service. When an AllJoyn IPE supports exposure of services provided by other oneM2M AE/CSE(s) to AllJoyn Consumer Applications the following applies: In order for the AllJoyn IPE to be able to notice when a service provided by a oneM2M entity via the IPE to AllJoyn Consumer Applications gets initiated, it shall subscribe to the specific [allJoynApp] resource with the 'direction' attribute indicating "oneM2MToAllJoyn" and named with the Well-Known-Name (WKN) [i.2] of the AllJoyn Producer Application part of the IPE. The following cases for creating subscriptions in order to consume a service via a specific AllJoyn interface are relevant in context of AllJoyn interworking: • Method calls: - When a particular attempt to call a method is made (see clause 7.3 for details on how to initiate that), the consumer of the service is creates an instance of an [allJoynMethodCall] resource as a child of the respective [allJoynMethod] resource. In order to get notice of the status and outcome of the calling attempt, the service consumer should subscribe to the [allJoynMethodCall] resource. In particular the subscription should be limited to monitor creation/changes of the callStatus and output attributes. However, the same functionality can be achieved by retrieving that resource with sufficient frequency. In the case an AllJoyn IPE acts as a service consumer towards other oneM2M AE/CSE(s) in order to expose those services within the AllJoyn proximal network as an AllJoyn Producer Application, the AllJoyn IPE shall either subscribe to the [allJoynMethodCall] resource instances it has created in that role or retrieve with sufficient frequency that it gets to know about changes in the callStatus and output attributes of the [allJoynMethodCall] resources it created. • Properties: - When a service consumer is interested in any changes of properties of an exposed AllJoyn interface, the consumer should subscribe to the respective [allJoynProperty] resource. Monitoring of properties is up to the consumer and is not required in general for consuming services based on the AllJoyn service object model. If an AllJoyn IPE is acting as a consumer of a service provided by a AE/CSE so that it can expose that service as an Alljoyn Producer Application inside the AllJoyn proximal network, it shall either subscribe to any [allJoynProperty] resource instances before it creates or modifies the requestedValue attribute of such a resource or frequently retrieve it in order to get to know about the outcome of such a request to change a property value. • Signals: - When a service consumer is interested in receiving signals generated for a particular AllJoyn interface, the consumer should subscribe to the respective <container> resource representing that signal in the AllJoyn interface. However, the same functionality can be achieved by retrieving that resource with sufficient frequency. In the case an AllJoyn IPE acts as a service consumer towards other oneM2M AE/CSE(s) in order to expose those services within the AllJoyn proximal network as an AllJoyn Producer Application, the AllJoyn IPE shall either subscribe to all <container> resources representing signals in the exposed AllJoyn interface or retrieve them with sufficient frequency to know about the occurrence of new <contentInstance> resources representing new signal instances. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 7.3 IPE interworking | |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 7.3.1 Introduction | When the AllJoyn Service Resources are created by the IPE or an AE/CSE exposing services to the AllJoyn side, oneM2M AE/CSE(s) trying to consume those exposed services can manipulate certain parts of those AllJoyn Service Resources in order to initiate and process the service consumption. Since an AllJoyn service is produced/consumed by an AllJoyn interface member access (i.e. by access to methods, properties, signals ), the IPE delivers method call, property change and signal generation from/to oneM2M and AllJoyn systems. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 21 oneM2M TS-0021 version 2.0.1 Release 2A |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 7.3.2 AllJoyn services consumed by AE/CSE(s) | For an AllJoyn service that is consumed by AE/CSE(s) (i.e. direction attribute of the respective [allJoynApp] resource is indicating "allJoynToOneM2m"), the IPE performs the following: • When a new instance of an [allJoynMethodCall] resource is created, the IPE shall parse the input attribute of the [allJoynMethodCall] resource and convert it into the corresponding AllJoyn method call message and send the message to the corresponding AllJoyn Producer Application. The IPE should update the callStatus and output attributes of the [allJoynMethodCall] resource to represent the actual status of the calling attempt (e.g. failed, OK) and the returned output of the method call accordingly. • When the requestedValue attribute of a [allJoynProperty] resource is created (i.e. added to the existing resource), the IPE shall parse the attribute values and convert it into the corresponding AllJoyn property set message and send the message to the corresponding AllJoyn Producer Application. The IPE should delete the requestedValue attribute and update the currentValue attribute of the [allJoynProperty] resource to represent the outcome of the attempted change of property value accordingly. • When the IPE receives an AllJoyn signal message, the IPE shall parse the message and convert it into a creation of a new instance of a <contentInstance> resource as a child of the signal <container> resource, whereby the content attribute of the <contentInstance> resource shall be set to a serialization of the signal's payload. |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 7.3.3 AllJoyn services produced by oneM2M AE/CSE(s) via the IPE | For an AllJoyn service that is produced by AE/CSE(s) and consumed by AllJoyn Consumer Applications on AllJoyn devices (i.e. direction attribute of [allJoynApp] resource is "oneM2MToAllJoyn"), the IPE shall perform the following: • When the AllJoyn Producer Application on the IPE receives AllJoyn method call message, it shall parse the message and convert it into creation of a new instance of an [allJoynMethodCall] resource as a child resource of the corresponding [allJoynMethod] resource. The IPE shall either subscribe to the created new instance of an [allJoynMethodCall] resource so that it gets notified about any creation or changes of the callStatus and output attributes or retrieve the information with sufficient frequency. The entity which is actually providing the respective service shall either be subscribed to the corresponding [allJoynMethod] parent resource or use frequent polling of it - and therefore -gets to know about the attempt to call a method. Upon this notification or retrieval of the resource, the oneM2M entity providing the service shall carry out the requested method and update the callStatus and output attributes of the [allJoynMethodCall] resource to represent the actual status of the calling attempt (e.g. failed, OK) and the returned output of the method call accordingly. When a method calling attempt initiated by the IPE has completed (successfully or not) the IPE shall parse the callStatus and output attributes - if applicable - and convert that information into the appropriate AllJoyn method call response message. Note that this is not always required and depends on what particular method is called. • When the AllJoyn Producer Application on the IPE receives an AllJoyn property set message, it shall parse and convert the message by the addition of the requestedValue attribute to the respective [allJoynProperty] resource. In order to find out what happens with the the respective [allJoynProperty] in the next steps, the IPE shall either subscribe to the corresponding [allJoynProperty] resource before addition of the requestedValue attribute or retrieve the corresponding [allJoynProperty] resource periodically. The oneM2M entity providing the service shall carry out the requested change of property value and update the value of currentValue attribute of the [allJoynProperty] accordingly. Finally the requestedValue attribute of the [allJoynProperty] shall be removed by the oneM2M entity providing the service. The IPE shall process the result of the property value change request which it will get to know - either by being notified due to the subscription made earlier or by periodic retrieval It is up to the IPE to choose polling or subscription/notification and possibly keep the subscription in place for later use or remove it. • When a new <contentInstance> resource gets created as a child of a signal <container> resource, the IPE - which shall either be subscribed to the parent <container> resource according to clause 7.2.4.2 or use frequent retrieval - shall parse the content attribute of the <contentInstance> resource and convert it into the AllJoyn signal message and send the message to the corresponding AllJoyn Consumer Application(s). ETSI ETSI TS 118 121 V2.0.1 (2020-03) 22 oneM2M TS-0021 version 2.0.1 Release 2A |
b91843ad94c9e1da80e5c8a88af6952a | 118 121 | 7.3.4 AllJoyn services addition and deletion | After the initial configuration of the IPE, new AllJoyn services can be exposed to oneM2M and existing AllJoyn services interworking can be stopped. Also services produced by oneM2M AE/CSE(s) and exposed to AllJoyn via the AllJoyn IPE can be added and removed. When a new AllJoyn service that is supposed to be exposed to oneM2M is discovered (see clause 7.3.2), the IPE shall create an [allJoynApp] resource as a child of the [svcObjWrapper] resource has and set the direction attribute set to indicate "allJoynToOneM2M" and create child/decedent resources as defined in clause 6.2 as well as clause 7.2.3. When the IPE supports exposure of oneM2M-provided services to AllJoyn (i.e. the IPE can also act as an AllJoyn Producer Application on the AllJoyn side) and if an AE/CS initiates a service that shall be exposed by the IPE as an AllJoyn service that would be consumed by AllJoyn Consumer Applications on AllJoyn devices, the service providing oneM2M entity shall create a new instance of an [allJoynSvcObject] resource as a child of the [allJoynApp] resource that was already created by the IPE at time of initialization as a child of the [svcObjWrapper] resource which has the direction attribute set to "oneM2MToAllJoyn". The oneM2M entity producing the service for AllJoyn Consumer Applications via the IPE is also responsible to create child/decedent resources as defined in clause 6.2 and clause 7.2.3. As already defined in clause 7.2.4.2, the IPE shall either be subscribed to the parent [allJoynApp] resource or retrieve it with sufficient frequency. Upon notification or retrieval about addition of a new [allJoynSvcObject] resource the IPE shall validate if the created child resource and its descendants are in line with the specified structure. When valid, the IPE shall initiate to offer the corresponding service as an AllJoyn Producer Application on the AllJoyn side, in that it shall start to carry out the advertisement and discovery procedures defined in the AllJoyn system for this service. When an already exposed AllJoyn service is stopped in the AllJoyn proximal network, then the IPE shall remove the corresponding [allJoynApp] resource as well as the child/descendant resources of this [allJoynApp] resource. Example usages of this removal are: AllJoyn Consumer Application on the IPE leaves the session established with an AllJoyn Producer Application in an AllJoyn proximal network, AllJoyn Producer Application on the IPE leaves the session established with AllJoyn Consumer Application(s) in an AllJoyn proximal network. Upon removal of the corresponding [allJoynApp] resource, oneM2M entities will not be able anymore to consume that service. For already exposed services produced on the oneM2M side, the service producer can remove the respective [allJoynSvcObject] resource that is a child of the [allJoynApp] resource that was already created by the IPE at time of initialization as a child of the [svcObjWrapper] resource which has the direction attribute set to "oneM2MToAllJoyn". The removal will either get notified to the IPE due to a previous established subscription or by periodic retrieval (polling). Upon getting information about the removal of a oneM2M-provided service that was exposed to AllJoyn, the IPE shall stop acting as an AllJoyn Producer Application and terminate any existing service sessions for that service on the AllJoyn side. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 23 oneM2M TS-0021 version 2.0.1 Release 2A Annex A (informative): oneM2M and AllJoyn technical comparison A.1 API styles Table A.1-1 describes how API styles of oneM2M and AllJoyn system are different to expose its services that can provide some functionalities. Table A.1-1: The Comparison of API Styles of oneM2M and AllJoyn System oneM2M AllJoyn API Style Resource based API (RESTful Architecture). It assigns all procedures, instances of data a resource identified by a URI and leverage web-based protocol's operations (CRUD) to define service behaviours. D-Bus [i.4] based API. It defines a protocol for exposing a typical object-oriented language-based service to other applications that consume the service. Representation of a Service An oneM2M Service is defined by one or more Resources specified in ETSI TS 118 101 [1]. An oneM2M resource defines a set of representations of data. Each resource has attributes that stores information regarding the resource itself, procedures or data. An AllJoyn Service is defined by one or more AllJoyn Interfaces. An AllJoyn interface can include one or more of following types of members: • Methods: a function call that typically takes a set of inputs, performs and returns. • Properties: a variable that holds values. • Signals: an asynchronous notification that is generated by a service to notify remote peers of an event or change. Tables A.1-2 and A.1-3 give examples how an oneM2M and AllJoyn service is described respectively. Both examples demonstrate a schema or introspection that describes location service to acquire the location information of a target information. Table A.1-2: Resource Schema of <locationPolicy> (v2.4.0) <xs:schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.onem2m.org/xml/protocols" xmlns:m2m="http://www.onem2m.org/xml/protocols" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" elementFormDefault="unqualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:include schemaLocation="CDT-commonTypes-v2_4_0.xsd" /> <xs:include schemaLocation="CDT-subscription-v2_4_0.xsd" /> <xs:element name="locationPolicy"> <xs:complexType> <xs:complexContent> <!-- Inherit common attributes for announceable Resources --> <xs:extension base="m2m:announceableResource"> <xs:sequence> <!-- Resource Specific Attributes --> <xs:element name="locationSource" type="m2m:locationSource" /> <xs:element name="locationUpdatePeriod" type="m2m:listOfDuration" minOccurs="0" /> <xs:element name="locationTargetID" type="m2m:nodeID" minOccurs="0" /> <xs:element name="locationServer" type="xs:anyURI" minOccurs="0" /> <xs:element name="locationContainerID" type="xs:anyURI" minOccurs="0" /> ETSI ETSI TS 118 121 V2.0.1 (2020-03) 24 oneM2M TS-0021 version 2.0.1 Release 2A <xs:element name="locationContainerName" type="xs:string" minOccurs="0" /> <xs:element name="locationStatus" type="xs:string" /> <!-- Child Resources --> <xs:choice minOccurs="0" maxOccurs="1"> <xs:element name="childResource" type="m2m:childResourceRef" minOccurs="1" maxOccurs="unbounded" /> <xs:choice minOccurs="1" maxOccurs="unbounded"> <xs:element ref="m2m:subscription"></xs:element> </xs:choice> </xs:choice> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element> <xs:element name="locationPolicyAnnc"> <xs:complexType> <xs:complexContent> <!-- Inherit common attributes for announced Resources --> <xs:extension base="m2m:announcedResource"> <xs:sequence> <!-- Resource Specific Attributes --> <xs:element name="locationSource" type="m2m:locationSource" minOccurs="0" /> <xs:element name="locationUpdatePeriod" type="m2m:listOfDuration" minOccurs="0" /> <xs:element name="locationTargetID" type="m2m:nodeID" minOccurs="0" /> <xs:element name="locationServer" type="xs:anyURI" minOccurs="0" /> <xs:element name="locationContainerID" type="xs:anyURI" minOccurs="0" /> <xs:element name="locationContainerName" type="xs:string" minOccurs="0" /> <xs:element name="locationStatus" type="xs:string" minOccurs="0" /> <!-- No Child Resources --> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element> </xs:schema><xs:schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.onem2m.org/xml/protocols" xmlns:m2m="http://www.onem2m.org/xml/protocols" elementFormDefault="unqualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:include schemaLocation="CDT-commonTypes-v0_7_1.xsd" /> <xs:element name="locationPolicy"> <xs:complexType> <xs:complexContent> <!-- Inherit Announce able Attributes from announceableResourceType --> <xs:extension base="m2m:announceableResourceType"> <xs:sequence> <!-- Resource Specific Attributes --> <xs:element name="locationSource" type="m2m:locationSource" /> <xs:element name="locationUpdatePeriod" type="xs:duration" minOccurs="0" /> <xs:element name="locationTargetID" type="m2m:nodeID" minOccurs="0" /> <xs:element name="locationServer" type="xs:anyURI" minOccurs="0" /> <xs:element name="locationContainerID" type="xs:anyURI" minOccurs="0" /> <xs:element name="locationContainerName" type="xs:string" minOccurs="0" /> <xs:element name="locationStatus" type="xs:string" minOccurs="0" /> ETSI ETSI TS 118 121 V2.0.1 (2020-03) 25 oneM2M TS-0021 version 2.0.1 Release 2A </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element> </xs:schema> The resource schema described in the table above can be also graphically represented as figure A.1-1. Figure A.1-1: Structure of <locationPolicy> resource Table A.1-3: Introspection XML of an AllJoyn Location Service (example) <node name="/com/alljoyn/LocationService"> <interface name="com.alljoyn.LocationService"> <method name="getLocation"> <arg name="locationSource" type="s" direction="in"> </arg> <arg name="targetID" type="s" direction="in"> </arg> </method> <signal name="locationPoint" sessionless="true> </signal> <property name="locationStatus" type="y" access="read"> </property> </interface> </node> ETSI ETSI TS 118 121 V2.0.1 (2020-03) 26 oneM2M TS-0021 version 2.0.1 Release 2A A.2 Service Discovery/Advertisement One of the most significant features of service layer protocol for the IoT is to advertise or discover services to a remote entity or application. Both systems have specified significantly different advertisement and discovery mechanism. Table A.2-1: The Comparison of API Styles of oneM2M and AllJoyn System oneM2M AllJoyn Service Consumer Since oneM2M is a web-based architecture, the service consumer firstly discover a target service instantiated in a CSE using GET method. The discovery message is sent over unicast transport protocol. If the target service is found, the service consumer consumes the service subject to access control. This behaviour is just like resource searching by using web-browser. A service consumer in AllJoyn network send a DNS-SD query message over Multicast DNS (mDNS) network to discover a target service implemented in other applications/devices. Since a site-local IP multicast mechanism is used for mDNS, the DNS-SD query can be sent toward mDNS multicast members within proximal network. In order to enable secure access a service resides in the remote network, All Seen Alliance has been specifying a Gateway Agent feature [i.4] (see note). Service Provider The notification for service advertisement which is sent toward unspecified applications causes network collapse due to the broadcast message flooding. Thus, oneM2M does not specify the proactive advertisement method acting by service provider. However, oneM2M has specified the service information forwarding (toward target node) method, "Announcement". If the services specified in the received query is provided by the service provider, the service provider responds a DNS-SD response message over unicast to the service consumer (see note). NOTE: This procedure supports after 14.06 version of AllJoyn system. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 27 oneM2M TS-0021 version 2.0.1 Release 2A Annex B (normative): <flexContainer> resource specializations B.1 Introduction In this annex, all AllJoyn specific resource types are defined. All resource types specific to AllJoyn interworking are specializations of the <flexContainer>. B.2 Resource Type svcObjWrapper This specialization of <flexContainer> is intended to be used to wrap a group of child resources related to AllJoyn service objects with minimal overhead. No custom attributes are needed for this specialization. Figure B.2-1: Structure of [svcObjWrapper] resource The [svcObjWrapper] resource shall contain the child resources specified in table B.2-1. Table B.2-1: Child resources of [svcObjWrapper] resource Child Resources of [svcObjWrapper] Child Resource Type Multiplicity Description [svcObjWrapperAnnc] Child Resource Type [variable] <subscription> 0..n See clause 9.6.8 in ETSI TS 118 101 [1] <subscription> [variable] <semanticDescriptor> 0..n See clause 9.6.30 in ETSI TS 118 101 [1] <semanticDescriptor>, <semanticDescriptorAnnc> [variable] [allJoynApp] 0..n See clause B.4 [allJoynAppAnnc] ETSI ETSI TS 118 121 V2.0.1 (2020-03) 28 oneM2M TS-0021 version 2.0.1 Release 2A The [svcObjWrapper] resource shall contain the attributes specified in table B.2-2. Table B.2-2: Attributes of [svcObjWrapper] resource Attributes of [svcObjWrapper] Multiplicity RW/ RO/ WO Description [svcObjWrapp er] Attributes resourceType 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceName 1 WO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA parentID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA expirationTime 1 RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA labels 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA creationTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA lastModifiedTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA stateTag 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] OA announceTo 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] OA containerDefinition 1 WO This contains a reference (URN) to the definition which shall be used by the CSE to statically validate the syntax of the specialization of the [wrapper] resource (see note). This URN shall refer to: • AllJoyn Interworking, wrapper MA creator 0..1 RO The AE-ID or CSE-ID of the entity which created the resource. NA ontologyRef 0..1 RW A reference (URI) of the ontology used to represent the information that is stored in the present [svcObjWrapper] resource. OA NOTE: The reference is a URN and not URL: the CSE does not retrieve the definition of the [wrapper] resource dynamically. B.3 Resource Type svcFwWrapper This specialization of <flexContainer> is intended to be used to wrap a group of child resources related to AllJoyn framework services with minimal overhead. No custom attributes are needed for this specialization. <subscription> 0..n [svcObjWrapper] 0..1 creator 1 containerDefinition <semanticDescriptor> 0..n Figure B.3-1: Structure of [svcFwWrapper] resource ETSI ETSI TS 118 121 V2.0.1 (2020-03) 29 oneM2M TS-0021 version 2.0.1 Release 2A The [svcFwWrapper] resource shall contain the child resources specified in table B.3-1. Table B.3-1: Child resources of [svcFwWrapper] resource Child Resources of [svcFwWrapper] Child Resource Type Multiplicity Description [svcFwWrapperAnnc] Child Resource Type [variable] <subscription> 0..n See clause 9.6.8 in ETSI TS 118 101 [1] <subscription> [variable] <semanticDescriptor> 0..n See clause 9.6.30 in ETSI TS 118 101 [1] <semanticDescriptor>, <semanticDescriptorAnnc> The [svcFwWrapper] resource shall contain the attributes specified in table B.3-2. Table B.3-2: Attributes of [svcFwWrapper] resource Attributes of [svcFwWrapper] Multiplicity RW/ RO/ WO Description [svcFwWrapper] Attributes resourceType 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceName 1 WO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA parentID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA expirationTime 1 RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA labels 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA creationTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA lastModifiedTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA stateTag 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] OA announceTo 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] OA containerDefinition 1 WO This contains a reference (URN) to the definition which shall be used by the CSE to statically validate the syntax of the specialization of the [wrapper] resource (see note). This URN shall refer to: • AllJoyn Interworking, wrapper MA creator 0..1 RO The AE-ID or CSE-ID of the entity which created the resource. NA ontologyRef 0..1 RW A reference (URI) of the ontology used to represent the information that is stored in the present [svcObjWrapper] resource. OA NOTE: The reference is a URN and not URL: the CSE does not retrieve the definition of the [wrapper] resource dynamically. B.4 Resource Type allJoynApp This specialization of <flexContainer> is used to represent a specific instance of an AllJoyn application. The name of an instance of this resource type shall be set to the Well-Known-Name of the represented AllJoyn application instance at the local AllJoyn bus for which interworking is enabled through this resource and its children. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 30 oneM2M TS-0021 version 2.0.1 Release 2A Figure B.4-1: Structure of [allJoynApp] resource The [allJoynApp] resource shall contain the child resources specified in table B.4-1. Table B.4-1: Child resources of [allJoynApp] resource Child Resources of [allJoynApp] Child Resource Type Multiplicity Description [allJoynAppAnnc] Child Resource Type [variable] <subscription> 0..n See clause 9.6.8 in ETSI TS 118 101 [1] <subscription> [variable] <semanticDescriptor> 0..n See clause 9.6.30 in ETSI TS 118 101 [1] <semanticDescriptor>, <semanticDescriptorAnnc> [variable] [allJoynSvcObject] 0..n See clause B.5 in the present document [allJoynSvcObject] [allJoynSvcObjectAnnc] The [allJoynApp] resource shall contain the attributes specified in table B.4-2. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 31 oneM2M TS-0021 version 2.0.1 Release 2A Table B.4-2: Attributes of [allJoynApp] resource Attributes of [allJoynApp] Multiplicity RW/ RO/ WO Description [allJoynApp ainerAnnc] Attributes resourceType 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceName 1 WO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA parentID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA expirationTime 1 RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA labels 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA creationTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA lastModifiedTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA stateTag 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] OA announceTo 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] OA containerDefinition 1 WO This contains a reference (URN) to the definition which shall be used by the CSE to statically validate the syntax of the specialization of the [wrapper] resource (see note). This URN shall refer to: • AllJoyn Interworking, allJoynApp MA creator 0..1 RO The AE-ID or CSE-ID of the entity which created the resource. NA direction 1 WO This attribute indicates whether the service is exposed from the AllJoyn side to the oneM2M side (value corresponding to "allJoynToOneM2m") or vice versa (value corresponding to "oneM2mToAllJoyn"). MA ontologyRef 0..1 RW A reference (URI) of the ontology used to represent the information that is stored in the present [svcObjWrapper] resource. OA NOTE: The reference is a URN and not URL: the CSE does not retrieve the definition of the [wrapper] dynamically. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 32 oneM2M TS-0021 version 2.0.1 Release 2A B.5 Resource Type allJoynSvcObject This specialization of <flexContainer> is used to represent a specific instance of an AllJoyn service object. Figure B.5-1: Structure of [allJoynSvcObject] resource The [allJoynSvcObject] resource shall contain the child resources specified in table B.5-1. Table B.5-1: Child resources of [allJoynSvcObject] resource Child Resources of [allJoynSvcObject] Child Resource Type Multiplicity Description [allJoynSvcObjectAnnc] Child Resource Type [variable] <subscription> 0..n See clause 9.6.8 in ETSI TS 118 101 [1] <subscription> [variable] <semanticDescriptor> 0..n See clause 9.6.30 in ETSI TS 118 101 [1] <semanticDescriptor>, <semanticDescriptorAnnc> [variable] [allJoynInterface] 0..n See clause B.6 of the present document [allJoynInterface] [allJoynInterfaceAnnc] ETSI ETSI TS 118 121 V2.0.1 (2020-03) 33 oneM2M TS-0021 version 2.0.1 Release 2A The [allJoynSvcObject] resource shall contain the attributes specified in table B.5-2. Table B.5-2: Attributes of [allJoynSvcObject] resource Attributes of [allJoynSvcObject] Multiplicity RW/ RO/ WO Description [allJoynSvcObj ectAnnc] Attributes resourceType 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceName 1 WO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA parentID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA expirationTime 1 RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA labels 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA creationTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA lastModifiedTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA stateTag 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] OA announceTo 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] OA containerDefinition 1 WO This contains a reference (URN) to the definition which shall be used by the CSE to statically validate the syntax of the specialization of the [wrapper] resource (see note). This URN shall refer to: • AllJoyn Interworking, allJoynSvcObject MA creator 0..1 RO The AE-ID or CSE-ID of the entity which created the resource. NA objectPath 1 WO This attribute contains a string equal to the AllJoyn object path for the represented AllJoyn service object. MA enable 1 RW This attribute contains a flag indicating whether the resource representing the corresponding AllJoyn service object - and all its child resources - can currently be used for service exposure. When this attribute is set to False, no service exposure interactions are supported for the AllJoyn service object represented by this [allJoynSvcObject] resource. If this attribute is set to True, service exposure interactions are supported for the AllJoyn service object represented by this [allJoynSvcObject] resource. OA ontologyRef 0..1 RW A reference (URI) of the ontology used to represent the information that is stored in the present [svcObjWrapper] resource. OA NOTE: The reference is a URN and not URL: the CSE does not retrieve the definition of the [wrapper] dynamically. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 34 oneM2M TS-0021 version 2.0.1 Release 2A B.6 Resource Type allJoynInterface This specialization of <flexContainer> is used to represent a specific implementation of an AllJoyn interface residing in an AllJoyn service object. Figure B.6-1: Structure of [allJoynInterface] resource The [allJoynInterface] resource shall contain the child resources specified in table B.6-1. Table B.6-1: Child resources of [allJoynInterface] resource Child Resources of [allJoynInterface] Child Resource Type Multiplicity Description [allJoynInterface Annc] Child Resource Type [variable] <subscription> 0..n See clause 9.6.8 in ETSI TS 118 101 [1] <subscription> [variable] <semanticDescriptor> 0..n See clause 9.6.30 in ETSI TS 118 101 [1] <semanticDescriptor>, <semanticDescriptorAnnc> [variable] [allJoynMethod] 0..n See clause B.7 in the present document [allJoynMethod] [allJoynMethodAnnc] [variable] [allJoynProperty] 0..n See clause B.9 in the present document [allJoynProperty] [allJoynPropertyAnnc] [variable] <container> 0..n See clause 9.6.6 in ETSI TS 118 101 [1] <container> <containerAnnc> The [allJoynInterface] resource shall contain the attributes specified in table B.6-2. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 35 oneM2M TS-0021 version 2.0.1 Release 2A Table B.6-2: Attributes of [allJoynInterface] resource Attributes of [allJoynInterface] Multiplicity RW/ RO/ WO Description [allJoynInterfa ce Annc] Attributes resourceType 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceName 1 WO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA parentID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA labels 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA stateTag 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] OA announceTo 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] OA containerDefinition 1 WO This contains a reference (URN) to the definition which shall be used by the CSE to statically validate the syntax of the specialization of the [wrapper] resource (see note). This URN shall refer to: • AllJoyn Interworking, allJoynInterface MA creator 0..1 RO The AE-ID or CSE-ID of the entity which created the resource. NA interfaceIntrospectXmlRef 1 WO This attribute contains a reference to the AllJoyn interface definition in XML. The reference can either be a reference to another resource containing the XML (e.g. a <contentInstance> resource) or a URI pointing to a publicly accessible location containing the XML definition. OA ontologyRef 0..1 RW A reference (URI) of the ontology used to represent the information that is stored in the present [svcObjWrapper] resource. OA NOTE: The reference is a URN and not URL: the CSE does not retrieve the definition of the [wrapper] dynamically. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 36 oneM2M TS-0021 version 2.0.1 Release 2A B.7 Resource Type allJoynMethod This specialization of <flexContainer> is used to represent a specific method of an AllJoyn interface residing in an AllJoyn service object. The name of an instance of this resource type shall be set to the name of the represented method in the AllJoyn interface in which this method resides. Figure B.7-1: Structure of [allJoynMethod] resource The [allJoynMethod] resource shall contain the child resources specified in table B.7-1. Table B.7-1: Child resources of [allJoynMethod] resource Child Resources of [allJoynMethod] Child Resource Type Multiplicity Description [allJoynMethodAnnc] Child Resource Type [variable] <subscription> 0..n See clause 9.6.8 in ETSI TS 118 101 [1] <subscription> [variable] <semanticDescriptor> 0..n See clause 9.6.30 in ETSI TS 118 101 [1] <semanticDescriptor>, <semanticDescriptorAnnc> [variable] [allJoynMethodCall] 0..n See clause B.8 in the present document [allJoynMethodCall] [allJoynMethodCallAnnc] The [allJoynMethod] resource shall contain the attributes specified in table B.7-2. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 37 oneM2M TS-0021 version 2.0.1 Release 2A Table B.7-2: Attributes of [allJoynMethod] resource Attributes of [allJoynMethod] Multiplicity RW/ RO/ WO Description [allJoynMetho dAnnc] Attributes resourceType 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceName 1 WO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA parentID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA labels 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA stateTag 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] OA announceTo 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] OA containerDefinition 1 WO This contains a reference (URN) to the definition which shall be used by the CSE to statically validate the syntax of the specialization of the [wrapper] resource (see note). This URN shall refer to: • AllJoyn Interworking, allJoynMethod MA creator 0..1 RO The AE-ID or CSE-ID of the entity which created the resource. NA ontologyRef 0..1 RW A reference (URI) of the ontology used to represent the information that is stored in the present [svcObjWrapper] resource. OA NOTE: The reference is a URN and not URL: the CSE does not retrieve the definition of the [wrapper] dynamically. B.8 Resource Type allJoynMethodCall This specialization of <flexContainer> is used to represent a specific calling instance of a method of an AllJoyn interface residing in an AllJoyn service object. For each call of the AllJoyn method represented by the parent [allJoynMethodCall] resource, the consumer of the service needs to create a new instance of a [allJoynMethodCall] resource. Upon successful creation of a [allJoynMethodCall], the corresponding AllJoyn method will be executed. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 38 oneM2M TS-0021 version 2.0.1 Release 2A Figure B.8-1: Structure of [allJoynMethodCall] resource The [allJoynMethodCall] resource shall contain the child resources specified in table B.8-1. Table B.8-1: Child resources of [allJoynMethodCall] resource Child Resources of [allJoynMethodCall] Child Resource Type Multiplicity Description [allJoynMethodCallAnnc] Child Resource Type [variable] <subscription> 0..n See clause 9.6.8 in ETSI TS 118 101 [1] <subscription> [variable] <semanticDescriptor> 0..n See clause 9.6.30 in ETSI TS 118 101 [1] <semanticDescriptor>, <semanticDescriptorAnnc> The [allJoynMethodCall] resource shall contain the attributes specified in table B.8-2. Table B.8-2: Attributes of [allJoynMethodCall] resource Attributes of [allJoynMethodCall] Multiplicity RW/ RO/ WO Description [allJoynMetho dCallAnnc] Attributes resourceType 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceName 1 WO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA parentID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA expirationTime 1 RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA labels 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA creationTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA lastModifiedTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA stateTag 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] OA announceTo 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] OA ETSI ETSI TS 118 121 V2.0.1 (2020-03) 39 oneM2M TS-0021 version 2.0.1 Release 2A Attributes of [allJoynMethodCall] Multiplicity RW/ RO/ WO Description [allJoynMetho dCallAnnc] Attributes containerDefinition 1 WO This contains a reference (URN) to the definition which shall be used by the CSE to statically validate the syntax of the specialization of the [wrapper] resource (see note). This URN shall refer to: • AllJoyn Interworking, allJoynMethodCall MA creator 0..1 RO The AE-ID or CSE-ID of the entity which created the resource. NA input 0..1 WO In cases where the AllJoyn method represented by the parent [allJoynMethod] resource requires input parameters, the input attribute needs to be present and contain a valid serialization of input parameters to the method call. NA callStatus 0..1 RW The entity which acts on creation of a new [allJoynMethodCall] resource - i.e. the IPE in case of a service exposed from AllJoyn to oneM2M or another AE in case of exposing a service from oneM2M to AllJoyn - needs to perform the requested method call and populate the callStatus attribute with corresponding status information. NA output 0..1 RW Upon completion of an AllJoyn method call which produces output parameters, the ouput attribute shall get populated with a valid serialization of the corresponding output of the method call - if any. Note that some AllJoyn methods do not return any output parameters upon completion of a call. NA ontologyRef 0..1 RW A reference (URI) of the ontology used to represent the information that is stored in the present [svcObjWrapper] resource. OA NOTE: The reference is a URN and not URL: the CSE does not retrieve the definition of the [wrapper] dynamically. B.9 Resource Type allJoynProperty This specialization of <flexContainer> is used to represent a specific property of an AllJoyn interface residing in an AllJoyn service object. The name of an instance of this resource type shall be set to the name of the represented property in the AllJoyn interface in which the represented property resides. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 40 oneM2M TS-0021 version 2.0.1 Release 2A Figure B.9-1: Structure of [allJoynProperty] resource The [allJoynProperty] resource shall contain the child resources specified in table B.9-1. Table B.9-1: Child resources of [allJoynProperty] resource Child Resources of [allJoynProperty] Child Resource Type Multiplicity Description [allJoynPropertyAnnc] Child Resource Type [variable] <subscription> 0..n See clause 9.6.8 in ETSI TS 118 101 [1] <subscription> [variable] <semanticDescriptor> 0..n See clause 9.6.30 in ETSI TS 118 101 [1] <semanticDescriptor>, <semanticDescriptorAnnc> ETSI ETSI TS 118 121 V2.0.1 (2020-03) 41 oneM2M TS-0021 version 2.0.1 Release 2A The [allJoynProperty] resource shall contain the attributes specified in table B.9-2. Table B.9-2: Attributes of [allJoynProperty] resource Attributes of [allJoynProperty] Multiplicity RW/ RO/ WO Description [allJoynProper tyAnnc] Attributes resourceType 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA resourceName 1 WO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA parentID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA labels 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] MA lastModifiedTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] NA stateTag 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [1] OA announceTo 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] NA dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [1] OA containerDefinition 1 WO This contains a reference (URN) to the definition which shall be used by the CSE to statically validate the syntax of the specialization of the [wrapper] resource (see note). This URN shall refer to: • AllJoyn Interworking, allJoynMethodCall MA creator 0..1 RO The AE-ID or CSE-ID of the entity which created the resource. NA currentValue 1 RW The attribute currentValue is representing the current value of the property. NA requestedValue 0..1 RW When the AllJoyn interface property represented by this resource is capable of being changed, the attribute requestedValue shall be created - if not already present - or updated - if already present - to request a change of the current value of the property to a new value. Upon completion of such a change request, the IPE or the service providing AE will update the new value of the property in the attribute currentValue. NA ontologyRef 0..1 RW A reference (URI) of the ontology used to represent the information that is stored in the present [svcObjWrapper] resource. OA NOTE: The reference is a URN and not URL: the CSE does not retrieve the definition of the [wrapper] dynamically. ETSI ETSI TS 118 121 V2.0.1 (2020-03) 42 oneM2M TS-0021 version 2.0.1 Release 2A Annex C (normative): AllJoyn interface mapping to oneM2M resource structure C.1 Notification service C.1.1 Notification interface AllJoyn Notification(org.alljoyn.Notification) interface and its members shall be mapped with the following structure. "org.alljoyn.Notification" <flexContainer> 1 "Notify" <container> 0..n signal <contentInstance> Figure C.1.1-1: Structure of Notification interface mapping Each resource in the figure above shall have the attribute values as follows. Table C.1.1-1: Attribute values of org.alljoyn.Notification resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "org.alljoyn. Notification" AllJoyn interface name containerDefinition "alljoynInterface" AllJoyn interface version "1" Version property value is "1" NOTE: The values for containerDefinition attribute is defined in ETSI TS 118 104 [2]. This applies in the other tables in this annex C. Table C.1.1-2: Attribute values of Notify resource Attribute Value Description resourceType "3" Enumeration value for the container resource type resourceName "Notify" "Notify" signal labels "Iwked-Technology:AllJoyn", "Iwked-Entity-Type:Signal Name" Table C.1.1-3: Attribute values of signal resource Attribute Value Description resourceType "4" Enumeration value for the contentInstance resource type resourceName (variable) content (variable) Signal message ETSI ETSI TS 118 121 V2.0.1 (2020-03) 43 oneM2M TS-0021 version 2.0.1 Release 2A C.1.2 Notification Producer interface AllJoyn Notification Producer(org.alljoyn.Notification.Producer) interface and its members shall be mapped with the following structure. "org.aljoyn.Notification.Producer" <flexContainer> 1 "Dismiss" <flexContainer> 0..n call <flexContainer> Figure C.1.2-1: Structure of Notification Producer interface mapping Each resource in the figure above shall have the attribute values as follows. Table C.1.2-1: Attribute values of org.alljoyn.Notification.Producer resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "org.alljoyn.Notification.Producer" AllJoyn interface name containerDefinition Value indicating alljoynInterface AllJoyn interface version "1" Version property value is "1" Table C.1.2-2: Attribute values of Dismiss resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "Dismiss" "Dismiss" method containerDefinition Value indicating alljoynMethod AllJoyn interface method Table C.1.2-3: Attribute values of call resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call input (variable) key-value pair of "msgId" callStatus (variable) ETSI ETSI TS 118 121 V2.0.1 (2020-03) 44 oneM2M TS-0021 version 2.0.1 Release 2A C.1.3 Dismisser interface AllJoyn Dismisser(org.alljoyn.Notification.Dismisser) interface and its members shall be mapped with the following structure. "org.alljoyn.Notification.Dismisser" <flexContainer> 1 "Dismiss" <container> 0..n signal <contentInstance> Figure C.1.3-1: Structure of Dismisser interface mapping Each resource in the figure above shall have the attribute values as follows. Table C.1.3-1: Attribute values of org.alljoyn.Notification.Dismisser resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "org.alljoyn.Notification.Dismisser" AllJoyn interface name containerDefinition Value indicating alljoynInterface AllJoyn interface version "1" Version property value is "1" Table C.1.3-2: Attribute values of Dismiss resource Attribute Value Description resourceType "3" Enumeration value for the container resource type resourceName "Dismiss" "Dismiss" signal labels "Iwked-Technology:AllJoyn", "Iwked-Entity-Type:Signal Name" Table C.1.3-3: Attribute values of signal resource Attribute Value Description resourceType "4" Enumeration value for the contentInstance resource type resourceName (variable) content (variable) Signal message ETSI ETSI TS 118 121 V2.0.1 (2020-03) 45 oneM2M TS-0021 version 2.0.1 Release 2A C.2 Control Panel service C.2.1 Container interface AllJoyn Container(org.alljoyn.ControlPanel.Container) interface and its members shall be mapped with the following structure. "org.alljon.ControlPanel.Container" <flexContainer> 1 "States" <flexContainer> 1 "MetadataChange" <container> 0..n signal <contentInstance> 1 "OptParams" <flexContainer> Figure C.2.1-1: Structure of Container interface mapping Each resource in the figure above shall have the attribute values as follows. Table C.2.1-1: Attribute values of org.alljoyn.ControlPanel.Container resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "org.alljoyn.ControlPanel.Container" AllJoyn interface name containerDefinition Value indicating alljoynInterface AllJoyn interface version "1" Version property value is "1" Table C.2.1-2: Attribute values of States resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "OptParams" "States" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only state "enabled" Table C.2.1-3: Attribute values of OptParams resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "OptParams" "OptParams" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only "Container" widget metadata ETSI ETSI TS 118 121 V2.0.1 (2020-03) 46 oneM2M TS-0021 version 2.0.1 Release 2A Table C.2.1-4: Attribute values of MetadataChange resource Attribute Value Description resourceType "3" Enumeration value for the container resource type resourceName "MetadataChange" "MetadataChange" signal labels "Iwked-Technology:AllJoyn", "Iwked-Entity-Type:Signal Name" Table C.2.1-5: Attribute values of signal resource Attribute Value Description resourceType "4" Enumeration value for the contentInstance resource type resourceName (variable) content "changed" Notification that the metadata is changed C.2.2 Property interface AllJoyn Property(org.alljoyn.ControlPanel.Property) interface and its members shall be mapped with the following structure. "org.alljoyn.ControlPanel.Property" <flexContainer> 1 "States" <flexContainer> 1 "ValueChanged" <container> 0..n signal <contentInstance> 1 "Value" <flexContainer> 1 "OptParams" <flexContainer> Figure C.2.2-1: Structure of Property interface mapping Each resource in the figure above shall have the attribute values as follows. Table C.2.2-1: Attribute values of org.alljoyn.ControlPanel.Property resource Attribute Value Description resourceType "3" Enumeration value for the container resource type resourceName "org.alljoyn.ControlPanel.Container" AllJoyn interface name containerDefinition Value indicating alljoynInterface AllJoyn interface version "1" Version property value is "1" Table C.2.2-2: Attribute values of States resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "States" "States" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only state "enabled" and "writable" ETSI ETSI TS 118 121 V2.0.1 (2020-03) 47 oneM2M TS-0021 version 2.0.1 Release 2A Table C.2.2-3: Attribute values of OptParams resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "OptParams" "OptParams" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only "OptParams" widget metadata Table C.2.2-4: Attribute values of Value resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "Value" "Value" property containerDefinition Value indicating alljoynProperty AllJoyn interface property requestedValue (variable) Suggested Property value currentValue (variable) Current Property value Table C.2.2-5: Attribute values of ValueChanged resource Attribute Value Description resourceType "3" Enumeration value for the container resource type resourceName "ValueChanged" "ValueChanged" signal labels "Iwked-Technology:AllJoyn", "Iwked-Entity-Type:Signal Name" Table C.2.2-6: Attribute values of signal resource Attribute Value Description resourceType "4" Enumeration value for the contentInstance resource type resourceName (variable) content (variable) Key-value pairs of property or metadata ETSI ETSI TS 118 121 V2.0.1 (2020-03) 48 oneM2M TS-0021 version 2.0.1 Release 2A C.2.3 LabelProperty interface AllJoyn LabelProperty(org.alljoyn.ControlPanel.LabelProperty) interface and its members shall be mapped with the following structure. "org.alljoyn.ConrolPanel.LabelProperty" <flexContainer> 1 "States" <flexContainer> 1 "MetadataChange" <container> 0..n signal <contentInstance> 1 "OptParams" <flexContainer> "Label" <flexContainer> 1 Figure C.2.3-1: Structure of LabelProperty interface mapping Each resource in the figure above shall have the attribute values as follows. Table C.2.3-1: Attribute values of org.alljoyn.ControlPanel.LabelProperty resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "org.alljoyn.ControlPanel.LabelProperty" AllJoyn interface name containerDefinition Value indicating alljoynInterface AllJoyn interface version "1" Version property value is "1" Table C.2.3-2: Attribute values of States resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "States" "States" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only state "enabled" Table C.2.3-3: Attribute values of Label resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "Label" "Label" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only label Table C.2.3-4: Attribute values of OptParams resource Attribute Value Description resourceType "3" Enumeration value for the container resource type resourceName "pOptParams" "OptParams" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only LabelProperty widget metadata ETSI ETSI TS 118 121 V2.0.1 (2020-03) 49 oneM2M TS-0021 version 2.0.1 Release 2A Table C.2.3-5: Attribute values of MetadataChange resource Attribute Value Description resourceType "3" Enumeration value for the container resource type resourceName "MetadataChange" "MetadataChange" signal labels "Iwked-Technology:AllJoyn", "Iwked-Entity-Type:Signal Name" Table C.2.3-6: Attribute values of signal resource Attribute Value Description resourceType "4" Enumeration value for the contentInstance resource type resourceName (variable) content "changed" Notification that the metadata is changed C.2.4 Action interface AllJoyn Action(org.alljoyn.ControlPanel.Action) interface and its members shall be mapped with the following structure. "org.alljoyn.ControlPanel.Action" <flexContainer> 1 "OptParams" <flexContainer> 0..n property <flexContainer> 1 "MetadataChange" <container> 0..n signal <contentInstance> 1 "Exec" <flexContainer> 0..n call <flexContainer> Figure C.2.4-1: Structure of Action interface mapping Each resource in the figure above shall have the attribute values as follows. Table C.2.4-1: Attribute values of org.alljoyn.ControlPanel.Action resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "org.alljoyn.ControlPanel.Container" AllJoyn interface name containerDefinition Value indicating alljoynInterface AllJoyn interface version "1" Version property value is "1" ETSI ETSI TS 118 121 V2.0.1 (2020-03) 50 oneM2M TS-0021 version 2.0.1 Release 2A Table C.2.4-2: Attribute values of States resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "States" "States" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only state "enabled" Table C.2.4-3: Attribute values of OptParams resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "OptParams" "OptParams" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only "Action" widget metadata Table C.2.4-4: Attribute values of Exec resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "Exec" "Exec" method containerDefinition Value indicating alljoynMethod AllJoyn interface method Table C.2.4-5: Attribute values of call resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call callStatus (variable) Table C.2.4-6: Attribute values of MetadataChange resource Attribute Value Description resourceType "3" Enumeration value for the container resource type resourceName "MetadataChange" "MetadataChange" signal labels "Iwked-Technology:AllJoyn", "Iwked-Entity-Type:Signal Name" Table C.2.4-7: Attribute values of signal resource Attribute Value Description resourceType "4" Enumeration value for the contentInstance resource type resourceName (variable) content "changed" Notification that the metadata is changed ETSI ETSI TS 118 121 V2.0.1 (2020-03) 51 oneM2M TS-0021 version 2.0.1 Release 2A C.2.5 NotificationAction interface AllJoyn NotificationAction(org.alljoyn.ControlPanel.Container) interface and its members shall be mapped with the following structure. "org.alljoyn.ControlPanel.NotificationAction" <flexContainer> 1 "Dismiss" <container> 0..n signal <contentInstance> Figure C.2.5-1: Structure of NotificationAction interface mapping Each resource in the figure above shall have the attribute values as follows. Table C.2.5-1: Attribute values of org.alljoyn.ControlPanel.NotificationAction resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "org.alljoyn.ControlPanel.NotificationAction" AllJoyn interface name containerDefinition Value indicating alljoynInterface AllJoyn interface version "1" Version property value is "1" Table C.2.5-2: Attribute values of Dismiss resource Attribute Value Description resourceType "3" Enumeration value for the container resource type resourceName "Dismiss" "Dismiss" signal labels "Iwked-Technology:AllJoyn", "Iwked-Entity-Type:Signal Name" Table C.2.5-3: Attribute values of signal resource Attribute Value Description resourceType "4" Enumeration value for the contentInstance resource type resourceName (variable) content "dismiss" Dismiss the notification panel ETSI ETSI TS 118 121 V2.0.1 (2020-03) 52 oneM2M TS-0021 version 2.0.1 Release 2A C.2.6 Dialog interface AllJoyn Dialog(org.alljoyn.ControlPanel.Dialog) interface and its members shall be mapped with the following structure. "org.alljoyn.ControlPanel.Dialog" <flexContainer> 1 "States" <flexContainer> 1 "MetadataChange" <container> 0..n signal <contentInstance> 1 "Action1" <flexContainer> 0..n call1 <flexContainer> "OptParams" <flexContainer> "Message" <flexContainer> 1 1 "NumActions" <flexContainer> 1 1 "Action2" <flexContainer> 0..n call2 <flexContainer> 1 "Action3" <flexContainer> 0..n call3 <flexContainer> Figure C.2.6-1: Structure of Dialog interface mapping Each resource in the figure above shall have the attribute values as follows. Table C.2.6-1: Attribute values of org.alljoyn.ControlPanel.Dialog resource Attribute Value Description resourceType "3" Enumeration value for the container resource type resourceName "ControlPanel.Dialog" org.alljoyn.ControlPanel.Dialog interface containerDefinition Value indicating alljoynInterface AllJoyn interface version "1" Version property value is "1" Table C.2.6-2: Attribute values of States resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "States" "States" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only state "enabled" ETSI ETSI TS 118 121 V2.0.1 (2020-03) 53 oneM2M TS-0021 version 2.0.1 Release 2A Table C.2.6-3: Attribute values of OptParams resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "OptParams" "OptParams" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only "Dialog" widget metadata Table C.2.6-4: Attribute values of Message resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "States" "States" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only display message Table C.2.6-5: Attribute values of NumActions resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "States" "States" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only number of actions Table C.2.6-6: Attribute values of Action1 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "Action1" "Action1" method containerDefinition Value indicating alljoynMethod AllJoyn interface method Table C.2.6-7: Attribute values of call1 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call callStatus (variable) Table C.2.6-8: Attribute values of Action2 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "Action2" "Action2" method containerDefinition Value indicating alljoynMethod AllJoyn interface method Table C.2.6-9: Attribute values of call2 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call callStatus (variable) ETSI ETSI TS 118 121 V2.0.1 (2020-03) 54 oneM2M TS-0021 version 2.0.1 Release 2A Table C.2.6-10: Attribute values of Action3 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "Action3" "Action3" method containerDefinition Value indicating alljoynMethod AllJoyn interface method Table C.2.6-11: Attribute values of call3 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call callStatus (variable) Table C.2.6-12: Attribute values of MetadataChange resource Attribute Value Description resourceType "3" Enumeration value for the container resource type resourceName "MetadataChange" "MetadataChange" signal labels "Iwked-Technology:AllJoyn", "Iwked-Entity-Type:Signal Name" Table C.2.6-13: Attribute values of signal resource Attribute Value Description resourceType "4" Enumeration value for the contentInstance resource type resourceName (variable) content "changed" Notification that the metadata is changed ETSI ETSI TS 118 121 V2.0.1 (2020-03) 55 oneM2M TS-0021 version 2.0.1 Release 2A C.2.7 ListProperty interface AllJoyn ListProperty(org.alljoyn.ControlPanel.ListProperty) interface and its members shall be mapped with the following structure. "org.alljoyn.ControlPanel.ListProperty" <flexContainer> 1 "States" <flexContainer> 1 "MetadataChanged" <container> 0..n signal2 (contentInstance) 1 "Delete" <flexContainer> 0..n call2 <flexContainer> 1 "OptParams" <flexContainer> 1 "Value" <flexContainer> 1 "Add" <flexContainer> 0..n call1 <flexContainer> 1 "View" <flexContainer> 0..n call3 <flexContainer> 1 "Update" <flexContainer> 0..n call4 <flexContainer> 1 "Confirm" <flexContainer> 0..n call5 <flexContainer> 1 "Cancel" <flexContainer> 0..n call6 <flexContainer> "ValueChanged" <container> 0..n signal1 (contentInstance) 1 Figure C.2.7-1: Structure of ListProperty interface mapping ETSI ETSI TS 118 121 V2.0.1 (2020-03) 56 oneM2M TS-0021 version 2.0.1 Release 2A Each resource in the figure above shall have the attribute values as follows. Table C.2.7-1: Attribute values of org.alljoyn.ControlPanel.ListProperty resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "org.alljoyn.ControlPanel.ListProperty" AllJoyn interface name containerDefinition Value indicating alljoynInterface AllJoyn interface version "1" Version property value is "1" Table C.2.7-2: Attribute values of States resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "States" "States" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only state "enabled" Table C.2.7-3: Attribute values of OptParams resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "OptParams" "OptParams" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only "ListProperty" widget metadata Table C.2.7-4: Attribute values of Value resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "Value" "Value" property containerDefinition Value indicating alljoynProperty AllJoyn interface property currentValue (variable) Read-only list of records Table C.2.7-5: Attribute values of Add resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "Add" "Add" method containerDefinition Value indicating alljoynMethod AllJoyn interface method Table C.2.7-6: Attribute values of call1 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call callStatus (variable) Table C.2.7-7: Attribute values of Delete resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "Delete" "Delete" method containerDefinition Value indicating alljoynMethod AllJoyn interface method ETSI ETSI TS 118 121 V2.0.1 (2020-03) 57 oneM2M TS-0021 version 2.0.1 Release 2A Table C.2.7-8: Attribute values of call2 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call input (variable) recordID callStatus (variable) Table C.2.7-9: Attribute values of View resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "View" "View" method containerDefinition Value indicating alljoynMethod AllJoyn interface method Table C.2.7-10: Attribute values of call3 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call input (variable) recordID callStatus (variable) Table C.2.7-11: Attribute values of Update resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "Update" "Update" method containerDefinition Value indicating alljoynMethod AllJoyn interface method Table C.2.7-12: Attribute values of call4 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call input (variable) recordID callStatus (variable) Table C.2.7-13: Attribute values of Confirm resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "Confirm" "Confirm" method containerDefinition Value indicating alljoynMethod AllJoyn interface method Table C.2.7-14: Attribute values of call5 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call callStatus (variable) ETSI ETSI TS 118 121 V2.0.1 (2020-03) 58 oneM2M TS-0021 version 2.0.1 Release 2A Table C.2.7-15: Attribute values of Cancel resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "Cancel" "Cancel" method containerDefinition Value indicating alljoynMethod AllJoyn interface method Table C.2.7-16: Attribute values of call6 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call callStatus (variable) Table C.2.7-17: Attribute values of ValueChanged resource Attribute Value Description resourceType "3" Enumeration value for the container resource type resourceName "Changed" "ValueChanged" signal labels "Iwked-Technology:AllJoyn", "Iwked-Entity-Type:Signal Name" Table C.2.7-18: Attribute values of signal1 resource Attribute Value Description resourceType "4" Enumeration value for the contentInstance resource type content "ValueChanged"" Notification that the property value is changed Table C.2.7-19: Attribute values of MetadataChanged resource Attribute Value Description resourceType "3" Enumeration value for the container resource type resourceName "Changed" "MetadataChanged" signal labels "Iwked-Technology:AllJoyn", "Iwked-Entity-Type:Signal Name" Table C.2.7-20: Attribute values of signal2 resource Attribute Value Description resourceType "4" Enumeration value for the contentInstance resource type content "MetadataChanged" Notification that the metadata is changed ETSI ETSI TS 118 121 V2.0.1 (2020-03) 59 oneM2M TS-0021 version 2.0.1 Release 2A C.3 Configuration service C.3.1 Config interface AllJoyn Config(org.alljoyn.Config) interface and its members shall be mapped with the following structure. "org.alljoyn.Config" <flexContainer> 1 "Restart" <flexContainer> 0..n call2 <flexContainer> 1 "FactoryReset" <flexContainer> 0..n call1 <flexContainer> 1 "SetPasscode" <flexContainer> 0..n call3 <flexContainer> 1 "GetConfigurations" <flexContainer> 0..n call4 <flexContainer> 1 "UpdateConfigurations" <flexContainer> 0..n call5 <flexContainer> 1 "ResetConfigurations" <flexContainer> 0..n call6 <flexContainer> Figure C.3.1-1: Structure of Config interface mapping Each resource in the figure above shall have the attribute values as follows. Table C.3.1-1: Attribute values of Config resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "org.alljoyn.Config" AllJoyn interface name containerDefinition Value indicating alljoynInterface AllJoyn interface version "1" Version property value is "1" ETSI ETSI TS 118 121 V2.0.1 (2020-03) 60 oneM2M TS-0021 version 2.0.1 Release 2A Table C.3.1-2: Attribute values of FactoryReset resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "FactoryReset" "FactoryReset" method containerDefinition Value indicating alljoynMethod AllJoyn interface method Table C.3.1-3: Attribute values of call1 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call callStatus (variable) Table C.3.1-4: Attribute values of Restart resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "Restart" "Restart" method containerDefinition Value indicating alljoynMethod AllJoyn interface method Table C.3.1-5: Attribute values of call2 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call callStatus (variable) Table C.3.1-6: Attribute values of SetPasscode resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "SetPasscode" "SetPasscode" method containerDefinition Value indicating alljoynMethod AllJoyn interface method Table C.3.1-7: Attribute values of call3 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call input (variable) "daeonRealm" and "newPasscode" parameter callStatus (variable) Table C.3.1-8: Attribute values of GetConfigurations resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "GetConfigurations" "GetConfigurations" method containerDefinition Value indicating alljoynMethod AllJoyn interface method ETSI ETSI TS 118 121 V2.0.1 (2020-03) 61 oneM2M TS-0021 version 2.0.1 Release 2A Table C.3.1-9: Attribute values of call4 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call input (variable) "languageTag" parameter callStatus (variable) Table C.3.1-10: Attribute values of UpdateConfigurations resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "UpdateConfigurations" "UpdateConfigurations" method containerDefinition Value indicating alljoynMethod AllJoyn interface method Table C.3.1-11: Attribute values of call5 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call input (variable) "languageTag" and "configMap" parameter callStatus (variable) Table C.3.1-12: Attribute values of ResetConfigurations resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName "ResetConfigurations" "ResetConfigurations" method containerDefinition Value indicating alljoynMethod AllJoyn interface method Table C.3.1-13: Attribute values of call6 resource Attribute Value Description resourceType "28" Enumeration value for the flexContainer resource type resourceName (variable) containerDefinition Value indicating alljoynMethodCall AllJoyn interface method call input (variable) "languageTag" and "fieldList" parameter callStatus (variable) ETSI ETSI TS 118 121 V2.0.1 (2020-03) 62 oneM2M TS-0021 version 2.0.1 Release 2A History Document history V2.0.0 September 2016 Publication V2.0.1 March 2020 Publication |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 1 Scope | The present document specifies the binding of Mca and Mcc primitives onto the WebSocket binding. It specifies: • Procedures and message formats for operating and closing of WebSocket connections. • How request and response primitives are mapped into the payload of the WebSocket protocol. |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 2 References | |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 2.1 Normative references | References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the referenced document (including any amendments) applies. Referenced documents which are not found to be publicly available in the expected location might be found at https://docbox.etsi.org/Reference/. NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee their long term validity. The following referenced documents are necessary for the application of the present document. [1] IETF RFC 6455 (December 2011): "The WebSocket Protocol". [2] ETSI TS 118 101: "oneM2M; Functional Architecture (oneM2M TS-0001)". [3] IETF RFC 7230 (June 2014): "Hypertext Transport Protocol (HTTP/1.1): Message Syntax and Routing". [4] ETSI TS 118 103: "oneM2M; Security solutions (oneM2M TS-0003)". [5] ETSI TS 118 104: "oneM2M; Service Layer Core Protocol (oneM2M TS-0004)". [6] IETF RFC 7692 (December 2015): "Compression Extension for WebSocket". |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 2.2 Informative references | References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the referenced document (including any amendments) applies. NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee their long term validity. The following referenced documents are not necessary for the application of the present document but they assist the user with regard to a particular subject area. [i.1] oneM2M Drafting Rules. NOTE: Available at http://www.onem2m.org/images/files/oneM2M-Drafting-Rules.pdf. ETSI ETSI TS 118 120 V3.0.1 (2021-01) 6 oneM2M TS-0020 version 3.0.1 Release 3 |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 3 Definition of terms, symbols and abbreviations | |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 3.1 Terms | For the purposes of the present document, the following terms apply: oneM2M WebSocket Client (WS Client): WebSocket Client associated with an AE or a CSE capable of establishing the WebSocket connections oneM2M WebSocket Server (WS Server): WebSocket Server associated with a CSE which accepts requests to establish WebSocket connections |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 3.2 Symbols | Void. |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 3.3 Abbreviations | For the purposes of the present document, the following abbreviations apply: ADN Application Dedicated Node AE Application Entity ASN Application Service Node CBOR Concise Binary Object Representation CMDH Communication Management and Delivery Handling CRUDN Create Retrieve Update Delete Notify CSE Common Services Entity FQDN Fully Qualified Domain Name GUID Globally Unique Identifier HTTP Hypertext Transport Protocol IETF Internet Engineering Task Force IN-CSE Infrastructure Node Common Services Entity IP Internet Protocol JSON JavaScript Object Notation MN Middle Node MN-CSE Middle Node Common Services Entity NAT Network Address Translator RFC Request for Comments SAEF Security Association Establishment Framework TCP Transmission Control Protocol TLS Transport Layer Security URI Uniform Resource Identifier WS WebSocket WSS WebSocket Secure XML eXtensible Markup Language |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 4 Conventions | The key words "Shall", "Shall not", "May", "Need not", "Should", "Should not" in the present document are to be interpreted as described in the oneM2M Drafting Rules [i.1]. ETSI ETSI TS 118 120 V3.0.1 (2021-01) 7 oneM2M TS-0020 version 3.0.1 Release 3 |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 5 Overview on WebSocket Binding | |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 5.1 Use of WebSocket | This binding makes use of the WebSocket protocol IETF RFC 6455 [1] to transport serialized representations of oneM2M request and response primitives over the Mca or Mcc reference points. Establishment of a WebSocket connection shall be initiated by a WebSocket client by sending a handshake to a WebSocket server as specified in section 4 of IETF RFC 6455 [1]. Once the WebSocket connection is established, both oneM2M request and response primitives can be exchanged bi-directionally between the two endpoints of the connection. Serialized representations of the request and response primitives shall be mapped in the Payload Data field of the WebSocket base framing protocol, as defined in section 5.2 of IETF RFC 6455 [1]. A WebSocket connection employs either a TCP/IP or a TLS over TCP/IP connection. The underlying TCP and TLS connections are established prior to sending the WebSocket client handshake as the first step (see example in annex A). |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 5.2 Binding Overview | WebSocket binding may be employed for communication between any two endpoints which can be connected over the Mca, Mcc or Mcc' interface reference points supported by the oneM2M Architecture as shown in figure 6.1-1 of ETSI TS 118 101 [2]. When using the WebSocket protocol, one communication endpoint shall act as the WebSocket server. The WebSocket server listens for inbound handshake messages arriving from any WebSocket client to which a WebSocket connection is not yet established. Whether a communication endpoint takes the role of the client or the server shall depend on the registration relationship between the communicating entities as follows: the registree shall always use a WebSocket client, while the associated registrar shall always use a WebSocket server on the respective reference point. This implies that ADN and ASN always take the role of a WebSocket client when WebSocket binding is employed. An MN-CSE uses a WebSocket server to communicate with its registrees and a WebSocket client to communicate with its own registrar (which can be another MN-CSE or an IN-CSE). The IN-CSE provides a WebSocket server functionality to communicate with all its registrees, i.e. within a service provider's domain. On the Mcc' reference points, i.e. for communication between IN-CSEs of different Service Provider domains, the IN-CSE shall provide both WebSocket client and server functionality. This enables any IN-CSE to open a WebSocket connection to any IN-CSE of another Service Provider's domain. Figure 5.2-1 shows some applicable example system configuration. ETSI ETSI TS 118 120 V3.0.1 (2021-01) 8 oneM2M TS-0020 version 3.0.1 Release 3 Figure 5.2-1: Example scenarios of WebSocket client and server configurations There exists a maximum of one WebSocket connection between two nodes. A WebSocket connection is established for the first time when the initial registration procedure of an entity to its registrar is performed. On an established WebSocket connection, request and response primitives can be exchanged in both directions. Any connection may be closed by either the WebSocket client or the server, depending on the communication schedule of either entity. However, the connection can be reopened from the client side only. If the connection is closed temporarily, it shall be reopened when the next request primitive is sent from the client to the server side, or when the time to become reachable configured at <schedule> resource. If the WebSocket connection with the next-hop entity is not opened, and the WebSocket connection cannot be established due to lack of pointOfAccess address for the entity, a sending CSE may enable buffering of primitives which should be sent to the entity until the connection is reopened or their expiration time is reached. See Annex H of ETSI TS 118 104 [5] about buffering of primitives by CMDH functionality. Figure 5.2-2 shows an example message flow for a scenario where an ADN-AE registers to its registrar MN-CSE using an unsecured TCP connection without proxy and then continues exchanging non-registration request and response primitives. AE WS Client CSE WS Server WS Client AE CSE WS Client AE AE WS Client CSE WS Client AE CSE WS Server WS Client AE CSE WS Server WS Client ADN ASN ADN MN MN ASN IN Mcc’ Mcc Mca Mcc Mca Mcc ETSI ETSI TS 118 120 V3.0.1 (2021-01) 9 oneM2M TS-0020 version 3.0.1 Release 3 Figure 5.2-2: Example message flow with WebSocket binding 1) The ADN-AE wants to register to its registrar MN-CSE. If a WebSocket connection does not exist, it is established by the following steps 2) and 3). It is assumed that the ADN-AE knows the point of access (i.e. WebSocket URI specified in IETF RFC 6455 [1]) under which the registrar CSE can be reached with WebSocket binding. 2) The WebSocket client opens handshake to the server with subprotocol name oneM2M.json following IETF RFC 6455 [1]. If the server can be reached under the WebSocket URI ws://example.net:9000/, the client handshake may look as follows: GET / HTTP/1.1 Host: mncse1234.net:9000 Upgrade: WebSocket Connection: Upgrade Sec-WebSocket-Key: ud63env87LQLd4uIV20/oQ== Sec-WebSocket-Protocol: oneM2M.json Sec-WebSocket-Version: 13 3) The WebSocket server replies with a handshake to the client. In the successful case, the status-line of this HTTP response may look as follow (note that text shown in brackets [...] is not sent explicitely): [Request-Version:] HTTP/1.1 [Status-Code:] 101 [Response-Phrase:] Switching Protocols Upgrade: WebSocket Connection: Upgrade Sec-WebSocket-Protocol: oneM2M.json Sec-WebSocket-Accept: FuSSKANnI7C/6/FrPMt70mfBY8E= AE WS client CSE WS server ADN MN 1) AE wants to start registration procedure and triggers WebSocket connection establishment 2) Client handshake 3) Server handshake 4) Request primitive 5) WebSocket Binding 6) WebSocket message 7) Unpacking request primitive 8) Request primitive 9) Receiver side processing of AE registration procedure 10) Response primitive 11) WebSocket Binding 12) WebSocket message 13) Unpacking response primitive 14) Response primitive 15) non-registration CRUDN operations ETSI ETSI TS 118 120 V3.0.1 (2021-01) 10 oneM2M TS-0020 version 3.0.1 Release 3 4) The ADN-AE issue a registration request primitive. The request primitive may e.g. look as follows as JSON-serialized representation (note that only mandatory parameters of the request primitive are shown in this example; the message may include any optional primitive parameters in addition, e.g. "fr"): {"op":1,"to":"//example.net/mncse1234","rqi":"A1234","pc":{"m2m:ae":{"api":"a56", "apn":"app1234"}},"ty": 2} NOTE: The WebSocket client associated with an ADN-AE does not need to be reachable for WebSocket Server handshake messages. 5) WebSocket Binding process, which transforms a single oneM2M primitive into one or more data frames of the WebSocket Framing protocol, as specified in IETF RFC 6455 [1]. When transmitting a JSON-serialized primitive in utf-8 text format, the 4-bit opcode in the WebSocket Base Framing Protocol of the first message fragment will be set to x1 ("text frame"). 6) The WebSocket message (consisting of one or more frames) shall be sent to the WS server. 7) The original request primitive shall be unpacked from the WebSocket message by the WS server. 8) The request primitive is delivered to the MN-CSE. 9) The MN-CSE performs the receiver side operations of AE registration as specified in ETSI TS 118 101 [2]. 10) The response primitive is issued to the WebSocket server. 11) WebSocket binding process for the response primitive is performed. 12) The WebSocket message (consisting of one or more frames) is sent to the client. 13) The response primitive is unpacked. 14) The response primitive is to the ADN-AE. 15) After successful completion of AE registration any other CRUDN requests and response primitives can be exchanged over the existing WebSocket connection in both directions. If the ADN-AE has no other requests to send, the WebSocket connection may be closed temporarily. When the WebSocket connection is closed after registration and reopened later again, the registration procedure as outlined in steps 4) to 14) is omitted. In this case any non-registration request primitives can be sent directly. |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6 Protocol Binding | |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.1 Introduction | The WebSocket protocol enables two-way communication between client and server even when a firewall and/or NAT are present between them. This means, once a WebSocket connection is established, request (and response) primitives can be exchanged in both directions, from the client to the server and vice versa. However, AEs may be capable of handling Notification request primitives only, or no request primitives at all. WebSocket binding applied by oneM2M entities/nodes shall be fully compliant with IETF RFC 6455 [1]. After establishment of a WebSocket connection between two nodes, at the transmitter side each individual request and response primitive is mapped into one or several WebSocket frames. |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2 WebSocket connection establishment | |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.1 General | A WebSocket connection is opened by the client side as specified in section 4 of IETF RFC 6455 [1] with sending of a client handshake. The server responds with a server handshake. The client handshake consists of an HTTP upgrade request, along with a list of required and optional header fields. ETSI ETSI TS 118 120 V3.0.1 (2021-01) 11 oneM2M TS-0020 version 3.0.1 Release 3 The handshake shall be a valid HTTP request as specified by IETF RFC 7230 [3]. The server handshake consists of a HTTP status-line and a list of header fields. The applicable format of the request-line, status-line and the applicable header fields are specified in the following clauses. HTTP headers fields have case-insensitive field names. CSEs capable to support WebSocket shall indicate the schemes ws and/or wss together with the applicable host name and port numbers in the pointOfAccess attribute of their <CSEBase> and in the <remoteCSE> resources, i.e. as ws://host:port1 and wss://host:port2, where host refers to either an IP address or an FQDN. By default, the WebSocket Protocol [1] uses port 80 for regular WebSocket connections and port 443 for WebSocket connections over Transport Layer Security (TLS). If a WebSocket URI does not include an explicit port number, the default port number shall apply. Possible example representations of the pointOfAccess attribute <CSEBase> or <remoteCSE> resources associated with entities supporting a WebSocket server are the following: ws://ws-server.example.com:80 ws://ws-server.example.com wss://10.251.232.119:443 NOTE: ADN-AEs and ASN-CSEs do not need to support WebSocket servers and therefore do not require a WebSocket URI in the pointOfAccess attribute (see figure 5.2-1). |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.2 Client handshake | |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.2.1 Format of request-line | The request-line of a client handshake shall begin with the method token "GET", followed by the request target "/" and the HTTP version set to "HTTP/1.1" as follows: GET / HTTP/1.1 If the client is configured to use a proxy when using the WebSocket Protocol, a connection to the proxy server shall be established prior to sending the above client handshake. This is described in clause 6.6. |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.2.2 Host header | The Host header shall be present in each client handshake. The Host header indicates the FQDN or IP address of the Receiver CSE of the next hop. If the originator of the client handshake is an oneM2M field entity, the host header represents the registrar CSE of the originator. When no proxy is used, the Host header shall be set as one of the pointOfAccess attribute values associated with the Receiver. Selection of the appropriate Receiver is described in ETSI TS 118 104 [5]. If the client is configured to use a proxy when using the WebSocket Protocol, then the client should connect to that proxy and ask it to open a TCP connection to the host and port rather than to the next hop CSE. |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.2.3 Upgrade header | The Upgrade header shall be present in each client handshake message with value WebSocket as follows: Upgrade: WebSocket |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.2.4 Connection header | The Connection header shall be present in each client handshake message with value Upgrade as follows: Connection: Upgrade ETSI ETSI TS 118 120 V3.0.1 (2021-01) 12 oneM2M TS-0020 version 3.0.1 Release 3 |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.2.5 Sec-WebSocket-Key header | The Sec-WebSocket-Key header shall be present in each client handshake message. The header field includes a base64- encoded representation of a random 16 bytes pattern, for example: Sec-WebSocket-Key: ud63env87LQLd4uIV20/oQ== |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.2.6 Sec-WebSocket-Version header | The Sec-WebSocket-Version header shall be present in each client handshake message with value 13 as follows: Sec-WebSocket-Version: 13 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.