Page History

References

...

Out-of-scope

• Working with wildcards and subscription update which will be taken care by a separate epic.
• Subscription create ( done as part of a different story ) 
• Merging of the ongoing subscriptions.

Assumptions

Issues & Decisions

Overview

Algorithm for CM Subscription Delete

@startuml
'https://plantuml.com/activity-diagram-beta

start
: DME to send Cm Subscription Delete Request;
: NCMP to extract out subscriptionId;
: using subscriptionId , Query all the ONGOING ACTIVE Cm Subscriptions;
: Populate details in Cm Notification Subscription Cache;
if (all the Subscription predicates are part of other ongoing Subscriptions ) then (YES)
  : directly delete the subscriptionId from the ongoing subscribers list from DB;
  : mark the subscription delete request as ACCEPTED in the cache;
  : respond back to the client with ACCEPTED ;
else (NO)
 : for all the 'last lights out' predicate information call the DMI Plugin;
 if (DMI Plugin accepts the delete request) then (YES)
    : using the information present in cmNotificationSubscriptionCache, delete the records from DB;
    : mark the subscription delete request as ACCEPTED in the cache;
    : respond back to the client with ACCEPTED;
 else (NO)
    : dont delete any records from DB;
    : mark the subscription delete request as REJECTED in the cache;
    : respond back to the client with REJECTED;
 endif
endif
: cleanup the cache;

stop

@enduml

1. Capture Incoming subscriptionId from the client.
2. Query the existing subscriptions we are tracking using the subscriptionId we got from the Cm Subscription Delete request.
3. Populate the cmSubscriptionCache with the relevant details ( this will be later used to send the response and manage the subscription ) using the above query we did.
4. Now check if the details we have are ALL the last subscribers or not.
   1. if all are NOT the last subscribers then we can right away delete it from the DB and send back the response to the client without sending any request to the DMI.
   2. if we have mixed records then we need to make a call to the DMI for the "last lights out" to get Acceptance from DMI 
