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;
78 public abstract Stream<ChampRelationship> retrieveRelationships(ChampObject object) throws ChampUnmarshallingException, ChampObjectNotExistsException;
80 public abstract Stream<ChampRelationship> queryRelationships(Map<String, Object> queryParams);
81 public abstract ChampPartition executeStorePartition(ChampPartition partition) throws ChampSchemaViolationException, ChampRelationshipNotExistsException, ChampMarshallingException, ChampObjectNotExistsException;
82 public abstract void executeDeletePartition(ChampPartition graph);
83 public abstract void executeStoreObjectIndex(ChampObjectIndex index);
85 public abstract Optional<ChampObjectIndex> retrieveObjectIndex(String indexName);
87 public abstract Stream<ChampObjectIndex> retrieveObjectIndices();
88 public abstract void executeDeleteObjectIndex(String indexName) throws ChampIndexNotExistsException;
89 public abstract void executeStoreRelationshipIndex(ChampRelationshipIndex index);
91 public abstract Optional<ChampRelationshipIndex> retrieveRelationshipIndex(String indexName);
92 public abstract Stream<ChampRelationshipIndex> retrieveRelationshipIndices();
93 public abstract void executeDeleteRelationshipIndex(String indexName) throws ChampIndexNotExistsException;
94 public abstract void storeSchema(ChampSchema schema) throws ChampSchemaViolationException;
95 public abstract ChampSchema retrieveSchema();
96 public abstract void updateSchema(ChampObjectConstraint objectConstraint) throws ChampSchemaViolationException;
97 public abstract void updateSchema(ChampRelationshipConstraint schema) throws ChampSchemaViolationException;
98 public abstract void deleteSchema();
99 public abstract ChampCapabilities capabilities();
102 /** Configuration property for setting the comma-separated list of servers to use for
103 * communicating with the event bus. */
104 public static final String PARAM_EVENT_STREAM_HOSTS = "champ.event.stream.hosts";
106 /** Configuration property for setting the number of events that we will try to 'batch'
107 * up before sending them to the event bus. */
108 public static final String PARAM_EVENT_STREAM_BATCH_SIZE = "champ.event.stream.batch-size";
109 public static final Integer DEFAULT_EVENT_STREAM_BATCH_SIZE = 1;
111 /** Configuration property for setting the maximum amount of time to wait for a batch of
112 * outgoing messages to fill up before sending the batch. */
113 public static final String PARAM_EVENT_STREAM_BATCH_TIMEOUT = "champ.event.stream.batch-timeout";
114 public static final Integer DEFAULT_EVENT_STREAM_BATCH_TIMEOUT_MS = 500;
116 public static final String PARAM_EVENT_STREAM_PUBLISHER_POOL_SIZE = "champ.event.stream.publisher-pool-size";
117 public static final Integer DEFAULT_EVENT_STREAM_PUBLISHER_POOL_SIZE = 100;
119 /** The event stream topic that we will publish Champ events to. */
120 public static final String EVENT_TOPIC = "champRawEvents";
122 /** Number of events to 'batch up' before actually publishing them to the event bus. */
123 private Integer eventStreamBatchSize;
125 private Integer eventStreamBatchTimeout;
127 private Integer eventStreamPublisherPoolSize;
129 /** Comma-separated list of hosts for connecting to the event bus. */
130 private String eventStreamHosts = null;
132 /** Client used for publishing messages to the event bus. */
133 protected CambriaPublisher producer;
135 /** Pool of worker threads that do the work of publishing the events to the event bus. */
136 protected ThreadPoolExecutor publisherPool;
140 * Create a new instance of the AbstractLoggingChampGraph.
142 * @param properties - Set of configuration properties for this graph instance.
144 protected AbstractLoggingChampGraph(Map<String, Object> properties) {
146 // Extract the necessary parameters from the configuration properties.
147 configure(properties);
149 // Create the executor pool that will do the work of publishing events to the event bus.
150 publisherPool = (ThreadPoolExecutor) Executors.newFixedThreadPool(eventStreamPublisherPoolSize);
152 // Make sure that we are actually provided a list of hosts for connecting to the event
153 // bus before we actually try to do anything useful.
154 if(eventStreamHosts == null) {
156 // We were not supplied a list of event bus hosts, so just bail.
157 logger.error("Cannot initialize event stream publisher without at least one event bus host.");
158 logger.error("NOTE!! Champ events will NOT be published to the event stream!");
164 // Instantiate the producer that we will use to publish events to the event stream.
165 setProducer(new CambriaClientBuilders.PublisherBuilder()
166 .usingHosts(eventStreamHosts)
167 .onTopic(EVENT_TOPIC)
168 .limitBatch(eventStreamBatchSize, eventStreamBatchTimeout)
171 } catch (MalformedURLException | GeneralSecurityException e) {
173 logger.error("Could not instantiate event stream producer due to: " + e.getMessage());
174 logger.error("NOTE: Champ events will NOT be published to the event stream");
181 * Process the configuration properties supplied for this graph instance.
183 * @param properties - Configuration parameters.
185 private void configure(Map<String, Object> properties) {
187 eventStreamBatchSize =
188 (Integer) getProperty(properties, PARAM_EVENT_STREAM_BATCH_SIZE, DEFAULT_EVENT_STREAM_BATCH_SIZE);
189 eventStreamBatchTimeout =
190 (Integer) getProperty(properties, PARAM_EVENT_STREAM_BATCH_TIMEOUT, DEFAULT_EVENT_STREAM_BATCH_TIMEOUT_MS);
191 eventStreamPublisherPoolSize =
192 (Integer) getProperty(properties, PARAM_EVENT_STREAM_PUBLISHER_POOL_SIZE, DEFAULT_EVENT_STREAM_PUBLISHER_POOL_SIZE);
194 if(properties.containsKey(PARAM_EVENT_STREAM_HOSTS)) {
195 eventStreamHosts = (String) properties.get(PARAM_EVENT_STREAM_HOSTS);
199 public void setProducer(CambriaPublisher aProducer) {
201 producer = aProducer;
204 private Object getProperty(Map<String, Object> properties, String property, Object defaultValue) {
206 if(properties.containsKey(property)) {
207 return properties.get(property);
214 public void shutdown() {
216 if(publisherPool != null) {
217 publisherPool.shutdown();
220 publisherPool.awaitTermination(1000, TimeUnit.MILLISECONDS);
221 } catch (InterruptedException e) {}
224 if(producer != null) {
229 public ChampObject storeObject(ChampObject object) throws ChampMarshallingException, ChampSchemaViolationException, ChampObjectNotExistsException {
231 ChampObject storedObject = executeStoreObject(object);
233 if(storedObject != null) {
235 // Update the event stream with the current operation.
236 logEvent(ChampEvent.builder()
237 .operation(ChampOperation.STORE)
238 .entity(storedObject)
246 public ChampObject replaceObject(ChampObject object)
247 throws ChampMarshallingException, ChampSchemaViolationException, ChampObjectNotExistsException {
249 ChampObject replacedObject = executeReplaceObject(object);
251 if(replacedObject != null) {
253 // Update the event stream with the current operation.
254 logEvent(ChampEvent.builder()
255 .operation(ChampOperation.REPLACE)
256 .entity(replacedObject)
260 return replacedObject;
264 public void deleteObject(Object key) throws ChampObjectNotExistsException {
266 // Retrieve the object that we are deleting before it's gone, so that we can
267 // report it to the event stream.
268 Optional<ChampObject> objectToDelete = Optional.empty();
270 objectToDelete = retrieveObject(key);
272 } catch (ChampUnmarshallingException e) {
273 logger.error("Unable to generate delete object log: " + e.getMessage(),e);
276 executeDeleteObject(key);
278 if(objectToDelete.isPresent()) {
279 // Update the event stream with the current operation.
280 logEvent(ChampEvent.builder()
281 .operation(ChampOperation.DELETE)
282 .entity(objectToDelete.get())
288 public ChampRelationship storeRelationship(ChampRelationship relationship)
289 throws ChampUnmarshallingException, ChampMarshallingException, ChampObjectNotExistsException, ChampSchemaViolationException, ChampRelationshipNotExistsException {
291 ChampRelationship storedRelationship = executeStoreRelationship(relationship);
293 if(storedRelationship != null) {
295 // Update the event stream with the current operation.
296 logEvent(ChampEvent.builder()
297 .operation(ChampOperation.STORE)
298 .entity(storedRelationship)
302 return storedRelationship;
306 public ChampRelationship replaceRelationship(ChampRelationship relationship)
307 throws ChampUnmarshallingException, ChampMarshallingException, ChampSchemaViolationException, ChampRelationshipNotExistsException {
309 ChampRelationship replacedRelationship = executeReplaceRelationship(relationship);
311 if(replacedRelationship != null) {
313 // Update the event stream with the current operation.
314 logEvent(ChampEvent.builder()
315 .operation(ChampOperation.REPLACE)
316 .entity(replacedRelationship)
320 return replacedRelationship;
324 public void deleteRelationship(ChampRelationship relationship) throws ChampRelationshipNotExistsException {
326 executeDeleteRelationship(relationship);
328 // Update the event stream with the current operation.
329 logEvent(ChampEvent.builder()
330 .operation(ChampOperation.DELETE)
331 .entity(relationship)
336 public ChampPartition storePartition(ChampPartition partition) throws ChampSchemaViolationException, ChampRelationshipNotExistsException, ChampMarshallingException, ChampObjectNotExistsException {
338 ChampPartition storedPartition = executeStorePartition(partition);
340 if(storedPartition != null) {
342 // Update the event stream with the current operation.
343 logEvent(ChampEvent.builder()
344 .operation(ChampOperation.STORE)
345 .entity(storedPartition)
349 return storedPartition;
353 public void deletePartition(ChampPartition graph) {
355 executeDeletePartition(graph);
357 // Update the event stream with the current operation.
358 logEvent(ChampEvent.builder()
359 .operation(ChampOperation.DELETE)
365 public void storeObjectIndex(ChampObjectIndex index) {
367 executeStoreObjectIndex(index);
369 // Update the event stream with the current operation.
370 logEvent(ChampEvent.builder()
371 .operation(ChampOperation.STORE)
377 public void deleteObjectIndex(String indexName) throws ChampIndexNotExistsException {
379 // Retrieve the index that we are deleting before it's gone, so that we can
380 // report it to the event stream.
381 Optional<ChampObjectIndex> indexToDelete = retrieveObjectIndex(indexName);
383 executeDeleteObjectIndex(indexName);
385 if(indexToDelete.isPresent()) {
386 // Update the event stream with the current operation.
387 logEvent(ChampEvent.builder()
388 .operation(ChampOperation.DELETE)
389 .entity(indexToDelete.get())
395 public void storeRelationshipIndex(ChampRelationshipIndex index) {
397 executeStoreRelationshipIndex(index);
399 // Update the event stream with the current operation.
400 logEvent(ChampEvent.builder()
401 .operation(ChampOperation.STORE)
407 public void deleteRelationshipIndex(String indexName) throws ChampIndexNotExistsException {
409 // Retrieve the index that we are deleting before it's gone, so that we can
410 // report it to the event stream.
411 Optional<ChampRelationshipIndex> indexToDelete = retrieveRelationshipIndex(indexName);
413 executeDeleteRelationshipIndex(indexName);
415 if(indexToDelete.isPresent()) {
416 // Update the event stream with the current operation.
417 logEvent(ChampEvent.builder()
418 .operation(ChampOperation.DELETE)
419 .entity(indexToDelete.get())
426 * Submits an event to be published to the event stream.
428 * @param anEvent - The event to be published.
430 public void logEvent(ChampEvent anEvent) {
432 if(logger.isDebugEnabled()) {
433 logger.debug("Submitting event to be published to the event bus: " + anEvent.toString());
438 // Try submitting the event to be published to the event bus.
439 publisherPool.execute(new EventPublisher(anEvent));
441 } catch (RejectedExecutionException re) {
442 logger.error("Event could not be published to the event bus due to: " + re.getMessage(),re);
444 } catch (NullPointerException npe) {
445 logger.error("Can not publish null event to event bus." + npe.getMessage(),npe);
451 * This class runs as a background thread and is responsible for pulling Champ events off
452 * of the internal queue and publishing them to the event stream.
454 private class EventPublisher implements Runnable {
456 /** Partition key to use when publishing events to the event stream. We WANT all events
457 * to go to a single partition, so we are just using a hard-coded key for every event. */
458 private static final String EVENTS_PARTITION_KEY = "champEventKey";
460 private ChampEvent event;
462 public EventPublisher(ChampEvent event) {
470 boolean done = false;
471 while(!done && !Thread.currentThread().isInterrupted()) {
474 // Make sure that we actually have a producer instance to use to publish
476 if(producer != null) {
478 // Try publishing the event to the event bus.
479 producer.send(EVENTS_PARTITION_KEY, event.toJson());
481 } else if (logger.isDebugEnabled()) {
482 logger.debug("Event bus producer is not instantiated - will not attempt to publish event");
487 } catch (IOException e) {
489 // We were unable to publish to the event bus, so wait a bit and then try
494 } catch (InterruptedException e1) {
495 logger.info("Stopping event publisher worker thread.");