...
It is to be noted here that the methods used for GET operation are not limited to Get a Node API and are reused in other API's as well. This epic covers the impact on all the API's due to the above mentioned changes in CPS core. A common task across the API's is to maintain backwards compatibility as well.
List of impacted API's
| Operation | API | Issues | Possible Solution |
|---|
| GET | Get a Node | - should return all the data trees when xpath is set to root(/)
- currently returns only the first data tree
| - modify the existing code for Get a Node API so it returns a List of fragment entities
- this impacts other API's as well which make use of the Get operation
- a separate API can be developed to return all the data trees, similar to Get all anchors and Get one anchor API in CPS
|
| PUT | Replace a node with descendants | - when the API is called with xpath set to "/", it will return all the data trees
- once all the data trees are returned the PUT operation will be performed
- if xpath is set to "/" and the number of data trees on which the replace operation is being performed is less than the total number of data trees the operation of retrieving all the data trees is not feasible
| - when xpath is set to "/" the replace operation can return an error message
- the user can specify the data tree for which Replace operation is to be performed, but the drawback of this approach is if the number of data trees on which replace operation is to be performed is significantly big
|
| DELETE | Delete a datanode |
| - when delete operation is performed with xpath set to root all the data trees must be deleted
|
| PATCH | Update node leaves | - when the API is called and xpath is set to "/", a get operation is executed internally to retrieve all the data trees first
- once all the data trees are returned in a List the API proceeds to perform the Patch operation
- if xpath is set to "/" and the number of data trees on which the patch operation is being performed is less than the total number of data trees the operation of retrieving all the data trees is not feasible
| - when xpath is set to "/" the patch operation can return an error message
- the user can specify the data tree for which patch operation is to be performed, but the drawback of this approach is, when the number of data trees on which patch operation is to be performed is significantly big
|
| PUT | Replace list content | - when the API is called with xpath set to "/", it will return all the data trees
- once all the data trees are returned the PUT operation will be performed
- if xpath is set to / and the number of data trees on which the replace operation is being performed is less than the total number of data trees the operation of retrieving all the data trees is not feasible
- this operation is to be performed on a list in an existing data tree. hence the possibility of multiple lists in multiple trees bring updated at same time is to be taken into consideration
| - when xpath is set to "/" the replace operation can return an error message
- the user can specify the data tree for which Replace operation is to be performed, but the drawback of this approach is if the number of data trees on which replace operation is to be performed is significantly big
|
The existing GET operation
| Code Block |
|---|
//Returns single fragment entity
default FragmentEntity findFirstRootByDataspaceAndAnchor(@NonNull DataspaceEntity dataspaceEntity,
@NonNull AnchorEntity anchorEntity) {
return findRootsByDataspaceAndAnchor(dataspaceEntity.getId(), anchorEntity.getId()).stream().findFirst()
.orElseThrow(() -> new DataNodeNotFoundException(dataspaceEntity.getName(), anchorEntity.getName())); |
The updated GET operation is as follows
| Code Block |
|---|
//Now returns a List of Fragment entities
default List<FragmentEntity> findFirstRootByDataspaceAndAnchor(@NonNull DataspaceEntity dataspaceEntity,
@NonNull AnchorEntity anchorEntity) {
final List<FragmentEntity> fragments = new ArrayList<>(findRootsByDataspaceAndAnchor(dataspaceEntity.getId(), anchorEntity.getId()));
if (!fragments.isEmpty()){
return fragments;
} else{
throw new DataNodeNotFoundException(dataspaceEntity.getName(), anchorEntity.getName());
}
} |
