hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
5884f20096a929755c7228996f24adba | 118 109 | 6.3 Status-Line | |
5884f20096a929755c7228996f24adba | 118 109 | 6.3.1 HTTP-Version | The HTTP version field in HTTP response messages shall be set to "HTTP/1.1". |
5884f20096a929755c7228996f24adba | 118 109 | 6.3.2 Status-Code | The Response Status Code parameter of response primitives shall be mapped to the HTTP Status-Code. Since the Response Status Code parameter values have been defined with more detailed information than HTTP status codes, one or more Response Status Code value may be mapped to the same HTTP Status-Code. The original Response Status Code parameter value shall be carried in the X-M2M-RSC header (see clause 6.4.17). The mapping of Response Status Code parameter value of oneM2M request primitive to Status-Code of HTTP request messages is specified in table 6.3.2-1. ETSI ETSI TS 118 109 V4.4.1 (2023-12) 15 oneM2M TS-0009 version 4.4.1 Release 4 Table 6.3.2-1: Status Code Mapping oneM2M Response Status Codes Status Code Mapping oneM2M Response Status Codes HTTP Status Codes [10] 2000 (OK) 200 (OK) 2002 (DELETED) 2004 (UPDATED) 2001 (CREATED) 201 (Created) 1000 (ACCEPTED) 202 (Accepted) 1001 (ACCEPTED for nonBlockingRequestSynch) 1002 (ACCEPTED for nonBlockingRequestAsynch) 4000 (BAD_REQUEST) 400 (Bad Request) 4102 (CONTENTS_UNACCEPTABLE) 4110 (GROUP_MEMBER_TYPE_INCONSISTENT) 4120 (INVALID_SEMANTICS) 4122 (INVALID_TRIGGER_PURPOSE) 4123 (ILLEGAL_TRANSACTION_STATE_TRANSITION_ATTEMPTED) 4131 (ONTOLOGY_MAPPING_POLICY_NOT_MATCHED) 4133 (BAD_FACT_INPUTS_FOR_REASONING) 4134 (BAD_RULE_INPUTS_FOR_REASONING) 4137 (PRIMITIVE_PROFILE_BAD_REQUEST) 4143 (INVALID_SPARQL_QUERY) 6010 (MAX_NUMBER_OF_MEMBER_EXCEEDED) 6022 (INVALID_CMDTYPE) 6023 (INVALID_ARGUMENTS) 6024 (INSUFFICIENT_ARGUMENTS) 4101 (SUBSCRIPTION_CREATOR_HAS_NO_PRIVILEGE) 403 (Forbidden) 4103 (ORIGINATOR_HAS_NO_PRIVILEGE) 5105 (RECEIVER_HAS_NO_PRIVILEGE) 5203 (TARGET_NOT_SUBSCRIBABLE) 5205 (SUBSCRIPTION_HOST_HAS_NO_PRIVILEGE) 4106 (ORIGINATOR_HAS_NOT_REGISTERED) 4107 (SECURITY_ASSOCIATION_REQUIRED) 4108 (INVALID_CHILD_RESOURCE_TYPE) 4109 (NO_MEMBERS) 4111 (ESPRIM_UNSUPPORTED_OPTION) 4112 (ESPRIM_UNKNOWN_KEY_ID) 4113 (ESPRIM_UNKNOWN_ORIG_RAND_ID) 4114 (ESPRIM_UNKNOWN_RECV_RAND_ID) 4115 (ESPRIM_BAD_MAC) 4116 (ESPRIM_IMPERSONATION_ERROR) 4117 (ORIGINATOR_HAS_ALREADY_REGISTERED) 4126 (APP_RULE_VALIDATION_FAILED) 4127 (OPERATION_DENIED_BY_REMOTE_ENTITY) 4128 (SERVICE_SUBSCRIPTION_NOT_ESTABLISHED) 4135 (DISCOVERY_LIMIT_EXCEEDED) 4136 (PRIMITIVE_PROFILE_NOT_ACCESSIBLE) 4138 (UNAUTHORIZED_USER) 4139 (SERVICE_SUBSCRIPTION_NOT_ACTIVE) 5208 (DISCOVERY_DENIED_BY_IPE) 5214 (TARGET_HAS_NO_SESSION_CAPABILITY) 5215 (SESSION_IS_ONLINE) 5218 (TRIGGERING_DISABLED_FOR_RECIPIENT) 5222 (TRANSACTION_PROCESSING_IS_INCOMPLETE) 6034 (REQUESTED_ACTIVITY_PATTERN_NOT_PERMITTED) 4004 (NOT_FOUND) 404 (Not Found) 4118 (ONTOLOGY_NOT_AVAILABLE) 4119 (LINKED_SEMANTICS_NOT_AVAILABLE) 4121 (MASHUP_MEMBER_NOT_FOUND) ETSI ETSI TS 118 109 V4.4.1 (2023-12) 16 oneM2M TS-0009 version 4.4.1 Release 4 Status Code Mapping oneM2M Response Status Codes HTTP Status Codes [10] 4130 (ONTOLOGY_MAPPING_ALGORITHM_NOT_AVAILABLE) 4132 (ONTOLOGY_MAPPING_NOT_AVAILABLE) 5103 (TARGET_NOT_REACHABLE) 5107 (REMOTE_ENTITY_NOT_REACHABLE) 6003 (EXTERNAL_OBJECT_NOT_REACHABLE) 6005 (EXTERNAL_OBJECT_NOT_FOUND) 4005 (OPERATION_NOT_ALLOWED) 405 (Method Not Allowed) 5207 (NOT_ACCEPTABLE) 406 (Not Acceptable) 4104 (GROUP_REQUEST_IDENTIFIER_EXISTS) 409 (Conflict) 4105 (CONFLICT) 4124 (BLOCKING_SUBSCRIPTION_ALREADY_EXISTS) 4140 (SOFTWARE_CAMPAIGN_CONFLICT) 5106 (ALREADY_EXISTS) 5219 (UNABLE_TO_REPLACE_REQUEST) 5220 (UNABLE_TO_RECALL_REQUEST) 6028 (ALREADY_COMPLETE) 6029 (MGMT_COMMAND_NOT_CANCELLABLE) 4015 (UNSUPPORTED_MEDIA_TYPE) 415 (Unsupported Media Type) 5000 (INTERNAL_SERVER_ERROR) 500 (Internal Server Error) 5204 (SUBSCRIPTION_VERIFICATION_INITIATION_FAILED) 5209 (GROUP_MEMBERS_NOT_RESPONDED) 5210 (ESPRIM_DECRYPTION_ERROR) 5211 (ESPRIM_ENCRYPTION_ERROR) 5212 (SPARQL_UPDATE_ERROR) 5216 (JOIN_MULTICAST_GROUP_FAILED) 5217 (LEAVE_MULTICAST_GROUP_FAILED) 5221 (CROSS_RESOURCE_OPERATION_FAILURE) 5230 (ONTOLOGY_MAPPING_ALGORITHM_FAILED) 5231 (ONTOLOGY_CONVERSION_FAILED) 5232 (REASONING_PROCESSING_FAILED) 6020 (MGMT_SESSION_CANNOT_BE_ESTABLISHED) 6021 (MGMT_SESSION_ESTABLISHMENT_TIMEOUT) 6025 (MGMT_CONVERSION_ERROR) 6026 (MGMT_CANCELLATION_FAILED) 6033 (NETWORK_QOS_CONFIG_ERROR) 4001 (RELEASE_VERSION_NOT_SUPPORTED) 501 (Not Implemented) 4125 (SPECIALIZATION_SCHEMA_NOT_FOUND) 5001 (NOT_IMPLEMENTED) 5206 (NON_BLOCKING_SYNCH_REQUEST_NOT_SUPPORTED) 4008 (REQUEST_TIMEOUT) 504 (Gateway Timeout) 6030 (EXTERNAL_OBJECT_NOT_REACHABLE_BEFORE_RQET_TIMEOUT) 6031 (EXTERNAL_OBJECT_NOT_REACHABLE_BEFORE_OET_TIMEOUT) |
5884f20096a929755c7228996f24adba | 118 109 | 6.3.3 Reason-Phrase | The Reason-Phrase shall be omitted in HTTP response messages. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4 Header Fields | |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.0 Introduction | The header fields listed in this clause shall be supported by all entities of the oneM2M system when using HTTP binding. Any other unrecognized HTTP headers shall be ignored by the HTTP client and server. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.1 Host | The Host header shall be present in each HTTP request message. ETSI ETSI TS 118 109 V4.4.1 (2023-12) 17 oneM2M TS-0009 version 4.4.1 Release 4 While the Request-Target indicates a target resource on the Hosting CSE, the Host header indicates the FQDN or IP address of the Receiver CSE of the next hop in multi-hop communication scenarios. Therefore, the Request-Target is not changed but the Host header is changed each time when a request is forwarded to the next hop CSE. When no HTTP proxy is used, the Host header shall be set as one of the pointOfAccess attribute values of the Receiver(i.e. pointOfAccess attribute of the corresponding <remoteCSE> resource). Selection of the appropriate Receiver is described in ETSI TS 118 104 [3]. In this case the origin-form of target URI shall be used (see clause 6.2.2). If the HTTP request message is sent to a HTTP proxy rather than to the next hop CSE, the Host header shall be set to the FQDN or IP address of the proxy. In this case the absolute-form of target URI shall be used (see clause 6.2.2). |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.2 Accept | The Originator may use the Accept header to indicate which media types are acceptable for the response. The Accept header shall be mapped to a set of media types among "application/xml", "application/json", "application/cbor" or the oneM2M defined media types defined in clause 6.7 of ETSI TS 118 104 [3]. Note that some of the oneM2M defined media types defined in clause 6.7 of ETSI TS 118 104 [3] are not applicable for the response. Note that this information is not included in a request primitive. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.3 Content-Type | Any HTTP request or response containing message-body shall include the Content-type header set to one of "application/xml", "application/json", or the oneM2M defined media types defined in clause 6.7 of ETSI TS 118 104 [3]. Content-Type of the HTTP response should be chosen by the Hosting CSE considering the Accept header given in the HTTP request. The value of the Resource Type primitive parameter, which is present in Create request primitives only, shall be appended to the Content-type of the corresponding HTTP request message in the form ty=value, separated by a semicolon character. A valid Content-Type header in this case looks e.g. as follows: Content-Type: application/vnd.onem2m-res+xml; ty=3 application/vnd.onem2m-res+json; ty=3 application/vnd.onem2m-res+cbor; ty=3 |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.4 Content-Location | The Content-Location header of the HTTP response to a Create request shall be set to the URI of the created resource, if this URI is present in the Content parameter of the Create response primitive. See clause 7.3.3.12 "Create a success response" in ETSI TS 118 104 [3]. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.5 Content-Length | If message-body is included into HTTP request or response messages, the Content-Length header shall be included indicating the length of the message-body in octets (8-bit bytes). |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.6 Etag | A response primitive sent in reply to a resource retrieval request primitive should include an Etag header [Error! Reference source not found.] in combination with the resource representation in the HTTP message body. Etag facilitates the use of conditional requests (i.e. using the if-match and if-none-match HTTP headers) [Error! Reference source not found.]. If a CSE supports the Etag header, then the CSE shall support conditional requests compliant with IETF RFC 7232 [Error! Reference source not found.]. ETSI ETSI TS 118 109 V4.4.1 (2023-12) 18 oneM2M TS-0009 version 4.4.1 Release 4 |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.7 X-M2M-Origin | The X-M2M-Origin header shall be mapped to the From parameter of request and response primitives and vice versa, if applicable. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.8 X-M2M-RI | The X-M2M-RI header shall be mapped to the Request Identifier parameter of request and response primitives and vice versa. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.9 Void | |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.10 X-M2M-GID | The X-M2M-GID header shall be mapped to the Group Request Identifier parameter of request primitives and vice versa, if applicable. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.11 X-M2M-RTU | The X-M2M-RTU header shall be mapped to the notificationURI element of the Response Type parameter of request primitives and vice versa, if applicable. If there are more than one value in the element, then the values shall be combined with "&" character. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.12 X-M2M-OT | The X-M2M-OT header shall be mapped to the Originating Timestamp parameter of request and response primitives, and vice versa, if applicable. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.13 X-M2M-RST | The X-M2M-RST header shall be mapped to the Result Expiration Timestamp parameter of request and response primitives, and vice versa, if applicable. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.14 X-M2M-RET | The X-M2M-RET header shall be mapped to the Request Expiration Timestamp parameter of request primitives and vice versa, if applicable. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.15 X-M2M-OET | The X-M2M-OET header shall be mapped to the Operation Execution Time parameter of request primitives and vice versa, if applicable. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.16 X-M2M-EC | The X-M2M-EC header shall be mapped to the Event Category parameter of request and response primitives, and vice versa, if applicable. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.17 X-M2M-RSC | The X-M2M-RSC header in a HTTP response message shall be mapped to the Response Status Code parameter of response primitives and vice versa (e.g. Response Status Code 4000 and 4102 are mapped to HTTP Status Code 400 in table 6.3.2-1). ETSI ETSI TS 118 109 V4.4.1 (2023-12) 19 oneM2M TS-0009 version 4.4.1 Release 4 |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.18 X-M2M-ATI | The X-M2M-ATI header in a HTTP response message shall be mapped to the Assigned Token Identifiers parameter of response primitives and vice versa. The format of the X-M2M-ATI header shall be represented as a sequence of lti-value:tkid-value pairs separated by a colon ":' and multiple pairs separated by '+' character. EXAMPLE: The header looks as follows: X-M2M-ATI: lti-value1:tkid-value1 + lti-value2:tkid-value2 + … if the XML representation of the Assigned Token Identifiers parameter is given as (using short element names): <ati> <ltia> <lti>lti-value1</lti> <tkid>tkid-value1</tkid> </ltia> <ltia> <lti>lti-value2</lti> <tkid>tkid-value2</tkid> </ltia> … </ati> The data type m2m:dynAuthlocalTokenIdAssignments of the Assigned Token Identifiers parameter is defined in clause 6.3.5.43 of ETSI TS 118 104 [3]. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.19 Authorization | If a request primitive includes a Tokens parameter it shall be mapped to the Authorization header. The Tokens primitive parameter is represented as a space separated list of JSON Web Signature (JWS) and JSON Web Encryption (JWE) strings in Compact Serialization format of datatype m2m:dynAuthJWT as defined in clause 6.3.3 of ETSI TS 118 104 [3]. When mapped into the Authorization header, each individual token in the Tokens primitive parameter shall be separated by '+' character. For example, if the Tokens parameter consists of a list of two JWS/JWE Tokens, eyJ0eXAiOiJK.eyJpc3MiOiJqb2UiLA0KIC.dBjftJeZ4CVP eyJ0eXAiOiJK.eyJpc3MiOiJqb2UiLA0KIC.dBjftJeZ4CVP.5eym8TW_c8SuK.SdiwkIr3a.XFBoMYUZo the Authorization header looks as follows: Authorization: eyJ0eXAiOiJK.eyJpc3MiOiJqb2UiLA0KIC.dBjftJeZ4CVP+ eyJ0eXAiOiJK.eyJpc3MiOiJqb2UiL A0KIC.dBjftJeZ4CVP.5eym8TW_c8SuK.SdiwkIr3a.XFBoMYUZo The line break in the above example is for illustrative purposes and shall not be included into the Authorization header. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.20 X-M2M-CTS | The X-M2M-CTS header shall be mapped to the Content Status parameter of response primitives and vice versa, if applicable. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.21 X-M2M-CTO | The X-M2M-CTO header shall be mapped to the Content Offset parameter of response primitives, and vice versa, if applicable. ETSI ETSI TS 118 109 V4.4.1 (2023-12) 20 oneM2M TS-0009 version 4.4.1 Release 4 |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.22 X-M2M-RVI | The X-M2M-RVI header shall be mapped to the Release Version Indicator parameter of request and response primitives and vice versa. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.23 X-M2M-VSI | The X-M2M-VSI header shall be mapped to the Vendor Information parameter of request and response primitives and vice versa. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.24 X-M2M-AS | If a request primitive includes an Authorization Signature parameter, it shall be mapped to the X-M2M-AS header. The Authorization Signature primitive parameter is represented as a space separated list of URL-safe base64 encoded (base64url)) strings of datatype m2m:signatureList as defined in clause 6.3.3 of ETSI TS 118 104 [3]. When mapped into the X-M2M-AS header, each individual signature in the Authorization Signature primitive parameter shall be separated by '+' character. For example, if the Authorization Signature parameter consists of a list of two elements: i6watmQQQ1y3GB-VsWq5fJKzQcBB4jRfH1bfJFj0JtFVtLotttzYyA== IWijxQjUrcXBYoCei4QxjWo9Kg8D3p9tlWoT4t0_gyTE96639In0FZFY2_rvP-_bMJ01EArmKZsR5VW3rwoPxw== The X-M2M-AS header looks as follows: X-M2M-AS: i6watmQQQ1y3GB-VsWq5fJKzQcBB4jRfH1bfJFj0JtFVtLotttzYyA==+ IWijxQjUrcXBYoCei4QxjWo9Kg8D3p9tlWoT4t0_gyTE96639In0FZFY2_rvP-_bMJ01EarmKZsR5VW3rwoPxw== The line break in the above example is for illustrative purposes and shall not be included into the X-M2M-AS header. Whitespace characters are insignificant and should not be included into the header. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.25 X-M2M-ASRI | The X-M2M-ASRI header in a HTTP response message shall be mapped to the Authorization Signature Request Information parameter of response primitives and vice versa, if applicable. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.26 X-M2M-OMR | The X-M2M-OMR header shall be mapped to the Ontology Mapping Resources parameter of request primitives and vice versa, if applicable. The format of the oneM2M-OMR header shall be represented as a sequence of oneM2M resource identifiers separated by a '+'. EXAMPLE: The header looks as follows: oneM2M-OMR: /IN-CSE-0001/omr1+/IN-CSE-0001/omr2+… |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.27 X-M2M-MSU | The X-M2M-MSU header shall be mapped to the M2M Service User parameter of request and response primitives, and vice versa, if applicable. |
5884f20096a929755c7228996f24adba | 118 109 | 6.4.28 X-M2M-PRPI | The X-M2M-PRPI header shall be mapped to the Primitive Profile Identifier parameter of request primitives and vice versa. ETSI ETSI TS 118 109 V4.4.1 (2023-12) 21 oneM2M TS-0009 version 4.4.1 Release 4 |
5884f20096a929755c7228996f24adba | 118 109 | 6.5 Message-body | Message-body shall be mapped to the Content parameter of request and response primitives, and vice versa, if applicable. This applies to the Content parameter of all primitives with the following exceptions: 1) For partial Retrieve request primitives. Attributes contained in the Content parameter of Retrieve request primitive shall be mapped to the fragment component of request-target, as specified in clause 6.2.2.2, and vice versa. 2) A Token Request Information parameter included in a response primitive shall be mapped into the message-body either as a XML or JSON serialized object. The Content-Type and Content-Length headers shall be set compliant with the data representation (i.e. Content-Type: application/xml or application/json depending on the serialization format). Note that the Token Request Information parameter is used in oneM2M error response primitives (X-M2M-RSC: 4103 "ORIGINATOR_HAS_NO_PRIVILEGE") only, which do not carry any other primitive content. Error response messages which include the Token Request Information parameter in the Message-Body shall not include any debugging information. |
5884f20096a929755c7228996f24adba | 118 109 | 6.6 Message Routing | HTTP request and response message routing shall be performed as described in HTTP/1.1 [1]. |
5884f20096a929755c7228996f24adba | 118 109 | 7 Security Consideration | |
5884f20096a929755c7228996f24adba | 118 109 | 7.1 Authentication on HTTP Request Message | When sending the credential to be checked by the Registrar CSE, Proxy-Authorization header should be used as specified in HTTP/1.1 (see IETF RFC 7235 [Error! Reference source not found.]). When sending the credential to be checked by Hosting CSE, Authorization header should be used as specified in HTTP/1.1 [Error! Reference source not found.]. When the credential to be checked by Hosting CSE is an Access Token which is compatible with Oauth 2.0 framework (see IETF RFC 6750 [5]), the Bearer authentication scheme shall be used as specified in Oauth 2.0 framework. NOTE: The oneM2M Security Solutions [7] does not provide any details on usage or provisioning of the token. |
5884f20096a929755c7228996f24adba | 118 109 | 7.2 Transport Layer Security | oneM2M primitive parameters contained in HTTP messages may be protected by TLS in a hop-by-hop manner. For the details, see the oneM2M Security Solutions specification [7]. NOTE: Some provisioning schemes of ETSI TS 118 103 [7] enable the provisioning of end-to-end credentials, but protocols to establish security associations between non-adjacent nodes are not addressed by oneM2M in the present document. ETSI ETSI TS 118 109 V4.4.1 (2023-12) 22 oneM2M TS-0009 version 4.4.1 Release 4 Annex A (informative): Example Procedures A.1 <container> resource creation Figure A.1-1 is HTTP mapping of procedure described in clause 7.4.6.2.1 of ETSI TS 118 104 [3]. Note the example shown in figure A.1-1 applies under the following assumptions: • "CSE1" is the name (i.e. value of the resourceName attribute) of the <CSEBase> resource of the registrar CSE. • "cont1" is the name of the created <container> resource chosen by the registrar CSE. Originator (ASN-AE) Registrar CSE (ASN-CSE) Step 1: AE requests to create a <container> resource at ASN-CSE POST /CSE1?rcn=0 HTTP/1.1 Host: 192.168.0.2 X-M2M-Origin: CAE1 X-M2M-RI: 0001 X-M2M-RVI: 2a Content-Type: application/vnd.onem2m-res+xml; ty=3 Content-Length: 32 <m2m:cnt><mni>10</mni></m2m:cnt> Step 3: CSE responses OK HTTP/1.1 201 X-M2M-RI: 0001 X-M2M-RVI: 2a Content-Location: /CSE1/cont1 Content-Lengh: 0 Step 2: Local Processing Process the request and create "cont1" resource Step 2: Local Processing Process the request and create "cont1" resource Figure A.1-1: oneM2M HTTP Binding Example - container creation ETSI ETSI TS 118 109 V4.4.1 (2023-12) 23 oneM2M TS-0009 version 4.4.1 Release 4 Annex B (informative): WebSocket B.1 Notification using WebSocket WebSocket [i.4] can be used for transporting notifications to an AE/CSE. This can be useful for an AE/CSE which is not server-capable or cannot be reachable for delivery of unsolicited requests. For example, when an AE needs to receive a notification message from the CSE, the AE establishes a WebSocket connection to a CSE. When a new notification message is generated, the notification will be sent to the AE as the data frame of the WebSocket. ETSI ETSI TS 118 109 V4.4.1 (2023-12) 24 oneM2M TS-0009 version 4.4.1 Release 4 History Document history V4.4.1 December 2023 Publication |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 1 Scope | The present document specifies the interworking capabilities of the M2M Service Layer between ASN/IN/MN CSEs and LWM2M Endpoints using the architecture identified in Annex F of ETSI TS 118 101 [2] for the following interworking scenarios: • Interworking for transparent transport of encoded LWM2M Objects and commands in Content Sharing Resources between LWM2M Endpoints and M2M Applications. • Interworking with full mapping of LWM2M Objects in LWM2M Endpoints to semantically enabled Content Sharing Resources that are utilized by M2M Applications. • Interworking with one-to-one mapping of LWM2M Objects with oneM2M <mgmtObj> resources NOTE: The present document limits Content Sharing Resources to <container> and <contentInstance> resources. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 2 References | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 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. The following referenced documents are necessary for the application of the present document. [1] ETSI TS 118 111: "oneM2M; Common Terminology (oneM2M TS-0011)". [2] ETSI TS 118 101: "oneM2M; Functional Architecture (oneM2M TS-0001)". [3] OMA-TS-LightweightM2M-V1-0-20150318-D: "Lightweight Machine to Machine Technical Specification". [4] ETSI TS 118 103: "oneM2M; Security solutions (oneM2M TS-0003)". [5] ETSI TS 118 105: "oneM2M; Management Enablement (OMA) (oneM2M TS-0005)". [6] IETF RFC 3986: " Uniform Resource Identifier (URI): Generic Syntax". [7] IETF RFC 6690: "Constrained RESTful Environments (CoRE) Link Format". |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 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. 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. [i.2] IETF RFC 7252: "Constrained Application Protocol (CoAP)". [i.3] IETF RFC 6347: "Datagram Transport Layer Security Version 1.2". [i.4] OMA-RD-LightweightM2M-V1-0: "OMA Lightweight Machine to Machine Requirement". [i.5] ETSI TS 118 112: "oneM2M; Base Ontology (oneM2M TS-0012)". oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 7 |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 3 Definition of terms, symbols and abbreviations | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 3.1 Terms | For the purposes of the present document, the terms given in ETSI TS 118 111 [1] and ETSI TS 118 101 [2] apply. A term defined in the present document takes precedence over the definition of the same term, if any, in ETSI TS 118 111 [1] and ETSI TS 118 101 [2]. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 3.2 Symbols | Void. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 3.3 Abbreviations | For the purposes of the present document, the abbreviations given in ETSI TS 118 111 [1] and the following apply: LWM2M Lightweight M2M OMA OMA SpecWorks (formerly Open Mobile Alliance) |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 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]. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 5 Architecture Model | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 5.1 Introduction | The architecture model followed in the present document is based on the architecture model in Annex F of ETSI TS 118 101 [2] that describes how interworking between CSEs and non-oneM2M solutions and protocol using specialized Interworking Proxy application Entities (IPE). The present document describes the LWM2M IPE that supports the following scenarios. Figure 5.1-1: LWM2M Interworking Scenarios Hybrid Application CSE(s) LWM2M Interface Mca LWM2M IPE Mca ( ) LWM2M Application LWM2M IPE Mca LWM2M Interface oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 8 In the scenarios depicted in Figure 5.1-1, the Hybrid and LWM2M Applications represent applications that implement the LWM2M Client role defined in the LWM2M Protocol [3]. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 5.2 Reference Model | The LWM2M Interworking reference model utilizes the Functional Architecture's reference model in ETSI TS 118 101 [2]; augmenting the ETSI TS 118 101 [2] reference model with capabilities provided by the LWM2M IPE. NOTE: The AE in the reference model could be registered with the same CSE as the LWM2M IPE. Figure 5.2-1: LWM2M Reference Model |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 5.3 Types of Interworking | LWM2M IPEs provide the following types of interworking: 1) Interworking using the Content Sharing Resource for transparent transport of encoded LWM2M Objects that are available to AEs as depicted in Figure 5.3-1. 2) Interworking with full mapping of the semantics of LWM2M Objects to semantically enabled resources that are available to AEs as depicted in Figure 5.3-2. 3) Interworking with one-to-one mapping of LWM2M Objects to oneM2M <mgmtObj> resources as depicted in Figure 5.3-3. While depicted outside the hosting CSE, the Content Sharing Resources are hosted in a CSE (e.g. CSE1). LWM2M Application CSE LWM2M Protocol LWM2M IPE Mca AE Mca ASN/MN/IN CSE Mcc/Mcc’ MN/IN oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 9 Figure 5.3-1: LWM2M Transparent Interworking Function In Figure 5.3-1, the LWM2M Objects are provided by the LWM2M Application to the LWM2M IPE using the LWM2M Protocol. The LWM2M IPE then encapsulates the LWM2M Objects in Content Sharing Resources and then hosts the Content Sharing Resources in a CSE using the Mca reference points for use by AEs. The AE accesses the Content Sharing Resource from the CSE that hosts the resource using the Mca reference point. Once the AE receives the Content Sharing Resource, the AE extracts the LWM2M Object from the Content Sharing Resource for the AE's purpose. Clause 7 describes this type of interworking in greater detail. Figure 5.3-2: LWM2M Semantically Enabled Interworking Function In Figure 5.3-2, the LWM2M Objects are provided by the LWM2M Application to the LWM2M IPE using the LWM2M Protocol. The LWM2M IPE then interworks the LWM2M Objects into Content Sharing Resources. The Content Sharing Resources are based on the oneM2M defined Semantic Ontology. The LWM2M IPE hosts the Content Sharing Resource in a CSE across the Mca reference for use by other AEs. The AE accesses the Content Sharing Resource from the CSE that hosts the resource using the Mca reference point. Once the AE receives the Content Sharing Resource, the AE encodes the information using the Semantic Ontology for the AE's purpose. Clause 8 describes this type of interworking in greater detail. oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 10 Figure 5.3-3: LWM2M Translation Interworking Function In Figure 5.3-3, the IPE is provisioned with knowledge of the resource definition for a LWM2M Object and the corresponding oneM2M <mgmtObj> XSD, which shall be generated as described in ETSI TS 118 105 [5]. The XSD shall map each LWM2M resource of a particular LWM2M Object ID to an [objectAttribute] in the corresponding oneM2M <mgmtObj>. The ordering of the [objectAttribute] in the XSD shall match the same order of resources defined in the corresponding LWM2M Object. For a given LWM2M Object, the IPE shall create a corresponding <mgmtObj> resource on the CSE and configure the mgmtSchema attribute with a URI of the XSD file for that <mgmtObj>. All AEs can then access the <mgmtObj> the same way they access other oneM2M resources. Clause 9 describes this type of interworking in more details. An instance of a LWM2M IPE shall provide the capability for transparent transport of encapsulated LWM2M Objects as Content Sharing Resources and/or translation of LWM2M Objects as oneM2M semantically enabled Content Sharing Resources or as mapped oneM2M <mgmtObj> resources. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 5.4 Composition of the Interworking Proxy Entity | The LWM2M IPE participation in the LWM2M Protocol as described in clause 5 does so in the role of a LWM2M Server to which LWM2M Applications (LWM2M Clients) interact. For each LWM2M Client (Endpoint) that is maintained by the LWM2M Server in the LWM2M IPE, the LWM2M IPE shall instantiate and maintains an instance of a Resource of type <AE>. oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 11 Figure 5.4-1: LWM2M IPE Architecture |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6 Architecture Aspects | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.1 Introduction | The LWM2M IPE participation in the LWM2M Protocol as described in clause 5 does so in the role of a LWM2M Server to which LWM2M Applications (LWM2M Clients) interact. As a LWM2M Server, the IPE provides the following Architecture Aspects based on the LWM2M Protocol Aspects described in clause A.2: • LWM2M Device and Endpoint Lifecycle (Client Registration). • LWM2M Object Discovery (Client Registration, Device Management and Service Enablement). • LWM2M Object Transport and Interworking (Device Management and Service Enablement). • LWM2M Object Subscription and Notification (Information Reporting). • LWM2M Interworking Proxy Entity Administration. • LWM2M Client Provisioning (Bootstrap). oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 12 • LWM2M Object Security (Device Management and Service Enablement). |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.2 LWM2M Device and Endpoint Lifecycle | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.2.1 Introduction | As the LWM2M IPE discovers LWM2M Endpoints when the LWM2M IPE interacts with the LWM2M Client over the LWM2M protocol's Bootstrap and Client Registration interfaces, the LWM2M IPE shall maintain the associated resources in the CSE that represents the LWM2M Device and Endpoint. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.2.2 LWM2M Device and Endpoint Resource Representation | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.2.2.1 Introduction | LWM2M Endpoint provides the management and control functions for an M2M Application on a device. As such, the CSE that hosts the M2M Application shall represent the LWM2M Endpoint as a <AE> resource (LWM2M Endpoint <AE> resource). The LWM2M Device that hosts the LWM2M Endpoint shall be represented as a <node> resource. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.2.2.2 LWM2M Device and Endpoint Resource Identification | LWM2M Endpoints are identified by their Endpoint Client Name described in clause 6.2.1 of the LWM2M Technical Specification [3]. The Endpoint Client Name URN without the "urn:" sequence is used as the AE-ID of the associated <AE> resource that represents the LWM2M Client. In most deployment scenarios, LWM2M Devices host one (1) LWM2M Endpoint. In this scenario the LWM2M Device's <node> resource's M2M-Node-ID should be the same as the LWM2M Endpoint Client Name URN without the "urn:" sequence. When a LWM2M Device host's more than one (>1) LWM2M Endpoint, the determination of the <node> resource's M2M-Node-ID is implementation specific. In all deployment scenarios, the <AE> resource is linked with the <node> resource as described in ETSI TS 118 101 [2]. As the LWM2M Endpoint is represented as an <AE> resource and a LWM2M Object is represented as a Content Sharing Resource in the M2M Service Layer, a reference shall be made between the <AE> resource that represents the LWM2M Endpoint and the Content Sharing Resources which represents the list of LWM2M Objects and Object Instances available in that LWM2M Client. In order to identify interworked entities hosted in a CSE for the LWM2M technology described in the present document, the <AE> resource that represents the LWM2M Endpoint and the Content Sharing Resources which represent the list of LWM2M Objects and Object Instances available in that LWM2M Client, shall have a Iwked_Technology labels attribute set to LWM2M. For the case where a LWM2M Endpoint is represented as an <AE> resource and LWM2M Objects are represented as <mgmtObj> resources in the M2M Service Layer, each <mgmtObj> resource shall be a child of the <node> resource representing the LWM2M Device that hosts the LWM2M Endpoint. In this case, the nodeLink attribute of the <AE> resource representing the LWM2M Endpoint shall reference the <node> resource representing the LWM2M Device. In addition the <AE> resource uses the Hierarchical and Non-Hierarchical mechanisms for Resource Addressing as defined in clause 9.3.1 of ETSI TS 118 101 [2] where the resourceName attribute of the <AE> resource shall be a Endpoint Client Name URN without the "urn:" sequence. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.2.2.3 LWM2M Endpoint Lifecycle | LWM2M Endpoint's are discovered when the LWM2M Client is successfully registers with the LWM2M Server using the LWM2M Register operation. In addition to the LWM2M Register operation, the LWM2M Client can periodically refresh the LWM2M Client's registration with the LWM2M IPE using the LWM2M Update operation. Finally a LWM2M Client can deregister when the LWM2M Client issues a De-register operation to the LWM2M IPE or the LWM2M Client's registration lifetime expires. The LWM2M Client Registration interface's operations and the registration lifetime expiration event maps to the following operations on the <AE> and <node> resources. oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 13 Table 6.2.2.3-1: LWM2M Endpoint Lifecycle Translation - Client Registration Interface LWM2M Operation Client Registration Interface oneM2M Resource and Operation Register create <AE>, create <Node> Update update <AE>, update <Node> De-register delete <AE>, delete <Node> Table 6.2.2.3-2: LWM2M Endpoint Lifecycle Translation - LWM2M Server Events LWM2M Server Events oneM2M Resource and Operation client lifetime expiration delete <AE>, delete <Node>, delete <container> resources associated with the <AE> resource, delete <mgmtObj> resources associated with <node> resource. Table 6.2.2.3-3: LWM2M Endpoint Lifecycle Attribute Translation LWM2M Attributes Client Registration Interface oneM2M Resource Attribute Endpoint Client Name <AE>: AE-ID, resourceName <Node>: M2M-Node-ID when the Device only supports one Endpoint; resourceName Lifetime <AE>, <Node>: expirationTime LWM2M Version <AE>, <Node>: labels. Value is "Iwked-Entity- Version:"appended with the value of the LWM2M Version. Binding Mode Not Applicable SMS Number Not Applicable Table 6.2.2.3-4: LWM2M Endpoint Lifecycle Response Code Translation LWM2M Errors Client Registration Interface oneM2M Resource Operation Response Register 2.01 Created: 4.00 Bad Request 4.03 Forbidden create <AE>, create <Node> 2001 Created All other codes 4105 Conflict Update 2.04 Changed 4.00 Bad Request 4.04 Not Found update <AE>, update <Node> 2004 Changed All other codes 4000 Not Found De-register 2.02 Deleted 4.04 Not Found delete <AE>, delete <Node> 2002 Deleted 4004 Not Found |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.2.2.4 Configuration of CMDH Policies | In the present document, the CMDH Policies associated with the <Node> resource for the AE is implementation specific. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.2.2.5 Registering a Registered LWM2M Endpoint | In the scenario where a LWM2M Client issues a Register operation for an AE that is already created, the LWM2M IPE shall treat the operation as if the LWM2M Client requested a De-Register (Delete <AE> resource) prior this Register operation (Create <AE> resource) as described in Table 6.2.2.3-1. The procedure for the LWM2M Server is defined in clause 5.3.1 of the LWM2M Technical Specification [3]. oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 14 |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.3 LWM2M Object Discovery | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.3.1 Introduction | The LWM2M Client uses the Registration Interface to provide the properties required by the LWM2M Server of the IPE to contact the LWM2M Client (e.g. Endpoint Name) and to maintain the session between these two LWM2M entities (e.g. Lifetime, Queue Mode). In addition, the LWM2M Client also provides the knowledge of the supported Objects and existing Object Instances across the Registration Interface. The LWM2M IPE uses the information exchange across this interface to synchronize which LWM2M Objects supported by the LWM2M Endpoint and what is defined in the hosting CSE for the M2M Application representing the LWM2M Endpoint. This clause specifies how discovered LWM2M Objects identifiers are translated to discoverable oneM2M resources along with the associated linkages to other oneM2M resources. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.3.2 LWM2M Object Identifier Representation | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.3.2.1 Introduction | Through the Registration Interface, the LWM2M Client provides the list of supported LWM2M Objects and existing LWM2M Object Instances. Each element of the list is described by its path, which can be the path of an Object or an Object Instance. For example the LWM2M Client could provide the following list of paths: </1/0>, </1/1>, </2/0>, </2/1>, </3/0>, </4/0>, </5>. This list of paths is a valid list of LWM2M Objects and LWM2M Object Instances in the CoRE Link Format (IETF RFC 6690 [7]), specifying that LWM2M Objects with OMNA Identifiers 1, 2, 3,4, and 5 are supported. The respective OMNA references are: urn:oma:lwm2m:oma:1, urn:oma:lwm2m:oma:2, urn:oma:lwm2m:oma:3, urn:oma:lwm2m:oma:4, urn:oma:lwm2m:oma:5. Additionally, information is provided that LWM2M Object 1 (Server Object) and LWM2M Object 2 (Access Control Object) have 2 instances (Instance Identifiers 0 and 1); LWM2M Object 3 (Device Object) and LWM2M Object 4 (Connectivity Monitoring Object) have 1 instance each (0); LWM2M Object 5 is supported but no instance has been created yet for that LWM2M Object. Optionally other information can be carried by that list as the capability for all the Objects in the LWM2M Client to support: • an alternate root path (default root path is '/'); • a specific Content-Format (e.g. LWM2M JSON Content-Format). For discovery of LWM2M Objects by M2M Applications, the properties carried by LWM2M Objects list (i.e. technology, Objects and LWM2M Object Instances Identifiers, optional alternate rootpath, supported Content-Format) shall be translated into the labels attribute of the Content Sharing Resource as separate entries with the following format: • Iwked-Technology:LWM2M • Iwked-Entity-Type:Resource Type • LWM2M-PATH:Resource Root Path (for LWM2M default rootpath is "/"). • Iwked-Entity-ID:Resource Path Object Identifier and Instance Identifier. • Iwked-Content-Type: Supported Content Format (LWM2M default Supported ContentFormat is LWM2M TLV other can be LWM2M JSON). For the case where LWM2M Objects are represented as <mgmtObj> resources in the M2M Service Layer, the properties carried by the LWM2M Objects list shall be translated into the labels attribute of the <node> resource using the above format. oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 15 For example if the LWM2M Endpoint provided the following LWM2M Objects as part of the Client Registration Interface: </lwm2m>;rt="oma.lwm2m";ct=LWM2M+JSON,</1/0> would translate into a <container> resource with the following entries in the labels attribute: Iwked-Technology:LWM2M Iwked-Entity-Type:"urn:oma:lwm2m:oma:1" LWM2MPTH:"/lwm2m" Iwked-Entity-ID: "/1/0" Iwked-Content-Type:LWM2M+JSON (see note). NOTE: LWM2M+JSON is an entry (numerical ID) in the CoAP Content-Format Registry representing the media-type "application/vnd.oma.lwm2m+json" used in LWM2M TS 1.0 enabler and currently engaged in the IANA registration process. The CoAP Resource Type may also be used as the semantic ontology of the <container> resource by inserting this value in the ontologyRef attribute of the <container> or other translated oneM2M resource. For the case where LWM2M Objects are represented as <mgmtObj> resources in the M2M Service Layer, the IPE shall use information carried in the LWM2M Objects list to configure not only the labels and description attributes but also the objectID and objectPath attributes of the <mgmtObj> resources since objectID and objectPath can also be helpful for discovery of the supported LWM2M Objects. For the case that 1:1 mapping of LWM2M Object to oneM2M <mgmtObj> is desired, the objectIDs attribute shall contain the URN of the corresponding LWM2M Object and the mgmtSchema attribute shall contain a URI of the schema file for the new <mgmtObj> specialization as outlined in clause 6.7 of ETSI TS 118 105 [4]. LWM2M Object Resources are identified by their URI within the context of the LWM2M Endpoint described in clause 6.2.1 of the LWM2M Technical Specification [3]. As the LWM2M Endpoint is represented as an <AE> resource and a LWM2M Object is represented as a oneM2M resource in the M2M Service Layer, a reference shall be made between the <AE> resource that represents the LWM2M Endpoint and the oneM2M resource which represent the list of LWM2M Objects and Object Instances available in the LWM2M Client. For the case where a LWM2M Object is represented as a <mgmtObj> resource, this reference is already provided by the AE's nodeLink attribute. In addition, oneM2M resources that represents the LWM2M Object or LWM2M Object Instance uses the Hierarchical and Non-Hierarchical mechanisms for Resource Addressing as defined in clause 9.3.1 of ETSI TS 118 101 [2] where the resourceName attribute of the Content Sharing or oneM2M resource shall be the value of the LWM2MURI. All characters that are not in the unreserved character set defined in clause 2.3 of the of IETF RFC 3986 [6] shall be percent encoded as defined in clause 2.1 of the same IETF RFC, specifically the forward slash (/) character. For example if the LWM2MURI is "/1/0 and the LWM2MPTH is "/" then the resourceName attribute of the oneM2M resource could be "%2F1%2F0". For the case where <mgmtObj> resources are used, the "/1/0" LWM2MURI is mapped to the <mgmtObj>'s objectPath attribute. All characters that are not in the unreserved character set shall be percent encoded as well. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.3.2.2 Void | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.3.2.3 LWM2M Object Lifecycle | LWM2M Endpoint's are discovered when the LWM2M Client is successfully registers with the LWM2M Server using the LWM2M Register operation. In addition to the LWM2M Register operation, the LWM2M Client can periodically refresh the LWM2M Client's registration with the LWM2M IPE using the LWM2M Update operation. Finally a LWM2M Client can deregister when the LWM2M Client issues a De-register operation to the LWM2M IPE or the LWM2M Client's registration lifetime expires. The LWM2M Client Registration interface's operations and the registration lifetime expiration event maps to the following operations on the resource. oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 16 Table 6.3.2.3-1: LWM2M Object Lifecycle Translation - Client Registration Interface LWM2M Operation Client Registration Interface oneM2M Resource and Operation Register create <container>, oneM2M resource Update update <container>, delete <container>, oneM2M resource De-register delete <container>, oneM2M resource Table 6.3.2.3-2: LWM2M Object Lifecycle Translation - LWM2M Server Events LWM2M Server Events oneM2M Resource and Operation Client lifetime expiration delete <container>, oneM2M resource Table 6.3.2.3-3: LWM2M Object Lifecycle Attribute Translation LWM2M Attributes Client Registration Interface oneM2M Resource Attribute Endpoint Client Name Not Applicable Resource Links <container>, oneM2M resource resourceName Lifetime <container>, oneM2M resource expirationTime LWM2M Version Not Applicable Binding Mode Not Applicable SMS Number Not Applicable Table 6.2.2.3-4: LWM2M Object Lifecycle Response Code Translation LWM2M Errors Client Registration Interface oneM2M Resource Operation Response Register 2.01 Created: 4.00 Bad Request 4.03 Forbidden create <container> 2001 Created All other codes 4105 Conflict Update 2.04 Changed 4.00 Bad Request 4.04 Not Found update <container> 2004 Changed All other codes 4000 Not Found De-register 2.02 Deleted 4.04 Not Found delete <container> 2002 Deleted 4004 Not Found |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.4 LWM2M Object Transport and Interworking | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.4.1 Introduction | When an oneM2M request is addressed from a CSE/AE to a hosting CSE containing the representation of a LWM2M Client, the oneM2M response to the Originator of the request is returned through the cooperation of the hosting CSE and the IPE. The LWM2M Client uses the Device Management & Service Enablement interface to provide the capabilities for the LWM2M Server of the IPE to access LWM2M Objects, Objects Instances and Resources available from the LWM2M Client. A hosting CSE maintains a representation of the LWM2M Data Model of LWM2M Object, Object Instance or Resources as instances of oneM2M resource types. These Content Sharing Resources are instantiated and registered as described in clause 6.3 allowing oneM2M AEs and CSEs to exchange data with LWM2M Clients. In reference to clause 6.3, at the end of the registration phase all declared LWM2M Object Instances and LWM2M Objects are associated to a Content Sharing Resource created with the resourceName attribute set accordingly to the proper LWM2M Object Instance path (e.g. /9/1) or to the LWM2M Object path (e.g. /9). oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 17 |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.4.2 LWM2M Interworking Mechanisms | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.4.2.1 Introduction | Cooperation between IPE and the oneM2M hosting CSE requires efficient mechanisms to maintain the latest state of the targeted LWM2M Objects, Object Instances and Resources. These mechanisms include data synchronization between the IPE and hosting CSE. Data synchronization relies on the oneM2M Subscription/Notification and LWM2M Observation/Notification mechanisms. For automated data synchronization between the IPE and hosting CSE to be achieved, the solution shall be granular enough to allow data synchronization for each LWM2M Object Instance. Access Control mechanisms relies on an interworking between oneM2M and LWM2M Access Control Policies. LWM2M and oneM2M mechanisms used to achieve Data Synchronization and Access Control is specified in more details in clauses 6.5 and 6.6. These following sub-clauses specify the sequences of operations involved for each type of supported oneM2M requests following the general procedures specified in clause 10 (CREATE,RETRIEVE, DELETE) as used within the context of the interworking for the present document |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.4.2.2 Relevant Interworked Resource Settings | A LWM2M Object Instance that is represented in oneM2M as a <container> resource has 2 direct children resource types: a <subscription> resource and a <contentInstance> resource when used with a <container> resource. A LWM2M Object Instance that is represented in oneM2M as a <mgmtObj> resource may have 1 direct child resource of type <subscription>. For supporting the LWM2M interworking process, a few attributes for the <container> resource and the <subscription> resource shall have a specified set of parameters. a) Attributes of <container> resource Table 6.4.2.2-1: <container> resource - Relevant Interworked Attributes Attributes of <container> resource Value accessControlPolicyIDs ACP set (see Clause 6.6) maxNrOfInstances 1 b) Child resource types of <container> resource Table 6.4.2.2-2: <container> resource - Relevant Child resource types Child resources of <container> resource <contentInstance> resource <subscription> resource c) Attributes of <subscription> resource oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 18 Table 6.4.2.2-3: <subscription> resource - Relevant Interworked Attributes Attributes of <subscription> resource Description / Value notificationURI IPE URI eventType B. Deletion of the subscribed-to resource; C. Creation of a direct child of the subscribed-to resource; E. An attempt to retrieve a <contentInstance> direct-child-resource of a subscribed-to <container> resource is performed while this child is an obsolete resource or the reference used for retrieving this resource is not assigned. This retrieval is performed by a RETRIEVE request targeting the subscribed-to resource with the Result Content parameter set to either "child-resources" or "attributes+child-resources". |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.4.2.3 oneM2M RETRIEVE Procedure | This procedure describes the retrieval of a resource using the oneM2M RETRIEVE request. The information contained within the resource is related to the LWM2M Objects Instances that are interworked through the IPE. This clause shall be treated in conformance with the RETRIEVE Procedure specified in ETSI TS 118 101 [2], clauses 10.1.2 and 10.2.4.2. The Receiver performs local processing to verify the existence of requested Resource and checks privileges for retrieving the information related to the resource. After successful verification, the Receiver shall return the requested information according to the procedures for the type of interworking (e.g. Transparent, Semantically Enabled, or Management Objects) as described in clauses 7, 8, and 9, otherwise an error response shall be returned to the Originator. Figure 6.4.2.3-1: Procedure for Retrieving a Resource (ETSI TS 118 101 [2], clause 10) The target of the request is a <container> or <mgmtObj> resource, the ResultContent and FilterCriteria parameters of the request (ETSI TS 118 101 [2], clause 8.1.2) specify the nature of the information to retrieve. Table 6.4.2.3-1: Effect of Request Parameters on Retrieval Request Request parameter: ResultContent Request parameter: FilterCriteria Effect child-resources resourceType = contentInstance Retrieval of LWM2M Object Instance attributes (default) labels, attribute Metadata retrieval of LWM2M Object Instance. Specific steps of the Receiver Processing according to the interworking process shall be followed: Step 001: Find and verify the targeted <container> or <mgmtObj> resource of the request: the resourceName corresponds to clause 6.3.2. Step 002: Using the Hosting CSE Access Control mechanisms, check for Access Control Policy attached to the <container> or <mgmtObj> resource of the request. oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 19 Step 003: On successful validation of the Access Control Policy, proceed to fetch the requested information: a) If "ResultContent" is "attributes", jump to step 4. b) If "ResultContent" is "child-resources" and "FilterCriteria" is "contentInstance", the associated <contenInstance> resource of the targeted container is considered. • Step 003.1: if the <contentInstance> resource is obsolete or its reference is not assigned, an event for Retrieval attempt (eventType 'E') is triggered to the Entity that subscribed to the event (i.e. IPE); as a Blocking Procedure, the Hosting CSE shall monitor the arrival of the new data or decide to report a timeout error in jumping to Step 004: - Step 003.1.1: On receiving the event of type 'E' (eventType 'E') the IPE performs a LWM2M READ request on the Object Instance of the targeted LWM2M Client. - Step 003.1.2: Once the targeted Object Instance is available to IPE, the IPE creates and populates with that data the <contentInstance> child-resource of the requested <container> resource. • Step 003.2: the up-to-date information is available in the <contentInstance> resource. Step 004: The Hosting CSE returns the appropriate response back to the Originator (e.g. Errors, or Data). NOTE: As an OBSERVATION has been set up on the targeted LWM2M Object Instance, the automatic synchronization between the Object Instance and its representation in the Hosting CSE is performed. Further oneM2M accesses to the resource should be simplified in minimizing impact of Step003 (up-to- date data already present from the Hosting CSE resources). General Exceptions: 1) The targeted resource/attribute in To parameter does not exist. The Receiver shall respond with an error. 2) The Originator does not have privileges to retrieve information stored in the resource on the Receiver. The Receiver shall respond with an error. 3) A timer has expired. The Receiver shall respond with an error. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.4.2.4 oneM2M CREATE Procedure | This procedure describes the update of a LWM2M Object Instance in a LWM2M Client using the oneM2M CREATE request. The information contained in the request via the Content parameter (ETSI TS 118 101 [2], clause 8.2.1) will be used to update an Object Instance in the LWM2M context. This clause shall be treated in conformance with the CREATE Procedure specified in ETSI TS 118 101 [2], clauses 10.1.2 and 10.2.4.1. 001: CREATE Request Originator requests creation of a Resource 004: CREATE Response Receiver responds to creation Request Originator (CSE or AE) Receiver (Hosting CSE) 002&3: Receiver Processing Figure 6.4.2.4-1: Procedure for Creating a Resource (ETSI TS 118 101 [2], clause 10) The target of the request is a <container> or <node> resource, the ResourceType parameters of the request (ETSI TS 118 101 [2], clause 8.1.2) specifies the type of the resource to create. oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 20 Table 6.4.2.4-1: Effect of Request Parameters on Create Request Request parameter:ResourceType Effect ContentInstance Replacement of the <latest> resource by a new one MgmtObj Creation of new <mgmtObj> resource or appropriate error message if one already exist In LWM2M Interworking context, if there is already an existing <contentInstance> resource, creating a new one shall violates the policy defined in the parent <container> resource regarding the maxNrOfInstances which shall be set to 1. Then the oldest <contentInstance> resources shall be removed from the <container> to enable the creation of the new <contentInstance> resource. In any case, a notification is sent to the IPE, which subscribed to the parent <container> or <node> resource with the eventType 'C' (Creation of a direct child of the subscribed-to resource). The IPE shall use that notification to update the LWM2M resource model with the new data received ("Content" parameter of the request). Specific steps of the Receiver Processing according to the interworking process shall be as followed: Step 001: Find and verify the <container> or <node> resource of the request: the resourceName corresponds to clause 6.3.2. Step 002: Using the Hosting CSE Access Control mechanisms, check for Access Control Policy attached to the <container> or <node> resource of the request. Step 003: On unsuccessful validation of the Access Control Policy, jump to step 4: • Step 003.1: When according to the request, a <contentInstance> or <mgmtObj> resource is created, an event for Child Creation (eventType 'C') is triggered to the Entity that subscribed to that event (i.e. IPE). • Step 003.2: On receiving the event of type 'C' the IPE - via the Mca reference point - get the data from the created <contentInstance> or <mgmtObj> resource and propagates the updated data to the related Object Instance in the LWM2M Client. Step 004: The Hosting CSE returns the appropriate response back to the Originator (e.g. Acknowledgment, Errors). General Exceptions: 1) The Originator does not have the privileges to create a resource on the Receiver, the Receiver shall respond with an error. 2) The resource with the specified name (if provided) already exists at the Receiver, the Receiver shall response with an error. 3) The provided information in Content is not accepted by the Receiver (e.g. missing mandatory parameter), the Receiver shall respond with an error. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.4.2.5 oneM2M UPDATE Procedure | This procedure describes the update of a LWM2M Object Instance or Resource in a LWM2M Client using the oneM2M UPDATE request. The information contained in the request via the Content parameter (ETSI TS 118 101 [2], clause 8.1.2) shall be used to update an Object Instance or Resource in the LWM2M context. This clause shall be treated in conformance with the UPDATE Procedure specified in ETSI TS 118 101 [2], clauses 10.1.3 and 10.2.8.4. oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 21 001: UPDATE Request Originator requests update of a Resource or create/delete attributes of a Resource 004: UPDATE Response Receiver responds to update request Originator (CSE or AE) Receiver (Hosting CSE) 002 & 003: Receiver Processing Figure 6.4.2.5-1: Procedure for UPDATing a Resource (ETSI TS 118 101 [2], clause 10) The target of the request is the <mgmtObj> resource itself. Specific steps of the Receiver Processing according to the interworking process shall be as followed: Step 001: Find and verify the <mgmtObj> resource of the request: the resourceName corresponds to clause 6.3.2. Step 002: Using the Hosting CSE Access Control mechanisms, check for Access Control Policy attached to the <mgmtObj> resource of the request. Step 003: On unsuccessful validation of the Access Control Policy, jump to step 4. Step 003.1: When according to the request, a <mgmtObj> attribute is updated, an event for update to attributes (eventType 'A') is triggered to the Entity that subscribed to that event (i.e. IPE). Step 003.2: On receiving the event of type 'A', the IPE - via the Mca reference point - gets the data from the attribute and propagates the updated data to the related Object Instance or Resource in the LWM2M Client. Step 004: The Hosting CSE returns the appropriate response back to the Originator (e.g. Acknowledgment, Errors). General Exceptions: 1) The targeted resource in To parameter does not exist. The Receiver responds with an error. 2) The Originator does not have the privilege to modify the resource, create attributes or delete attributes on the Receiver. The Receiver responds with error. 3) The provided information in the Content is not accepted by the Receiver. The Receiver responds with error. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.4.2.6 oneM2M DELETE Procedure | This procedure describes the removal of a LWM2M Object Instance within a LWM2M Client using the oneM2M DELETE request. This clause shall be treated in conformance with the DELETE Procedure specified in ETSI TS 118 101 [2], clauses 10.1.4 and 10.2.4.4. oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 22 001: DELETE Request Originator requests deletion of a Resource 004: DELETE Response Receiver responds to deletion Request Originator (CSE or AE) Receiver (Hosting CSE) 002 & 003 : Receiver Processing Figure 6.4.2.6-1: Procedure for Deleting a resource (ETSI TS 118 101 [2], clause 10) Specific steps of the Receiver Processing according to the interworking process shall be as followed: Step 001: Find and verify the <container> or <mgmtObj> resource of the request: the resourceName corresponds to clause 6.3.2. Step 002: Using the Hosting CSE Access Control mechanisms, check for Access Control Policy attached to the <container> or <mgmtObj> resource of the request. Step 003: On unsuccessful validation of the Access Control Policy, jump to step 4: • Step 003.1: When the <container> or <mgmtObj> resource is deleted an event (eventType 'B': Deletion of subscribed-to resource) is triggered to the Entity that subscribed to that event (i.e. IPE). • Step 003.2: On receiving the event type 'B', the IPE requests the LWM2M Client to delete the Object Instance related to the <container> or <mgmtObj> resource. • Step 003.3: On Object Instance deletion, the LWM2M Client performs a De-Registration operation to the IPE. • Step 003.4: Via the Mca reference point, the IPE communicates to the Hosting CSE the status of this De-Registration. Step 004: The Hosting CSE returns the appropriate response back to the Originator (e.g. Success, Errors). oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 23 |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.4.3 oneM2M Resource Operation Responses | Table 6.4.3-1: LWM2M Response Codes to oneM2M Resource Operation Response Codes LWM2M Client Response Codes on Device Management & Service Enablement interface oneM2M Resource Operation Response Create 2.01 Created: 4.00 Bad Request 4.01 Unauthorized 4.04 Not Found 2001 Created 4000 4103 4004 Read 2.05 Content: 4.01 Unauthorized 4.04 Not Found 4.05 Method Not Allowed 2000 OK 4103 4004 4005 Write 2.04 Changed 4.00 Bad Request 4.01 Unauthorized 4.04 Not Found 4.05 Method Not Allowed 2004 Changed 4000 4103 4004 4005 4102 Delete 2.02 Deleted 4.00 Bad Request 4.01 Unauthorized 4.04 Not Found 4.05 Method Not Allowed 2002 deleted 4103 4103 4004 4005 |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.5 LWM2M Object Subscription and Notification | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.5.1 Introduction | The LWM2M Server uses the Information Reporting Interface to provide the capabilities for a LWM2M Server to subscribe to changes to the LWM2M Objects, LWM2M Object instances and the associated LWM2M Object's resources. Likewise the LWM2M Client uses the Information Reporting Interface to notify subscribed LWM2M Server's when the LWM2M Object, LWM2M Object instance and/or LWM2M Object's resources change and to cancel the subscription on LWM2M Objects, LWM2M Object instances and the associated LWM2M Object's resources. The LWM2M Server uses the Device Management & Service Enablement Interface to set the notification criteria for a subscription. The oneM2M Subscription capabilities permit subscription changes to an oneM2M resource's attributes and its direct child resources. Likewise, the oneM2M Notification capabilities include a rich set of criteria for when a subscribed-to oneM2M resource is notified of a change. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.5.2 LWM2M Subscription Procedure | The LWM2M IPE interworks the oneM2M resource's <subscription> child resource with the corresponding LWM2M Object using the oneM2M <subscription> resource's attributes and the corresponding LWM2M Object resource's Notification class Attributes. NOTE: Each LWM2M Object resource has an associated set of Notification class Attributes that are used for defining the applicable subscription and notification criteria. When the LWM2M IPE creates a oneM2M Content Sharing Resource, the LWM2M IPE creates a subscription on the Content Sharing Resource to be notified whenever the oneM2M resource's subscription attribute is changed by setting the <subscription> resource's attributes as follows. oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 24 Table 6.5.2-1: LWM2M Subscription Procedure - <subscription> resource Attributes of <subscription> Description accessControlPolicyIDs Link a <accessControlPolicy> resource with the privileges: accessControlOriginator originatorID set to the LWM2M IPE AE's AE-ID accessControlOperations: Set to RETRIEVE, CREATE, UPDATE, DELETE, DISCOVER, NOTIFY pendingNotification Set to "sendLatest" latestNotify Set to "latest". notificationContentTy pe Set to "resource" <schedule> Set to immediate notification Whenever another AE or CSE creates or deletes a subscription to the <container> resource, the LWM2M IPE shall be notified of the change and shall perform the following steps: Step 001: Find the associated LWM2M Object or Object Instance for notification's subscriptionReference. Step 002: If the oneM2M notification indicates a subscription deletion: • Step 002a: If the associated LWM2M Object or Object Instance has an outstanding Observation request from the LWM2M IPE then issue the LWM2M Cancel Observation operation. Step 003: If the oneM2M notification indicates a subscription creation: • Step 003a: If the associated LWM2M Object or Object Instance does not have an outstanding Observation request from the LWM2M IPE then: - Step 003a001: Retrieve the Parent resource of the <subscription> resource from the notification's subscriptionReference. - Step 003a002: Determine the LWM2M Notification class Attributes to set from the set of subscriptions of the Parent resource using the <schedule> resource associated with each of the Parent resource's subscriptions. - Step 003a003: Issue the LWM2M Observe operation with the LWM2M Notification class attributes. General Exceptions: The processing for recovery of a failed LWM2M Cancel Observation or Observation operation is vendor specific. Table 6.5.2-2: LWM2M Subscription Procedure - Information Reporting Interface LWM2M Operation Information Reporting Interface oneM2M Resource and Operation Observe NOTIFY (m2m:notification subscriptionDeletion=false) Cancel Observation NOTIFY (m2m:notification subscriptionDeletion=true) Table 6.5.2-3: LWM2M Subscription Procedure Attribute Translation LWM2M Operation DM and SE Interface Notification class Attributes oneM2M <subscription> Attribute Minimum Period <schedule> resource Maximum Period <schedule> resource Greater Than Not Applicable Less Than Not Applicable Step Not Applicable oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 25 |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.5.3 LWM2M Notification Procedure | When the LWM2M IPE is notified by the LWM2M Client of a change in a LWM2M Object or Object Instance the LWM2M IPE creates a new <contentInstance> for the associated <container> resource according to the procedures for the type of interworking (e.g. Transparent, Semantic) as described in clause 7 or 8. For the case where LWM2M Objects are represented as <mgmtObj> resources in the M2M Service Layer and when the LWM2M IPE is notified by the LWM2M Client of a change in a LWM2M Object or Object Instance, the LWM2M IPE updates the corresponding <mgmtObj> resource according to the procedures described in clause 9. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.6 LWM2M Object Security | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.6.1 Introduction | OMA-LWM2M and oneM2M Access Control Policies shall collaborate in order to assure the interworked resources are accessible according to the oneM2M Authorisation Procedure specified in clause 11.3.4 (M2M Authorization Procedure) of ETSI TS 118 101 [2] and clause 7 (Authorization) of ETSI TS 118 103 [5]. 6.6.2 LWM2M Interworking Access Control Policy The oneM2M Access Control Policy mechanisms specified in clause 7 of ETSI TS 118 103 [5], shall be used to check and validate the parameters of a request message against the ACPs (<accessControlPolicy> resources) which have been assigned to the accessed resource. In order to assure a proper LWM2M Interworking with oneM2M, the IPE shall setup the hosting CSE by: 1) providing a mandatory set of <accessControlPolicy> (ACPs) resources; 2) assigning a proper set of ACPs to the accessControlPolicyIDs attribute of each <container> resource allocated during the CSE registration phase (clause 6.3 LWM2M Object Discovery). The process for provisioning the IPE in order to perform such a setup is described in clause 6.6.3 "IPE and Object Security provisioning" of the present document. In addition, the Access Control Policy mechanisms specified in clause 7 of ETSI TS 118 103 [5] are fully applicable in this LWM2M interworking context. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.6.3 IPE and Object Security provisioning | In order to provide oneM2M information specified in the clause 6.6.2 (set of <accessControlPolicy> (ACPs) resources, assignment of accessControlPolicyIDs), the LWM2M IPE shall be supplied by information such as: • a list of oneM2M originators and their associated Access Control Rules likely to be exercised on the Hosting CSE resources; • a list of oneM2M originators likely to contact the LWM2M Clients with the associated set of authorized operations. In combining such an information with the Access Control Policy specified in a given LWM2M Client (clause 6.8 LWM2M Client Provisioning) the LWM2M IPE shall be able to provide to the Hosting CSE, the oneM2M Access Control Policy materials needed for properly registering LWM2M Objects representation. In the current release of the present document, this procedure of how the Access Control Policy materials are provided is implementation specific. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.7 LWM2M IPE Administration and Maintenance | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.7.1 Introduction | 6. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 7.1 Introduction | The IPE described in clause 5.4 is comprised functionality that includes the LWM2M Server and the IPE's AE. This clause describes the administration and maintenance of these functional elements. oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 26 |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.7.2 Administration and Maintenance of the LWM2M Server Functionality | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.7.2.1 Introduction | The LWM2M IPE provides the functionality that plays the role of the LWM2M Server in order to communicate with LWM2M Clients. In order for communication to be established information needs to be provisioned into the LWM2M Client and LWM2M Server where the following artefacts are necessary to be established for the LWM2M Server: • LWM2M Server and Client Credentials. • LWM2M Access control lists. In addition, the LWM2M Server maintains information about each LWM2M Client and has actions that are used to maintain the LWM2M Server. These aspects of the LWM2M Server are further described in clause E.2 of the LWM2M Server resource [3]. The mechanisms used to administer and maintain the LWM2M Server functionality within the LWM2M IPE is out of scope of the present document. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.7.2.2 LWM2M Server Maintenance | The LWM2M Server maintains a set of LWM2M Server account information for each LWM2M Client that allows the LWM2M Server to access and communicate with LWM2M Client. These are: • LWM2M Server identifier associated with and assigned by the LWM2M Client (LWM2M Server identifier, registration lifetime). • Policies for default observation behavior. The following actions can also be performed that affects the state of the LWM2M Server's interaction with the LWM2M Client: • On-demand request for the LWM2M Client to update its registration. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.7.3 Maintenance of the LWM2M IPE AE Context | |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.7.3.1 Introduction | The LWM2M IPE AE maintains information related to the operational context of the LWM2M IPE AE. Specifically the following elements are maintained for the LWM2M IPE AE: • List of currently registered LWM2M Endpoints. • Configuration of the Interworking Functions to be used for the LWM2M Objects and Object Instances. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.7.3.2 LWM2M Endpoint List | Whenever an LWM2M Endpoint <AE> resource is created, updated or deleted as described in clause 6.2, the LWM2M IPE also manages the list of LWM2M Endpoint <AE> resources using a oneM2M <group> resource. The oneM2M <group> resource's lifecycle is linked to the LWM2M IPE <AE> resource's lifecycle. oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 27 Table 6.7.3.2-1: LWM2M IPE <AE> resource - Group Lifecycle LWM2M IPE <AE> resource Operation oneM2M Resource and Operation create create <group>. The group resourceName is the AE-ID of the LWM2M IPE <AE>.resource update update <group> delete delete <group> The LWM2M Endpoint <AE> resources' lifecycle operation maps to the following operations on the oneM2M <group> resource. Table 6.7.3.2-2: LWM2M Endpoint <AE> resource - Group member Lifecycle LWM2M Endpoint <AE> resource Operation oneM2M Resource and Operation Create update <group> (add member) Delete update <group> (delete member) |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.7.3.3 Configuration of Interworking Functions | Clause 5.3 describes the types of interworking functions as Transparent Interworking Function and Semantically Enabled Interworking Function. An IPE provides the capability to perform one or both types of interworking functions. The granularity (e.g. Object/Object Instance, IPE) that is used to define which interworking function(s) to use is implementation specific. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 6.8 LWM2M Client Provisioning (Bootstrap) | The present document makes assumptions that the LWM2M Clients and LWM2M Servers functionality of the IPE have been provisioned with the proper LWM2M credential materials in accordance to the LWM2M specification (clause A.5.3.1) in order to securely communicate between the LWM2M Client and LWM2M Server. Additionally, a LWM2M Client connected to a LWM2M IPE, should be provisioned with the LWM2M Access Control Policy information associated to the Object Instances contained in the LWM2M Client as described in clause 6.6 LWM2M Object Security. Additionally, in current release of the present document, the LWM2M Server role of the LWM2M IPE does not contain the LWM2M Bootstrap Server capability, consequently the LWM2M Client provisioning operations shall be part of an out-of-band process. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 7 Transparent Interworking Function | 7.1 Introduction Clause 5.3 introduced the Transparent Interworking function as depicted in Figure 5.3-1. This clause specifies the mappings of the attributes of the <contentInstance> resource for a <container> resource in order to allow an AE that uses the Content Sharing Resource to understand that the Content Sharing Resource has an encapsulated LWM2M Object or Object Instance. |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 7.2 Attribute Mapping for the <contentInstance> Resources | When an AE accesses a <contentInstance> resource, the AE needs to know that the <contentInstance> resource encapsulates a LWM2M Object or Object Instance as well as how the LWM2M Object or Object Instance is encoded. oneM2M TS-0014 version 4.0.1 Release 4 ETSI ETSI TS 118 114 V4.0.1 (2023-11) 28 Table 7.2-1: Transparent Interworking Function Mapping Interworking Function Mapping oneM2M Resource Attribute Indication that a LWM2M Object or Object Instance is encapsulated in the <contentInstance> resource with the content type and encoding of the LWM2M Object or Object Instance. <contentInstance> resource: labels. Value is "LWM2M- Object-Encapsulation" The content type of the LWM2M Object or Object Instance based on the Content-Type option <contentInstance>: contentInfo. Possible contentInfo values are translated from the LWM2M Content-Type option (see note). NOTE: The LWM2M Technical Specification [3] defines the value to be used for the [encoding] if the Content-Type option is not present. 8 Semantically Enabled Interworking Function (Informative) |
d34e080defcc243403ce1e85fbc15804 | 118 114 | 8.1 Introduction | Clause 5.3 introduced the Semantically Enabled Interworking function as depicted in Figure 5.3-2. This clause specifies how LWM2M Objects and their associated LWM2M Resources are organized as <container> resources in order for values associated with the LWM2M Resources be translated into <contentInstance> resources. In addition, this clause specifies the mapping of Content Sharing Resources the oneM2M Base Ontology [i.5]. 8.2 Organization of Semantically Enabled Content Sharing Resources |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.