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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021-2023 Nordix Foundation
* Modifications Copyright (C) 2022 Bell Canada
* ================================================================================
* 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.dmi.rest.controller;
import static org.onap.cps.ncmp.dmi.model.DataAccessRequest.OperationEnum;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.onap.cps.ncmp.dmi.model.CmHandles;
import org.onap.cps.ncmp.dmi.model.DataAccessRequest;
import org.onap.cps.ncmp.dmi.model.DataOperationRequest;
import org.onap.cps.ncmp.dmi.model.ModuleReferencesRequest;
import org.onap.cps.ncmp.dmi.model.ModuleResourcesReadRequest;
import org.onap.cps.ncmp.dmi.model.ModuleSet;
import org.onap.cps.ncmp.dmi.model.YangResources;
import org.onap.cps.ncmp.dmi.notifications.async.AsyncTaskExecutor;
import org.onap.cps.ncmp.dmi.rest.api.DmiPluginApi;
import org.onap.cps.ncmp.dmi.rest.api.DmiPluginInternalApi;
import org.onap.cps.ncmp.dmi.rest.controller.handlers.DatastoreType;
import org.onap.cps.ncmp.dmi.service.DmiService;
import org.onap.cps.ncmp.dmi.service.model.ModuleReference;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RequestMapping("${rest.api.dmi-base-path}")
@RestController
@Slf4j
@RequiredArgsConstructor
public class DmiRestController implements DmiPluginApi, DmiPluginInternalApi {
private final DmiService dmiService;
private final ObjectMapper objectMapper;
private final AsyncTaskExecutor asyncTaskExecutor;
private static final Map<OperationEnum, HttpStatus> operationToHttpStatusMap = new HashMap<>(6);
@Value("${notification.async.executor.time-out-value-in-ms:2000}")
private int timeOutInMillis;
static {
operationToHttpStatusMap.put(null, HttpStatus.OK);
operationToHttpStatusMap.put(OperationEnum.READ, HttpStatus.OK);
operationToHttpStatusMap.put(OperationEnum.CREATE, HttpStatus.CREATED);
operationToHttpStatusMap.put(OperationEnum.PATCH, HttpStatus.OK);
operationToHttpStatusMap.put(OperationEnum.UPDATE, HttpStatus.OK);
operationToHttpStatusMap.put(OperationEnum.DELETE, HttpStatus.NO_CONTENT);
}
@Override
public ResponseEntity<ModuleSet> getModuleReferences(final String cmHandle,
final ModuleReferencesRequest body) {
// For onap-dmi-plugin we don't need cmHandleProperties, so DataAccessReadRequest is not used.
final ModuleSet moduleSet = dmiService.getModulesForCmHandle(cmHandle);
return ResponseEntity.ok(moduleSet);
}
@Override
public ResponseEntity<YangResources> retrieveModuleResources(
final String cmHandle,
final ModuleResourcesReadRequest moduleResourcesReadRequest) {
final List<ModuleReference> moduleReferences = convertRestObjectToJavaApiObject(moduleResourcesReadRequest);
final YangResources yangResources = dmiService.getModuleResources(cmHandle, moduleReferences);
return new ResponseEntity<>(yangResources, HttpStatus.OK);
}
/**
* This method register given list of cm-handles to ncmp.
*
* @param cmHandles list of cm-handles
* @return (@ code ResponseEntity) response entity
*/
public ResponseEntity<String> registerCmHandles(final CmHandles cmHandles) {
final List<String> cmHandlesList = cmHandles.getCmHandles();
if (cmHandlesList.isEmpty()) {
return new ResponseEntity<>("Need at least one cmHandle to process.", HttpStatus.BAD_REQUEST);
}
dmiService.registerCmHandles(cmHandlesList);
return new ResponseEntity<>("cm-handle registered successfully.", HttpStatus.CREATED);
}
/**
* This method is not implemented for ONAP DMI plugin.
*
* @param requestId requestId generated by NCMP as an ack for client
* @param topic client given topic name
* @param dataOperationRequests list of operation details
* @return (@ code ResponseEntity) response entity
*/
@Override
public ResponseEntity<Void> getResourceDataForCmHandleDataOperation(final String requestId, final String topic,
final List<DataOperationRequest> dataOperationRequests) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
/**
* This method fetches the resource for given cm handle using pass through operational or running datastore.
* It filters the response on the basis of options query parameters and returns response. Passthrough Running
* supports both read and write operation whereas passthrough operational does not support write operations.
*
* @param resourceIdentifier resource identifier to fetch data
* @param datastoreName name of the datastore
* @param cmHandle cm handle identifier
* @param optionsParamInQuery options query parameter
* @param topicParamInQuery topic name for (triggering) async responses
* @param dataAccessRequest data Access Request
* @return {@code ResponseEntity} response entity
*/
@Override
public ResponseEntity<Object> dataAccessPassthrough(final String resourceIdentifier,
final String datastoreName,
final String cmHandle,
final String optionsParamInQuery,
final String topicParamInQuery,
final DataAccessRequest dataAccessRequest) {
if (DatastoreType.PASSTHROUGH_OPERATIONAL == DatastoreType.fromDatastoreName(datastoreName)) {
return dataAccessPassthroughOperational(resourceIdentifier, cmHandle, dataAccessRequest,
optionsParamInQuery, topicParamInQuery);
}
return dataAccessPassthroughRunning(resourceIdentifier, cmHandle, dataAccessRequest,
optionsParamInQuery, topicParamInQuery);
}
private ResponseEntity<Object> dataAccessPassthroughOperational(final String resourceIdentifier,
final String cmHandle,
final DataAccessRequest dataAccessRequest,
final String optionsParamInQuery,
final String topicParamInQuery) {
if (isReadOperation(dataAccessRequest)) {
if (hasTopic(topicParamInQuery)) {
return handleAsyncRequest(resourceIdentifier, cmHandle, dataAccessRequest, optionsParamInQuery,
topicParamInQuery);
}
final String resourceDataAsJson = dmiService.getResourceData(cmHandle, resourceIdentifier,
optionsParamInQuery, DmiService.RESTCONF_CONTENT_PASSTHROUGH_OPERATIONAL_QUERY_PARAM);
return ResponseEntity.ok(resourceDataAsJson);
}
return new ResponseEntity<>(HttpStatus.BAD_REQUEST);
}
private ResponseEntity<Object> dataAccessPassthroughRunning(final String resourceIdentifier,
final String cmHandle,
final DataAccessRequest dataAccessRequest,
final String optionsParamInQuery,
final String topicParamInQuery) {
if (hasTopic(topicParamInQuery)) {
asyncTaskExecutor.executeAsyncTask(() ->
getSdncResponseForPassThroughRunning(
resourceIdentifier,
cmHandle,
dataAccessRequest,
optionsParamInQuery),
topicParamInQuery,
dataAccessRequest.getRequestId(),
dataAccessRequest.getOperation(),
timeOutInMillis
);
return new ResponseEntity<>(HttpStatus.NO_CONTENT);
}
final String sdncResponse =
getSdncResponseForPassThroughRunning(resourceIdentifier, cmHandle, dataAccessRequest, optionsParamInQuery);
return new ResponseEntity<>(sdncResponse, operationToHttpStatusMap.get(dataAccessRequest.getOperation()));
}
private String getSdncResponseForPassThroughRunning(final String resourceIdentifier,
final String cmHandle,
final DataAccessRequest dataAccessRequest,
final String optionsParamInQuery) {
if (isReadOperation(dataAccessRequest)) {
return dmiService.getResourceData(cmHandle, resourceIdentifier, optionsParamInQuery,
DmiService.RESTCONF_CONTENT_PASSTHROUGH_RUNNING_QUERY_PARAM);
}
return dmiService.writeData(dataAccessRequest.getOperation(), cmHandle, resourceIdentifier,
dataAccessRequest.getDataType(), dataAccessRequest.getData());
}
private boolean isReadOperation(final DataAccessRequest dataAccessRequest) {
return dataAccessRequest.getOperation() == null
|| dataAccessRequest.getOperation().equals(DataAccessRequest.OperationEnum.READ);
}
private List<ModuleReference> convertRestObjectToJavaApiObject(
final ModuleResourcesReadRequest moduleResourcesReadRequest) {
return objectMapper
.convertValue(moduleResourcesReadRequest.getData().getModules(),
new TypeReference<List<ModuleReference>>() {});
}
private boolean hasTopic(final String topicParamInQuery) {
return !(topicParamInQuery == null || topicParamInQuery.isBlank());
}
private ResponseEntity<Object> handleAsyncRequest(final String resourceIdentifier,
final String cmHandle,
final DataAccessRequest dataAccessRequest,
final String optionsParamInQuery,
final String topicParamInQuery) {
asyncTaskExecutor.executeAsyncTask(() ->
dmiService.getResourceData(
cmHandle,
resourceIdentifier,
optionsParamInQuery,
DmiService.RESTCONF_CONTENT_PASSTHROUGH_OPERATIONAL_QUERY_PARAM),
topicParamInQuery,
dataAccessRequest.getRequestId(),
dataAccessRequest.getOperation(),
timeOutInMillis
);
return new ResponseEntity<>(HttpStatus.NO_CONTENT);
}
}
|
