0b8002b1bbddea8ae5fed2e6ddc6e6c67a010a85
[appc.git] /
1 /*-
2  * ============LICENSE_START=======================================================
3  * ONAP : APPC
4  * ================================================================================
5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
6  * ================================================================================
7  * Copyright (C) 2017 Amdocs
8  * =============================================================================
9  * Licensed under the Apache License, Version 2.0 (the "License");
10  * you may not use this file except in compliance with the License.
11  * You may obtain a copy of the License at
12  * 
13  *      http://www.apache.org/licenses/LICENSE-2.0
14  * 
15  * Unless required by applicable law or agreed to in writing, software
16  * distributed under the License is distributed on an "AS IS" BASIS,
17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18  * See the License for the specific language governing permissions and
19  * limitations under the License.
20  * 
21  * ============LICENSE_END=========================================================
22  */
23
24 package org.onap.appc.requesthandler.conv;
25
26 import com.att.eelf.configuration.EELFLogger;
27 import com.att.eelf.configuration.EELFManager;
28
29 import com.fasterxml.jackson.annotation.JsonIgnore;
30 import com.fasterxml.jackson.annotation.JsonInclude;
31 import com.fasterxml.jackson.annotation.JsonProperty;
32 import com.fasterxml.jackson.annotation.JsonValue;
33 import com.fasterxml.jackson.core.JsonProcessingException;
34 import com.fasterxml.jackson.databind.MapperFeature;
35 import com.fasterxml.jackson.databind.ObjectMapper;
36 import com.fasterxml.jackson.databind.ObjectWriter;
37 import com.fasterxml.jackson.databind.SerializationFeature;
38 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.*;
39 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.CommonHeader;
40 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.CommonHeaderBuilder;
41 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.Flags;
42 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.FlagsBuilder;
43 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.status.Status;
44 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.status.StatusBuilder;
45 import org.opendaylight.yangtools.concepts.Builder;
46 import org.opendaylight.yangtools.yang.binding.DataContainer;
47 import org.onap.appc.domainmodel.lcm.ResponseContext;
48 import org.onap.appc.domainmodel.lcm.VNFOperation;
49 import org.onap.appc.requesthandler.impl.DmaapOutgoingMessage;
50
51 import java.text.ParseException;
52 import java.text.SimpleDateFormat;
53 import java.util.Date;
54 import java.util.TimeZone;
55
56
57 public class Converter {
58     private static final String ISO_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'";
59     private final static String DMaaP_ROOT_VALUE = "output";
60     private static final SimpleDateFormat isoFormatter = new SimpleDateFormat(ISO_FORMAT);
61     static {
62         isoFormatter.setTimeZone(TimeZone.getTimeZone("UTC"));
63     }
64
65     public static Builder<?> convAsyncResponseToBuilder(VNFOperation vnfOperation, String rpcName, ResponseContext response) {
66         Builder<?> outObj = null;
67         if(response == null){
68             throw new IllegalArgumentException("empty asyncResponse");
69         }
70         if(vnfOperation == null){
71             throw new IllegalArgumentException("empty asyncResponse.action");
72         }
73         Action action = Action.valueOf(vnfOperation.name());
74         CommonHeader commonHeader = convAsyncResponseTorev160108CommonHeader(response);
75         Status status = convAsyncResponseTorev160108Status(response);
76         Payload payload = convAsyncResponseTorev160108Payload(response);
77         switch (action){
78             case Rollback:
79                 outObj = new RollbackOutputBuilder();
80                 ((RollbackOutputBuilder)outObj).setCommonHeader(commonHeader);
81                 ((RollbackOutputBuilder)outObj).setStatus(status);
82                 return outObj;
83             case Snapshot:
84                 outObj = new SnapshotOutputBuilder();
85                 ((SnapshotOutputBuilder)outObj).setCommonHeader(commonHeader);
86                 ((SnapshotOutputBuilder)outObj).setStatus(status);
87                 try {
88                     ((SnapshotOutputBuilder) outObj).setSnapshotId(response.getAdditionalContext().get("output.snapshot-id"));
89                 } catch (NullPointerException ignored) {
90                     // in case of negative response, snapshotID does not populated, so just ignore NPL
91                 }
92                 return outObj;
93             case Audit:
94                 outObj = new AuditOutputBuilder();
95                 ((AuditOutputBuilder)outObj).setCommonHeader(commonHeader);
96                 ((AuditOutputBuilder)outObj).setStatus(status);
97                 ((AuditOutputBuilder)outObj).setPayload(payload);
98                 return outObj;
99             case HealthCheck:
100                 outObj = new HealthCheckOutputBuilder();
101                 ((HealthCheckOutputBuilder)outObj).setCommonHeader(commonHeader);
102                 ((HealthCheckOutputBuilder)outObj).setStatus(status);
103                 ((HealthCheckOutputBuilder)outObj).setPayload(payload);
104                 return outObj;
105             case LiveUpgrade:
106                 outObj = new LiveUpgradeOutputBuilder();
107                 ((LiveUpgradeOutputBuilder)outObj).setCommonHeader(commonHeader);
108                 ((LiveUpgradeOutputBuilder)outObj).setStatus(status);
109                 return outObj;
110             case Lock:
111                 outObj = new LockOutputBuilder();
112                 ((LockOutputBuilder)outObj).setCommonHeader(commonHeader);
113                 ((LockOutputBuilder)outObj).setStatus(status);
114                 return outObj;
115             case Configure:
116                 outObj = new ConfigureOutputBuilder();
117                 ((ConfigureOutputBuilder)outObj).setCommonHeader(commonHeader);
118                 ((ConfigureOutputBuilder)outObj).setStatus(status);
119                 ((ConfigureOutputBuilder)outObj).setPayload(payload);
120                 return outObj;
121             case ConfigModify:
122                 outObj = new ConfigModifyOutputBuilder();
123                 ((ConfigModifyOutputBuilder)outObj).setCommonHeader(commonHeader);
124                 ((ConfigModifyOutputBuilder)outObj).setStatus(status);
125                 ((ConfigModifyOutputBuilder)outObj).setPayload(payload);
126                 return outObj;
127             case ConfigScaleOut:
128                 outObj = new ConfigScaleOutOutputBuilder();
129                 ((ConfigScaleOutOutputBuilder)outObj).setCommonHeader(commonHeader);
130                 ((ConfigScaleOutOutputBuilder)outObj).setStatus(status);
131                 ((ConfigScaleOutOutputBuilder)outObj).setPayload(payload);
132                 return outObj;
133             case ConfigRestore:
134                 outObj = new ConfigRestoreOutputBuilder();
135                 ((ConfigRestoreOutputBuilder)outObj).setCommonHeader(commonHeader);
136                 ((ConfigRestoreOutputBuilder)outObj).setStatus(status);
137                 ((ConfigRestoreOutputBuilder)outObj).setPayload(payload);
138                 return outObj;
139             case SoftwareUpload:
140                 outObj = new SoftwareUploadOutputBuilder();
141                 ((SoftwareUploadOutputBuilder)outObj).setCommonHeader(commonHeader);
142                 ((SoftwareUploadOutputBuilder)outObj).setStatus(status);
143                 return outObj;
144             case Stop:
145                 outObj = new StopOutputBuilder();
146                 ((StopOutputBuilder)outObj).setCommonHeader(commonHeader);
147                 ((StopOutputBuilder)outObj).setStatus(status);
148                 return outObj;
149             case Sync:
150                 outObj = new SyncOutputBuilder();
151                 ((SyncOutputBuilder)outObj).setCommonHeader(commonHeader);
152                 ((SyncOutputBuilder)outObj).setStatus(status);
153                 ((SyncOutputBuilder)outObj).setPayload(payload);
154                 return outObj;
155             case Terminate:
156                 outObj = new TerminateOutputBuilder();
157                 ((TerminateOutputBuilder)outObj).setCommonHeader(commonHeader);
158                 ((TerminateOutputBuilder)outObj).setStatus(status);
159                 return outObj;
160             case Test:
161                 outObj = new TestOutputBuilder();
162                 ((TestOutputBuilder)outObj).setCommonHeader(commonHeader);
163                 ((TestOutputBuilder)outObj).setStatus(status);
164                 return outObj;
165             case Unlock:
166                 outObj = new UnlockOutputBuilder();
167                 ((UnlockOutputBuilder)outObj).setCommonHeader(commonHeader);
168                 ((UnlockOutputBuilder)outObj).setStatus(status);
169                 return outObj;
170             case Restart:
171                 outObj = new RestartOutputBuilder();
172                 ((RestartOutputBuilder)outObj).setCommonHeader(commonHeader);
173                 ((RestartOutputBuilder)outObj).setStatus(status);
174                 return outObj;
175             case Rebuild:
176                 outObj = new RebuildOutputBuilder();
177                 ((RebuildOutputBuilder)outObj).setCommonHeader(commonHeader);
178                 ((RebuildOutputBuilder)outObj).setStatus(status);
179                 return outObj;
180             case Reboot:
181                 outObj = new RebootOutputBuilder();
182                 ((RebootOutputBuilder)outObj).setCommonHeader(commonHeader);
183                 ((RebootOutputBuilder)outObj).setStatus(status);
184                 return outObj;
185             case Migrate:
186                 outObj = new MigrateOutputBuilder();
187                 ((MigrateOutputBuilder)outObj).setCommonHeader(commonHeader);
188                 ((MigrateOutputBuilder)outObj).setStatus(status);
189                 return outObj;
190             case Evacuate:
191                 outObj = new EvacuateOutputBuilder();
192                 ((EvacuateOutputBuilder)outObj).setCommonHeader(commonHeader);
193                 ((EvacuateOutputBuilder)outObj).setStatus(status);
194                 return outObj;
195             case ConfigBackup:
196                 outObj = new ConfigBackupOutputBuilder();
197                 ((ConfigBackupOutputBuilder)outObj).setCommonHeader(commonHeader);
198                 ((ConfigBackupOutputBuilder)outObj).setStatus(status);
199                 ((ConfigBackupOutputBuilder)outObj).setPayload(payload);
200                 return outObj;
201             case ConfigBackupDelete:
202                 outObj = new ConfigBackupDeleteOutputBuilder();
203                 ((ConfigBackupDeleteOutputBuilder)outObj).setCommonHeader(commonHeader);
204                 ((ConfigBackupDeleteOutputBuilder)outObj).setStatus(status);
205                 ((ConfigBackupDeleteOutputBuilder)outObj).setPayload(payload);
206                 return outObj;
207             case ConfigExport:
208                 outObj = new ConfigExportOutputBuilder();
209                 ((ConfigExportOutputBuilder)outObj).setCommonHeader(commonHeader);
210                 ((ConfigExportOutputBuilder)outObj).setStatus(status);
211                 return outObj;
212             case Start:
213                 outObj = new StartOutputBuilder();
214                 ((StartOutputBuilder)outObj).setCommonHeader(commonHeader);
215                 ((StartOutputBuilder)outObj).setStatus(status);
216                 return outObj;
217             case StopApplication:
218                 outObj = new StopApplicationOutputBuilder();
219                 ((StopApplicationOutputBuilder)outObj).setCommonHeader(commonHeader);
220                 ((StopApplicationOutputBuilder)outObj).setStatus(status);
221                 return outObj;
222             case StartApplication:
223                 outObj = new StartApplicationOutputBuilder();
224                 ((StartApplicationOutputBuilder)outObj).setCommonHeader(commonHeader);
225                 ((StartApplicationOutputBuilder)outObj).setStatus(status);
226                 return outObj;
227     case QuiesceTraffic:
228                 outObj = new QuiesceTrafficOutputBuilder();
229                 ((QuiesceTrafficOutputBuilder)outObj).setCommonHeader(commonHeader);
230                 ((QuiesceTrafficOutputBuilder)outObj).setStatus(status);
231                 return outObj;
232             case ResumeTraffic:
233                 outObj = new ResumeTrafficOutputBuilder();
234                 ((ResumeTrafficOutputBuilder)outObj).setCommonHeader(commonHeader);
235                 ((ResumeTrafficOutputBuilder)outObj).setStatus(status);
236                 return outObj;
237             case UpgradeSoftware:
238                 outObj = new UpgradeSoftwareOutputBuilder();
239                 ((UpgradeSoftwareOutputBuilder)outObj).setCommonHeader(commonHeader);
240                 ((UpgradeSoftwareOutputBuilder)outObj).setStatus(status);
241                 return outObj;
242             case UpgradePostCheck:
243                 outObj = new UpgradePostCheckOutputBuilder();
244                 ((UpgradePostCheckOutputBuilder)outObj).setCommonHeader(commonHeader);
245                 ((UpgradePostCheckOutputBuilder)outObj).setStatus(status);
246                 ((UpgradePostCheckOutputBuilder)outObj).setPayload(payload);
247                 return outObj;
248             case UpgradeBackup:
249                 outObj = new UpgradeBackupOutputBuilder();
250                 ((UpgradeBackupOutputBuilder)outObj).setCommonHeader(commonHeader);
251                 ((UpgradeBackupOutputBuilder)outObj).setStatus(status);
252                 return outObj;
253             case UpgradeBackout:
254                 outObj = new UpgradeBackoutOutputBuilder();
255                 ((UpgradeBackoutOutputBuilder)outObj).setCommonHeader(commonHeader);
256                 ((UpgradeBackoutOutputBuilder)outObj).setStatus(status);
257                 return outObj;
258             case UpgradePreCheck:
259                 outObj = new UpgradePreCheckOutputBuilder();
260                 ((UpgradePreCheckOutputBuilder)outObj).setCommonHeader(commonHeader);
261                 ((UpgradePreCheckOutputBuilder)outObj).setStatus(status);
262                 ((UpgradePreCheckOutputBuilder)outObj).setPayload(payload);
263                 return outObj;
264             case AttachVolume:
265                 outObj = new AttachVolumeOutputBuilder();
266                 ((AttachVolumeOutputBuilder)outObj).setCommonHeader(commonHeader);
267                 ((AttachVolumeOutputBuilder)outObj).setStatus(status);
268                 return outObj;  
269             case DetachVolume:
270                 outObj = new DetachVolumeOutputBuilder();
271                 ((DetachVolumeOutputBuilder)outObj).setCommonHeader(commonHeader);
272                 ((DetachVolumeOutputBuilder)outObj).setStatus(status);
273                 return outObj;
274             default:
275                 throw new IllegalArgumentException(action+" action is not supported");
276         }
277     }
278
279     public static Payload convAsyncResponseTorev160108Payload(ResponseContext inObj)  {
280         Payload payload = null;
281         if(inObj.getPayload() != null) {
282             payload = new Payload(inObj.getPayload());
283         }
284         return payload;
285     }
286
287     public static String convPayloadObjectToJsonString(Object inObj) throws ParseException {
288         String payloadAsString = null;
289         if(inObj != null) {
290
291                 if(inObj instanceof String){
292                     payloadAsString = (String)inObj;
293                 }else {
294                     try {
295                         ObjectMapper objectMapper = new ObjectMapper();
296                         payloadAsString = objectMapper.writeValueAsString(inObj);
297                     } catch (JsonProcessingException e) {
298                         String errMsg = "Error serialize payload json to string";
299                         throw new ParseException(errMsg + "-" + e.toString(), 0);
300                     }
301                 }
302         }
303         return payloadAsString;
304     }
305
306     public static Status convAsyncResponseTorev160108Status(ResponseContext inObj) {
307         StatusBuilder statusBuilder = new StatusBuilder();
308         statusBuilder.setCode(inObj.getStatus().getCode());
309         statusBuilder.setMessage(inObj.getStatus().getMessage());
310         return statusBuilder.build();
311     }
312
313     public static CommonHeader convAsyncResponseTorev160108CommonHeader(ResponseContext inObj) {
314         CommonHeader outObj = null;
315         if(inObj == null){
316             throw new IllegalArgumentException("empty asyncResponse");
317         }
318
319         CommonHeaderBuilder commonHeaderBuilder = new CommonHeaderBuilder();
320         org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.Flags commonHeaderFlags;
321         if(inObj.getCommonHeader().getFlags() != null){
322             commonHeaderFlags = Converter.convFlagsMapTorev160108Flags(inObj.getCommonHeader().getFlags());
323             commonHeaderBuilder.setFlags(commonHeaderFlags);
324         }
325
326
327         commonHeaderBuilder.setApiVer(inObj.getCommonHeader().getApiVer());
328         commonHeaderBuilder.setRequestId(inObj.getCommonHeader().getRequestId());
329         if(inObj.getCommonHeader().getSubRequestId() != null){
330             commonHeaderBuilder.setSubRequestId(inObj.getCommonHeader().getSubRequestId());
331         }
332
333         if(inObj.getCommonHeader().getOriginatorId() != null){
334             commonHeaderBuilder.setOriginatorId(inObj.getCommonHeader().getOriginatorId());
335         }
336
337         if(inObj.getCommonHeader().getTimeStamp() != null){
338             String zuluTimestampStr = Converter.convDateToZuluString(inObj.getCommonHeader().getTimeStamp());
339             ZULU zuluTimestamp = new ZULU(zuluTimestampStr);
340             commonHeaderBuilder.setTimestamp(zuluTimestamp);
341         }
342         outObj = commonHeaderBuilder.build();
343         return outObj;
344
345     }
346
347     public static String convDateToZuluString(Date timeStamp) {
348         return isoFormatter.format(timeStamp);
349     }
350
351     public static org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.Flags
352     convFlagsMapTorev160108Flags(org.onap.appc.domainmodel.lcm.Flags flags) {
353         Flags rev160108flags;
354         boolean anyFlag = false;
355         FlagsBuilder flagsBuilder = new FlagsBuilder();
356         /*
357          * TODO: The below flags are related to APP-C request and should not be sent back - uncomment when response flags are introduced.
358          */
359         /*
360         if(flags.containsKey(FORCE_FLAG)){
361             org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.Flags.Force force =
362                     org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.Flags.Force.valueOf(flags.get(FORCE_FLAG).toString());
363             flagsBuilder.setForce(force);
364             anyFlag = true;
365         }
366         if(flags.containsKey(MODE_FLAG)){
367             org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.Flags.Mode mode =
368                     org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.common.header.Flags.Mode.valueOf(flags.get(MODE_FLAG).toString());
369             flagsBuilder.setMode(mode);
370             anyFlag = true;
371         }
372         if(flags.containsKey(TTL_FLAG)){
373             flagsBuilder.setTtl(Integer.valueOf(flags.get(TTL_FLAG).toString()));
374             anyFlag = true;
375         }
376         if(anyFlag){
377             rev160108flags = flagsBuilder.build();
378         }
379          */
380
381         rev160108flags = flagsBuilder.build();
382         return rev160108flags;
383     }
384
385     public static String convAsyncResponseToJsonStringBody(VNFOperation vnfOperation, String rpcName, ResponseContext asyncResponse) throws JsonProcessingException {
386         Builder<?> builder = Converter.convAsyncResponseToBuilder(vnfOperation, rpcName, asyncResponse);
387         Object message = builder.build();
388         ObjectMapper objectMapper = new ObjectMapper();
389         objectMapper.addMixInAnnotations(message.getClass(), MixInFlagsMessage.class);
390         objectMapper.addMixInAnnotations(CommonHeader.class, MixInCommonHeader.class);
391         objectMapper.addMixInAnnotations(Flags.class, MixIn.class);
392         objectMapper.addMixInAnnotations(Status.class, MixIn.class);
393         objectMapper.addMixInAnnotations(Payload.class, MixIn.class);
394         objectMapper.addMixInAnnotations(ZULU.class, MixIn.class);
395
396 //                .configure(SerializationConfig.Feature.SORT_PROPERTIES_ALPHABETICALLY,true)
397         ObjectWriter writer = objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL).configure(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY,true)
398                 .writer(SerializationFeature.WRAP_ROOT_VALUE).withRootName(DMaaP_ROOT_VALUE).withoutFeatures(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS);
399         return writer.writeValueAsString(message);
400     }
401
402     public static String convAsyncResponseToDmaapOutgoingMessageJsonString(VNFOperation vnfOperation, String rpcName, ResponseContext asyncResponse) throws JsonProcessingException {
403         DmaapOutgoingMessage dmaapOutgoingMessage = convAsyncResponseToDmaapOutgoingMessage(vnfOperation, rpcName, asyncResponse);
404         ObjectMapper objectMapper = new ObjectMapper();
405         objectMapper.addMixInAnnotations(dmaapOutgoingMessage.getBody().getOutput().getClass(), MixInFlagsMessage.class);
406         objectMapper.addMixInAnnotations(CommonHeader.class, MixInCommonHeader.class);
407         objectMapper.addMixInAnnotations(Flags.class, MixIn.class);
408         objectMapper.addMixInAnnotations(Status.class, MixIn.class);
409         objectMapper.addMixInAnnotations(Payload.class, MixIn.class);
410         objectMapper.addMixInAnnotations(ZULU.class, MixIn.class);
411
412 //                .configure(SerializationConfig.Feature.SORT_PROPERTIES_ALPHABETICALLY,true)
413         ObjectWriter writer = objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL).configure(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY,true).writer();
414         return writer.writeValueAsString(dmaapOutgoingMessage);
415     }
416
417     public static DmaapOutgoingMessage convAsyncResponseToDmaapOutgoingMessage(VNFOperation vnfOperation, String rpcName, ResponseContext asyncResponse) throws JsonProcessingException {
418         DmaapOutgoingMessage outObj = new DmaapOutgoingMessage();
419         String correlationID = getCorrelationID(asyncResponse);
420         outObj.setCorrelationID(correlationID);
421         outObj.setType("response");
422         outObj.setRpcName(rpcName);
423         Builder<?> builder = Converter.convAsyncResponseToBuilder(vnfOperation, rpcName, asyncResponse);
424         Object messageBody = builder.build();
425         DmaapOutgoingMessage.Body body = new DmaapOutgoingMessage.Body(messageBody);
426         outObj.setBody(body);
427         return outObj;
428     }
429
430     private static String getCorrelationID(ResponseContext context) {
431         return context.getCommonHeader().getRequestId()
432                 + (context.getCommonHeader().getSubRequestId() == null ?
433                     "":"-" + context.getCommonHeader().getSubRequestId());
434     }
435
436     abstract class MixIn {
437         @JsonIgnore
438         abstract Class<? extends DataContainer> getImplementedInterface(); // to be removed during serialization
439
440         @JsonValue
441         abstract java.lang.String getValue();
442     }
443     abstract class MixInCommonHeader extends MixIn {
444         @JsonProperty("api-ver")
445         abstract java.lang.String getApiVer();
446         @JsonProperty("originator-id")
447         abstract java.lang.String getOriginatorId();
448         @JsonProperty("request-id")
449         abstract java.lang.String getRequestId();
450         @JsonProperty("sub-request-id")
451         abstract java.lang.String getSubRequestId();
452
453     }
454     abstract class MixInFlagsMessage extends MixIn {
455         @JsonProperty("common-header")
456         abstract  CommonHeader getCommonHeader();
457     }
458 }