PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyDecision.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 PolicyDecision that can be returned as a part of
  27  * {@link org.onap.policy.api.DecisionResponse} getDecision().
  28  *
  29  * @version 0.1
  30  */
  31 public enum PolicyDecision {
  32     /**
  33      * Indicates that the Decision is to Permit.
  34      */
  35     PERMIT("permit"),
  36     /**
  37      * Indicates that the Decision is to Deny.
  38      */
  39     DENY("deny"),
  40     /**
  41      * Indicates that the Decision process has some issues.
  42      */
  43     ERROR("error");
  44
  45     private final String name;
  46
  47     private PolicyDecision(final String name) {
  48         this.name = name;
  49     }
  50
  51     /**
  52      * Returns the <code>String</code> name for this <code>PolicyDecision</code>
  53      *
  54      * @return the <code>String</code> name for this <code>PolicyDecision</code>
  55      */
  56     @Override
  57     public String toString() {
  58         return this.name;
  59     }
  60
  61     @JsonCreator
  62     public static PolicyDecision create(final String value) {
  63         for (final PolicyDecision type : values()) {
  64             if (type.toString().equalsIgnoreCase(value) || type.name().equalsIgnoreCase(value)) {
  65                 return type;
  66             }
  67         }
  68         throw new IllegalArgumentException("Invalid value: " + value);
  69     }
  70 }