2 * ============LICENSE_START==========================================
4 * ===================================================================
5 * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
6 * Copyright © 2017 Amdocs
7 * ===================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 * ============LICENSE_END============================================
20 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22 package org.onap.aai.champ.event;
24 import java.io.IOException;
25 import java.net.MalformedURLException;
26 import java.security.GeneralSecurityException;
28 import java.util.Optional;
29 import java.util.concurrent.Executors;
30 import java.util.concurrent.RejectedExecutionException;
31 import java.util.concurrent.ThreadPoolExecutor;
32 import java.util.concurrent.TimeUnit;
33 import java.util.stream.Stream;
35 import org.onap.aai.champ.ChampCapabilities;
36 import org.onap.aai.champ.ChampGraph;
37 import org.onap.aai.champ.event.ChampEvent.ChampOperation;
38 import org.onap.aai.champ.exceptions.ChampIndexNotExistsException;
39 import org.onap.aai.champ.exceptions.ChampMarshallingException;
40 import org.onap.aai.champ.exceptions.ChampObjectNotExistsException;
41 import org.onap.aai.champ.exceptions.ChampRelationshipNotExistsException;
42 import org.onap.aai.champ.exceptions.ChampSchemaViolationException;
43 import org.onap.aai.champ.exceptions.ChampUnmarshallingException;
44 import org.onap.aai.champ.model.ChampObject;
45 import org.onap.aai.champ.model.ChampObjectConstraint;
46 import org.onap.aai.champ.model.ChampObjectIndex;
47 import org.onap.aai.champ.model.ChampPartition;
48 import org.onap.aai.champ.model.ChampRelationship;
49 import org.onap.aai.champ.model.ChampRelationshipConstraint;
50 import org.onap.aai.champ.model.ChampRelationshipIndex;
51 import org.onap.aai.champ.model.ChampSchema;
52 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
55 import com.att.nsa.cambria.client.CambriaClientBuilders;
56 import com.att.nsa.cambria.client.CambriaPublisher;
60 * This class provides the hooks to allow Champ operations to be logged to an event
63 public abstract class AbstractLoggingChampGraph implements ChampGraph {
65 private static final Logger logger = LoggerFactory.getLogger(AbstractLoggingChampGraph.class);
67 public abstract ChampObject executeStoreObject(ChampObject object) throws ChampMarshallingException, ChampSchemaViolationException, ChampObjectNotExistsException;
68 public abstract ChampObject executeReplaceObject(ChampObject object) throws ChampMarshallingException, ChampSchemaViolationException, ChampObjectNotExistsException;
69 public abstract Optional<ChampObject> retrieveObject(Object key) throws ChampUnmarshallingException;
70 public abstract void executeDeleteObject(Object key) throws ChampObjectNotExistsException;
71 public abstract Stream<ChampObject> queryObjects(Map<String, Object> queryParams);
72 public abstract ChampRelationship executeStoreRelationship(ChampRelationship relationship) throws ChampUnmarshallingException, ChampMarshallingException, ChampObjectNotExistsException, ChampSchemaViolationException, ChampRelationshipNotExistsException;
73 public abstract ChampRelationship executeReplaceRelationship(ChampRelationship relationship) throws ChampUnmarshallingException, ChampMarshallingException, ChampSchemaViolationException, ChampRelationshipNotExistsException;
75 public abstract Optional<ChampRelationship> retrieveRelationship(Object key) throws ChampUnmarshallingException;
76 public abstract void executeDeleteRelationship(ChampRelationship relationship) throws ChampRelationshipNotExistsException;
77 public abstract Stream<ChampRelationship> retrieveRelationships(ChampObject object) throws ChampUnmarshallingException, ChampObjectNotExistsException;
78 public abstract Stream<ChampRelationship> queryRelationships(Map<String, Object> queryParams);
79 public abstract ChampPartition executeStorePartition(ChampPartition partition) throws ChampSchemaViolationException, ChampRelationshipNotExistsException, ChampMarshallingException, ChampObjectNotExistsException;
80 public abstract void executeDeletePartition(ChampPartition graph);
81 public abstract void executeStoreObjectIndex(ChampObjectIndex index);
82 public abstract Optional<ChampObjectIndex> retrieveObjectIndex(String indexName);
83 public abstract Stream<ChampObjectIndex> retrieveObjectIndices();
84 public abstract void executeDeleteObjectIndex(String indexName) throws ChampIndexNotExistsException;
85 public abstract void executeStoreRelationshipIndex(ChampRelationshipIndex index);
86 public abstract Optional<ChampRelationshipIndex> retrieveRelationshipIndex(String indexName);
87 public abstract Stream<ChampRelationshipIndex> retrieveRelationshipIndices();
88 public abstract void executeDeleteRelationshipIndex(String indexName) throws ChampIndexNotExistsException;
89 public abstract void storeSchema(ChampSchema schema) throws ChampSchemaViolationException;
90 public abstract ChampSchema retrieveSchema();
91 public abstract void updateSchema(ChampObjectConstraint objectConstraint) throws ChampSchemaViolationException;
92 public abstract void updateSchema(ChampRelationshipConstraint schema) throws ChampSchemaViolationException;
93 public abstract void deleteSchema();
94 public abstract ChampCapabilities capabilities();
97 /** Configuration property for setting the comma-separated list of servers to use for
98 * communicating with the event bus. */
99 public static final String PARAM_EVENT_STREAM_HOSTS = "champ.event.stream.hosts";
101 /** Configuration property for setting the number of events that we will try to 'batch'
102 * up before sending them to the event bus. */
103 public static final String PARAM_EVENT_STREAM_BATCH_SIZE = "champ.event.stream.batch-size";
104 public final static Integer DEFAULT_EVENT_STREAM_BATCH_SIZE = 1;
106 /** Configuration property for setting the maximum amount of time to wait for a batch of
107 * outgoing messages to fill up before sending the batch. */
108 public final static String PARAM_EVENT_STREAM_BATCH_TIMEOUT = "champ.event.stream.batch-timeout";
109 public final static Integer DEFAULT_EVENT_STREAM_BATCH_TIMEOUT_MS = 500;
111 public final static String PARAM_EVENT_STREAM_PUBLISHER_POOL_SIZE = "champ.event.stream.publisher-pool-size";
112 public final static Integer DEFAULT_EVENT_STREAM_PUBLISHER_POOL_SIZE = 100;
114 /** The event stream topic that we will publish Champ events to. */
115 public final static String EVENT_TOPIC = "champRawEvents";
117 /** Number of events to 'batch up' before actually publishing them to the event bus. */
118 private Integer eventStreamBatchSize;
120 private Integer eventStreamBatchTimeout;
122 private Integer eventStreamPublisherPoolSize;
124 /** Comma-separated list of hosts for connecting to the event bus. */
125 private String eventStreamHosts = null;
127 /** Client used for publishing messages to the event bus. */
128 protected CambriaPublisher producer;
130 /** Pool of worker threads that do the work of publishing the events to the event bus. */
131 protected ThreadPoolExecutor publisherPool;
135 * Create a new instance of the AbstractLoggingChampGraph.
137 * @param properties - Set of configuration properties for this graph instance.
139 protected AbstractLoggingChampGraph(Map<String, Object> properties) {
141 // Extract the necessary parameters from the configuration properties.
142 configure(properties);
144 // Create the executor pool that will do the work of publishing events to the event bus.
145 publisherPool = (ThreadPoolExecutor) Executors.newFixedThreadPool(eventStreamPublisherPoolSize);
147 // Make sure that we are actually provided a list of hosts for connecting to the event
148 // bus before we actually try to do anything useful.
149 if(eventStreamHosts == null) {
151 // We were not supplied a list of event bus hosts, so just bail.
152 logger.error("Cannot initialize event stream publisher without at least one event bus host.");
153 logger.error("NOTE!! Champ events will NOT be published to the event stream!");
159 // Instantiate the producer that we will use to publish events to the event stream.
160 setProducer(new CambriaClientBuilders.PublisherBuilder()
161 .usingHosts(eventStreamHosts)
162 .onTopic(EVENT_TOPIC)
163 .limitBatch(eventStreamBatchSize, eventStreamBatchTimeout)
166 } catch (MalformedURLException | GeneralSecurityException e) {
168 logger.error("Could not instantiate event stream producer due to: " + e.getMessage());
169 logger.error("NOTE: Champ events will NOT be published to the event stream");
176 * Process the configuration properties supplied for this graph instance.
178 * @param properties - Configuration parameters.
180 private void configure(Map<String, Object> properties) {
182 eventStreamBatchSize =
183 (Integer) getProperty(properties, PARAM_EVENT_STREAM_BATCH_SIZE, DEFAULT_EVENT_STREAM_BATCH_SIZE);
184 eventStreamBatchTimeout =
185 (Integer) getProperty(properties, PARAM_EVENT_STREAM_BATCH_TIMEOUT, DEFAULT_EVENT_STREAM_BATCH_TIMEOUT_MS);
186 eventStreamPublisherPoolSize =
187 (Integer) getProperty(properties, PARAM_EVENT_STREAM_PUBLISHER_POOL_SIZE, DEFAULT_EVENT_STREAM_PUBLISHER_POOL_SIZE);
189 if(properties.containsKey(PARAM_EVENT_STREAM_HOSTS)) {
190 eventStreamHosts = (String) properties.get(PARAM_EVENT_STREAM_HOSTS);
194 public void setProducer(CambriaPublisher aProducer) {
196 producer = aProducer;
199 private Object getProperty(Map<String, Object> properties, String property, Object defaultValue) {
201 if(properties.containsKey(property)) {
202 return properties.get(property);
209 public void shutdown() {
211 if(publisherPool != null) {
212 publisherPool.shutdown();
215 publisherPool.awaitTermination(1000, TimeUnit.MILLISECONDS);
216 } catch (InterruptedException e) {}
219 if(producer != null) {
224 public ChampObject storeObject(ChampObject object) throws ChampMarshallingException, ChampSchemaViolationException, ChampObjectNotExistsException {
226 ChampObject storedObject = executeStoreObject(object);
228 if(storedObject != null) {
230 // Update the event stream with the current operation.
231 logEvent(ChampEvent.builder()
232 .operation(ChampOperation.STORE)
233 .entity(storedObject)
241 public ChampObject replaceObject(ChampObject object)
242 throws ChampMarshallingException, ChampSchemaViolationException, ChampObjectNotExistsException {
244 ChampObject replacedObject = executeReplaceObject(object);
246 if(replacedObject != null) {
248 // Update the event stream with the current operation.
249 logEvent(ChampEvent.builder()
250 .operation(ChampOperation.REPLACE)
251 .entity(replacedObject)
255 return replacedObject;
259 public void deleteObject(Object key) throws ChampObjectNotExistsException {
261 // Retrieve the object that we are deleting before it's gone, so that we can
262 // report it to the event stream.
263 Optional<ChampObject> objectToDelete = Optional.empty();
265 objectToDelete = retrieveObject(key);
267 } catch (ChampUnmarshallingException e) {
268 logger.error("Unable to generate delete object log: " + e.getMessage());
271 executeDeleteObject(key);
273 if(objectToDelete.isPresent()) {
274 // Update the event stream with the current operation.
275 logEvent(ChampEvent.builder()
276 .operation(ChampOperation.DELETE)
277 .entity(objectToDelete.get())
283 public ChampRelationship storeRelationship(ChampRelationship relationship)
284 throws ChampUnmarshallingException, ChampMarshallingException, ChampObjectNotExistsException, ChampSchemaViolationException, ChampRelationshipNotExistsException {
286 ChampRelationship storedRelationship = executeStoreRelationship(relationship);
288 if(storedRelationship != null) {
290 // Update the event stream with the current operation.
291 logEvent(ChampEvent.builder()
292 .operation(ChampOperation.STORE)
293 .entity(storedRelationship)
297 return storedRelationship;
301 public ChampRelationship replaceRelationship(ChampRelationship relationship)
302 throws ChampUnmarshallingException, ChampMarshallingException, ChampSchemaViolationException, ChampRelationshipNotExistsException {
304 ChampRelationship replacedRelationship = executeReplaceRelationship(relationship);
306 if(replacedRelationship != null) {
308 // Update the event stream with the current operation.
309 logEvent(ChampEvent.builder()
310 .operation(ChampOperation.REPLACE)
311 .entity(replacedRelationship)
315 return replacedRelationship;
319 public void deleteRelationship(ChampRelationship relationship) throws ChampRelationshipNotExistsException {
321 executeDeleteRelationship(relationship);
323 // Update the event stream with the current operation.
324 logEvent(ChampEvent.builder()
325 .operation(ChampOperation.DELETE)
326 .entity(relationship)
331 public ChampPartition storePartition(ChampPartition partition) throws ChampSchemaViolationException, ChampRelationshipNotExistsException, ChampMarshallingException, ChampObjectNotExistsException {
333 ChampPartition storedPartition = executeStorePartition(partition);
335 if(storedPartition != null) {
337 // Update the event stream with the current operation.
338 logEvent(ChampEvent.builder()
339 .operation(ChampOperation.STORE)
340 .entity(storedPartition)
344 return storedPartition;
348 public void deletePartition(ChampPartition graph) {
350 executeDeletePartition(graph);
352 // Update the event stream with the current operation.
353 logEvent(ChampEvent.builder()
354 .operation(ChampOperation.DELETE)
360 public void storeObjectIndex(ChampObjectIndex index) {
362 executeStoreObjectIndex(index);
364 // Update the event stream with the current operation.
365 logEvent(ChampEvent.builder()
366 .operation(ChampOperation.STORE)
372 public void deleteObjectIndex(String indexName) throws ChampIndexNotExistsException {
374 // Retrieve the index that we are deleting before it's gone, so that we can
375 // report it to the event stream.
376 Optional<ChampObjectIndex> indexToDelete = retrieveObjectIndex(indexName);
378 executeDeleteObjectIndex(indexName);
380 if(indexToDelete.isPresent()) {
381 // Update the event stream with the current operation.
382 logEvent(ChampEvent.builder()
383 .operation(ChampOperation.DELETE)
384 .entity(indexToDelete.get())
390 public void storeRelationshipIndex(ChampRelationshipIndex index) {
392 executeStoreRelationshipIndex(index);
394 // Update the event stream with the current operation.
395 logEvent(ChampEvent.builder()
396 .operation(ChampOperation.STORE)
402 public void deleteRelationshipIndex(String indexName) throws ChampIndexNotExistsException {
404 // Retrieve the index that we are deleting before it's gone, so that we can
405 // report it to the event stream.
406 Optional<ChampRelationshipIndex> indexToDelete = retrieveRelationshipIndex(indexName);
408 executeDeleteRelationshipIndex(indexName);
410 if(indexToDelete.isPresent()) {
411 // Update the event stream with the current operation.
412 logEvent(ChampEvent.builder()
413 .operation(ChampOperation.DELETE)
414 .entity(indexToDelete.get())
421 * Submits an event to be published to the event stream.
423 * @param anEvent - The event to be published.
425 public void logEvent(ChampEvent anEvent) {
427 if(logger.isDebugEnabled()) {
428 logger.debug("Submitting event to be published to the event bus: " + anEvent.toString());
433 // Try submitting the event to be published to the event bus.
434 publisherPool.execute(new EventPublisher(anEvent));
436 } catch (RejectedExecutionException re) {
437 logger.error("Event could not be published to the event bus due to: " + re.getMessage());
439 } catch (NullPointerException npe) {
440 logger.error("Can not publish null event to event bus.");
446 * This class runs as a background thread and is responsible for pulling Champ events off
447 * of the internal queue and publishing them to the event stream.
449 private class EventPublisher implements Runnable {
451 /** Partition key to use when publishing events to the event stream. We WANT all events
452 * to go to a single partition, so we are just using a hard-coded key for every event. */
453 private static final String EVENTS_PARTITION_KEY = "champEventKey";
455 private ChampEvent event;
457 public EventPublisher(ChampEvent event) {
465 boolean done = false;
466 while(!done && !Thread.currentThread().isInterrupted()) {
469 // Make sure that we actually have a producer instance to use to publish
471 if(producer != null) {
473 // Try publishing the event to the event bus.
474 producer.send(EVENTS_PARTITION_KEY, event.toJson());
476 } else if (logger.isDebugEnabled()) {
477 logger.debug("Event bus producer is not instantiated - will not attempt to publish event");
482 } catch (IOException e) {
484 // We were unable to publish to the event bus, so wait a bit and then try
489 } catch (InterruptedException e1) {
490 logger.info("Stopping event publisher worker thread.");