You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 27 Next »

References

CPS-2155 - Getting issue details... STATUS

Assumptions

#AssumptionNotes
1

Issues & Decisions


IssueNotes Decision
1dataaccepttype Do we need to consider this parameter in our NCMP internal Java interface?The controller should accept/reject dataaccepttype. From the client application

The Controller will validate and set the Default as necessary kieran mccarthy Sourabh Sourabh Kolawole Adebisi-Adeolokun Toine Siebelink 

2datacontenttype Do we need to consider this parameter in our NCMP internal Java interface?NCMP should maintain the content type as received and not modify datacontenttype.

NCMP should maintain what content type as received and not modify   kieran mccarthy Sourabh Sourabh Kolawole Adebisi-Adeolokun Toine Siebelink 

3

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

kieran mccarthy & Rafael to come back with a 'definition' and 'example

Kolawole Adebisi-Adeolokun to follow up with stakeholders on decision by 19/03/2024

4

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

kieran mccarthy & Rafael to come back with a 'definition' and 'example

Read and Write data jobs are 2 deff. objects.  


Kolawole Adebisi-Adeolokun to follow up with stakeholders on decision by 19/03/2024

5

Combine all java api parameters into 1 parameter object?

There is a limit (sonar quality check) 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


Data Structures

                                                         

Proposed Method signature

processDataJob
void processReadDataJob(String dataAcceptType,  String datContentType, String dataJobId, List<ReadOperation> readOperations)
void processWriteDataJob(String dataAcceptType,  String datContentType, String dataJobId, List<WriteOperation> writeOperations, Map<String,String> metadata)

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


Examples from DCM Study

DataJob Read request (rAPP -> DCM)

Datajob Write request (rAPP -> DCM)




  • No labels