| Table of Contents |
|---|
Related Jira(s)
...
| 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 : { |
| 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 |
| { |
Managing TrustLevel
...
Proposal for Notification's Schema
kafka-key : cmHandleId ( *Note : when publishing the notification , use the cmHandleId as the key of the message. This will enable clients to read the most updated message/state when the compaction is triggered)
Cloud event Definition
Element | Name | Parent | Type | Mandatory | Description | Format | (example) Value | |
|---|---|---|---|---|---|---|---|---|
| 1 | Header | id | String | Yes | random id for cloud event header. UUID is suggested | |||
| 2 | source | String | Yes | source of information | ncmp.<cmhandle-id> | ncmp.12ac34e43556e | ||
| 3 | specversion | String | Yes | cloud event version spec | fixed value | 1.0 | ||
| 4 | type | String | Yes | type of event | fixed value | trustLevelChangeEvent | ||
| 5 | dataschema | String | Yes | data schema | fixed value | org.onap.cps.ncmp.events.cmhandle.TrustLevelChangeEvent:1.0.0 | ||
| 6 | correlationid | String | Yes | The cmHandle which is been notified. The value will be similar as we have in the source field. | <cmhandle-id> | |||
| 7 | Payload | data | Object | Yes | The actual data payload. Details will be provided below. | 3GPP TS 28.532 standard | ||
| 8 | attributeName | data | String | Yes | The attribute which has changed. | <name> | trustLevel | |
| 9 | oldAttributeValue | data | String | No | The old value of the attribute which has changed. | COMPLETE | ||
| 10 | newAttributeValue | data | String | No | The new value of the attribute which has changed. | NONE |
...