Page Comparison

Table of Contents

...

Interface

Name

Trigger

Description

Type

Endpoint or Topic

Schema

1

HealthCheck

30 second interval (configurable)

NCMP is to perform a health check against each of the DMI Plugins

REST

http://<dmiPluginServiceName>/manage/health

This endpoint will be the standard heath check endpoint provided by spring boot actuator. We don't store it anywhere. We just document it for now.

2

CMHandle trust level change

A CMHandle managed by DMI Plugin's trust level has changed

data contains {trustLevel: ENUM}

event id is cmhandle id in kafka header

Kafka

kafka topic:

dmi-device-heartbeat

<cloudEvents-header>

id : <cmhandleId>

type : org.onap.cm.events.trustlevel-notification

data : {
trustlevel : "COMPLETE/NONE"
}

3

CMHandle Query API with trustLevel Query Condition

Client Request

CmHandle is to be returned based on the values in above CMHandle Trust Map

REST

http://<host>:<port>/ncmp/v1/ch/id-searches
http://<host>:<port>/v1/ch/searches

{
  "cmHandleQueryParameters": [
    {
        "conditionName": "cmHandleWithTrustLevel",
        "conditionParameters": [ {"trustLevel": "COMPLETE"} ]
    }
  ]
}

Managing TrustLevel

...

kafka-key : cmHandleId/deviceId

17 Oct 2023 Toine Siebelink Kolawole Adebisi-Adeolokun

language

Code Block

text	title	NCMP to Clients Notifications on Trust Level Changes
linenumbers	true
Notification (Proposed by Kieran)
collapse	true

id : "random UUID"
source : "NCMPncmp.<cmhandleId>" specversion	: "1.0" type# :// "deviceTrustLevelNotification" dataschemaadding : "org.onap.cps.ncmp.events.trustlevel.DeviceTrustLevelNotification:1.0.0"
correlationid : "deviceId+trustLevel"
"data": {
	"deviceId": "CmHandle1",  // or we can call it cmHandleId as well [mandatory]
	"oldValues": {  // optional
			"trustLevel" : "NONE"
				},
	"newValues" : { // optional
			"trustLevel" : "COMPLETE"
		}
}

17 Oct 2023 Toine Siebelink Kolawole Adebisi-Adeolokun

Code Block

title	NCMP to Clients Notification (Proposed by Kieran)
collapse	true

id : "random UUID"
source : "ncmp.<cmhandleId>"   # //  adding cmhandle to be a little more specific on the origin of the change event.  If the event was triggered by DMI plugin then use the “source” supplied from that even if available.  If not available then set as <dmi-plugin-name>.<cmhandleId>
specversion : "1.0"
type : "trustLevelChangeEvent"
dataschema : cmhandle to be a little more specific on the origin of the change event.  If the event was triggered by DMI plugin then use the “source” supplied from that even if available.  If not available then set as <dmi-plugin-name>.<cmhandleId>
specversion : "1.0"
type : "trustLevelChangeEvent"
dataschema : "org.onap.cps.ncmp.events.cmhandle.TrustLevelChangeEvent:1.0.0"
correlationid : "<cmhandleId>
"data": {
   "attributeValueChange": [  # Mandatory
        { 
         "attributeName"     : " trustLevel",
         "oldAttributeValue" : "NONE",
         "newAttributeValue" : "COMPLETE"
        }
    ]
}

attribute-name	type	value
id	header	random UUID
source	header	ncmp.<cmhandle-id>
specversion	header	"1.0"
type	header	"trustLevelChangeEvent"
dataschema	header	"org.onap.cps.ncmp.events.cmhandle.TrustLevelChangeEvent:1.0.0"

...

correlationid

ext-header

"<cmhandle-id>"

data

payload

Compliant with the below.

Code Block

title	attributeValueChange
collapse	true

"attributeValueChange": {
         "type": "array",
            "items": {
              "

...

$ref": "#/definitions/attributeValueChange-Type"
            }

...

},
"attributeValueChange-Type": {
      "type": "object",
        "properties": {
          "attributeName": {
            "

...

type"

...

: "

...

string"
          },
          "oldAttributeValue": {},
          "newAttributeValue": {}
        }

...

Versions Compared

Old Version 47

New Version 48

Key

Managing TrustLevel