controlloop/common/policy-yaml/src/main/java/org/onap/policy/controlloop/policy/Policy.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * policy-yaml
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.controlloop.policy;
  22
  23 import java.io.Serializable;
  24 import java.util.Collections;
  25 import java.util.Map;
  26 import java.util.UUID;
  27
  28 public class Policy implements Serializable {
  29     private static final long serialVersionUID = 1L;
  30
  31     private String id = UUID.randomUUID().toString();
  32     private String name;
  33     private String description;
  34     private String actor;
  35     private String recipe;
  36     private Map<String, String> payload;
  37     private Target target;
  38     private OperationsAccumulateParams operationsAccumulateParams;
  39     private Integer retry = 0;
  40     private Integer timeout = 300;
  41     private String success = FinalResult.FINAL_SUCCESS.toString();
  42     private String failure = FinalResult.FINAL_FAILURE.toString();
  43     private String failureRetries = FinalResult.FINAL_FAILURE_RETRIES.toString();
  44     private String failureTimeout = FinalResult.FINAL_FAILURE_TIMEOUT.toString();
  45     private String failureException = FinalResult.FINAL_FAILURE_EXCEPTION.toString();
  46     private String failureGuard = FinalResult.FINAL_FAILURE_GUARD.toString();
  47
  48
  49     public Policy() {
  50         //Does Nothing Empty Constructor
  51     }
  52
  53     public Policy(String id) {
  54         this.id = id;
  55     }
  56
  57     /**
  58      * Constructor.
  59      *
  60      * @param name name
  61      * @param actor actor
  62      * @param recipe recipe
  63      * @param payload payload
  64      * @param target target
  65      */
  66     public Policy(String name, String actor, String recipe, Map<String, String> payload, Target target) {
  67         this.name = name;
  68         this.actor = actor;
  69         this.recipe = recipe;
  70         this.target = target;
  71         if (payload != null) {
  72             this.payload = Collections.unmodifiableMap(payload);
  73         }
  74     }
  75
  76     /**
  77      * Constructor.
  78      *
  79      * @param name name
  80      * @param actor actor
  81      * @param recipe recipe
  82      * @param payload payload
  83      * @param target target
  84      * @param retries retries
  85      * @param timeout timeout
  86      */
  87     public Policy(String name, String actor, String recipe, Map<String, String> payload, Target target,
  88                   Integer retries, Integer timeout) {
  89         this(name, actor, recipe, payload, target);
  90         this.retry = retries;
  91         this.timeout = timeout;
  92     }
  93
  94     /**
  95      * Constructor.
  96      *
  97      * @param policyParam provide parameter object
  98      */
  99     public Policy(PolicyParam policyParam) {
 100         this(policyParam.getName(), policyParam.getActor(), policyParam.getRecipe(), policyParam.getPayload(),
 101                 policyParam.getTarget(), policyParam.getRetries(), policyParam.getTimeout());
 102         this.id = policyParam.getId();
 103         this.description = policyParam.getDescription();
 104     }
 105
 106     /**
 107      * Constructor.
 108      *
 109      * @param policy copy object
 110      */
 111     public Policy(Policy policy) {
 112         this.id = policy.id;
 113         this.name = policy.name;
 114         this.description = policy.description;
 115         this.actor = policy.actor;
 116         this.recipe = policy.recipe;
 117         if (policy.payload != null) {
 118             this.payload = Collections.unmodifiableMap(policy.payload);
 119         }
 120         this.target = policy.target;
 121         this.operationsAccumulateParams = policy.operationsAccumulateParams;
 122         this.retry = policy.retry;
 123         this.timeout = policy.timeout;
 124         this.success = policy.success;
 125         this.failure = policy.failure;
 126         this.failureException = policy.failureException;
 127         this.failureGuard = policy.failureGuard;
 128         this.failureRetries = policy.failureRetries;
 129         this.failureTimeout = policy.failureTimeout;
 130     }
 131
 132     public String getId() {
 133         return id;
 134     }
 135
 136     public void setId(String id) {
 137         this.id = id;
 138     }
 139
 140     public String getName() {
 141         return name;
 142     }
 143
 144     public void setName(String name) {
 145         this.name = name;
 146     }
 147
 148     public String getDescription() {
 149         return description;
 150     }
 151
 152     public void setDescription(String description) {
 153         this.description = description;
 154     }
 155
 156     public String getActor() {
 157         return actor;
 158     }
 159
 160     public void setActor(String actor) {
 161         this.actor = actor;
 162     }
 163
 164     public String getRecipe() {
 165         return recipe;
 166     }
 167
 168     public void setRecipe(String recipe) {
 169         this.recipe = recipe;
 170     }
 171
 172     public Map<String, String> getPayload() {
 173         return payload;
 174     }
 175
 176     public void setPayload(Map<String, String> payload) {
 177         this.payload = payload;
 178     }
 179
 180     public Target getTarget() {
 181         return target;
 182     }
 183
 184     public void setTarget(Target target) {
 185         this.target = target;
 186     }
 187
 188     public OperationsAccumulateParams getOperationsAccumulateParams() {
 189         return operationsAccumulateParams;
 190     }
 191
 192     public void setOperationsAccumulateParams(OperationsAccumulateParams operationsAccumulateParams) {
 193         this.operationsAccumulateParams = operationsAccumulateParams;
 194     }
 195
 196     public Integer getRetry() {
 197         return retry;
 198     }
 199
 200     public void setRetry(Integer retry) {
 201         this.retry = retry;
 202     }
 203
 204     public Integer getTimeout() {
 205         return timeout;
 206     }
 207
 208     public void setTimeout(Integer timeout) {
 209         this.timeout = timeout;
 210     }
 211
 212     public String getSuccess() {
 213         return success;
 214     }
 215
 216     public void setSuccess(String success) {
 217         this.success = success;
 218     }
 219
 220     public String getFailure() {
 221         return failure;
 222     }
 223
 224     public void setFailure(String failure) {
 225         this.failure = failure;
 226     }
 227
 228     public String getFailure_retries() {
 229         return failureRetries;
 230     }
 231
 232     public void setFailure_retries(String failureRetries) {
 233         this.failureRetries = failureRetries;
 234     }
 235
 236     public String getFailure_timeout() {
 237         return failureTimeout;
 238     }
 239
 240     public void setFailure_timeout(String failureTimeout) {
 241         this.failureTimeout = failureTimeout;
 242     }
 243
 244     public String getFailure_exception() {
 245         return failureException;
 246     }
 247
 248     public void setFailure_exception(String failureException) {
 249         this.failureException = failureException;
 250     }
 251
 252     public String getFailure_guard() {
 253         return failureGuard;
 254     }
 255
 256     public void setFailure_guard(String failureGuard) {
 257         this.failureGuard = failureGuard;
 258     }
 259
 260     public boolean isValid() {
 261         return id != null && name != null && actor != null && recipe != null && target != null;
 262     }
 263
 264     @Override
 265     public String toString() {
 266         return "Policy [id=" + id + ", name=" + name + ", description=" + description + ", actor=" + actor + ", recipe="
 267                 + recipe + ", payload=" + payload + ", target=" + target + ", operationsAccumulateParams="
 268                 + operationsAccumulateParams + ", retry=" + retry + ", timeout=" + timeout
 269                 + ", success=" + success + ", failure=" + failure + ", failure_retries=" + failureRetries
 270                 + ", failure_timeout=" + failureTimeout + ", failure_exception=" + failureException
 271                 + ", failure_guard=" + failureGuard + "]";
 272     }
 273
 274     @Override
 275     public int hashCode() {
 276         int result = 1;
 277         result = addHashCodeForField(result, actor);
 278         result = addHashCodeForField(result, description);
 279         result = addHashCodeForField(result, failure);
 280         result = addHashCodeForField(result, failureException);
 281         result = addHashCodeForField(result, failureGuard);
 282         result = addHashCodeForField(result, failureRetries);
 283         result = addHashCodeForField(result, failureTimeout);
 284         result = addHashCodeForField(result, id);
 285         result = addHashCodeForField(result, name);
 286         result = addHashCodeForField(result, payload);
 287         result = addHashCodeForField(result, recipe);
 288         result = addHashCodeForField(result, retry);
 289         result = addHashCodeForField(result, success);
 290         result = addHashCodeForField(result, target);
 291         result = addHashCodeForField(result, operationsAccumulateParams);
 292         result = addHashCodeForField(result, timeout);
 293         return result;
 294     }
 295
 296     private int addHashCodeForField(int hashCode, Object field) {
 297         final int prime = 31;
 298         return prime * hashCode + ((field == null) ? 0 : field.hashCode());
 299     }
 300
 301     @Override
 302     public boolean equals(Object obj) {
 303         if (this == obj) {
 304             return true;
 305         }
 306         if (obj == null) {
 307             return false;
 308         }
 309         if (getClass() != obj.getClass()) {
 310             return false;
 311         }
 312         Policy other = (Policy) obj;
 313         return equalsMayBeNull(actor, other.actor)
 314                 && equalsMayBeNull(description, other.description)
 315                 && equalsMayBeNull(failure, other.failure)
 316                 && equalsMayBeNull(failureException, other.failureException)
 317                 && equalsMayBeNull(failureGuard, other.failureGuard)
 318                 && equalsMayBeNull(failureRetries, other.failureRetries)
 319                 && equalsMayBeNull(id, other.id)
 320                 && equalsMayBeNull(name, other.name)
 321                 && equalsMayBeNull(payload, other.payload)
 322                 && equalsMayBeNull(recipe, other.recipe)
 323                 && equalsMayBeNull(retry, other.retry)
 324                 && equalsMayBeNull(success, other.success)
 325                 && equalsMayBeNull(operationsAccumulateParams, other.operationsAccumulateParams)
 326                 && equalsMayBeNull(target, other.target)
 327                 && equalsMayBeNull(timeout, other.timeout);
 328     }
 329
 330     private boolean equalsMayBeNull(final Object obj1, final Object obj2) {
 331         if ( obj1 == null ) {
 332             return obj2 == null;
 333         }
 334         return obj1.equals(obj2);
 335     }
 336 }