Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Jira
serverONAP Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-2155

Assumptions

<optional, assumptions are like decisions made upfront ie. everyone agrees on the answer but they are important to mention>

Replacing the list of FNDs with DataSubJob object as defined below.
#AssumptionNotes
1The input parameters for async read/write can be jobId and a list of DataSubJob

Issues & Decisions


IssueNotes Decision
1dataaccepttype Do we need to consider this parameter in our NCMP internal Java interface?

2datacontenttype Do we need to consider this parameter in our NCMP internal Java interface?

3

attributes This has plural but all examples contain a single String, why?



4

The study mentions 'fields and attributes". None of the examples use 'fields'. We can see only 'value' Objects (in the write use cases)



5

Combine all java api paramaters into 1 parameter object

There is a limit (sonar quality check)

<Note. use green for closed issues, yellow for important ones if needed>

...

of 7 parameter max for a method

Team 
follow common practice and  have a few parameters ie. dataJobId is NOT part of the client request but generated in DCM so it seems logical to keep this separates


Proposed Method signature

Code Block
languagejava
titleprocessDataJob
void processDataJob(String dataJobId, List<Operations>)

Notes

  1. The order of Operations is important and needs to be maintained hence the use of 'List'
  2. The output is 'void' for the scope in this user story, it will be defined later
  3. dataaccepttype and datacontenttype might be needed too, see issue #1 and #2. If required we could combine them to reduce the number of parameter in an object like RestProtocolParameters

Proposed structure for Operation

NameDescriptionType
path

It is a unique identifier of a managed object (MO) on a network element. 
Defines the resource on which operation is executed. Typically could be Fully Distinguished Name (FDN).

String
op

Describes the operation to execute. The value can be:

"add",
"replace",
"remove",
"action", 
"read" 

String
operationId

Unique identifier of the operation within the request

Integer
attributesAllows selection of specific fields for attributes with complex data type for the operation. List of String
valueIt is for only WRITE operation.Object
scopeType

ScopeType selects MOs depending on relationships with Base Managed Object.
Only for READ operation.

String
scopeLevel

Only for READ operation.
Only used once the scope type when BASE_NTH_LEVEL.

Integer
filter

The parameter is used to filter the scoped Managed Objects. Only Managed Objects passing the filter criteria will be fetched.

String

...