2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021-2023 Nordix Foundation
4 * Modifications Copyright (C) 2022 Bell Canada
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.cps.ncmp.api.impl.operations;
24 import static org.onap.cps.ncmp.api.impl.operations.DatastoreType.PASSTHROUGH_RUNNING;
25 import static org.onap.cps.ncmp.api.impl.operations.OperationType.READ;
27 import java.util.Collection;
28 import java.util.List;
31 import java.util.stream.Collectors;
32 import lombok.extern.slf4j.Slf4j;
33 import org.onap.cps.ncmp.api.NcmpEventResponseCode;
34 import org.onap.cps.ncmp.api.impl.client.DmiRestClient;
35 import org.onap.cps.ncmp.api.impl.config.NcmpConfiguration;
36 import org.onap.cps.ncmp.api.impl.exception.HttpClientRequestException;
37 import org.onap.cps.ncmp.api.impl.executor.TaskExecutor;
38 import org.onap.cps.ncmp.api.impl.utils.DmiServiceUrlBuilder;
39 import org.onap.cps.ncmp.api.impl.utils.data.operation.ResourceDataOperationRequestUtils;
40 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
41 import org.onap.cps.ncmp.api.inventory.CmHandleState;
42 import org.onap.cps.ncmp.api.inventory.InventoryPersistence;
43 import org.onap.cps.ncmp.api.models.DataOperationRequest;
44 import org.onap.cps.spi.exceptions.CpsException;
45 import org.onap.cps.utils.JsonObjectMapper;
46 import org.springframework.http.ResponseEntity;
47 import org.springframework.stereotype.Component;
48 import org.springframework.util.LinkedMultiValueMap;
49 import org.springframework.util.MultiValueMap;
50 import org.springframework.web.util.UriComponentsBuilder;
53 * Operations class for DMI data.
57 public class DmiDataOperations extends DmiOperations {
59 private static final long DEFAULT_ASYNC_TASK_EXECUTOR_TIMEOUT_IN_MILLISECONDS = 30000L;
61 public DmiDataOperations(final InventoryPersistence inventoryPersistence,
62 final JsonObjectMapper jsonObjectMapper,
63 final NcmpConfiguration.DmiProperties dmiProperties,
64 final DmiRestClient dmiRestClient,
65 final DmiServiceUrlBuilder dmiServiceUrlBuilder) {
66 super(inventoryPersistence, jsonObjectMapper, dmiProperties, dmiRestClient, dmiServiceUrlBuilder);
70 * This method fetches the resource data from operational data store for given cm handle
71 * identifier on given resource using dmi client.
73 * @param dataStoreName name of data store
74 * @param cmHandleId network resource identifier
75 * @param resourceId resource identifier
76 * @param optionsParamInQuery options query
77 * @param topicParamInQuery topic name for (triggering) async responses
78 * @param requestId requestId for async responses
79 * @return {@code ResponseEntity} response entity
81 public ResponseEntity<Object> getResourceDataFromDmi(final String dataStoreName,
82 final String cmHandleId,
83 final String resourceId,
84 final String optionsParamInQuery,
85 final String topicParamInQuery,
86 final String requestId) {
87 final YangModelCmHandle yangModelCmHandle = getYangModelCmHandle(cmHandleId);
88 final CmHandleState cmHandleState = yangModelCmHandle.getCompositeState().getCmHandleState();
89 validateIfCmHandleStateReady(yangModelCmHandle, cmHandleState);
90 final String jsonRequestBody = getDmiRequestBody(READ, requestId, null, null,
92 final String dmiResourceDataUrl = getDmiRequestUrl(dataStoreName, cmHandleId, resourceId, optionsParamInQuery,
93 topicParamInQuery, yangModelCmHandle.resolveDmiServiceName(RequiredDmiService.DATA));
94 return dmiRestClient.postOperationWithJsonData(dmiResourceDataUrl, jsonRequestBody, READ);
98 * This method fetches all the resource data from operational data store for given cm handle
99 * identifier using dmi client.
101 * @param dataStoreName data store name
102 * @param cmHandleId network resource identifier
103 * @param requestId requestId for async responses
104 * @return {@code ResponseEntity} response entity
106 public ResponseEntity<Object> getResourceDataFromDmi(final String dataStoreName,
107 final String cmHandleId,
108 final String requestId) {
109 final YangModelCmHandle yangModelCmHandle = getYangModelCmHandle(cmHandleId);
110 final String jsonRequestBody = getDmiRequestBody(READ, requestId, null, null,
112 final String dmiResourceDataUrl = getDmiRequestUrl(dataStoreName, cmHandleId, "/",
114 yangModelCmHandle.resolveDmiServiceName(RequiredDmiService.DATA));
115 final CmHandleState cmHandleState = yangModelCmHandle.getCompositeState().getCmHandleState();
116 validateIfCmHandleStateReady(yangModelCmHandle, cmHandleState);
117 return dmiRestClient.postOperationWithJsonData(dmiResourceDataUrl, jsonRequestBody, READ);
121 * This method requests the resource data by data store for given list of cm handles using dmi client.
122 * The data wil be returned as message on the topic specified.
124 * @param topicParamInQuery topic name for (triggering) async responses
125 * @param dataOperationRequest data operation request to execute operations
126 * @param requestId requestId for as a response
128 public void requestResourceDataFromDmi(final String topicParamInQuery,
129 final DataOperationRequest dataOperationRequest,
130 final String requestId) {
132 final Set<String> cmHandlesIds
133 = getDistinctCmHandleIdsFromDataOperationRequest(dataOperationRequest);
135 final Collection<YangModelCmHandle> yangModelCmHandles
136 = inventoryPersistence.getYangModelCmHandles(cmHandlesIds);
138 final Map<String, List<DmiDataOperation>> operationsOutPerDmiServiceName
139 = ResourceDataOperationRequestUtils.processPerDefinitionInDataOperationsRequest(topicParamInQuery,
140 requestId, dataOperationRequest, yangModelCmHandles);
142 buildDataOperationRequestUrlAndSendToDmiService(topicParamInQuery, requestId, operationsOutPerDmiServiceName);
146 * This method creates the resource data from pass-through running data store for given cm handle
147 * identifier on given resource using dmi client.
149 * @param cmHandleId network resource identifier
150 * @param resourceId resource identifier
151 * @param operationType operation enum
152 * @param requestData the request data
153 * @param dataType data type
154 * @return {@code ResponseEntity} response entity
156 public ResponseEntity<Object> writeResourceDataPassThroughRunningFromDmi(final String cmHandleId,
157 final String resourceId,
158 final OperationType operationType,
159 final String requestData,
160 final String dataType) {
161 final YangModelCmHandle yangModelCmHandle = getYangModelCmHandle(cmHandleId);
162 final String jsonRequestBody = getDmiRequestBody(operationType, null, requestData, dataType,
164 final String dmiUrl = getDmiRequestUrl(PASSTHROUGH_RUNNING.getDatastoreName(), cmHandleId, resourceId,
166 yangModelCmHandle.resolveDmiServiceName(RequiredDmiService.DATA));
167 final CmHandleState cmHandleState = yangModelCmHandle.getCompositeState().getCmHandleState();
168 validateIfCmHandleStateReady(yangModelCmHandle, cmHandleState);
169 return dmiRestClient.postOperationWithJsonData(dmiUrl, jsonRequestBody, operationType);
172 private YangModelCmHandle getYangModelCmHandle(final String cmHandleId) {
173 return inventoryPersistence.getYangModelCmHandle(cmHandleId);
176 private String getDmiRequestBody(final OperationType operationType,
177 final String requestId,
178 final String requestData,
179 final String dataType,
180 final YangModelCmHandle yangModelCmHandle) {
181 final DmiRequestBody dmiRequestBody = DmiRequestBody.builder()
182 .operationType(operationType)
183 .requestId(requestId)
187 dmiRequestBody.asDmiProperties(yangModelCmHandle.getDmiProperties());
188 return jsonObjectMapper.asJsonString(dmiRequestBody);
191 private String getDmiRequestUrl(final String dataStoreName,
192 final String cmHandleId,
193 final String resourceId,
194 final String optionsParamInQuery,
195 final String topicParamInQuery,
196 final String dmiServiceName) {
197 return dmiServiceUrlBuilder.getDmiDatastoreUrl(
198 dmiServiceUrlBuilder.populateQueryParams(resourceId, optionsParamInQuery,
199 topicParamInQuery), dmiServiceUrlBuilder.populateUriVariables(dataStoreName, dmiServiceName,
203 private String getDmiServiceDataOperationRequestUrl(final String dmiServiceName,
204 final String topicParamInQuery,
205 final String requestId) {
206 final MultiValueMap<String, String> dataOperationRequestQueryParams = dmiServiceUrlBuilder
207 .getDataOperationRequestQueryParams(topicParamInQuery, requestId);
208 return dmiServiceUrlBuilder.getDataOperationRequestUrl(dataOperationRequestQueryParams,
209 dmiServiceUrlBuilder.populateDataOperationRequestUriVariables(dmiServiceName));
212 private void validateIfCmHandleStateReady(final YangModelCmHandle yangModelCmHandle,
213 final CmHandleState cmHandleState) {
214 if (cmHandleState != CmHandleState.READY) {
215 throw new CpsException("State mismatch exception.", "Cm-Handle not in READY state. "
216 + "cm handle state is "
217 + yangModelCmHandle.getCompositeState().getCmHandleState());
221 private static Set<String> getDistinctCmHandleIdsFromDataOperationRequest(final DataOperationRequest
222 dataOperationRequest) {
223 return dataOperationRequest.getDataOperationDefinitions().stream()
224 .flatMap(dataOperationDefinition ->
225 dataOperationDefinition.getCmHandleIds().stream()).collect(Collectors.toSet());
228 private void buildDataOperationRequestUrlAndSendToDmiService(final String topicParamInQuery,
229 final String requestId,
230 final Map<String, List<DmiDataOperation>>
231 groupsOutPerDmiServiceName) {
233 groupsOutPerDmiServiceName.entrySet().forEach(groupsOutPerDmiServiceNameEntry -> {
234 final String dmiServiceName = groupsOutPerDmiServiceNameEntry.getKey();
235 final List<DmiDataOperation> dmiDataOperationRequestBodies = groupsOutPerDmiServiceNameEntry.getValue();
236 final String dmiDataOperationResourceUrl =
237 getDmiServiceDataOperationRequestUrl(dmiServiceName, topicParamInQuery, requestId);
238 sendDataOperationRequestToDmiService(dmiDataOperationResourceUrl, dmiDataOperationRequestBodies);
242 private void sendDataOperationRequestToDmiService(final String dataOperationResourceUrl,
243 final List<DmiDataOperation> dmiDataOperationRequestBodies) {
244 final DmiDataOperationRequest dmiDataOperationRequest = DmiDataOperationRequest.builder()
245 .operations(dmiDataOperationRequestBodies).build();
246 final String dmiDataOperationRequestAsJsonString =
247 jsonObjectMapper.asJsonString(dmiDataOperationRequest);
248 TaskExecutor.executeTask(() -> dmiRestClient.postOperationWithJsonData(dataOperationResourceUrl,
249 dmiDataOperationRequestAsJsonString, READ),
250 DEFAULT_ASYNC_TASK_EXECUTOR_TIMEOUT_IN_MILLISECONDS)
251 .whenCompleteAsync((response, throwable) -> handleTaskCompletionException(throwable,
252 dataOperationResourceUrl, dmiDataOperationRequestBodies));
255 private void handleTaskCompletionException(final Throwable throwable,
256 final String dataOperationResourceUrl,
257 final List<DmiDataOperation> dmiDataOperationRequestBodies) {
258 if (throwable != null) {
259 final MultiValueMap<String, String> dataOperationResourceUrlParameters =
260 UriComponentsBuilder.fromUriString(dataOperationResourceUrl).build().getQueryParams();
261 final String topicName = dataOperationResourceUrlParameters.get("topic").get(0);
262 final String requestId = dataOperationResourceUrlParameters.get("requestId").get(0);
264 final MultiValueMap<String, Map<NcmpEventResponseCode, List<String>>>
265 cmHandleIdsPerResponseCodesPerOperationId = new LinkedMultiValueMap<>();
267 dmiDataOperationRequestBodies.forEach(dmiDataOperationRequestBody -> {
268 final List<String> cmHandleIds = dmiDataOperationRequestBody.getCmHandles().stream()
269 .map(CmHandle::getId).collect(Collectors.toList());
270 if (throwable.getCause() instanceof HttpClientRequestException) {
271 cmHandleIdsPerResponseCodesPerOperationId.add(dmiDataOperationRequestBody.getOperationId(),
272 Map.of(NcmpEventResponseCode.UNABLE_TO_READ_RESOURCE_DATA, cmHandleIds));
274 cmHandleIdsPerResponseCodesPerOperationId.add(dmiDataOperationRequestBody.getOperationId(),
275 Map.of(NcmpEventResponseCode.DMI_SERVICE_NOT_RESPONDING, cmHandleIds));
278 ResourceDataOperationRequestUtils.publishErrorMessageToClientTopic(topicName, requestId,
279 cmHandleIdsPerResponseCodesPerOperationId);