...
Table of Contents |
---|
References
- CPS-1515 - Spike: Support multiple CM-Handles for NCMP Get Operation
- ARC Configuration Persistence Service (CPS) Component Description - Jakarta-R10
Requirements
Functional
# | Interface | Requirement | Additional Information |
---|---|---|---|
1 | REST CPS(-NCMP)-xxE-05 | Support batch read operation (new) using an asynchronous response to client specified topic | payload includes list of cm handle ids |
2 | REST DMY-yyDMI-I-01 (TBC) | Support batch read operation (new) using an asynchronous response to client specified topic | payload includes list of (associated for this plugin) cm handles ids with their private (additional, TBC) properties |
Error handling
# | Error Scenario | Expected behavior |
---|---|---|
1 | DMI Not respond to initial synchronous request with normal HTTTP HTTP timeout | Special Error message send to client topic detailing cm-handles |
2 | Topic not supplied on CPS-E-05 | Return HTTP 501 |
3 | Client specided Topic is not configured | See issue #9 |
Capabilities
# | Parameter | Expectation | Notes |
---|---|---|---|
1 | Response Time 1 Batch request | <2 seconds |
|
2 | Batch-size | 200-300 cm handles | No hardcoded limit |
3 | Response payload size | ?? KB | Performance test for cabilitie should be tested with this average response size |
4 | Maximum registered #cm handles | 20,000 | This will effect the internal query time |
5 | Supported # DMI PLugins | <30 (TBC) | This might effect processing time |
6 | Environment |
Out-of-scope
- support Support for multiple resource identifies in one batch operation
- Support cache data batch requests: only passthrough datastores passthrough datastores will be supported (see decision #2)decision #2)
- 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 |
...