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-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
  26 import java.io.Serializable;
  27 import java.util.HashMap;
  28 import java.util.Map;
  29 import lombok.EqualsAndHashCode;
  30 import lombok.Getter;
  31 import lombok.Setter;
  32
  33 @Getter
  34 @Setter
  35 @EqualsAndHashCode
  36 public class Response implements Serializable {
  37
  38     private static final long serialVersionUID = 434953706339865151L;
  39
  40     @SerializedName("CommonHeader")
  41     private CommonHeader commonHeader;
  42
  43     /**
  44      * This should only be populated if the incoming message actually has a "Status"
  45      * field. Otherwise, actor.appc will be unable to use this to distinguish between
  46      * Request and Response objects.
  47      */
  48     @SerializedName("Status")
  49     private ResponseStatus status;
  50
  51     @SerializedName("Payload")
  52     private Map<String, Object> payload = new HashMap<>();
  53
  54     public Response() {
  55
  56     }
  57
  58     /**
  59      * Construct an instance from an existing instance.
  60      *
  61      * @param request the existing instance
  62      */
  63     public Response(Request request) {
  64         if (request.getCommonHeader() != null) {
  65             this.commonHeader = new CommonHeader(request.getCommonHeader());
  66         }
  67         if (request.getPayload() != null) {
  68             this.payload.putAll(request.getPayload());
  69         }
  70     }
  71
  72     @Override
  73     public String toString() {
  74         return "Response [CommonHeader=" + commonHeader + ", Status=" + status + ", Payload=" + payload + "]";
  75     }
  76 }