2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Copyright (C) 2017 Amdocs
8 * ================================================================================
9 * Modifications Copyright (C) 2018 Orange
10 * =============================================================================
11 * Licensed under the Apache License, Version 2.0 (the "License");
12 * you may not use this file except in compliance with the License.
13 * You may obtain a copy of the License at
15 * http://www.apache.org/licenses/LICENSE-2.0
17 * Unless required by applicable law or agreed to in writing, software
18 * distributed under the License is distributed on an "AS IS" BASIS,
19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20 * See the License for the specific language governing permissions and
21 * limitations under the License.
23 * ============LICENSE_END=========================================================
26 package org.onap.appc.requesthandler.conv;
28 import com.att.eelf.configuration.EELFLogger;
29 import com.att.eelf.configuration.EELFManager;
31 import com.fasterxml.jackson.annotation.JsonIgnore;
32 import com.fasterxml.jackson.annotation.JsonInclude;
33 import com.fasterxml.jackson.annotation.JsonProperty;
34 import com.fasterxml.jackson.annotation.JsonValue;
35 import com.fasterxml.jackson.core.JsonProcessingException;
36 import com.fasterxml.jackson.databind.MapperFeature;
37 import com.fasterxml.jackson.databind.ObjectMapper;
38 import com.fasterxml.jackson.databind.ObjectWriter;
39 import com.fasterxml.jackson.databind.SerializationFeature;
40 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.*;
41 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.CommonHeader;
42 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.CommonHeaderBuilder;
43 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.Flags;
44 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.FlagsBuilder;
45 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.status.Status;
46 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.status.StatusBuilder;
47 import org.opendaylight.yangtools.concepts.Builder;
48 import org.opendaylight.yangtools.yang.binding.DataContainer;
49 import org.onap.appc.domainmodel.lcm.ResponseContext;
50 import org.onap.appc.domainmodel.lcm.VNFOperation;
51 import org.onap.appc.requesthandler.impl.DmaapOutgoingMessage;
53 import java.text.ParseException;
54 import java.text.SimpleDateFormat;
55 import java.util.Date;
56 import java.util.TimeZone;
59 public class Converter {
60 private static final String ISO_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'";
61 private final static String DMaaP_ROOT_VALUE = "output";
62 private static final SimpleDateFormat isoFormatter = new SimpleDateFormat(ISO_FORMAT);
64 isoFormatter.setTimeZone(TimeZone.getTimeZone("UTC"));
67 public static Builder<?> convAsyncResponseToBuilder(VNFOperation vnfOperation, String rpcName, ResponseContext response) {
68 Builder<?> outObj = null;
70 throw new IllegalArgumentException("empty asyncResponse");
72 if(vnfOperation == null){
73 throw new IllegalArgumentException("empty asyncResponse.action");
75 Action action = Action.valueOf(vnfOperation.name());
76 CommonHeader commonHeader = convAsyncResponseTorev160108CommonHeader(response);
77 Status status = convAsyncResponseTorev160108Status(response);
78 Payload payload = convAsyncResponseTorev160108Payload(response);
81 outObj = new RollbackOutputBuilder();
82 ((RollbackOutputBuilder)outObj).setCommonHeader(commonHeader);
83 ((RollbackOutputBuilder)outObj).setStatus(status);
86 outObj = new SnapshotOutputBuilder();
87 ((SnapshotOutputBuilder)outObj).setCommonHeader(commonHeader);
88 ((SnapshotOutputBuilder)outObj).setStatus(status);
90 ((SnapshotOutputBuilder) outObj).setSnapshotId(response.getAdditionalContext().get("output.snapshot-id"));
91 } catch (NullPointerException ignored) {
92 // in case of negative response, snapshotID does not populated, so just ignore NPL
96 outObj = new AuditOutputBuilder();
97 ((AuditOutputBuilder)outObj).setCommonHeader(commonHeader);
98 ((AuditOutputBuilder)outObj).setStatus(status);
99 ((AuditOutputBuilder)outObj).setPayload(payload);
102 outObj = new HealthCheckOutputBuilder();
103 ((HealthCheckOutputBuilder)outObj).setCommonHeader(commonHeader);
104 ((HealthCheckOutputBuilder)outObj).setStatus(status);
105 ((HealthCheckOutputBuilder)outObj).setPayload(payload);
108 outObj = new LiveUpgradeOutputBuilder();
109 ((LiveUpgradeOutputBuilder)outObj).setCommonHeader(commonHeader);
110 ((LiveUpgradeOutputBuilder)outObj).setStatus(status);
113 outObj = new LockOutputBuilder();
114 ((LockOutputBuilder)outObj).setCommonHeader(commonHeader);
115 ((LockOutputBuilder)outObj).setStatus(status);
118 outObj = new ConfigureOutputBuilder();
119 ((ConfigureOutputBuilder)outObj).setCommonHeader(commonHeader);
120 ((ConfigureOutputBuilder)outObj).setStatus(status);
121 ((ConfigureOutputBuilder)outObj).setPayload(payload);
124 outObj = new ConfigModifyOutputBuilder();
125 ((ConfigModifyOutputBuilder)outObj).setCommonHeader(commonHeader);
126 ((ConfigModifyOutputBuilder)outObj).setStatus(status);
127 ((ConfigModifyOutputBuilder)outObj).setPayload(payload);
130 outObj = new ConfigScaleOutOutputBuilder();
131 ((ConfigScaleOutOutputBuilder)outObj).setCommonHeader(commonHeader);
132 ((ConfigScaleOutOutputBuilder)outObj).setStatus(status);
133 ((ConfigScaleOutOutputBuilder)outObj).setPayload(payload);
136 outObj = new ConfigRestoreOutputBuilder();
137 ((ConfigRestoreOutputBuilder)outObj).setCommonHeader(commonHeader);
138 ((ConfigRestoreOutputBuilder)outObj).setStatus(status);
139 ((ConfigRestoreOutputBuilder)outObj).setPayload(payload);
142 outObj = new SoftwareUploadOutputBuilder();
143 ((SoftwareUploadOutputBuilder)outObj).setCommonHeader(commonHeader);
144 ((SoftwareUploadOutputBuilder)outObj).setStatus(status);
147 outObj = new StopOutputBuilder();
148 ((StopOutputBuilder)outObj).setCommonHeader(commonHeader);
149 ((StopOutputBuilder)outObj).setStatus(status);
152 outObj = new SyncOutputBuilder();
153 ((SyncOutputBuilder)outObj).setCommonHeader(commonHeader);
154 ((SyncOutputBuilder)outObj).setStatus(status);
155 ((SyncOutputBuilder)outObj).setPayload(payload);
158 outObj = new TerminateOutputBuilder();
159 ((TerminateOutputBuilder)outObj).setCommonHeader(commonHeader);
160 ((TerminateOutputBuilder)outObj).setStatus(status);
163 outObj = new TestOutputBuilder();
164 ((TestOutputBuilder)outObj).setCommonHeader(commonHeader);
165 ((TestOutputBuilder)outObj).setStatus(status);
168 outObj = new UnlockOutputBuilder();
169 ((UnlockOutputBuilder)outObj).setCommonHeader(commonHeader);
170 ((UnlockOutputBuilder)outObj).setStatus(status);
173 outObj = new RestartOutputBuilder();
174 ((RestartOutputBuilder)outObj).setCommonHeader(commonHeader);
175 ((RestartOutputBuilder)outObj).setStatus(status);
178 outObj = new RebuildOutputBuilder();
179 ((RebuildOutputBuilder)outObj).setCommonHeader(commonHeader);
180 ((RebuildOutputBuilder)outObj).setStatus(status);
183 outObj = new RebootOutputBuilder();
184 ((RebootOutputBuilder)outObj).setCommonHeader(commonHeader);
185 ((RebootOutputBuilder)outObj).setStatus(status);
188 outObj = new MigrateOutputBuilder();
189 ((MigrateOutputBuilder)outObj).setCommonHeader(commonHeader);
190 ((MigrateOutputBuilder)outObj).setStatus(status);
193 outObj = new EvacuateOutputBuilder();
194 ((EvacuateOutputBuilder)outObj).setCommonHeader(commonHeader);
195 ((EvacuateOutputBuilder)outObj).setStatus(status);
198 outObj = new ConfigBackupOutputBuilder();
199 ((ConfigBackupOutputBuilder)outObj).setCommonHeader(commonHeader);
200 ((ConfigBackupOutputBuilder)outObj).setStatus(status);
201 ((ConfigBackupOutputBuilder)outObj).setPayload(payload);
203 case ConfigBackupDelete:
204 outObj = new ConfigBackupDeleteOutputBuilder();
205 ((ConfigBackupDeleteOutputBuilder)outObj).setCommonHeader(commonHeader);
206 ((ConfigBackupDeleteOutputBuilder)outObj).setStatus(status);
207 ((ConfigBackupDeleteOutputBuilder)outObj).setPayload(payload);
210 outObj = new ConfigExportOutputBuilder();
211 ((ConfigExportOutputBuilder)outObj).setCommonHeader(commonHeader);
212 ((ConfigExportOutputBuilder)outObj).setStatus(status);
215 outObj = new StartOutputBuilder();
216 ((StartOutputBuilder)outObj).setCommonHeader(commonHeader);
217 ((StartOutputBuilder)outObj).setStatus(status);
219 case StopApplication:
220 outObj = new StopApplicationOutputBuilder();
221 ((StopApplicationOutputBuilder)outObj).setCommonHeader(commonHeader);
222 ((StopApplicationOutputBuilder)outObj).setStatus(status);
224 case StartApplication:
225 outObj = new StartApplicationOutputBuilder();
226 ((StartApplicationOutputBuilder)outObj).setCommonHeader(commonHeader);
227 ((StartApplicationOutputBuilder)outObj).setStatus(status);
230 outObj = new QuiesceTrafficOutputBuilder();
231 ((QuiesceTrafficOutputBuilder)outObj).setCommonHeader(commonHeader);
232 ((QuiesceTrafficOutputBuilder)outObj).setStatus(status);
235 outObj = new ResumeTrafficOutputBuilder();
236 ((ResumeTrafficOutputBuilder)outObj).setCommonHeader(commonHeader);
237 ((ResumeTrafficOutputBuilder)outObj).setStatus(status);
239 case UpgradeSoftware:
240 outObj = new UpgradeSoftwareOutputBuilder();
241 ((UpgradeSoftwareOutputBuilder)outObj).setCommonHeader(commonHeader);
242 ((UpgradeSoftwareOutputBuilder)outObj).setStatus(status);
244 case UpgradePostCheck:
245 outObj = new UpgradePostCheckOutputBuilder();
246 ((UpgradePostCheckOutputBuilder)outObj).setCommonHeader(commonHeader);
247 ((UpgradePostCheckOutputBuilder)outObj).setStatus(status);
248 ((UpgradePostCheckOutputBuilder)outObj).setPayload(payload);
251 outObj = new UpgradeBackupOutputBuilder();
252 ((UpgradeBackupOutputBuilder)outObj).setCommonHeader(commonHeader);
253 ((UpgradeBackupOutputBuilder)outObj).setStatus(status);
256 outObj = new UpgradeBackoutOutputBuilder();
257 ((UpgradeBackoutOutputBuilder)outObj).setCommonHeader(commonHeader);
258 ((UpgradeBackoutOutputBuilder)outObj).setStatus(status);
260 case UpgradePreCheck:
261 outObj = new UpgradePreCheckOutputBuilder();
262 ((UpgradePreCheckOutputBuilder)outObj).setCommonHeader(commonHeader);
263 ((UpgradePreCheckOutputBuilder)outObj).setStatus(status);
264 ((UpgradePreCheckOutputBuilder)outObj).setPayload(payload);
267 outObj = new AttachVolumeOutputBuilder();
268 ((AttachVolumeOutputBuilder)outObj).setCommonHeader(commonHeader);
269 ((AttachVolumeOutputBuilder)outObj).setStatus(status);
272 outObj = new DetachVolumeOutputBuilder();
273 ((DetachVolumeOutputBuilder)outObj).setCommonHeader(commonHeader);
274 ((DetachVolumeOutputBuilder)outObj).setStatus(status);
276 case DistributeTraffic:
277 outObj = new DistributeTrafficOutputBuilder();
278 ((DistributeTrafficOutputBuilder)outObj).setCommonHeader(commonHeader);
279 ((DistributeTrafficOutputBuilder)outObj).setStatus(status);
282 throw new IllegalArgumentException(action+" action is not supported");
286 public static Payload convAsyncResponseTorev160108Payload(ResponseContext inObj) {
287 Payload payload = null;
288 if(inObj.getPayload() != null) {
289 payload = new Payload(inObj.getPayload());
294 public static String convPayloadObjectToJsonString(Object inObj) throws ParseException {
295 String payloadAsString = null;
298 if(inObj instanceof String){
299 payloadAsString = (String)inObj;
302 ObjectMapper objectMapper = new ObjectMapper();
303 payloadAsString = objectMapper.writeValueAsString(inObj);
304 } catch (JsonProcessingException e) {
305 String errMsg = "Error serialize payload json to string";
306 throw new ParseException(errMsg + "-" + e.toString(), 0);
310 return payloadAsString;
313 public static Status convAsyncResponseTorev160108Status(ResponseContext inObj) {
314 StatusBuilder statusBuilder = new StatusBuilder();
315 statusBuilder.setCode(inObj.getStatus().getCode());
316 statusBuilder.setMessage(inObj.getStatus().getMessage());
317 return statusBuilder.build();
320 public static CommonHeader convAsyncResponseTorev160108CommonHeader(ResponseContext inObj) {
321 CommonHeader outObj = null;
323 throw new IllegalArgumentException("empty asyncResponse");
326 CommonHeaderBuilder commonHeaderBuilder = new CommonHeaderBuilder();
327 org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.Flags commonHeaderFlags;
328 if(inObj.getCommonHeader().getFlags() != null){
329 commonHeaderFlags = Converter.convFlagsMapTorev160108Flags(inObj.getCommonHeader().getFlags());
330 commonHeaderBuilder.setFlags(commonHeaderFlags);
334 commonHeaderBuilder.setApiVer(inObj.getCommonHeader().getApiVer());
335 commonHeaderBuilder.setRequestId(inObj.getCommonHeader().getRequestId());
336 if(inObj.getCommonHeader().getSubRequestId() != null){
337 commonHeaderBuilder.setSubRequestId(inObj.getCommonHeader().getSubRequestId());
340 if(inObj.getCommonHeader().getOriginatorId() != null){
341 commonHeaderBuilder.setOriginatorId(inObj.getCommonHeader().getOriginatorId());
344 if(inObj.getCommonHeader().getTimeStamp() != null){
345 String zuluTimestampStr = Converter.convDateToZuluString(inObj.getCommonHeader().getTimeStamp());
346 ZULU zuluTimestamp = new ZULU(zuluTimestampStr);
347 commonHeaderBuilder.setTimestamp(zuluTimestamp);
349 outObj = commonHeaderBuilder.build();
354 public static String convDateToZuluString(Date timeStamp) {
355 return isoFormatter.format(timeStamp);
358 public static org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.Flags
359 convFlagsMapTorev160108Flags(org.onap.appc.domainmodel.lcm.Flags flags) {
360 Flags rev160108flags;
361 boolean anyFlag = false;
362 FlagsBuilder flagsBuilder = new FlagsBuilder();
364 * TODO: The below flags are related to APP-C request and should not be sent back - uncomment when response flags are introduced.
367 if(flags.containsKey(FORCE_FLAG)){
368 org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.Flags.Force force =
369 org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.Flags.Force.valueOf(flags.get(FORCE_FLAG).toString());
370 flagsBuilder.setForce(force);
373 if(flags.containsKey(MODE_FLAG)){
374 org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.Flags.Mode mode =
375 org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.Flags.Mode.valueOf(flags.get(MODE_FLAG).toString());
376 flagsBuilder.setMode(mode);
379 if(flags.containsKey(TTL_FLAG)){
380 flagsBuilder.setTtl(Integer.valueOf(flags.get(TTL_FLAG).toString()));
384 rev160108flags = flagsBuilder.build();
388 rev160108flags = flagsBuilder.build();
389 return rev160108flags;
392 public static String convAsyncResponseToJsonStringBody(VNFOperation vnfOperation, String rpcName, ResponseContext asyncResponse) throws JsonProcessingException {
393 Builder<?> builder = Converter.convAsyncResponseToBuilder(vnfOperation, rpcName, asyncResponse);
394 Object message = builder.build();
395 ObjectMapper objectMapper = new ObjectMapper();
396 objectMapper.addMixInAnnotations(message.getClass(), MixInFlagsMessage.class);
397 objectMapper.addMixInAnnotations(CommonHeader.class, MixInCommonHeader.class);
398 objectMapper.addMixInAnnotations(Flags.class, MixIn.class);
399 objectMapper.addMixInAnnotations(Status.class, MixIn.class);
400 objectMapper.addMixInAnnotations(Payload.class, MixIn.class);
401 objectMapper.addMixInAnnotations(ZULU.class, MixIn.class);
403 // .configure(SerializationConfig.Feature.SORT_PROPERTIES_ALPHABETICALLY,true)
404 ObjectWriter writer = objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL).configure(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY,true)
405 .writer(SerializationFeature.WRAP_ROOT_VALUE).withRootName(DMaaP_ROOT_VALUE).withoutFeatures(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS);
406 return writer.writeValueAsString(message);
409 public static String convAsyncResponseToDmaapOutgoingMessageJsonString(VNFOperation vnfOperation, String rpcName, ResponseContext asyncResponse) throws JsonProcessingException {
410 DmaapOutgoingMessage dmaapOutgoingMessage = convAsyncResponseToDmaapOutgoingMessage(vnfOperation, rpcName, asyncResponse);
411 ObjectMapper objectMapper = new ObjectMapper();
412 objectMapper.addMixInAnnotations(dmaapOutgoingMessage.getBody().getOutput().getClass(), MixInFlagsMessage.class);
413 objectMapper.addMixInAnnotations(CommonHeader.class, MixInCommonHeader.class);
414 objectMapper.addMixInAnnotations(Flags.class, MixIn.class);
415 objectMapper.addMixInAnnotations(Status.class, MixIn.class);
416 objectMapper.addMixInAnnotations(Payload.class, MixIn.class);
417 objectMapper.addMixInAnnotations(ZULU.class, MixIn.class);
419 // .configure(SerializationConfig.Feature.SORT_PROPERTIES_ALPHABETICALLY,true)
420 ObjectWriter writer = objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL).configure(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY,true).writer();
421 return writer.writeValueAsString(dmaapOutgoingMessage);
424 public static DmaapOutgoingMessage convAsyncResponseToDmaapOutgoingMessage(VNFOperation vnfOperation, String rpcName, ResponseContext asyncResponse) throws JsonProcessingException {
425 DmaapOutgoingMessage outObj = new DmaapOutgoingMessage();
426 String correlationID = getCorrelationID(asyncResponse);
427 outObj.setCorrelationID(correlationID);
428 outObj.setType("response");
429 outObj.setRpcName(rpcName);
430 Builder<?> builder = Converter.convAsyncResponseToBuilder(vnfOperation, rpcName, asyncResponse);
431 Object messageBody = builder.build();
432 DmaapOutgoingMessage.Body body = new DmaapOutgoingMessage.Body(messageBody);
433 outObj.setBody(body);
437 private static String getCorrelationID(ResponseContext context) {
438 return context.getCommonHeader().getRequestId()
439 + (context.getCommonHeader().getSubRequestId() == null ?
440 "":"-" + context.getCommonHeader().getSubRequestId());
443 abstract class MixIn {
445 abstract Class<? extends DataContainer> getImplementedInterface(); // to be removed during serialization
448 abstract java.lang.String getValue();
450 abstract class MixInCommonHeader extends MixIn {
451 @JsonProperty("api-ver")
452 abstract java.lang.String getApiVer();
453 @JsonProperty("originator-id")
454 abstract java.lang.String getOriginatorId();
455 @JsonProperty("request-id")
456 abstract java.lang.String getRequestId();
457 @JsonProperty("sub-request-id")
458 abstract java.lang.String getSubRequestId();
461 abstract class MixInFlagsMessage extends MixIn {
462 @JsonProperty("common-header")
463 abstract CommonHeader getCommonHeader();