2 * ===============================LICENSE_START======================================
4 * ================================================================================
5 * Copyright © 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
11 * http://www.apache.org/licenses/LICENSE-2.0
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===========================================
21 package org.onap.dcae.apod.analytics.cdap.common;
24 * Contains static constant variable names and values of all DCAE CDAP Components for
25 * e.g. app names, app descriptions, streams, datasets, flows, flowlets, workers, outputs etc.
28 * A strict naming convention must be followed for variable names for CDAP Components names for proper
29 * identification of CDAP Component variable purpose and function. A custom configuration settings can be
31 * deployment purposes based on variable naming conventions.
33 * The variable names should have 4 parts separated by an underscore:
35 * <li>Name of the DCAE sub module (e.g. TCA) to which variable is applicable</li>
36 * <li>Information about variable name:
38 * <li>FIXED - if variable value is fixed and cannot be changed</li>
39 * <li>DEFAULT - if variable name is default name and can be changed by cdap settings file
40 * when application is created</li>
43 * <li>Actual Descriptive name about the CDAP component (may contain underscrores) </li>
44 * <li>CDAP component type e.g STREAM, DATASET, APP, FLOW, FLOWLET, OUTPUT</li>
47 * <p>e.g TCA_DEFAULT_DMAAP_INPUT_STREAM</p>
49 * <p><strong>RegEx Format (DCAE MODULE NAME)_(FIXED|DEFAULT)_(VARIABLE NAME)_(CDAP COMPONENT TYPE)</strong></p>
51 * @author Rajiv Singla . Creation Date: 10/24/2016.
53 public abstract class CDAPComponentsConstants {
55 // =============== Common Module Constants ==================== //
58 * Default DCAE App Name. It should be overriden by sub modules
60 public static final String COMMON_DEFAULT_DCAE_CDAP_NAME_APP = "DCAE_ANALYTICS_GENERIC_APP";
63 * Default DCAE App Description. It should be overriden by sub modules
65 public static final String COMMON_DEFAULT_DCAE_CDAP_DESCRIPTION_APP = "DCAE ANALYTICS GENERIC APP DESCRIPTION";
67 // =============== TCA Module Constants ==================== //
70 * Default TCA application name if application name is not provided from startup configuration
72 public static final String TCA_DEFAULT_NAME_APP = "dcae-tca";
75 * Default TCA application description if not provided from startup configuration
77 public static final String TCA_DEFAULT_DESCRIPTION_APP = "DCAE Analytics Threshold Crossing Alert Application";
80 * Default TCA DMaaP Subscriber output stream name if not provided from startup configuration
82 public static final String TCA_DEFAULT_SUBSCRIBER_OUTPUT_NAME_STREAM = "TCASubscriberOutputStream";
86 * Fixed TCA DMaaP Subscriber output stream description
88 public static final String TCA_FIXED_SUBSCRIBER_OUTPUT_DESCRIPTION_STREAM =
89 "Stream which contains all message from VES Collector DMaaP MR topic";
93 * Fixed Name of TCA DMaaP Subscriber Worker - which will be fetching DMaaP Messages posting them to CDAP stream
95 public static final String TCA_FIXED_DMAAP_SUBSCRIBER_WORKER = "TCADMaaPMRSubscriberWorker";
98 * Fixed Description of TCA DMaaP Subscriber Worker
100 public static final String TCA_FIXED_DMAAP_SUBSCRIBER_DESCRIPTION_WORKER =
101 "Fetches messages from DMaaP MR Topic at frequent intervals and writes them to a CDAP stream";
104 * Fixed Name of TCA DMaaP Publisher Worker - which will be publishing messages to DMaaP MR
106 public static final String TCA_FIXED_DMAAP_PUBLISHER_WORKER = "TCADMaaPMRPublisherWorker";
109 * Fixed Description of TCA DMaaP Publisher Worker
111 public static final String TCA_FIXED_DMAAP_PUBLISHER_DESCRIPTION_WORKER =
112 "Polls TCA Alerts Table at frequent intervals for new alerts and publishes them to DMaaP MR Topic";
115 * Fixed name for TCA VES Collector Messages Processing Flow
117 public static final String TCA_FIXED_VES_COLLECTOR_NAME_FLOW = "TCAVESCollectorFlow";
121 * Fixed description for TCA VES Collector Messages Processing Flow
123 public static final String TCA_FIXED_VES_COLLECTOR_DESCRIPTION_FLOW = "Flow performs TCA on VES Collector Messages";
127 * Fixed Name for TCA VES Message Router Flowlet
129 public static final String TCA_FIXED_VES_MESSAGE_ROUTER_NAME_FLOWLET = "TCAVESMessageRouterFlowlet";
132 * Fixed Description for TCA VES Message Router Flowlet
134 public static final String TCA_FIXED_VES_MESSAGE_ROUTER_DESCRIPTION_FLOWLET =
135 "Routes message received from TCA VES Collector to TCA Threshold Calculator Flowlet instances";
138 * Fixed TCA VES Message Router Flowlet Output
140 public static final String TCA_FIXED_VES_MESSAGE_ROUTER_OUTPUT = "TCAVESMessageRouterOutput";
143 * Fixed Name for TCA VES Message Policy Violated Threshold Calculator Flowlet
145 public static final String TCA_FIXED_VES_THRESHOLD_VIOLATION_CALCULATOR_NAME_FLOWLET =
146 "TCAVESThresholdViolationCalculatorFlowlet";
149 * Fixed Description for TCA VES Message Policy Violated Threshold Calculator Flowlet
151 public static final String TCA_FIXED_VES_THRESHOLD_VIOLATION_CALCULATOR_DESCRIPTION_FLOWLET =
152 "Applies TCA Policy Thresholds to VES Message and determined if any message violated TCA Policy thresholds";
155 * Fixed Name for TCA VES Message Policy Violated Threshold Calculator Output
157 public static final String TCA_FIXED_VES_TCA_CALCULATOR_NAME_OUTPUT = "TCAThresholdViolationCalculatorOutput";
161 * Fixed Name for TCA VES Alerts Abatement Flowlet
163 public static final String TCA_FIXED_VES_ALERTS_ABATEMENT_NAME_FLOWLET = "TCAVESAlertsAbatementFlowlet";
166 * Fixed Description for TCA VES Alerts Abatement Flowlet
168 public static final String TCA_FIXED_VES_ALERTS_ABATEMENT_DESCRIPTION_FLOWLET =
169 "Determines if abatement event needs to be posted to downstream systems";
172 * Fixed Name for TCA VES Alerts Abatement Flowlet output
174 public static final String TCA_FIXED_VES_ALERTS_ABATEMENT_NAME_OUTPUT = "TCAVESAlertsAbatementFlowletOutput";
178 * Fixed Name for TCA VES A&AI Enrichment Flowlet
180 public static final String TCA_FIXED_VES_AAI_ENRICHMENT_NAME_FLOWLET = "TCAVESAAIEnrichmentFlowlet";
183 * Fixed Description for TCA VES A&AI Enrichment Flowlet
185 public static final String TCA_FIXED_VES_AAI_ENRICHMENT_DESCRIPTION_FLOWLET =
186 "Performs A&AI Enrichment of non abated alerts";
189 * Fixed Name for TCA VES A&AI Enrichment Flowlet output
191 public static final String TCA_FIXED_VES_AAI_ENRICHMENT_NAME_OUTPUT = "TCAVESAAIEnrichmentFlowletOutput";
194 * Fixed Name for TCA VES Alerts Sink Flowlet
196 public static final String TCA_FIXED_VES_ALERTS_SINK_NAME_FLOWLET = "TCAVESAlertsSinkFlowlet";
199 * Fixed Description for TCA VES Alerts Sink Flowlet
201 public static final String TCA_FIXED_VES_ALERTS_SINK_DESCRIPTION_FLOWLET =
202 "Saves messages which violated TCA Policy in a data set";
206 * Default Name for TCA VES Message status table which contain status of all messages processed by TCA
208 public static final String TCA_DEFAULT_VES_MESSAGE_STATUS_NAME_TABLE = "TCAVESMessageStatusTable";
212 * Fixed Description for TCA VES Message status table which contain status of all messages processed by TCA
214 public static final String TCA_FIXED_VES_MESSAGE_STATUS_DESCRIPTION_TABLE =
215 "Store processing information about all incoming TCA VES Messages";
218 * Default Name for TCA VES Alerts table which contains alerts that can be send to downstream systems
220 public static final String TCA_DEFAULT_VES_ALERTS_NAME_TABLE = "TCAVESAlertsTable";
223 * Fixed Description for TCA VES Alerts table which contains alerts that can be send to downstream systems
225 public static final String TCA_FIXED_VES_ALERTS_DESCRIPTION_TABLE =
226 "Stores alert messages that need to be DMaaP";
229 * Default Name for TCA Alerts abatement table which contains information to send out abated alerts
231 public static final String TCA_DEFAULT_ALERTS_ABATEMENT_NAME_TABLE = "TCAAlertsAbatementTable";
234 * Fixed Description for TCA Alerts abatement table which contains information to determine abatement alerts
236 public static final String TCA_FIXED_ALERTS_ABATEMENT_DESCRIPTION_TABLE =
237 "Stores information to determine creation of abatement alerts";
240 private CDAPComponentsConstants() {