Versions Compared

Key

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

...

Table of Contents

References

  1. Image ModifiedCPS-1515 - Spike: Support multiple CM-Handles for NCMP Get Operation
  2. ARC Configuration Persistence Service (CPS) Component Description - Jakarta-R10

Requirements

Functional

#InterfaceRequirementAdditional Information
1REST CPS(-NCMP)-xxE-05Support batch read operation (new) using an asynchronous response to client specified topicpayload includes list of cm handle ids
2REST DMY-yyDMI-I-01 (TBC)Support batch read operation (new) using an asynchronous response to client specified topicpayload includes list of (associated for this plugin) cm handles ids with their private (additional, TBC) properties

Error handling

#Error ScenarioExpected behavior
1DMI Not respond to initial synchronous request with normal HTTTP HTTP timeoutSpecial Error message send to client topic detailing cm-handles
2Topic not supplied on CPS-E-05Return HTTP 501
3Client specided Topic is not configuredSee issue #9

Capabilities

#ParameterExpectationNotes
1Response Time 1 Batch request<2 seconds
  • Async response available on client topic
  • No delay in DMI PLugin (tested/measured using stub DMI Plugin)
2Batch-size200-300 cm handlesNo hardcoded limit
3Response payload size?? KBPerformance test for cabilitie should be tested with this average response size
4Maximum registered #cm handles 20,000This will effect the internal query time
5Supported # DMI PLugins<30 (TBC)This might effect processing time
6Environment

Out-of-scope

  1. support Support for multiple resource identifies in one batch operation
  2. Support cache data batch requests: only passthrough datastores passthrough datastores will be supported (see decision #2)decision #2)
  3. NCMP does NOT keep track of request status to see if  it is completed, amalgamate responses or anything like that. It wil simply forward responses from the internal topic to the client topic.

Assumptions

#

Assumption

Notes

1

"fields" and "scope" are proprietary options or not in the scope of this analysis.

agreed with kieran mccarthy , these are optional parameters (name-value pairs) not interpreted by NCMP but can be interpreted by proprietary plugins

2

same xpath (resourceIdentifierInQuery) for all cm handles or different for each cm handle

agreed with kieran mccarthy , if different resources are required on the same cm-handle the client wil send another (batch) request

...