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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
|
/*-
* ============LICENSE_START=======================================================
* policy-endpoints
* ================================================================================
* Copyright (C) 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.policy.drools.event.comm.bus;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Properties;
import org.openecomp.policy.drools.event.comm.bus.internal.SingleThreadedUebTopicSource;
import org.openecomp.policy.common.logging.flexlogger.FlexLogger;
import org.openecomp.policy.common.logging.flexlogger.Logger;
import org.openecomp.policy.drools.properties.PolicyProperties;
/**
* UEB Topic Source Factory
*/
public interface UebTopicSourceFactory {
/**
* Creates an UEB Topic Source based on properties files
*
* @param properties Properties containing initialization values
*
* @return an UEB Topic Source
* @throws IllegalArgumentException if invalid parameters are present
*/
public List<UebTopicSource> build(Properties properties)
throws IllegalArgumentException;
/**
* Instantiates a new UEB Topic Source
*
* @param servers list of servers
* @param topic topic name
* @param apiKey API Key
* @param apiSecret API Secret
* @param consumerGroup Consumer Group
* @param consumerInstance Consumer Instance
* @param fetchTimeout Read Fetch Timeout
* @param fetchLimit Fetch Limit
* @param managed is this source endpoint managed?
*
* @return an UEB Topic Source
* @throws IllegalArgumentException if invalid parameters are present
*/
public UebTopicSource build(List<String> servers,
String topic,
String apiKey,
String apiSecret,
String consumerGroup,
String consumerInstance,
int fetchTimeout,
int fetchLimit,
boolean managed,
boolean useHttps,
boolean allowSelfSignedCerts)
throws IllegalArgumentException;
/**
* Instantiates a new UEB Topic Source
*
* @param servers list of servers
* @param topic topic name
* @param apiKey API Key
* @param apiSecret API Secret
*
* @return an UEB Topic Source
* @throws IllegalArgumentException if invalid parameters are present
*/
public UebTopicSource build(List<String> servers,
String topic,
String apiKey,
String apiSecret)
throws IllegalArgumentException;
/**
* Instantiates a new UEB Topic Source
*
* @param uebTopicSourceType Implementation type
* @param servers list of servers
* @param topic topic name
*
* @return an UEB Topic Source
* @throws IllegalArgumentException if invalid parameters are present
*/
public UebTopicSource build(List<String> servers,
String topic)
throws IllegalArgumentException;
/**
* Destroys an UEB Topic Source based on a topic
*
* @param topic topic name
* @throws IllegalArgumentException if invalid parameters are present
*/
public void destroy(String topic);
/**
* Destroys all UEB Topic Sources
*/
public void destroy();
/**
* gets an UEB Topic Source based on topic name
* @param topic the topic name
* @return an UEB Topic Source with topic name
* @throws IllegalArgumentException if an invalid topic is provided
* @throws IllegalStateException if the UEB Topic Source is
* an incorrect state
*/
public UebTopicSource get(String topic)
throws IllegalArgumentException, IllegalStateException;
/**
* Provides a snapshot of the UEB Topic Sources
* @return a list of the UEB Topic Sources
*/
public List<UebTopicSource> inventory();
}
/* ------------- implementation ----------------- */
/**
* Factory of UEB Source Topics indexed by topic name
*/
class IndexedUebTopicSourceFactory implements UebTopicSourceFactory {
// get an instance of logger
private static Logger logger = FlexLogger.getLogger(IndexedUebTopicSourceFactory.class);
/**
* UEB Topic Name Index
*/
protected HashMap<String, UebTopicSource> uebTopicSources =
new HashMap<String, UebTopicSource>();
/**
* {@inheritDoc}
*/
@Override
public UebTopicSource build(List<String> servers,
String topic,
String apiKey,
String apiSecret,
String consumerGroup,
String consumerInstance,
int fetchTimeout,
int fetchLimit,
boolean managed,
boolean useHttps,
boolean allowSelfSignedCerts)
throws IllegalArgumentException {
if (servers == null || servers.isEmpty()) {
throw new IllegalArgumentException("UEB Server(s) must be provided");
}
if (topic == null || topic.isEmpty()) {
throw new IllegalArgumentException("A topic must be provided");
}
synchronized(this) {
if (uebTopicSources.containsKey(topic)) {
return uebTopicSources.get(topic);
}
UebTopicSource uebTopicSource =
new SingleThreadedUebTopicSource(servers, topic,
apiKey, apiSecret,
consumerGroup, consumerInstance,
fetchTimeout, fetchLimit, useHttps, allowSelfSignedCerts);
if (managed)
uebTopicSources.put(topic, uebTopicSource);
return uebTopicSource;
}
}
/**
* {@inheritDoc}
*/
@Override
public List<UebTopicSource> build(Properties properties)
throws IllegalArgumentException {
String readTopics = properties.getProperty(PolicyProperties.PROPERTY_UEB_SOURCE_TOPICS);
if (readTopics == null || readTopics.isEmpty()) {
logger.warn("No topic for UEB Source " + properties);
return new ArrayList<UebTopicSource>();
}
List<String> readTopicList = new ArrayList<String>(Arrays.asList(readTopics.split("\\s*,\\s*")));
List<UebTopicSource> newUebTopicSources = new ArrayList<UebTopicSource>();
synchronized(this) {
for (String topic: readTopicList) {
if (this.uebTopicSources.containsKey(topic)) {
newUebTopicSources.add(this.uebTopicSources.get(topic));
continue;
}
String servers = properties.getProperty(PolicyProperties.PROPERTY_UEB_SOURCE_TOPICS + "." +
topic +
PolicyProperties.PROPERTY_TOPIC_SERVERS_SUFFIX);
if (servers == null || servers.isEmpty()) {
logger.error("No UEB servers provided in " + properties);
continue;
}
List<String> serverList = new ArrayList<String>(Arrays.asList(servers.split("\\s*,\\s*")));
String apiKey = properties.getProperty(PolicyProperties.PROPERTY_UEB_SOURCE_TOPICS +
"." + topic +
PolicyProperties.PROPERTY_TOPIC_API_KEY_SUFFIX);
String apiSecret = properties.getProperty(PolicyProperties.PROPERTY_UEB_SOURCE_TOPICS +
"." + topic +
PolicyProperties.PROPERTY_TOPIC_API_SECRET_SUFFIX);
String consumerGroup = properties.getProperty(PolicyProperties.PROPERTY_UEB_SOURCE_TOPICS +
"." + topic +
PolicyProperties.PROPERTY_TOPIC_SOURCE_CONSUMER_GROUP_SUFFIX);
String consumerInstance = properties.getProperty(PolicyProperties.PROPERTY_UEB_SOURCE_TOPICS +
"." + topic +
PolicyProperties.PROPERTY_TOPIC_SOURCE_CONSUMER_INSTANCE_SUFFIX);
String fetchTimeoutString = properties.getProperty(PolicyProperties.PROPERTY_UEB_SOURCE_TOPICS +
"." + topic +
PolicyProperties.PROPERTY_TOPIC_SOURCE_FETCH_TIMEOUT_SUFFIX);
int fetchTimeout = UebTopicSource.DEFAULT_TIMEOUT_MS_FETCH;
if (fetchTimeoutString != null && !fetchTimeoutString.isEmpty()) {
try {
fetchTimeout = Integer.parseInt(fetchTimeoutString);
} catch (NumberFormatException nfe) {
logger.warn("Fetch Timeout in invalid format for topic " + topic + ": " + fetchTimeoutString);
}
}
String fetchLimitString = properties.getProperty(PolicyProperties.PROPERTY_UEB_SOURCE_TOPICS +
"." + topic +
PolicyProperties.PROPERTY_TOPIC_SOURCE_FETCH_TIMEOUT_SUFFIX);
int fetchLimit = UebTopicSource.DEFAULT_LIMIT_FETCH;
if (fetchLimitString != null && !fetchLimitString.isEmpty()) {
try {
fetchLimit = Integer.parseInt(fetchLimitString);
} catch (NumberFormatException nfe) {
logger.warn("Fetch Limit in invalid format for topic " + topic + ": " + fetchLimitString);
}
}
String managedString = properties.getProperty(PolicyProperties.PROPERTY_UEB_SOURCE_TOPICS + "." +
topic + PolicyProperties.PROPERTY_MANAGED_SUFFIX);
boolean managed = true;
if (managedString != null && !managedString.isEmpty()) {
managed = Boolean.parseBoolean(managedString);
}
String useHttpsString = properties.getProperty(PolicyProperties.PROPERTY_UEB_SOURCE_TOPICS + "." + topic +
PolicyProperties.PROPERTY_HTTP_HTTPS_SUFFIX);
//default is to use HTTP if no https property exists
boolean useHttps = false;
if (useHttpsString != null && !useHttpsString.isEmpty()){
useHttps = Boolean.parseBoolean(useHttpsString);
}
String allowSelfSignedCertsString = properties.getProperty(PolicyProperties.PROPERTY_UEB_SOURCE_TOPICS + "." + topic +
PolicyProperties.PROPERTY_ALLOW_SELF_SIGNED_CERTIFICATES_SUFFIX);
//default is to disallow self-signed certs
boolean allowSelfSignedCerts = false;
if (allowSelfSignedCertsString != null && !allowSelfSignedCertsString.isEmpty()){
allowSelfSignedCerts = Boolean.parseBoolean(allowSelfSignedCertsString);
}
UebTopicSource uebTopicSource = this.build(serverList, topic,
apiKey, apiSecret,
consumerGroup, consumerInstance,
fetchTimeout, fetchLimit, managed, useHttps, allowSelfSignedCerts);
newUebTopicSources.add(uebTopicSource);
}
}
return newUebTopicSources;
}
/**
* {@inheritDoc}
*/
@Override
public UebTopicSource build(List<String> servers,
String topic,
String apiKey,
String apiSecret) {
return this.build(servers, topic,
apiKey, apiSecret,
null, null,
UebTopicSource.DEFAULT_TIMEOUT_MS_FETCH,
UebTopicSource.DEFAULT_LIMIT_FETCH, true, false, true);
}
/**
* {@inheritDoc}
*/
@Override
public UebTopicSource build(List<String> servers, String topic) {
return this.build(servers, topic, null, null);
}
/**
* {@inheritDoc}
*/
@Override
public void destroy(String topic)
throws IllegalArgumentException {
if (topic == null || topic.isEmpty()) {
throw new IllegalArgumentException("A topic must be provided");
}
UebTopicSource uebTopicSource;
synchronized(this) {
if (!uebTopicSources.containsKey(topic)) {
return;
}
uebTopicSource = uebTopicSources.remove(topic);
}
uebTopicSource.shutdown();
}
/**
* {@inheritDoc}
*/
@Override
public UebTopicSource get(String topic)
throws IllegalArgumentException, IllegalStateException {
if (topic == null || topic.isEmpty()) {
throw new IllegalArgumentException("A topic must be provided");
}
synchronized(this) {
if (uebTopicSources.containsKey(topic)) {
return uebTopicSources.get(topic);
} else {
throw new IllegalStateException("UebTopiceSource for " + topic + " not found");
}
}
}
@Override
public synchronized List<UebTopicSource> inventory() {
List<UebTopicSource> readers =
new ArrayList<UebTopicSource>(this.uebTopicSources.values());
return readers;
}
@Override
public void destroy() {
List<UebTopicSource> readers = this.inventory();
for (UebTopicSource reader: readers) {
reader.shutdown();
}
synchronized(this) {
this.uebTopicSources.clear();
}
}
}
|