src/main/java/org/onap/clamp/loop/components/external/ExternalComponentState.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP CLAMP
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights
   6  *                             reserved.
   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  */
  23
  24 package org.onap.clamp.loop.components.external;
  25
  26 import com.google.gson.annotations.Expose;
  27
  28 /**
  29  * This is a transient state reflecting the deployment status of a component. It
  30  * can be Policy, DCAE, or whatever... This is object is generic. Clamp is now
  31  * stateless, so it triggers the different components at runtime, the status per
  32  * component is stored here. The state level is used to re-compute the global
  33  * state when multiple sub states are required for that computation (generally
  34  * provided sequentially to the method computeState from the camel routes.
  35  *
  36  */
  37 public class ExternalComponentState implements Comparable<ExternalComponentState> {
  38     @Expose
  39     private String stateName;
  40     @Expose
  41     private String description;
  42     private int stateLevel;
  43
  44     /**
  45      * Constructor taking stateName, description and its level.
  46      *
  47      * @param stateName   The stateName in string
  48      * @param description The description in string
  49      * @param level       The level, higher value has higher priority and can't be
  50      *                    down-graded
  51      */
  52     public ExternalComponentState(String stateName, String description, int level) {
  53         this.stateName = stateName;
  54         this.description = description;
  55         this.stateLevel = level;
  56     }
  57
  58     public ExternalComponentState(String stateName, String description) {
  59         this(stateName, description, 0);
  60     }
  61
  62     public ExternalComponentState() {
  63     }
  64
  65     public String getStateName() {
  66         return stateName;
  67     }
  68
  69     public String getDescription() {
  70         return description;
  71     }
  72
  73     @Override
  74     public String toString() {
  75         return stateName;
  76     }
  77
  78     public int getLevel() {
  79         return stateLevel;
  80     }
  81
  82     public void setLevel(int priority) {
  83         this.stateLevel = priority;
  84     }
  85
  86     @Override
  87     public int hashCode() {
  88         final int prime = 31;
  89         int result = 1;
  90         result = prime * result + ((stateName == null) ? 0 : stateName.hashCode());
  91         return result;
  92     }
  93
  94     @Override
  95     public boolean equals(Object obj) {
  96         if (this == obj) {
  97             return true;
  98         }
  99         if (obj == null) {
 100             return false;
 101         }
 102         if (getClass() != obj.getClass()) {
 103             return false;
 104         }
 105         ExternalComponentState other = (ExternalComponentState) obj;
 106         if (stateName == null) {
 107             if (other.stateName != null) {
 108                 return false;
 109             }
 110         } else if (!stateName.equals(other.stateName)) {
 111             return false;
 112         }
 113         return true;
 114     }
 115
 116     /**
 117      * This method compares this object by using the level of them.
 118      *
 119      * @param stateToCompare The state to compare to the current object
 120      * @return If the one given in input has a higher level than the current object
 121      *         it returns -1, 1 otherwise and 0 if equals.
 122      */
 123     @Override
 124     public int compareTo(ExternalComponentState stateToCompare) {
 125         return Integer.compare(this.getLevel(), stateToCompare.getLevel());
 126     }
 127
 128 }