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-2019 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
  26 import java.io.Serializable;
  27 import java.time.Instant;
  28 import java.util.ArrayList;
  29 import java.util.Collection;
  30 import java.util.Map;
  31 import java.util.UUID;
  32
  33 import lombok.Getter;
  34 import lombok.Setter;
  35
  36 @Getter
  37 @Setter
  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
  92     @Override
  93     public int hashCode() {
  94         final int prime = 31;
  95         int result = 1;
  96         result = prime * result + ((apiVer == null) ? 0 : apiVer.hashCode());
  97         result = prime * result + ((flags == null) ? 0 : flags.hashCode());
  98         result = prime * result + ((originatorId == null) ? 0 : originatorId.hashCode());
  99         result = prime * result + ((requestId == null) ? 0 : requestId.hashCode());
 100         result = prime * result + ((requestTrack == null) ? 0 : requestTrack.hashCode());
 101         result = prime * result + ((subRequestId == null) ? 0 : subRequestId.hashCode());
 102         result = prime * result + ((timeStamp == null) ? 0 : timeStamp.hashCode());
 103         return result;
 104     }
 105
 106     @Override
 107     public boolean equals(Object obj) {
 108         if (this == obj) {
 109             return true;
 110         }
 111         if (obj == null) {
 112             return false;
 113         }
 114         if (getClass() != obj.getClass()) {
 115             return false;
 116         }
 117         CommonHeader other = (CommonHeader) obj;
 118         if (apiVer == null) {
 119             if (other.apiVer != null) {
 120                 return false;
 121             }
 122         } else if (!apiVer.equals(other.apiVer)) {
 123             return false;
 124         }
 125         if (flags == null) {
 126             if (other.flags != null) {
 127                 return false;
 128             }
 129         } else if (!flags.equals(other.flags)) {
 130             return false;
 131         }
 132         if (originatorId == null) {
 133             if (other.originatorId != null) {
 134                 return false;
 135             }
 136         } else if (!originatorId.equals(other.originatorId)) {
 137             return false;
 138         }
 139         if (requestId == null) {
 140             if (other.requestId != null) {
 141                 return false;
 142             }
 143         } else if (!requestId.equals(other.requestId)) {
 144             return false;
 145         }
 146         if (requestTrack == null) {
 147             if (other.requestTrack != null) {
 148                 return false;
 149             }
 150         } else if (!requestTrack.equals(other.requestTrack)) {
 151             return false;
 152         }
 153         if (subRequestId == null) {
 154             if (other.subRequestId != null) {
 155                 return false;
 156             }
 157         } else if (!subRequestId.equals(other.subRequestId)) {
 158             return false;
 159         }
 160         if (timeStamp == null) {
 161             return other.timeStamp == null;
 162         } else {
 163             return timeStamp.equals(other.timeStamp);
 164         }
 165     }
 166 }