2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021 highstreet technologies GmbH
4 * Modifications Copyright (C) 2021-2022 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 static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum;
28 import java.util.Collection;
30 import org.onap.cps.ncmp.api.models.CmHandleQueryApiParameters;
31 import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
32 import org.onap.cps.ncmp.api.models.DmiPluginRegistrationResponse;
33 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
34 import org.onap.cps.spi.model.ModuleReference;
37 * Datastore interface for handling CPS data.
39 public interface NetworkCmProxyDataService {
42 * Registration of New CM Handles.
44 * @param dmiPluginRegistration Dmi Plugin Registration
45 * @return dmiPluginRegistrationResponse
47 DmiPluginRegistrationResponse updateDmiRegistrationAndSyncModule(DmiPluginRegistration dmiPluginRegistration);
50 * Get resource data for data store pass-through operational
53 * @param cmHandleId cm handle identifier
54 * @param resourceIdentifier resource identifier
55 * @param optionsParamInQuery options query
56 * @param topicParamInQuery topic name for (triggering) async responses
57 * @param requestId unique requestId for async request
58 * @return {@code Object} resource data
60 Object getResourceDataOperationalForCmHandle(String cmHandleId,
61 String resourceIdentifier,
62 String optionsParamInQuery,
63 String topicParamInQuery,
67 * Get resource data for data store pass-through running
70 * @param cmHandleId cm handle identifier
71 * @param resourceIdentifier resource identifier
72 * @param optionsParamInQuery options query
73 * @param topicParamInQuery topic name for (triggering) async responses
74 * @param requestId unique requestId for async request
75 * @return {@code Object} resource data
77 Object getResourceDataPassThroughRunningForCmHandle(String cmHandleId,
78 String resourceIdentifier,
79 String optionsParamInQuery,
80 String topicParamInQuery,
84 * Write resource data for data store pass-through running
85 * using dmi for given cm-handle.
86 * @param cmHandleId cm handle identifier
87 * @param resourceIdentifier resource identifier
88 * @param operation required operation
89 * @param requestBody request body to create resource
90 * @param contentType content type in body
91 * @return {@code Object} return data
93 Object writeResourceDataPassThroughRunningForCmHandle(String cmHandleId,
94 String resourceIdentifier,
95 OperationEnum operation,
100 * Retrieve module references for the given cm handle.
102 * @param cmHandleId cm handle identifier
103 * @return a collection of modules names and revisions
105 Collection<ModuleReference> getYangResourcesModuleReferences(String cmHandleId);
108 * Query cm handle identifiers for the given collection of module names.
110 * @param moduleNames module names.
111 * @return a collection of cm handle identifiers. The schema set for each cm handle must include all the
114 Collection<String> executeCmHandleHasAllModulesSearch(Collection<String> moduleNames);
117 * Query cm handle details by cm handle's name.
119 * @param cmHandleId cm handle identifier
120 * @return a collection of cm handle details.
122 NcmpServiceCmHandle getNcmpServiceCmHandle(String cmHandleId);
125 * Query and return cm handles that match the given query parameters.
127 * @param cmHandleQueryApiParameters the cm handle query parameters
128 * @return collection of cm handle ids
130 Set<String> queryCmHandles(CmHandleQueryApiParameters cmHandleQueryApiParameters);