CCSDK-2872 DP: Agree and document proposed long-term Persistence SPI(s)

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

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

Are 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 as a based but maybe supplement with a xpath-builder

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

Should we use the name node or fragment?

We decided on the name DataNode

Do 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

Do 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

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

DataStoreService

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

DataNode Object

• DataNode createDataNode(DataNode)

• String getCpsPath()

• DataNode getAttributes()

• DataNode getAttribute(name)

• Void setAttributes()

• Void setAttribute(name)

• Module getModule(moduleName)

^{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);

DataspacePersistenceService

• Void createDataspace(dataspaceName)

• Void getDataspace(dataspaceName)

• Void getDataspaces()

• boolean exists(dataspaceName)

AnchorPersistenceService

• Void createAnchor(dataspaceName, anchorName)

• Anchor getAnchors()

• Anchor getAnchor(anchorName)

• Void deleteAnchor(anchorName)

• Void associateAnchor(anchorName, moduleSetName)

• Void associateAnchor(anchorName, moduleRef)

• Void addDataNode(anchorName, dataNode)

Dataspace (object)

• Void createDataspace(dataspaceName)

• String getName(Dataspace)

Anchor Object

• Void createAnchor(anchorName)

• String getName(Anchor)

^{ModuleStoreService}

• Collection<String> getModules(String dataspaceName, String moduleSetName);
  
  

• Collection<ModuleRef> getModuleRefs(String dataspaceName, String moduleSetName);
  
  

• Void deleteModuleSet(String dataspaceName, String moduleSetName);

ModulePersistenceService

• YangModule getModule(moduleRef)

• Collection<YangModule> getModules(moduleSetName)

YangModule

• ModuleRef getModuleRef(moduleRef)

• String getModuleContent(moduleRef)

ModuleRef

• String getNamespace(moduleRef)

• String getRevision(moduleRef)

ModuleSet

• String getName(moduleRef)

• Collection<ModuleRef> getModuleRefs()