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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019, 2021 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 the type of PDP messages.
  26  *
  27  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  28  */
  29 public enum PdpMessageType {
  30
  31     /**
  32      * Used by PDPs to report status to PAP.
  33      */
  34     PDP_STATUS,
  35
  36     /**
  37      * Used by PAP to update the policies running on PDPs, triggers a PDP_STATUS message with the result of the
  38      * PDP_UPDATE operation.
  39      */
  40     PDP_UPDATE,
  41
  42     /**
  43      * Used by PAP to change the state of PDPs, triggers a PDP_STATUS message with the result of the PDP_STATE_CHANGE
  44      * operation.
  45      */
  46     PDP_STATE_CHANGE,
  47
  48     /**
  49      * Used by PAP to order a health check on PDPs, triggers a PDP_STATUS message with the result of the
  50      * PDP_HEALTH_CHECK operation.
  51      */
  52     PDP_HEALTH_CHECK,
  53
  54     /**
  55      * Used by PDPs to check their ability to send and receive messages on the PDP-PAP topic.
  56      */
  57     PDP_TOPIC_CHECK,
  58 }