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