PolicyEngineAPI/src/main/java/org/onap/policy/api/PolicyConfigType.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 the Policy Config Types that is used as a part of
  27  * {@link org.onap.policy.api.PolicyParameters}.
  28  *
  29  * @version 0.1
  30  */
  31 public enum PolicyConfigType{
  32         /**
  33          * Indicates Base Config Policy.
  34          */
  35         Base("Base"),
  36         /**
  37          * Indicates ClosedLoop Fault Policy.
  38          */
  39         ClosedLoop_Fault("Fault"),
  40         /**
  41          * Indicates ClosedLoop Performance Metrics Policy.
  42          */
  43         ClosedLoop_PM("PM"),
  44         /**
  45          * Indicates Firewall Config Policy.
  46          */
  47         Firewall("FW"),
  48         /**
  49          * Indicates BRMS based raw DRL Rule Policy.
  50          */
  51         BRMS_RAW("BRMS_Raw"),
  52         /**
  53          * Indicates BRMS based Param DRL policy.
  54          */
  55         BRMS_PARAM("BRMS_Param"),
  56         /**
  57          * Indicates DCAE Micro Service based Policy.
  58          */
  59         MicroService("MS"),
  60         /**
  61          * Indicates OOF Optimization Policy.
  62          */
  63         Optimization("Optimization"),
  64         /**
  65          * Indicates Custom Extended Policy type.
  66          */
  67         Extended("EXTENDED")
  68         ;
  69
  70         private String name;
  71
  72         private PolicyConfigType(String name){
  73                 this.name = name;
  74         }
  75
  76         /**
  77          * Returns the <code>String</code> format of Type for this <code>PolicyClass</code>
  78          * @return the <code>String</code> of the Type for this <code>PolicyClass</code>
  79          */
  80         @Override
  81         public String toString() {
  82                 return name;
  83         }
  84
  85         @JsonCreator
  86     public static PolicyConfigType create (String value) {
  87         for(PolicyConfigType type: values()){
  88             if(type.toString().equals(value) || type.equals(PolicyConfigType.valueOf(value))){
  89                 return type;
  90             }
  91         }
  92         throw new IllegalArgumentException();
  93     }
  94 }