dcae-analytics-cdap-common/src/main/java/org/openecomp/dcae/apod/analytics/cdap/common/CDAPComponentsConstants.java

   1 /*\r
   2  * ===============================LICENSE_START======================================\r
   3  *  dcae-analytics\r
   4  * ================================================================================\r
   5  *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * ================================================================================\r
   7  *  Licensed under the Apache License, Version 2.0 (the "License");\r
   8  *  you may not use this file except in compliance with the License.\r
   9  *   You may obtain a copy of the License at\r
  10  *\r
  11  *          http://www.apache.org/licenses/LICENSE-2.0\r
  12  *\r
  13  *  Unless required by applicable law or agreed to in writing, software\r
  14  *  distributed under the License is distributed on an "AS IS" BASIS,\r
  15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  *  See the License for the specific language governing permissions and\r
  17  *  limitations under the License.\r
  18  *  ============================LICENSE_END===========================================\r
  19  */\r
  20 \r
  21 package org.openecomp.dcae.apod.analytics.cdap.common;\r
  22 \r
  23 /**\r
  24  *  Contains static constant variable names and values of all DCAE CDAP Components for\r
  25  *  e.g. app names, app descriptions, streams, datasets, flows, flowlets, workers, outputs etc.\r
  26  *\r
  27  *  <p>\r
  28  *      A strict naming convention must be followed for variable names for CDAP Components names for proper\r
  29  *      identification of CDAP Component variable purpose and function. A custom configuration settings can be\r
  30  *      generated for app\r
  31  *      deployment purposes based on variable naming conventions.\r
  32  *\r
  33  *      The variable names should have 4 parts separated by an underscore:\r
  34  *          <ul>\r
  35  *              <li>Name of the DCAE sub module (e.g. TCA) to which variable is applicable</li>\r
  36  *              <li>Information about variable name:\r
  37  *                  <ul>\r
  38  *                      <li>FIXED - if variable value is fixed and cannot be changed</li>\r
  39  *                      <li>DEFAULT - if variable name is default name and can be changed by cdap settings file\r
  40  *                                    when application is created</li>\r
  41  *                  </ul>\r
  42  *              </li>\r
  43  *              <li>Actual Descriptive name about the CDAP component (may contain underscrores) </li>\r
  44  *              <li>CDAP component type e.g STREAM, DATASET, APP, FLOW, FLOWLET, OUTPUT</li>\r
  45  *          </ul>\r
  46  *\r
  47  *  <p>e.g TCA_DEFAULT_DMAAP_INPUT_STREAM</p>\r
  48  *\r
  49  *  <p><strong>RegEx Format (DCAE MODULE NAME)_(FIXED|DEFAULT)_(VARIABLE NAME)_(CDAP COMPONENT TYPE)</strong></p>\r
  50  *\r
  51  * @author Rajiv Singla . Creation Date: 10/24/2016.\r
  52  */\r
  53 public abstract class CDAPComponentsConstants {\r
  54 \r
  55     // ===============  Common Module Constants ==================== //\r
  56 \r
  57     /**\r
  58      * Default DCAE App Name. It should be overriden by sub modules\r
  59      */\r
  60     public static final String COMMON_DEFAULT_DCAE_CDAP_NAME_APP = "DCAE_ANALYTICS_GENERIC_APP";\r
  61 \r
  62     /**\r
  63      * Default DCAE App Description. It should be overriden by sub modules\r
  64      */\r
  65     public static final String COMMON_DEFAULT_DCAE_CDAP_DESCRIPTION_APP = "DCAE ANALYTICS GENERIC APP DESCRIPTION";\r
  66 \r
  67     // ===============  TCA Module Constants ==================== //\r
  68 \r
  69     /**\r
  70      * Default TCA application name if application name is not provided from startup configuration\r
  71      */\r
  72     public static final String TCA_DEFAULT_NAME_APP = "dcae-tca";\r
  73 \r
  74     /**\r
  75      * Default TCA application description if not provided from startup configuration\r
  76      */\r
  77     public static final String TCA_DEFAULT_DESCRIPTION_APP = "DCAE Analytics Threshold Crossing Alert Application";\r
  78 \r
  79     /**\r
  80      * Default TCA DMaaP Subscriber output stream name if not provided from startup configuration\r
  81      */\r
  82     public static final String TCA_DEFAULT_SUBSCRIBER_OUTPUT_NAME_STREAM = "TCASubscriberOutputStream";\r
  83 \r
  84 \r
  85     /**\r
  86      * Fixed TCA DMaaP Subscriber output stream description\r
  87      */\r
  88     public static final String TCA_FIXED_SUBSCRIBER_OUTPUT_DESCRIPTION_STREAM =\r
  89             "Stream which contains all message from VES Collector DMaaP MR topic";\r
  90 \r
  91 \r
  92     /**\r
  93      * Fixed Name of TCA DMaaP Subscriber Worker - which will be fetching DMaaP Messages posting them to CDAP stream\r
  94      */\r
  95     public static final String TCA_FIXED_DMAAP_SUBSCRIBER_WORKER = "TCADMaaPMRSubscriberWorker";\r
  96 \r
  97     /**\r
  98      * Fixed Description of TCA DMaaP Subscriber Worker\r
  99      */\r
 100     public static final String TCA_FIXED_DMAAP_SUBSCRIBER_DESCRIPTION_WORKER =\r
 101             "Fetches messages from DMaaP MR Topic at frequent intervals and writes them to a CDAP stream";\r
 102 \r
 103     /**\r
 104      * Fixed Name of TCA DMaaP Publisher Worker - which will be publishing messages to DMaaP MR\r
 105      */\r
 106     public static final String TCA_FIXED_DMAAP_PUBLISHER_WORKER = "TCADMaaPMRPublisherWorker";\r
 107 \r
 108     /**\r
 109      * Fixed Description of TCA DMaaP Publisher Worker\r
 110      */\r
 111     public static final String TCA_FIXED_DMAAP_PUBLISHER_DESCRIPTION_WORKER =\r
 112             "Polls TCA Alerts Table at frequent intervals for new alerts and publishes them to DMaaP MR Topic";\r
 113 \r
 114     /**\r
 115      * Fixed name for TCA VES Collector Messages Processing Flow\r
 116      */\r
 117     public static final String TCA_FIXED_VES_COLLECTOR_NAME_FLOW = "TCAVESCollectorFlow";\r
 118 \r
 119 \r
 120     /**\r
 121      * Fixed description for TCA VES Collector Messages Processing Flow\r
 122      */\r
 123     public static final String TCA_FIXED_VES_COLLECTOR_DESCRIPTION_FLOW = "Flow performs TCA on VES Collector Messages";\r
 124 \r
 125 \r
 126     /**\r
 127      * Fixed Name for TCA VES Message Router Flowlet\r
 128      */\r
 129     public static final String TCA_FIXED_VES_MESSAGE_ROUTER_NAME_FLOWLET = "TCAVESMessageRouterFlowlet";\r
 130 \r
 131     /**\r
 132      * Fixed Description for TCA VES Message Router Flowlet\r
 133      */\r
 134     public static final String TCA_FIXED_VES_MESSAGE_ROUTER_DESCRIPTION_FLOWLET =\r
 135             "Routes message received from TCA VES Collector to TCA Threshold Calculator Flowlet instances";\r
 136 \r
 137     /**\r
 138      * Fixed TCA VES Message Router Flowlet Output\r
 139      */\r
 140     public static final String TCA_FIXED_VES_MESSAGE_ROUTER_OUTPUT = "TCAVESMessageRouterFlowlet";\r
 141 \r
 142     /**\r
 143      * Fixed Name for TCA VES Message Policy Violated Threshold Calculator Flowlet\r
 144      */\r
 145     public static final String TCA_FIXED_VES_THRESHOLD_VIOLATION_CALCULATOR_NAME_FLOWLET =\r
 146             "TCAVESThresholdViolationCalculatorFlowlet";\r
 147 \r
 148     /**\r
 149      * Fixed Description for TCA VES Message Policy Violated Threshold Calculator Flowlet\r
 150      */\r
 151     public static final String TCA_FIXED_VES_THRESHOLD_VIOLATION_CALCULATOR_DESCRIPTION_FLOWLET =\r
 152             "Applies TCA Policy Thresholds to VES Message and determined if any message violated TCA Policy thresholds";\r
 153 \r
 154     /**\r
 155      * Fixed Name for TCA VES Message Policy Violated Threshold Calculator Output\r
 156      */\r
 157     public static final String TCA_FIXED_VES_TCA_CALCULATOR_NAME_OUTPUT = "TCAThresholdViolationCalculatorOutput";\r
 158 \r
 159 \r
 160     /**\r
 161      * Fixed Name for TCA VES Alerts Abatement Flowlet\r
 162      */\r
 163     public static final String TCA_FIXED_VES_ALERTS_ABATEMENT_NAME_FLOWLET = "TCAVESAlertsAbatementFlowlet";\r
 164 \r
 165     /**\r
 166      * Fixed Description for TCA VES Alerts Abatement Flowlet\r
 167      */\r
 168     public static final String TCA_FIXED_VES_ALERTS_ABATEMENT_DESCRIPTION_FLOWLET =\r
 169             "Determines if abatement event needs to be posted to downstream systems";\r
 170 \r
 171     /**\r
 172      * Fixed Name for TCA VES Alerts Abatement Flowlet output\r
 173      */\r
 174     public static final String TCA_FIXED_VES_ALERTS_ABATEMENT_NAME_OUTPUT = "TCAVESAlertsAbatementFlowletOutput";\r
 175 \r
 176 \r
 177     /**\r
 178      * Fixed Name for TCA VES A&AI Enrichment Flowlet\r
 179      */\r
 180     public static final String TCA_FIXED_VES_AAI_ENRICHMENT_NAME_FLOWLET = "TCAVESAAIEnrichmentFlowlet";\r
 181 \r
 182     /**\r
 183      * Fixed Description for TCA VES A&AI Enrichment Flowlet\r
 184      */\r
 185     public static final String TCA_FIXED_VES_AAI_ENRICHMENT_DESCRIPTION_FLOWLET =\r
 186             "Performs A&AI Enrichment of non abated alerts";\r
 187 \r
 188     /**\r
 189      * Fixed Name for TCA VES A&AI Enrichment Flowlet output\r
 190      */\r
 191     public static final String TCA_FIXED_VES_AAI_ENRICHMENT_NAME_OUTPUT = "TCAVESAAIEnrichmentFlowletOutput";\r
 192 \r
 193     /**\r
 194      * Fixed Name for TCA VES Alerts Sink Flowlet\r
 195      */\r
 196     public static final String TCA_FIXED_VES_ALERTS_SINK_NAME_FLOWLET = "TCAVESAlertsSinkFlowlet";\r
 197 \r
 198     /**\r
 199      * Fixed Description for TCA VES Alerts Sink Flowlet\r
 200      */\r
 201     public static final String TCA_FIXED_VES_ALERTS_SINK_DESCRIPTION_FLOWLET =\r
 202             "Saves messages which violated TCA Policy in a data set";\r
 203 \r
 204 \r
 205     /**\r
 206      * Default Name for TCA VES Message status table which contain status of all messages processed by TCA\r
 207      */\r
 208     public static final String TCA_DEFAULT_VES_MESSAGE_STATUS_NAME_TABLE = "TCAVESMessageStatusTable";\r
 209 \r
 210 \r
 211     /**\r
 212      * Fixed Description for TCA VES Message status table which contain status of all messages processed by TCA\r
 213      */\r
 214     public static final String TCA_FIXED_VES_MESSAGE_STATUS_DESCRIPTION_TABLE =\r
 215             "Store processing information about all incoming TCA VES Messages";\r
 216 \r
 217     /**\r
 218      * Default Name for TCA VES Alerts table which contains alerts that can be send to downstream systems\r
 219      */\r
 220     public static final String TCA_DEFAULT_VES_ALERTS_NAME_TABLE = "TCAVESAlertsTable";\r
 221 \r
 222     /**\r
 223      * Fixed Description for TCA VES Alerts table which contains alerts that can be send to downstream systems\r
 224      */\r
 225     public static final String TCA_FIXED_VES_ALERTS_DESCRIPTION_TABLE =\r
 226             "Stores alert messages that need to be DMaaP";\r
 227 \r
 228     /**\r
 229      * Default Name for TCA Alerts abatement table which contains information to send out abated alerts\r
 230      */\r
 231     public static final String TCA_DEFAULT_ALERTS_ABATEMENT_NAME_TABLE = "TCAAlertsAbatementTable";\r
 232 \r
 233     /**\r
 234      * Fixed Description for TCA Alerts abatement table which contains information to determine abatement alerts\r
 235      */\r
 236     public static final String TCA_FIXED_ALERTS_ABATEMENT_DESCRIPTION_TABLE =\r
 237             "Stores information to determine creation of abatement alerts";\r
 238 \r
 239 \r
 240     private CDAPComponentsConstants() {\r
 241 \r
 242     }\r
 243 \r
 244 }\r