models-interactions/model-impl/appc/src/main/java/org/onap/policy/appc/CommonHeader.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * appc
   4  * ================================================================================
   5  * Copyright (C) 2017-2020 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2019 Nordix Foundation.
   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.onap.policy.appc;
  23
  24 import com.google.gson.annotations.SerializedName;
  25 import java.io.Serializable;
  26 import java.time.Instant;
  27 import java.util.ArrayList;
  28 import java.util.Collection;
  29 import java.util.Map;
  30 import java.util.UUID;
  31 import lombok.EqualsAndHashCode;
  32 import lombok.Getter;
  33 import lombok.Setter;
  34
  35 @Getter
  36 @Setter
  37 @EqualsAndHashCode
  38 public class CommonHeader implements Serializable {
  39     private static final long serialVersionUID = -3581658269910980336L;
  40
  41     @SerializedName("TimeStamp")
  42     private Instant timeStamp = Instant.now();
  43
  44     @SerializedName("APIver")
  45     private String apiVer = "1.01";
  46
  47     @SerializedName("OriginatorID")
  48     private String originatorId;
  49
  50     @SerializedName("RequestID")
  51     private UUID requestId;
  52
  53     @SerializedName("SubRequestID")
  54     private String subRequestId;
  55
  56     @SerializedName("RequestTrack")
  57     private Collection<String> requestTrack = new ArrayList<>();
  58
  59     @SerializedName("Flags")
  60     private Collection<Map<String, String>> flags = new ArrayList<>();
  61
  62     public CommonHeader() {
  63         // Default constructor
  64     }
  65
  66     /**
  67      * Construct an instance from an existing instance.
  68      *
  69      * @param commonHeader the existing instance
  70      */
  71     public CommonHeader(CommonHeader commonHeader) {
  72         this.originatorId = commonHeader.originatorId;
  73         this.requestId = commonHeader.requestId;
  74         this.subRequestId = commonHeader.subRequestId;
  75         this.timeStamp = commonHeader.getTimeStamp();
  76         this.apiVer = commonHeader.getApiVer();
  77         if (commonHeader.requestTrack != null) {
  78             this.requestTrack.addAll(commonHeader.requestTrack);
  79         }
  80         if (commonHeader.flags != null) {
  81             this.flags.addAll(commonHeader.flags);
  82         }
  83     }
  84
  85     @Override
  86     public String toString() {
  87         return "CommonHeader [TimeStamp=" + timeStamp + ", APIver=" + apiVer + ", OriginatorId=" + originatorId
  88                 + ", RequestId=" + requestId + ", SubrequestId=" + subRequestId + ", RequestTrack=" + requestTrack
  89                 + ", Flags=" + flags + "]";
  90     }
  91 }