src/main/java/org/openecomp/restclient/client/OperationResult.java

   1 /**\r
   2  * ============LICENSE_START=======================================================\r
   3  * org.onap.aai\r
   4  * ================================================================================\r
   5  * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * Copyright © 2017 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  * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  22  */\r
  23 package org.openecomp.restclient.client;\r
  24 \r
  25 import javax.ws.rs.core.MultivaluedMap;\r
  26 \r
  27 public class OperationResult {\r
  28 \r
  29   private String requestedLink;\r
  30   private String result;\r
  31   private String failureCause;\r
  32   private boolean fromCache;\r
  33   private int resultCode;\r
  34   private int numRetries;\r
  35   private MultivaluedMap<String, String> responseHeaders;\r
  36 \r
  37 \r
  38   public OperationResult() {\r
  39     super();\r
  40     this.numRetries = 0;\r
  41     this.fromCache = false;\r
  42   }\r
  43 \r
  44   /**\r
  45    * Instantiates a new operation result.\r
  46    *\r
  47    * @param resultCode the result code\r
  48    * @param result the result\r
  49    */\r
  50   public OperationResult(int resultCode, String result) {\r
  51     this();\r
  52     this.resultCode = resultCode;\r
  53     this.result = result;\r
  54   }\r
  55 \r
  56   /**\r
  57    * Get the HTTP headers of the response.\r
  58    *\r
  59    * @return the HTTP headers of the response.\r
  60    */\r
  61   public MultivaluedMap<String, String> getHeaders() {\r
  62     return responseHeaders;\r
  63   }\r
  64 \r
  65   /**\r
  66    * Returns true if the HTTP Status Code 200 <= x <= 299\r
  67    *\r
  68    * @return true, if successful\r
  69    */\r
  70   public boolean wasSuccessful() {\r
  71     return (resultCode > 199 && resultCode < 300);\r
  72   }\r
  73 \r
  74   public void setHeaders(MultivaluedMap<String, String> headers) {\r
  75     this.responseHeaders = headers;\r
  76   }\r
  77 \r
  78   public String getResult() {\r
  79     return result;\r
  80   }\r
  81 \r
  82   public void setResult(String result) {\r
  83     this.result = result;\r
  84   }\r
  85 \r
  86   public int getResultCode() {\r
  87     return resultCode;\r
  88   }\r
  89 \r
  90   public String getFailureCause() {\r
  91     return failureCause;\r
  92   }\r
  93   \r
  94   /**\r
  95    * Sets the result.\r
  96    *\r
  97    * @param resultCode the result code\r
  98    * @param result the result\r
  99    */\r
 100   public void setResult(int resultCode, String result) {\r
 101     this.resultCode = resultCode;\r
 102     this.result = result;\r
 103   }\r
 104   \r
 105   public void setFailureCause(String failureCause) {\r
 106     this.failureCause = failureCause;\r
 107   }\r
 108 \r
 109   /**\r
 110    * Sets the failure cause.\r
 111    *\r
 112    * @param resultCode the result code\r
 113    * @param failureCause the result error\r
 114    */\r
 115   public void setFailureCause(int resultCode, String failureCause) {\r
 116     this.resultCode = resultCode;\r
 117     this.failureCause = failureCause;\r
 118   }\r
 119 \r
 120   \r
 121   public void setResultCode(int resultCode) {\r
 122     this.resultCode = resultCode;\r
 123   }\r
 124 \r
 125   public String getRequestedLink() {\r
 126     return requestedLink;\r
 127   }\r
 128 \r
 129   public void setRequestedLink(String requestedLink) {\r
 130     this.requestedLink = requestedLink;\r
 131   }\r
 132 \r
 133   public boolean isFromCache() {\r
 134     return fromCache;\r
 135   }\r
 136 \r
 137   public void setFromCache(boolean fromCache) {\r
 138     this.fromCache = fromCache;\r
 139   }\r
 140 \r
 141   public int getNumRetries() {\r
 142     return numRetries;\r
 143   }\r
 144 \r
 145   public void setNumRetries(int numRetries) {\r
 146     this.numRetries = numRetries;\r
 147   }\r
 148 \r
 149   @Override\r
 150   public String toString() {\r
 151     return "OperationResult [result=" + result + ", requestedLink=" + requestedLink\r
 152         + ", failureCause=" + failureCause + ", resultCode=" + resultCode + ", numRetries="\r
 153         + numRetries + ", responseHeaders=" + responseHeaders + "]";\r
 154   }\r
 155 \r
 156 }\r