| Table of Contents |
|---|
Introduction
Although the PoC will only implement a few of the possible Java API methods it is important to have a good detailed view of the structure and naming of this interface going forward and document it.
Acceptance Criteria for Proposed Java Interface:
- Should follow ONAP or wider best practice
- Documented on ONAP Wiki
- Discussed and agreed within CPS Team
- Discussed and agreed with wider community
Currently we are considering 3 'separated' Java APIs or 'groups' of methods:
- Models (add, list)
- Data (CRUD)
- Queries
Jira Ticket:
| Jira | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Jira Backlog:
Open Issues/Decisions
# | Description | Details | Decisions |
|---|---|---|---|
| 1 | Should the java interface take in objects(like REST interface) or a few individual fields in a signature? |
CPS provides the following interfaces:
Interface Name | Interface Definition | Interface Capabilities | Consumed Models |
|---|---|---|---|
| Model Interface | Behavior interface that provides the capability to access cps modules. | Create a module set Merge a module set Read all modules Validate modules Update a module set Create a module set and validate it against a module reference (using a separate SPI) | Yang models that are broken into fragments. |
| Data Interface | Behavior interface that represents CPS data. | Create a (root) node. Delete a dataspace Create a dataspace Create an anchor Read an anchor of a particular node Read an anchor in a namespace and dataspace Read all anchors for one dataspace Delete an anchor for a namespace in a dataspace Associate an anchor to a module set Associate an dataspace to a anchor | |
| Query Interface | Provides the capability to query CPS data. | Create a node Read the parent of a node that matches an xpath expression Read all nodes under an anchor point Read the anchor of a node Read all nodes that match a schema node identifier |