models-interactions/model-impl/appc/src/main/java/org/onap/policy/appc/Response.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.util.HashMap;
  28 import java.util.Map;
  29 import lombok.Getter;
  30 import lombok.Setter;
  31
  32 @Getter
  33 @Setter
  34 public class Response implements Serializable {
  35
  36     private static final long serialVersionUID = 434953706339865151L;
  37
  38     @SerializedName("CommonHeader")
  39     private CommonHeader commonHeader;
  40
  41     /**
  42      * This should only be populated if the incoming message actually has a "Status"
  43      * field. Otherwise, actor.appc will be unable to use this to distinguish between
  44      * Request and Response objects.
  45      */
  46     @SerializedName("Status")
  47     private ResponseStatus status;
  48
  49     @SerializedName("Payload")
  50     private Map<String, Object> payload = new HashMap<>();
  51
  52     public Response() {
  53
  54     }
  55
  56     /**
  57      * Construct an instance from an existing instance.
  58      *
  59      * @param request the existing instance
  60      */
  61     public Response(Request request) {
  62         if (request.getCommonHeader() != null) {
  63             this.commonHeader = new CommonHeader(request.getCommonHeader());
  64         }
  65         if (request.getPayload() != null) {
  66             this.payload.putAll(request.getPayload());
  67         }
  68     }
  69
  70     @Override
  71     public String toString() {
  72         return "Response [CommonHeader=" + commonHeader + ", Status=" + status + ", Payload=" + payload + "]";
  73     }
  74
  75     @Override
  76     public int hashCode() {
  77         final int prime = 31;
  78         int result = 1;
  79         result = prime * result + ((commonHeader == null) ? 0 : commonHeader.hashCode());
  80         result = prime * result + ((payload == null) ? 0 : payload.hashCode());
  81         result = prime * result + ((status == null) ? 0 : status.hashCode());
  82         return result;
  83     }
  84
  85     @Override
  86     public boolean equals(Object obj) {
  87         if (this == obj) {
  88             return true;
  89         }
  90         if (obj == null) {
  91             return false;
  92         }
  93         if (getClass() != obj.getClass()) {
  94             return false;
  95         }
  96         Response other = (Response) obj;
  97         if (commonHeader == null) {
  98             if (other.commonHeader != null) {
  99                 return false;
 100             }
 101         } else if (!commonHeader.equals(other.commonHeader)) {
 102             return false;
 103         }
 104         if (payload == null) {
 105             if (other.payload != null) {
 106                 return false;
 107             }
 108         } else if (!payload.equals(other.payload)) {
 109             return false;
 110         }
 111         if (status == null) {
 112             return other.status == null;
 113         } else {
 114             return status.equals(other.status);
 115         }
 116     }
 117 }