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