1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021 highstreet technologies GmbH
* Modifications Copyright (C) 2021 Nordix Foundation
* Modifications Copyright (C) 2021 Pantheon.tech
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.cps.ncmp.api;
import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum;
import java.util.Collection;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
import org.onap.cps.spi.FetchDescendantsOption;
import org.onap.cps.spi.model.DataNode;
import org.onap.cps.spi.model.ModuleReference;
/*
* Datastore interface for handling CPS data.
*/
public interface NetworkCmProxyDataService {
/**
* Retrieves datanode by XPath for a given cm handle.
*
* @param cmHandle The identifier for a network function, network element, subnetwork or any other cm
* object by managed Network CM Proxy
* @param xpath xpath
* @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
* (recursively) as well
* @return data node object
*/
DataNode getDataNode(@NonNull String cmHandle, @NonNull String xpath,
@NonNull FetchDescendantsOption fetchDescendantsOption);
/**
* Get datanodes for the given cm handle by cps path.
*
* @param cmHandle The identifier for a network function, network element, subnetwork or any other cm
* object by managed Network CM Proxy
* @param cpsPath cps path
* @param fetchDescendantsOption defines whether the descendants of the node(s) found by the query should be
* included in the output
* @return a collection of datanodes
*/
Collection<DataNode> queryDataNodes(@NonNull String cmHandle, @NonNull String cpsPath,
@NonNull FetchDescendantsOption fetchDescendantsOption);
/**
* Creates data node with descendants at root level or under existing node (if parent node xpath is provided).
*
* @param cmHandle The identifier for a network function, network element, subnetwork or any other cm
* object managed by Network CM Proxy
* @param parentNodeXpath xpath to parent node or '/' for root level
* @param jsonData data as JSON string
*/
void createDataNode(@NonNull String cmHandle, @NonNull String parentNodeXpath, @NonNull String jsonData);
/**
* Creates one or more child node elements with descendants under existing node from list-node data fragment.
*
* @param cmHandle The identifier for a network function, network element, subnetwork or any other cm
* object managed by Network CM Proxy
* @param parentNodeXpath xpath to parent node
* @param jsonData data as JSON string
*/
void addListNodeElements(@NonNull String cmHandle, @NonNull String parentNodeXpath, @NonNull String jsonData);
/**
* Updates data node for given cm handle using xpath to parent node.
*
* @param cmHandle The identifier for a network function, network element, subnetwork or any other cm object
* by managed Network CM Proxy
* @param parentNodeXpath xpath to parent node
* @param jsonData json data
*/
void updateNodeLeaves(@NonNull String cmHandle, @NonNull String parentNodeXpath, @NonNull String jsonData);
/**
* Replaces existing data node content including descendants.
*
* @param cmHandle The identifier for a network function, network element, subnetwork or any other cm object
* by managed Network CM Proxy
* @param parentNodeXpath xpath to parent node
* @param jsonData json data
*/
void replaceNodeTree(@NonNull String cmHandle, @NonNull String parentNodeXpath, @NonNull String jsonData);
/**
* Registration of New CM Handles.
*
* @param dmiPluginRegistration Dmi Plugin Registration
*/
void updateDmiRegistrationAndSyncModule(DmiPluginRegistration dmiPluginRegistration);
/**
* Get resource data for data store pass-through operational
* using dmi.
*
* @param cmHandle cm handle
* @param resourceIdentifier resource identifier
* @param acceptParamInHeader accept param
* @param optionsParamInQuery options query
* @return {@code Object} resource data
*/
Object getResourceDataOperationalForCmHandle(String cmHandle,
String resourceIdentifier,
String acceptParamInHeader,
String optionsParamInQuery);
/**
* Get resource data for data store pass-through running
* using dmi.
*
* @param cmHandle cm handle
* @param resourceIdentifier resource identifier
* @param acceptParamInHeader accept param
* @param optionsParamInQuery options query
* @return {@code Object} resource data
*/
Object getResourceDataPassThroughRunningForCmHandle(String cmHandle,
String resourceIdentifier,
String acceptParamInHeader,
String optionsParamInQuery);
/**
* Write resource data for data store pass-through running
* using dmi for given cm-handle.
* @param cmHandle cm handle
* @param resourceIdentifier resource identifier
* @param operation required operation
* @param requestBody request body to create resource
* @param contentType content type in body
*/
void writeResourceDataPassThroughRunningForCmHandle(String cmHandle,
String resourceIdentifier,
OperationEnum operation,
String requestBody,
String contentType);
/**
* Retrieve module references for the given cm handle.
*
* @param cmHandle cm handle
* @return a collection of modules names and revisions
*/
Collection<ModuleReference> getYangResourcesModuleReferences(String cmHandle);
/**
* Query cm handle identifiers for the given collection of module names.
*
* @param moduleNames module names.
* @return a collection of cm handle identifiers. The schema set for each cm handle must include all the
* given module names
*/
Collection<String> executeCmHandleHasAllModulesSearch(Collection<String> moduleNames);
}
|
