CM-Handle State Changes and Notifications Overview

1 Overview
2 Diagram of the possible transactions between CM-Handle states
3 Notification details
- 3.1 Notification handling in code
- 3.2 The Event structure of the notification
  - 3.2.1 Event schema
    - 3.2.1.1 LcmEvent Scema (cps-ncmp-events)
  - 3.2.2 Event examples
4 Typical use cases which leads to state changes and trigger notification events
5 Source materials
- 5.1 Important links to related Spikes and Implementation proposals

Overview

CPS-1142: Create summary page about CMHandle state changes and eventsClosed

Each Cm-Handle state change triggers a LCM event notification sent to the user to notify about the state change.
When a Cm-Handle is registered it will initially be set in an 'ADVISED' state.
If the module sync watchdog operation starts to work on an 'ADVISED' Cm-Handle, the Cm-Handle state will transition to 'READY' or 'LOCKED' based on if the module-sync has succeeded or failed respectively.
If the module sync watchdog operation is successful, data-sync-enabled will be set to false and the data sync-state will be 'NONE_REQUESTED'.
If the user wants to set data-sync-enabled to true, it has to be enabled on its dedicated API endpoint.
Once data sync-enabled is set to true, the data sync-state will be set to 'UNSYNCHRONIZED'.
Only the handles with an 'UNSYNCHRONIZED' data sync-state will be picked up by the data-sync watchdog operation.
If the data-sync watchdog was able to complete the sync successfully then the dataStoreSync state will changed to SYNCHRONIZED.
If the handles are to be deleted during update, then their states will be set to 'DELETING'. Once deletion is complete, the state is set to 'DELETED'.

Diagram of the possible transactions between CM-Handle states

CPS-799 Spike: Define states and state handling for CM handle

Notification details

Notification handling in code

The Event structure of the notification

Event schema

LcmEvent Scema (cps-ncmp-events)

{

  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "$id": "urn:cps:org.onap.ncmp.cmhandle.lcm-event:v1",

  "$ref": "#/definitions/LcmEvent",

  "definitions": {

    "Values": {
      "description": "Values that represents the state of a cmHandle",
      "type": "object",
      "properties": {
        "dataSyncEnabled":{
          "description": "Whether data sync enabled",
          "type": "boolean"
        },
        "cmHandleState": {
          "description": "State of cmHandle",
          "type": "string",
          "enum": ["ADVISED", "READY", "LOCKED", "DELETING", "DELETED"]
        },
        "cmHandleProperties": {
          "description": "cmHandle properties",
          "type": "object",
          "default": null,
          "existingJavaType": "java.util.List<java.util.Map<String,String>>",
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },

    "Event": {
      "description": "The Payload of an event",
      "type": "object",
      "properties": {
        "cmHandleId": {
          "description": "cmHandle id",
          "type": "string"
        },
        "oldValues": {
          "$ref": "#/definitions/Values"
        },
        "newValues": {
          "$ref": "#/definitions/Values"
        }
      },
      "required": [
        "cmHandleId"
      ],
      "additionalProperties": false
    },

    "LcmEvent": {
      "description": "The payload for LCM event",
      "type": "object",
      "javaType" : "org.onap.ncmp.cmhandle.event.lcm.LcmEvent",
      "properties": {
        "eventId": {
          "description": "The unique id identifying the event",
          "type": "string"
        },
        "eventCorrelationId": {
          "description": "The id identifying the event",
          "type": "string"
        },
        "eventTime": {
          "description": "The timestamp when original event occurred",
          "type": "string"
        },
        "eventSource": {
          "description": "The source of the event",
          "type": "string"
        },
        "eventType": {
          "description": "The type of the event",
          "type": "string"
        },
        "eventSchema": {
          "description": "The schema that this event adheres to",
          "type": "string"
        },
        "eventSchemaVersion": {
          "description": "The version of the schema that this event adheres to",
          "type": "string"
        },
        "event": {
          "$ref": "#/definitions/Event"
        }
      },
      "required": [
        "eventId",
        "eventCorrelationId",
        "eventTime",
        "eventSource",
        "eventType",
        "eventSchema",
        "eventSchemaVersion",
        "event"
      ],
      "additionalProperties": false
    }

  }
}

ONAP Wiki

CM-Handle State Changes and Notifications Overview

Overview

Diagram of the possible transactions between CM-Handle states

Notification details

Notification handling in code

The Event structure of the notification

Event schema

LcmEvent Scema (cps-ncmp-events)

Event examples

Typical use cases which leads to state changes and trigger notification events

State changes after new cm Handle is registered

State changes after cm Handle update received

State changes during module-sync watchdog execution

State changes during data-sync watchdog execution

Source materials

Important links to related Spikes and Implementation proposals