models-pdp/src/main/java/org/onap/policy/models/pdp/enums/PdpState.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019 AT&T Intellectual Property.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.models.pdp.enums;
  23
  24 /**
  25  * Class to hold the possible values for state of PDP.
  26  *
  27  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  28  */
  29 public enum PdpState {
  30
  31     /**
  32      * Policy execution is always rejected irrespective of PDP type.
  33      */
  34     PASSIVE,
  35
  36     /**
  37      * Policy execution proceeds, but changes to domain state or context are not carried out. The PDP returns an
  38      * indication that it is running in SAFE mode together with the action it would have performed if it was operating
  39      * in ACTIVE mode.
  40      */
  41     SAFE,
  42
  43     /**
  44      * Policy execution proceeds and changes to domain and state are carried out in a test environment. The PDP returns
  45      * an indication that it is running in TEST mode together with the action it has performed on the test environment.
  46      */
  47     TEST,
  48
  49     /**
  50      * Policy execution is executed in the live environment by the PDP.
  51      */
  52     ACTIVE,
  53
  54     /**
  55      * Policy execution is terminated and not available.
  56      */
  57     TERMINATED
  58 }