src/main/java/org/onap/aai/restclient/client/OperationResult.java

   1 /**\r
   2  * ============LICENSE_START=======================================================\r
   3  * org.onap.aai\r
   4  * ================================================================================\r
   5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.\r
   6  * Copyright © 2017-2018 Amdocs\r
   7  * ================================================================================\r
   8  * Licensed under the Apache License, Version 2.0 (the "License");\r
   9  * you may not use this file except in compliance with the License.\r
  10  * You may obtain a copy of the License at\r
  11  *\r
  12  *       http://www.apache.org/licenses/LICENSE-2.0\r
  13  *\r
  14  * Unless required by applicable law or agreed to in writing, software\r
  15  * distributed under the License is distributed on an "AS IS" BASIS,\r
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  17  * See the License for the specific language governing permissions and\r
  18  * limitations under the License.\r
  19  * ============LICENSE_END=========================================================\r
  20  */\r
  21 package org.onap.aai.restclient.client;\r
  22 \r
  23 import javax.ws.rs.core.MultivaluedMap;\r
  24 \r
  25 public class OperationResult {\r
  26 \r
  27   private String requestedLink;\r
  28   private String result;\r
  29   private String failureCause;\r
  30   private boolean fromCache;\r
  31   private int resultCode;\r
  32   private int numRetries;\r
  33   private MultivaluedMap<String, String> responseHeaders;\r
  34 \r
  35 \r
  36   public OperationResult() {\r
  37     super();\r
  38     this.numRetries = 0;\r
  39     this.fromCache = false;\r
  40   }\r
  41 \r
  42   /**\r
  43    * Instantiates a new operation result.\r
  44    *\r
  45    * @param resultCode the result code\r
  46    * @param result the result\r
  47    */\r
  48   public OperationResult(int resultCode, String result) {\r
  49     this();\r
  50     this.resultCode = resultCode;\r
  51     this.result = result;\r
  52   }\r
  53 \r
  54   /**\r
  55    * Get the HTTP headers of the response.\r
  56    *\r
  57    * @return the HTTP headers of the response.\r
  58    */\r
  59   public MultivaluedMap<String, String> getHeaders() {\r
  60     return responseHeaders;\r
  61   }\r
  62 \r
  63   /**\r
  64    * Returns true if the HTTP Status Code 200 <= x <= 299\r
  65    *\r
  66    * @return true, if successful\r
  67    */\r
  68   public boolean wasSuccessful() {\r
  69     return (resultCode > 199 && resultCode < 300);\r
  70   }\r
  71 \r
  72   public void setHeaders(MultivaluedMap<String, String> headers) {\r
  73     this.responseHeaders = headers;\r
  74   }\r
  75 \r
  76   public String getResult() {\r
  77     return result;\r
  78   }\r
  79 \r
  80   public void setResult(String result) {\r
  81     this.result = result;\r
  82   }\r
  83 \r
  84   public int getResultCode() {\r
  85     return resultCode;\r
  86   }\r
  87 \r
  88   public String getFailureCause() {\r
  89     return failureCause;\r
  90   }\r
  91   \r
  92   /**\r
  93    * Sets the result.\r
  94    *\r
  95    * @param resultCode the result code\r
  96    * @param result the result\r
  97    */\r
  98   public void setResult(int resultCode, String result) {\r
  99     this.resultCode = resultCode;\r
 100     this.result = result;\r
 101   }\r
 102   \r
 103   public void setFailureCause(String failureCause) {\r
 104     this.failureCause = failureCause;\r
 105   }\r
 106 \r
 107   /**\r
 108    * Sets the failure cause.\r
 109    *\r
 110    * @param resultCode the result code\r
 111    * @param failureCause the result error\r
 112    */\r
 113   public void setFailureCause(int resultCode, String failureCause) {\r
 114     this.resultCode = resultCode;\r
 115     this.failureCause = failureCause;\r
 116   }\r
 117 \r
 118   \r
 119   public void setResultCode(int resultCode) {\r
 120     this.resultCode = resultCode;\r
 121   }\r
 122 \r
 123   public String getRequestedLink() {\r
 124     return requestedLink;\r
 125   }\r
 126 \r
 127   public void setRequestedLink(String requestedLink) {\r
 128     this.requestedLink = requestedLink;\r
 129   }\r
 130 \r
 131   public boolean isFromCache() {\r
 132     return fromCache;\r
 133   }\r
 134 \r
 135   public void setFromCache(boolean fromCache) {\r
 136     this.fromCache = fromCache;\r
 137   }\r
 138 \r
 139   public int getNumRetries() {\r
 140     return numRetries;\r
 141   }\r
 142 \r
 143   public void setNumRetries(int numRetries) {\r
 144     this.numRetries = numRetries;\r
 145   }\r
 146 \r
 147   @Override\r
 148   public String toString() {\r
 149     return "OperationResult [result=" + result + ", requestedLink=" + requestedLink\r
 150         + ", failureCause=" + failureCause + ", resultCode=" + resultCode + ", numRetries="\r
 151         + numRetries + ", responseHeaders=" + responseHeaders + "]";\r
 152   }\r
 153 \r
 154 }\r