PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyResponseStatus.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * PolicyEngineAPI
   4  * ================================================================================
   5  * Copyright (C) 2017 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.api;
  22
  23 import com.fasterxml.jackson.annotation.JsonCreator;
  24
  25 /**
  26  * Enumeration of PolicyResponseStatus that can be returned as a part of
  27  * {@link org.onap.policy.api.PolicyResponse}.
  28  *
  29  * @version 0.2
  30  */
  31 public enum PolicyResponseStatus {
  32         /**
  33          * Indicates there is no action required.
  34          */
  35         NO_ACTION_REQUIRED("no_action"),
  36         /**
  37          * Indicates that an action has been advised.
  38          */
  39         ACTION_ADVISED("action_advised"),
  40         /**
  41          * Indicates that an action has been taken.
  42          */
  43         ACTION_TAKEN("action_taken")
  44         ;
  45
  46         private String name;
  47         private PolicyResponseStatus(String name){
  48                 this.name = name;
  49         }
  50
  51         /**
  52          * Get the <code>PolicyResponseStatus</code> based on <code>String</code> representation of <code>PolicyResponse</code>
  53          *
  54          * @param responseStatus the <code>String</code> Response Status
  55          * @return the <code>PolicyResponseStatus</code> with the name matching <code>ACTION_ADVISED</code> or <code>ACTION_TAKEN</code> or <code>NO_ACTION_REQUIRED</code>
  56          */
  57         public static PolicyResponseStatus getStatus(String responseStatus) {
  58                 if(responseStatus.equalsIgnoreCase("action_advised")) {
  59                         return ACTION_ADVISED;
  60                 }else if(responseStatus.equalsIgnoreCase("action_taken")) {
  61                         return ACTION_TAKEN;
  62                 }else {
  63                         return NO_ACTION_REQUIRED;
  64                 }
  65         }
  66
  67         /**
  68          * Returns the <code>String</code> name for this <code>PolicyResponseStatus</code>
  69          *
  70          * @return the <code>String</code> name for this <code>PolicyResponseStatus</code>
  71          */
  72         public String toString(){
  73                 return this.name;
  74         }
  75
  76         @JsonCreator
  77     public static PolicyResponseStatus create (String value) {
  78         for(PolicyResponseStatus type: values()){
  79             if(type.toString().equals(value) || type.equals(PolicyResponseStatus.valueOf(value))){
  80                 return type;
  81             }
  82         }
  83         throw new IllegalArgumentException();
  84     }
  85 }