appc-dispatcher/appc-request-handler/appc-request-handler-core/src/main/java/org/openecomp/appc/requesthandler/conv/Converter.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * openECOMP : APP-C
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights
   6  *                                              reserved.
   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
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  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.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.openecomp.appc.requesthandler.conv;
  23
  24 import java.text.ParseException;
  25 import java.text.SimpleDateFormat;
  26 import java.util.Date;
  27 import java.util.TimeZone;
  28
  29 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.Action;
  30 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.AuditOutputBuilder;
  31 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.HealthCheckOutputBuilder;
  32 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.LiveUpgradeOutputBuilder;
  33 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.LockOutputBuilder;
  34 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.ModifyConfigOutputBuilder;
  35 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.Payload;
  36 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.RollbackOutputBuilder;
  37 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.SnapshotOutputBuilder;
  38 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.SoftwareUploadOutputBuilder;
  39 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.StopOutputBuilder;
  40 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.SyncOutputBuilder;
  41 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.TerminateOutputBuilder;
  42 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.TestOutputBuilder;
  43 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.UnlockOutputBuilder;
  44 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.ZULU;
  45 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.common.header.CommonHeader;
  46 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.common.header.CommonHeaderBuilder;
  47 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.common.header.common.header.Flags;
  48 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.common.header.common.header.FlagsBuilder;
  49 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.status.Status;
  50 import org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.status.StatusBuilder;
  51 import org.opendaylight.yangtools.concepts.Builder;
  52 import org.opendaylight.yangtools.yang.binding.DataContainer;
  53 import org.openecomp.appc.domainmodel.lcm.ResponseContext;
  54 import org.openecomp.appc.domainmodel.lcm.VNFOperation;
  55 import org.openecomp.appc.requesthandler.impl.DmaapOutgoingMessage;
  56 import com.att.eelf.configuration.EELFLogger;
  57 import com.att.eelf.configuration.EELFManager;
  58
  59 import com.fasterxml.jackson.annotation.JsonIgnore;
  60 import com.fasterxml.jackson.annotation.JsonInclude;
  61 import com.fasterxml.jackson.annotation.JsonProperty;
  62 import com.fasterxml.jackson.annotation.JsonValue;
  63 import com.fasterxml.jackson.core.JsonProcessingException;
  64 import com.fasterxml.jackson.databind.MapperFeature;
  65 import com.fasterxml.jackson.databind.ObjectMapper;
  66 import com.fasterxml.jackson.databind.ObjectWriter;
  67 import com.fasterxml.jackson.databind.SerializationFeature;
  68
  69
  70 public class Converter {
  71     public static final String ISO_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'";
  72     public static final String MODE_FLAG = "MODE";
  73     public static final String FORCE_FLAG = "FORCE";
  74     public static final String TTL_FLAG = "TTL";
  75     public final static String DMaaP_ROOT_VALUE = "output";
  76     private static final SimpleDateFormat isoFormatter = new SimpleDateFormat(ISO_FORMAT);
  77     private static final EELFLogger logger = EELFManager.getInstance().getLogger(Converter.class);
  78     static {
  79         isoFormatter.setTimeZone(TimeZone.getTimeZone("UTC"));
  80     }
  81
  82     public static Builder<?> convAsyncResponseToBuilder(VNFOperation vnfOperation, String rpcName, ResponseContext response) {
  83         Builder<?> outObj = null;
  84         if(response == null){
  85             throw new IllegalArgumentException("empty asyncResponse");
  86         }
  87         if(vnfOperation == null){
  88             throw new IllegalArgumentException("empty asyncResponse.action");
  89         }
  90         Action action = Action.valueOf(vnfOperation.name());
  91         CommonHeader commonHeader = convAsyncResponseTorev160108CommonHeader(response);
  92         Status status = convAsyncResponseTorev160108Status(response);
  93         switch (action){
  94             case Rollback:
  95                 outObj = new RollbackOutputBuilder();
  96                 ((RollbackOutputBuilder)outObj).setCommonHeader(commonHeader);
  97                 ((RollbackOutputBuilder)outObj).setStatus(status);
  98                 return outObj;
  99             case Snapshot:
 100                 outObj = new SnapshotOutputBuilder();
 101                 ((SnapshotOutputBuilder)outObj).setCommonHeader(commonHeader);
 102                 ((SnapshotOutputBuilder)outObj).setStatus(status);
 103                 try {
 104                     ((SnapshotOutputBuilder) outObj).setSnapshotId(response.getAdditionalContext().get("output.snapshot-id"));
 105                 } catch (NullPointerException ignored) {
 106                     // in case of negative response, snapshotID does not populated, so just ignore NPL
 107                 }
 108                 return outObj;
 109             case Audit:
 110                 outObj = new AuditOutputBuilder();
 111                 ((AuditOutputBuilder)outObj).setCommonHeader(commonHeader);
 112                 ((AuditOutputBuilder)outObj).setStatus(status);
 113                 return outObj;
 114             case HealthCheck:
 115                 outObj = new HealthCheckOutputBuilder();
 116                 ((HealthCheckOutputBuilder)outObj).setCommonHeader(commonHeader);
 117                 ((HealthCheckOutputBuilder)outObj).setStatus(status);
 118                 return outObj;
 119             case LiveUpgrade:
 120                 outObj = new LiveUpgradeOutputBuilder();
 121                 ((LiveUpgradeOutputBuilder)outObj).setCommonHeader(commonHeader);
 122                 ((LiveUpgradeOutputBuilder)outObj).setStatus(status);
 123                 return outObj;
 124             case Lock:
 125                 outObj = new LockOutputBuilder();
 126                 ((LockOutputBuilder)outObj).setCommonHeader(commonHeader);
 127                 ((LockOutputBuilder)outObj).setStatus(status);
 128                 return outObj;
 129             case ModifyConfig:
 130                 outObj = new ModifyConfigOutputBuilder();
 131                 ((ModifyConfigOutputBuilder)outObj).setCommonHeader(commonHeader);
 132                 ((ModifyConfigOutputBuilder)outObj).setStatus(status);
 133                 return outObj;
 134             case SoftwareUpload:
 135                 outObj = new SoftwareUploadOutputBuilder();
 136                 ((SoftwareUploadOutputBuilder)outObj).setCommonHeader(commonHeader);
 137                 ((SoftwareUploadOutputBuilder)outObj).setStatus(status);
 138                 return outObj;
 139             case Stop:
 140                 outObj = new StopOutputBuilder();
 141                 ((StopOutputBuilder)outObj).setCommonHeader(commonHeader);
 142                 ((StopOutputBuilder)outObj).setStatus(status);
 143                 return outObj;
 144             case Sync:
 145                 outObj = new SyncOutputBuilder();
 146                 ((SyncOutputBuilder)outObj).setCommonHeader(commonHeader);
 147                 ((SyncOutputBuilder)outObj).setStatus(status);
 148                 return outObj;
 149             case Terminate:
 150                 outObj = new TerminateOutputBuilder();
 151                 ((TerminateOutputBuilder)outObj).setCommonHeader(commonHeader);
 152                 ((TerminateOutputBuilder)outObj).setStatus(status);
 153                 return outObj;
 154             case Test:
 155                 outObj = new TestOutputBuilder();
 156                 ((TestOutputBuilder)outObj).setCommonHeader(commonHeader);
 157                 ((TestOutputBuilder)outObj).setStatus(status);
 158                 return outObj;
 159             case Unlock:
 160                 outObj = new UnlockOutputBuilder();
 161                 ((UnlockOutputBuilder)outObj).setCommonHeader(commonHeader);
 162                 ((UnlockOutputBuilder)outObj).setStatus(status);
 163                 return outObj;
 164             default:
 165                 throw new IllegalArgumentException(action+" action is not supported");
 166         }
 167     }
 168
 169     public static Payload convAsyncResponseTorev160108Payload(ResponseContext inObj) throws ParseException {
 170         Payload payload = null;
 171         if(inObj.getPayload() != null) {
 172             payload = new Payload(inObj.getPayload());
 173         }
 174         return payload;
 175     }
 176
 177     public static String convPayloadObjectToJsonString(Object inObj) throws ParseException {
 178         String payloadAsString = null;
 179         if(inObj != null) {
 180
 181                 if(inObj instanceof String){
 182                     payloadAsString = (String)inObj;
 183                 }else {
 184                     try {
 185                         ObjectMapper objectMapper = new ObjectMapper();
 186                         payloadAsString = objectMapper.writeValueAsString(inObj);
 187 //                        payloadAsString = objectMapper.writeValueAsString(payloadAsString);
 188                     } catch (JsonProcessingException e) {
 189                         String errMsg = "Error serialize payload json to string";
 190                         throw new ParseException(errMsg + "-" + e.toString(), 0);
 191                     }
 192                 }
 193         }
 194         return payloadAsString;
 195     }
 196
 197     public static Status convAsyncResponseTorev160108Status(ResponseContext inObj) {
 198         StatusBuilder statusBuilder = new StatusBuilder();
 199         statusBuilder.setCode(inObj.getStatus().getCode());
 200         statusBuilder.setMessage(inObj.getStatus().getMessage());
 201         return statusBuilder.build();
 202     }
 203
 204     public static CommonHeader convAsyncResponseTorev160108CommonHeader(ResponseContext inObj) {
 205         CommonHeader outObj = null;
 206         if(inObj == null){
 207             throw new IllegalArgumentException("empty asyncResponse");
 208         }
 209
 210         CommonHeaderBuilder commonHeaderBuilder = new CommonHeaderBuilder();
 211         org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.common.header.common.header.Flags commonHeaderFlags = null;
 212         if(inObj.getCommonHeader().getFlags() != null){
 213             commonHeaderFlags = Converter.convFlagsMapTorev160108Flags(inObj.getCommonHeader().getFlags());
 214             commonHeaderBuilder.setFlags(commonHeaderFlags);
 215         }
 216
 217
 218         commonHeaderBuilder.setApiVer(inObj.getCommonHeader().getApiVer());
 219         commonHeaderBuilder.setRequestId(inObj.getCommonHeader().getRequestId());
 220         if(inObj.getCommonHeader().getSubRequestId() != null){
 221             commonHeaderBuilder.setSubRequestId(inObj.getCommonHeader().getSubRequestId());
 222         }
 223
 224         if(inObj.getCommonHeader().getOriginatorId() != null){
 225             commonHeaderBuilder.setOriginatorId(inObj.getCommonHeader().getOriginatorId());
 226         }
 227
 228         if(inObj.getCommonHeader().getTimeStamp() != null){
 229             String zuluTimestampStr = Converter.convDateToZuluString(Date.from(inObj.getCommonHeader().getTimeStamp()));
 230             ZULU zuluTimestamp = new ZULU(zuluTimestampStr);
 231             commonHeaderBuilder.setTimestamp(zuluTimestamp);
 232         }
 233         outObj = commonHeaderBuilder.build();
 234         return outObj;
 235
 236     }
 237
 238     public static String convDateToZuluString(Date timeStamp) {
 239         return isoFormatter.format(timeStamp);
 240     }
 241
 242     public static org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.common.header.common.header.Flags
 243     convFlagsMapTorev160108Flags(org.openecomp.appc.domainmodel.lcm.Flags flags) {
 244         Flags rev160108flags = null;
 245         boolean anyFlag = false;
 246         FlagsBuilder flagsBuilder = new FlagsBuilder();
 247         /*
 248          * TODO: The below flags are related to APP-C request and should not be sent back - uncomment when response flags are introduced.
 249          */
 250         /*
 251         if(flags.containsKey(FORCE_FLAG)){
 252             org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.common.header.common.header.Flags.Force force =
 253                     org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.common.header.common.header.Flags.Force.valueOf(flags.get(FORCE_FLAG).toString());
 254             flagsBuilder.setForce(force);
 255             anyFlag = true;
 256         }
 257         if(flags.containsKey(MODE_FLAG)){
 258             org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.common.header.common.header.Flags.Mode mode =
 259                     org.opendaylight.yang.gen.v1.org.openecomp.appc.rev160108.common.header.common.header.Flags.Mode.valueOf(flags.get(MODE_FLAG).toString());
 260             flagsBuilder.setMode(mode);
 261             anyFlag = true;
 262         }
 263         if(flags.containsKey(TTL_FLAG)){
 264             flagsBuilder.setTtl(Integer.valueOf(flags.get(TTL_FLAG).toString()));
 265             anyFlag = true;
 266         }
 267         if(anyFlag){
 268             rev160108flags = flagsBuilder.build();
 269         }
 270          */
 271
 272         rev160108flags = flagsBuilder.build();
 273         return rev160108flags;
 274     }
 275
 276     public static String convAsyncResponseToJsonStringBody(VNFOperation vnfOperation, String rpcName, ResponseContext asyncResponse) throws JsonProcessingException {
 277         Builder<?> builder = Converter.convAsyncResponseToBuilder(vnfOperation, rpcName, asyncResponse);
 278         Object message = builder.build();
 279         ObjectMapper objectMapper = new ObjectMapper();
 280         objectMapper.addMixInAnnotations(message.getClass(), MixInFlagsMessage.class);
 281         objectMapper.addMixInAnnotations(CommonHeader.class, MixInCommonHeader.class);
 282         objectMapper.addMixInAnnotations(Flags.class, MixIn.class);
 283         objectMapper.addMixInAnnotations(Status.class, MixIn.class);
 284         objectMapper.addMixInAnnotations(Payload.class, MixIn.class);
 285         objectMapper.addMixInAnnotations(ZULU.class, MixIn.class);
 286
 287 //                              .configure(SerializationConfig.Feature.SORT_PROPERTIES_ALPHABETICALLY,true)
 288         ObjectWriter writer = objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL).configure(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY,true)
 289                 .writer(SerializationFeature.WRAP_ROOT_VALUE).withRootName(DMaaP_ROOT_VALUE).withoutFeatures(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS);
 290         return writer.writeValueAsString(message);
 291     }
 292
 293     public static String convAsyncResponseToDmaapOutgoingMessageJsonString(VNFOperation vnfOperation, String rpcName, ResponseContext asyncResponse) throws JsonProcessingException {
 294         DmaapOutgoingMessage dmaapOutgoingMessage = convAsyncResponseToDmaapOutgoingMessage(vnfOperation, rpcName, asyncResponse);
 295         ObjectMapper objectMapper = new ObjectMapper();
 296         objectMapper.addMixInAnnotations(dmaapOutgoingMessage.getBody().getOutput().getClass(), MixInFlagsMessage.class);
 297         objectMapper.addMixInAnnotations(CommonHeader.class, MixInCommonHeader.class);
 298         objectMapper.addMixInAnnotations(Flags.class, MixIn.class);
 299         objectMapper.addMixInAnnotations(Status.class, MixIn.class);
 300         objectMapper.addMixInAnnotations(Payload.class, MixIn.class);
 301         objectMapper.addMixInAnnotations(ZULU.class, MixIn.class);
 302
 303 //                              .configure(SerializationConfig.Feature.SORT_PROPERTIES_ALPHABETICALLY,true)
 304         ObjectWriter writer = objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL).configure(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY,true).writer();
 305         return writer.writeValueAsString(dmaapOutgoingMessage);
 306     }
 307
 308     public static DmaapOutgoingMessage convAsyncResponseToDmaapOutgoingMessage(VNFOperation vnfOperation, String rpcName, ResponseContext asyncResponse) throws JsonProcessingException {
 309         DmaapOutgoingMessage outObj = new DmaapOutgoingMessage();
 310         outObj.setRpcName(rpcName);
 311         Builder<?> builder = Converter.convAsyncResponseToBuilder(vnfOperation, rpcName, asyncResponse);
 312         Object messageBody = builder.build();
 313         DmaapOutgoingMessage.Body body = new DmaapOutgoingMessage.Body(messageBody);
 314         outObj.setBody(body);
 315         return outObj;
 316     }
 317
 318     abstract class MixIn {
 319         @JsonIgnore
 320         abstract Class<? extends DataContainer> getImplementedInterface(); // to be removed during serialization
 321
 322         @JsonValue
 323         abstract java.lang.String getValue();
 324     }
 325     abstract class MixInCommonHeader extends MixIn {
 326         @JsonProperty("api-ver")
 327         abstract java.lang.String getApiVer();
 328         @JsonProperty("originator-id")
 329         abstract java.lang.String getOriginatorId();
 330         @JsonProperty("request-id")
 331         abstract java.lang.String getRequestId();
 332         @JsonProperty("sub-request-id")
 333         abstract java.lang.String getSubRequestId();
 334
 335     }
 336     abstract class MixInFlagsMessage extends MixIn {
 337         @JsonProperty("common-header")
 338         abstract  CommonHeader getCommonHeader();
 339     }
 340 }