models-interactions/model-impl/appclcm/src/main/java/org/onap/policy/appclcm/LcmResponse.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * appclcm
   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.appclcm;
  23
  24 import com.google.gson.annotations.SerializedName;
  25
  26 import java.io.Serializable;
  27
  28 public class LcmResponse implements Serializable {
  29
  30     private static final long serialVersionUID = 6332508597287669750L;
  31
  32     @SerializedName(value = "common-header")
  33     private LcmCommonHeader commonHeader;
  34
  35     @SerializedName(value = "status")
  36     private LcmResponseStatus status = new LcmResponseStatus();
  37
  38     @SerializedName(value = "payload")
  39     private String payload;
  40
  41     public LcmResponse() {
  42         // EMPTY
  43     }
  44
  45     /**
  46      * Constructs a response using the common header of the request since they will be the same.
  47      *
  48      * @param request an appc lcm request object specified by the lcm api guide
  49      */
  50     public LcmResponse(LcmRequest request) {
  51         this.commonHeader = new LcmCommonHeader(request.getCommonHeader());
  52         String requestPayload = request.getPayload();
  53         if (requestPayload != null) {
  54             this.payload = requestPayload;
  55         }
  56     }
  57
  58     /**
  59      * Get the common header.
  60      *
  61      * @return the commonHeader
  62      */
  63     public LcmCommonHeader getCommonHeader() {
  64         return commonHeader;
  65     }
  66
  67     /**
  68      * Set the common header.
  69      *
  70      * @param commonHeader the commonHeader to set
  71      */
  72     public void setCommonHeader(LcmCommonHeader commonHeader) {
  73         this.commonHeader = commonHeader;
  74     }
  75
  76     /**
  77      * Get the status.
  78      *
  79      * @return the status
  80      */
  81     public LcmResponseStatus getStatus() {
  82         return status;
  83     }
  84
  85     /**
  86      * Set the status.
  87      *
  88      * @param status the status to set
  89      */
  90     public void setStatus(LcmResponseStatus status) {
  91         this.status = status;
  92     }
  93
  94     /**
  95      * Get the payload.
  96      *
  97      * @return the payload
  98      */
  99     public String getPayload() {
 100         return payload;
 101     }
 102
 103     /**
 104      * Set the payload.
 105      *
 106      * @param payload the payload to set
 107      */
 108     public void setPayload(String payload) {
 109         this.payload = payload;
 110     }
 111
 112     @Override
 113     public String toString() {
 114         return "Response [commonHeader=" + commonHeader + ", status=" + status + ", payload=" + payload + "]";
 115     }
 116
 117     @Override
 118     public int hashCode() {
 119         final int prime = 31;
 120         int result = 1;
 121         result = prime * result + ((commonHeader == null) ? 0 : commonHeader.hashCode());
 122         result = prime * result + ((payload == null) ? 0 : payload.hashCode());
 123         result = prime * result + ((status == null) ? 0 : status.hashCode());
 124         return result;
 125     }
 126
 127     @Override
 128     public boolean equals(Object obj) {
 129         if (this == obj) {
 130             return true;
 131         }
 132         if (obj == null) {
 133             return false;
 134         }
 135         if (getClass() != obj.getClass()) {
 136             return false;
 137         }
 138         LcmResponse other = (LcmResponse) obj;
 139         if (commonHeader == null) {
 140             if (other.commonHeader != null) {
 141                 return false;
 142             }
 143         } else if (!commonHeader.equals(other.commonHeader)) {
 144             return false;
 145         }
 146         if (payload == null) {
 147             if (other.payload != null) {
 148                 return false;
 149             }
 150         } else if (!payload.equals(other.payload)) {
 151             return false;
 152         }
 153         if (status == null) {
 154             if (other.status != null) {
 155                 return false;
 156             }
 157         } else if (!status.equals(other.status)) {
 158             return false;
 159         }
 160         return true;
 161     }
 162 }