Versions Compared

Version Old Version 1 New Version Current
Changes made by

Toine Siebelink

Niamh Core

Saved on

Key

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

Table of Contents
maxLevel4

...

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCCSDKCPS-275237


Decisions

...

/Open Issues

Warning
titleDecoupling

It is very important that the SPI doesn't expose any database implementation for example database ID's


#

Description

Details

Decisions

1


Description

Details

Decisions

1Assume flat attributes (no complex data types) but data could be stored as json object in SPI impl. for convenience/PoC

2SPI Implementation NOT using Model (service) current ENM SPI does!

Open Issues



3Are we going to have XPath/query builder?
  • We should decide based on what the users want to use/is easy to use
  • We don't want a query builder that eventually mimics XPaths functionality, use what is defined already XPATH
sa
  • as a based but maybe supplement with a xpath-builder
2

Having a fluent interface in my opinion would be way more intuitive and practical. E.g.

//AND of two restrictions

Restriction and(Restriction firstRestriction,  Restriction secondRestriction)

//OR of two restrictions

Restriction or(Restriction firstRestriction,  Restriction secondRestriction)

//NOT of a restriction

Restriction not(Restriction restriction)

This will give any user of the API an intuitive way to build a complex query and the developer of the API a tree to navigate and translate to SQL (or any other query language). A developer could do something the likes of myQuery.setRestriction(restriction1.and(restrcition2).and(restriction3))

3

SPI should be type safe (the SPI impl. has no access to models)

    1. All numeric types could be passed as ‘long’ in Java
We can do validation but still store as a string (JSON object).

4When do we get attributes?

How do control how many attributes we get back?

We will have an (optional) output specification with the following options

  1. Default is no attributes 
  2. All Attributes
  3. Specify attributes - output specification (filter)
5Should we use the name node or fragment?
We decided on the name DataNode
6Do we want to split the interface? 

Maybe we could just have a 

3 Alternatives 

  1. all in one interface
  2. Limited number of interfaces e.g Data Objects/ Data Persistence/Query
  3. Very fine grained (see below)
  1. DataStore SPI - methods to add data. 
    e.g dataStore.addChild(parentDataObject, childDataObject)
  2. CpsAdmin Interface will handle the dataspaces and anchors
  3. Module SPI - responsible for handling modules and module sets

The above will be in separate maven modules. Any data object they need will be in the same module.

We will not have a querybuilder in SPI but the SPI will have to understand the cpsPath. The java API will use a builder pattern to create a cpsPath

7Do we need objects for very simple concept like dataspaceName which are just a string?
  • We will not use objects for name fields. We will just use Strings.
  • We may need an object for AnchorName
8Should we share common objects between the Java API and SPI?

Alternatives

  1. API depends on model objects defined in SPI
  2. SPI depends on model objects defined in API
  3. Extract common model API in separate module (deliverable)
  4. Use separate models with slightly different names e.g Anchor in API and AnchorDetails in SPI (CPService will transfer when needed)

ENM SPI Study

Details about the ENM SPI can be found here: https://wiki.onap.org/pages/resumedraft.action?draftId=92998891&draftShareId=2f0190f4-bc97-47b7-bd82-6561f3606575&ENM Study


Interface Proposal

can be found at : Interface Proposal for CPS

Proposed Future Implementation of CPS SPI

...

DataStore SPI

Name

Definition

 Capabilities

1

Name

Definition

 Capabilities

1 

Module SPI

...

Definition

...

 Capabilities

...

Module Interface

...

Provides CRUD operations on a module set.

...

  • 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)

Query SPI


 Capabilities

1DataStoreService
  • String addDataNode(String dataspaceName, String anchorName, DataNode dataNode);
  • String addDataNode(String dataspaceName, String anchorName, String xPath, DataNode dataNode);​
  • String getCpsPath(String dataspaceName, String anchorName, DataNode dataNode);
  • String getCpsPath(String dataspaceName, String anchorName, DataNode dataNode);
  • DataNode getDataNode(String dataspaceName, String anchorName, String xPathId);
  • Collection<DataNode> queryDataNodes(String dataspaceName, String anchorName, String cpsPath);
  • Collection<DataNode> queryDataNodes(String dataspaceName, String anchorName, String cpsPath, String outputSpecification);
  • Integer count(String dataspaceName, String anchorName, String cpsPath);
  • Integer count(String dataspaceName, String cpsPath);
  • void updateDataNode(String dataspaceName, String anchorName, DataNode dataNode);
  • void setLeaf(String dataspaceName, String anchorName, String xPathId, String leafName, Object leafValue);
  • Void deleteDataNode(String dataspaceName, String anchorName, String xPathId);
2DataNode Object
  • DataNode createDataNode(DataNode)
  • String getCpsPath()
  • DataNode getAttributes()
  • DataNode getAttribute(name)
  • Void setAttributes()
  • Void setAttribute(name)
  • Module getModule(moduleName)

CpsAdmin SPI


Name


 Capabilities

1
CpsAdminService
  • String createDataspace(String dataspaceName);
  • String createAnchor(String dataspaceName, String anchorName);
  • List<String> getDataspaces();
  • Collection<Anchor> getAnchors(String dataspaceName);
  • Anchor getAnchor(String dataspaceName, String anchorName);
  • void deleteAnchor(String dataspaceName, String anchorName);
  • void associateAnchorToModuleSet(String dataspaceName, String moduleSetName, String anchorName);
  • boolean exists(String dataspaceName);
2

DataspacePersistenceService


  • Void createDataspace(dataspaceName)
  • Void getDataspace(dataspaceName)
  • Void getDataspaces()
  • boolean exists(dataspaceName)
3AnchorPersistenceService
  • Void createAnchor(dataspaceName, anchorName)
  • Anchor getAnchors()
  • Anchor getAnchor(anchorName)
  • Void deleteAnchor(anchorName)
  • Void associateAnchor(anchorName, moduleSetName)
  • Void associateAnchor(anchorName, moduleRef)
  • Void addDataNode(anchorName, dataNode)
4Dataspace (object)
  • Void createDataspace(dataspaceName)
  • String getName(Dataspace)
5Anchor Object
  • Void createAnchor(anchorName)
  • String getName(Anchor)

Module SPI


Name


 Capabilities

1
ModuleStoreService
  • Collection<String> getModules(String dataspaceName, String moduleSetName);
  • Collection<ModuleRef> getModuleRefs(String dataspaceName, String moduleSetName);
  • Void deleteModuleSet(String dataspaceName, String moduleSetName);
2

ModulePersistenceService


  • YangModule getModule(moduleRef)
  • Collection<YangModule> getModules(moduleSetName)
3YangModule
  • ModuleRef getModuleRef(moduleRef)
  • String getModuleContent(moduleRef)
4ModuleRef
  • String getNamespace(moduleRef)
  • String getRevision(moduleRef)
5ModuleSet
  • String getName(moduleRef)
  • Collection<ModuleRef> getModuleRefs()


Javadoc


View file
namejavadoc.zip
height250