2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021 highstreet technologies GmbH
4 * Modifications Copyright (C) 2021-2023 Nordix Foundation
5 * Modifications Copyright (C) 2021 Pantheon.tech
6 * Modifications Copyright (C) 2022 Bell Canada
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
20 * SPDX-License-Identifier: Apache-2.0
21 * ============LICENSE_END=========================================================
24 package org.onap.cps.ncmp.api;
26 import java.util.Collection;
28 import org.onap.cps.ncmp.api.impl.inventory.CompositeState;
29 import org.onap.cps.ncmp.api.impl.operations.OperationType;
30 import org.onap.cps.ncmp.api.models.CmHandleQueryApiParameters;
31 import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters;
32 import org.onap.cps.ncmp.api.models.DataOperationRequest;
33 import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
34 import org.onap.cps.ncmp.api.models.DmiPluginRegistrationResponse;
35 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
36 import org.onap.cps.spi.FetchDescendantsOption;
37 import org.onap.cps.spi.model.ModuleDefinition;
38 import org.onap.cps.spi.model.ModuleReference;
41 * Datastore interface for handling CPS data.
43 public interface NetworkCmProxyDataService {
46 * Registration of New CM Handles.
48 * @param dmiPluginRegistration Dmi Plugin Registration
49 * @return dmiPluginRegistrationResponse
51 DmiPluginRegistrationResponse updateDmiRegistrationAndSyncModule(DmiPluginRegistration dmiPluginRegistration);
54 * Get resource data for given data store using dmi.
56 * @param datastoreName datastore name
57 * @param cmHandleId cm handle identifier
58 * @param resourceIdentifier resource identifier
59 * @param optionsParamInQuery options query
60 * @param topicParamInQuery topic name for (triggering) async responses
61 * @param requestId unique requestId for async request
62 * @return {@code Object} resource data
64 Object getResourceDataForCmHandle(String datastoreName,
66 String resourceIdentifier,
67 String optionsParamInQuery,
68 String topicParamInQuery,
72 * Get resource data for operational.
74 * @param datastoreName datastore name
75 * @param cmHandleId cm handle identifier
76 * @param resourceIdentifier resource identifier
77 * @Link FetchDescendantsOption fetch descendants option
78 * @return {@code Object} resource data
80 Object getResourceDataForCmHandle(String datastoreName,
82 String resourceIdentifier,
83 FetchDescendantsOption fetchDescendantsOption);
86 * Execute (async) data operation for group of cm handles using dmi.
88 * @param topicParamInQuery topic name for (triggering) async responses
89 * @param dataOperationRequest contains a list of operation definitions(multiple operations)
91 void executeDataOperationForCmHandles(String topicParamInQuery,
92 DataOperationRequest dataOperationRequest,
97 * Write resource data for data store pass-through running using dmi for given cm-handle.
99 * @param cmHandleId cm handle identifier
100 * @param resourceIdentifier resource identifier
101 * @param operationType required operation type
102 * @param requestBody request body to create resource
103 * @param contentType content type in body
104 * @return {@code Object} return data
106 Object writeResourceDataPassThroughRunningForCmHandle(String cmHandleId,
107 String resourceIdentifier,
108 OperationType operationType,
113 * Retrieve module references for the given cm handle.
115 * @param cmHandleId cm handle identifier
116 * @return a collection of modules names and revisions
118 Collection<ModuleReference> getYangResourcesModuleReferences(String cmHandleId);
121 * Retrieve module definitions for the given cm handle.
123 * @param cmHandleId cm handle identifier
124 * @return a collection of module definition (moduleName, revision and yang resource content)
126 Collection<ModuleDefinition> getModuleDefinitionsByCmHandleId(String cmHandleId);
129 * Query cm handle details by cm handle's name.
131 * @param cmHandleId cm handle identifier
132 * @return a collection of cm handle details.
134 NcmpServiceCmHandle getNcmpServiceCmHandle(String cmHandleId);
137 * Get cm handle public properties by cm handle id.
139 * @param cmHandleId cm handle identifier
140 * @return a collection of cm handle public properties.
142 Map<String, String> getCmHandlePublicProperties(String cmHandleId);
145 * Get cm handle composite state by cm handle id.
147 * @param cmHandleId cm handle identifier
148 * @return a cm handle composite state
150 CompositeState getCmHandleCompositeState(String cmHandleId);
153 * Query and return cm handles that match the given query parameters.
155 * @param cmHandleQueryApiParameters the cm handle query parameters
156 * @return collection of cm handles
158 Collection<NcmpServiceCmHandle> executeCmHandleSearch(CmHandleQueryApiParameters cmHandleQueryApiParameters);
161 * Query and return cm handle ids that match the given query parameters.
163 * @param cmHandleQueryApiParameters the cm handle query parameters
164 * @return collection of cm handle ids
166 Collection<String> executeCmHandleIdSearch(CmHandleQueryApiParameters cmHandleQueryApiParameters);
169 * Set the data sync enabled flag, along with the data sync state to true or false based on the cm handle id.
171 * @param cmHandleId cm handle id
172 * @param dataSyncEnabled data sync enabled flag
174 void setDataSyncEnabled(String cmHandleId, Boolean dataSyncEnabled);
177 * Get all cm handle IDs by DMI plugin identifier.
179 * @param dmiPluginIdentifier DMI plugin identifier
180 * @return collection of cm handle IDs
182 Collection<String> getAllCmHandleIdsByDmiPluginIdentifier(String dmiPluginIdentifier);
185 * Get all cm handle IDs by various search criteria.
187 * @param cmHandleQueryServiceParameters cm handle query parameters
188 * @return collection of cm handle IDs
190 Collection<String> executeCmHandleIdSearchForInventory(CmHandleQueryServiceParameters
191 cmHandleQueryServiceParameters);