PolicyEngineAPI/src/main/java/org/openecomp/policy/api/NotificationScheme.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.openecomp.policy.api;
  22
  23 /**
  24  * Enumeration of <code>NotificationScheme</code> describes the Notification Scheme that will be used by the PolicyEngine.
  25  *
  26  * @version 0.1
  27  */
  28 public enum NotificationScheme {
  29         /**
  30          * Notifications for policyUpdates on policy Configs already retrieved
  31          */
  32         AUTO_NOTIFICATIONS("auto_notifications"),
  33         /**
  34          * Subscribing to all notifications from the PDP
  35          */
  36         AUTO_ALL_NOTIFICATIONS("auto_all_notifications"),
  37         /**
  38          * Client can poll for updates that receive policyUpdates on policy Configs that have already been retrieved
  39          */
  40         MANUAL_NOTIFICATIONS("manual_notifications"),
  41         /**
  42          * Client can poll for updates that receive all notifications from the PDP
  43          */
  44         MANUAL_ALL_NOTIFICATIONS("manual_all_notifications")
  45         ;
  46
  47         private String name;
  48         private NotificationScheme(String name){
  49                 this.name = name;
  50         }
  51
  52         /**
  53          * Returns the <code>String</code> name for this <code>NotificationScheme</code>
  54          *
  55          * @return the <code>String</code> name for this <code>NotificationScheme</code>
  56          */
  57         @Override
  58         public String toString(){
  59                 return this.name;
  60         }
  61 }