5. if DMI accepts it , then whatever we have in the cache can be used to DELETE the rows from the DB ( similar to what we did for create )
6. Once the rows are deleted then we can send back the response to the client and clear up the cache ( for ACCEPTED/REJECTED
7. We receive an event of type : subscriptionDeleted from the client ( DME ) containing the subscription clientId and subscription name along with datastore and dataCategory details ( DMEtoNCMP )
8. We check in NCMP that we have an ongoing subscription using clientId and subscriptionName.
9. If we have ongoing subscription , we forward the event to dmi-plugins so that the changes are applied in the devices managed by dmi-plugin as well. ( Impl. Proposal CM Event Subscription LCM: Delete ( Positive Scenarios ) )
10. Now if the dmi-plugins have applied the request then we get an event back from dmi-plugin and NCMP will process that event and based on that it will delete the ongoing subscription request from the database itself. If the response from DMI plugins is accepted ( i.e it can delete the subscriptions from the underlying devices and no subscription delete request are in PENDING or REJECTED state )Then we delete the subscriptions from the DB as well. ( Impl. Proposal CM Event Subscription LCM: Delete ( Positive Scenarios ) )
11. After processing the received event from DMI , NCMP will send the final event to the client (DME). (  Impl. Proposal CM Event Subscription LCM: Delete ( Positive Scenarios ) )

Subscription Delete Sequence Diagram

@startuml
autonumber

participant DME
participant NCMP
participant "CPS-DB"
participant "DMI-PLUGIN"

DME --> NCMP : 'Request to delete the CmSubscription using subscriptionId'
NCMP --> NCMP : 'Check if the CmSubscription is fully shared or exclusive per DMI'
NCMP --> "DMI-PLUGIN" : 'for exclusive CmSubscription(part of the subscription) notify the "DMI-PLUGIN"s to ACCEPT/REJECT the subscription'
"DMI-PLUGIN" --> NCMP : 'Request ACCEPTED by "DMI-PLUGIN"'
NCMP --> "CPS-DB" : 'Delete the CmSubscription from the database and update the cache with ACCEPTED'
NCMP --> DME : 'Respond with the status as ACCEPTED'

@enduml

...

@startuml
autonumber

participant DME
participant NCMP
participant "CPS-DB"

DME --> NCMP : 'Request to Delete the CmSubscription using subscriptionId'
NCMP --> NCMP : 'Check if the CmSubscription is fully SHARED or EXCLUSIVE per DMI'
NCMP --> NCMP : 'for SHARED CmSubscription dont notify the "DMI-PLUGIN"s'
NCMP --> "CPS-DB" : 'Delete the CmSubscription from the database and update the cache with ACCEPTED'
NCMP --> DME : 'Respond with the status as ACCEPTED'

@enduml

Schema Definitions

1. DME to NCMP Cm Subscription Delete Request
   
   

   	Name	Parent	Type	Example	Mandatory ?	Notes
   1	id	header	String		Y
   2	version	header	String	1.0	Y
   3	source	header	String	DME	Y
   4	type	header	String	subscriptionDeleteRequest	Y
   5	dataschema	header	URI	org.onap.ncmp.cm.subscription:1.0.0	Y
   6	data		Object		Y
   7	subscriptionId	data	String	cm-subscription-001	Y
   8	predicates	data	Object		N

   
   Example

   Code Block

Subscription Delete Event

NCMP to DMI-Plugins

...

1. title DME to NCMP Cm Subscription Delete Request linenumbers true collapse true

   id : random-UUID version : "1.0" source : "DME" type : "subscriptionDeleteRequest", dataschema : org.onap.ncmp.cm.subscription:1.0.0 { "data": { "subscriptionId": "unique subscription id" // mandatory }

   
   
   

2. NCMP to DMI-Plugin Subscription Request

   	Name	Parent	Type	Example	Mandatory ?	Notes
   1	id	header	String		Y
   2	version	header	String	1.0	Y
   3	source	header	String	NCMP	Y
   4	type	header	String	subscriptionDeleteRequest	Y
   5	dataschema	header	URI	org.onap.ncmp.dmi.cm.subscription:1.0.0	Y
   6	correlationid	header	String	subscriptionId#dmiPluginName	Y	Concatenation of subscriptionId and dmi plugin name
   7	data		Object		Y
   8	cmHandles	data	Array		Y
   9	cmhandleId	cmHandles	String		Y
   10	privateProperties	cmHandles	Map		N
   11	predicates	data	Array		N
   12	targetFilter	predicates	Array of String		Y	list of cm handle ids
   13	scopeFilter	predicates	Object		N
   14	datastore	scopeFilter	String		Y	ncmp-datastore:passthrough-operational OR ncmp-datastore:passthrough-running
   15	xpathFilter	scopeFilter	Array of String		Y

   
   Example

   Code Block
   title NCMP to DMI-Plugin Subscription Request linenumbers true collapse true
   id : random UUID version : 1.0 source : "NCMP" type : "subscriptionDeleteRequest" dataschema : org.onap.ncmp.dmi.cm.subscription:1.0.0 correlationId ( concatenation of subscriptionId and dmi-plugin-name with a separator) { "data": { "cmhandles" : [ // mandatory { "cmHandleId": "cmhandle1", "private-properties": {...} }, { "cmHandleId": "cmhandle2", "private-properties": {...} }, { "cmHandleId": "cmhandle3", "private-properties": {...} } ] "predicates": [ { “targetFilter” : [“cmHandle1”, “cmHandle2”, "cmhandle3"], // mandatory "scopeFilter" : { "datastore": “ncmp-datastore:passthrough-operational or ncmp-datastore:passthrough-running", // optional. default is passthrough-operational "xpath-filter": list of valid xpaths // mandatory } }, { “targetFilter” : [“cmHandle1”, “cmHandle2”, "cmhandle3"], "scopeFilter" : { "datastore": “ncmp-datastore:passthrough-operational or ncmp-datastore:passthrough-running", // optional. default is passthrough-operational "xpath-filter": list of valid xpaths * } } ] }

   
   
   

3. DMI-Plugin to NCMP Cm Subscription Delete Response
   
   

   	Name	Parent	Type	Example	Mandatory ?	Notes
   1	id	header	String		Y
   2	version	header	String	1.0	Y
   3	source	header	String	DME	Y
   4	type	header	String	subscriptionDeleteResponse	Y
   5	dataschema	header	URI	org.onap.ncmp.dmi.cm.subscription:1.0.0	Y
   6	correlationid	header	String	subscriptionId#dmiPluginName	Y	Concatenation of subscriptionId and dmi plugin name
   7	data		Object		Y
   8	statusCode	data	String		Y	1 - Accept the subscription request 104 - Reject the subscription request
   9	statusMessage	data	String		Y	ACCEPTED REJECTED

   
   Example

   Code Block
   title DMI-Plugin to NCMP Cm Subscription Delete Response linenumbers true collapse true
   id : random UUID version : "1.0" source : <dmi-plugin-name> type : "subcriptionDeleteResponse" dataschema : org.onap.ncmp.dmi.cm.subscription:1.0.0 correlationid : ( concatenation of subscriptionId and dmi-plugin-name with a separator) { "data" : { "statusCode": "1/104", // mandatory "statusMessage" : "ACCEPTED/REJECTED" // mandatory } }

   
   
   

4. NCMP to DME Cm Subscription Delete Response
   
   

   	Name	Parent	Type	Example	Mandatory ?	Notes
   1	id	header	String		Y
   2	version	header	String	1.0	Y
   3	source	header	String	DME	Y
   4	type	header	String	subscriptionDeleteResponse	Y
   5	dataschema	header	URI	org.onap.ncmp.cm.subscription:1.0.0	Y
   6	correlationid	header	String	subscriptionId	Y
   7	data		Object		Y
   8	subscriptionId	data	String		Y
   9	acceptedTargets	data	Array of String		N
   10	rejectedTargets	data	Array of String		N
   11	pendingTargets	data	Array of String		N

   
   Example

   Code Block
   title NCMP to DME Cm Subscription Delete Response linenumbers true collapse true
   id : random UUID version : "1.0" source : "NCMP" type : "subcriptionDeleteResponse", dataschema : org.onap.ncmp.cm.subscription:1.0.0, correlationid : <subscriptionId> { "data": { "subscriptionId": "sample-subscription-id", // mandatory "acceptedTargets" : ["ch-1", ...], // optional "rejectedTargets" : ["ch-1", ...], // optional "pendingTargets" : ["ch-1", ...], // optional } }

DMI-Plugins to NCMP

...

NCMP to DME

...