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     private final String name;
  46
  47     private PolicyResponseStatus(final String name) {
  48         this.name = name;
  49     }
  50
  51     /**
  52      * Get the <code>PolicyResponseStatus</code> based on <code>String</code>
  53      * representation of <code>PolicyResponse</code>
  54      *
  55      * @param responseStatus
  56      *            the <code>String</code> Response Status
  57      * @return the <code>PolicyResponseStatus</code> with the name matching
  58      *         <code>ACTION_ADVISED</code> or <code>ACTION_TAKEN</code> or
  59      *         <code>NO_ACTION_REQUIRED</code>
  60      */
  61     public static PolicyResponseStatus getStatus(final String responseStatus) {
  62         if (ACTION_ADVISED.name.equalsIgnoreCase(responseStatus)) {
  63             return ACTION_ADVISED;
  64         } else if (ACTION_TAKEN.name.equalsIgnoreCase(responseStatus)) {
  65             return ACTION_TAKEN;
  66         } else {
  67             return NO_ACTION_REQUIRED;
  68         }
  69     }
  70
  71     /**
  72      * Returns the <code>String</code> name for this
  73      * <code>PolicyResponseStatus</code>
  74      *
  75      * @return the <code>String</code> name for this
  76      *         <code>PolicyResponseStatus</code>
  77      */
  78     @Override
  79     public String toString() {
  80         return this.name;
  81     }
  82
  83     @JsonCreator
  84     public static PolicyResponseStatus create(final String value) {
  85         for (final PolicyResponseStatus type : values()) {
  86             if (type.toString().equalsIgnoreCase(value) || type.name().equalsIgnoreCase(value)) {
  87                 return type;
  88             }
  89         }
  90         throw new IllegalArgumentException("Invalid value: " + value);
  91     }
  92 }