services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/impl/eventrequestor/EventRequestorProducer.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  *  Modifications Copyright (C) 2019 Nordix Foundation.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.apex.service.engine.event.impl.eventrequestor;
  23
  24 import java.util.EnumMap;
  25 import java.util.Map;
  26 import java.util.Properties;
  27
  28 import org.onap.policy.apex.service.engine.event.ApexEventConsumer;
  29 import org.onap.policy.apex.service.engine.event.ApexEventException;
  30 import org.onap.policy.apex.service.engine.event.ApexEventProducer;
  31 import org.onap.policy.apex.service.engine.event.ApexEventRuntimeException;
  32 import org.onap.policy.apex.service.engine.event.PeeredReference;
  33 import org.onap.policy.apex.service.engine.event.SynchronousEventCache;
  34 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
  35 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerPeeredMode;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 /**
  40  * Concrete implementation of an Apex event producer that sends one or more events to its peered event requestor
  41  * consumer.
  42  *
  43  * @author Liam Fallon (liam.fallon@ericsson.com)
  44  *
  45  */
  46 public class EventRequestorProducer implements ApexEventProducer {
  47     private static final Logger LOGGER = LoggerFactory.getLogger(EventRequestorProducer.class);
  48
  49     // The name for this producer
  50     private String name = null;
  51
  52     // The peer references for this event handler
  53     private final Map<EventHandlerPeeredMode, PeeredReference> peerReferenceMap =
  54             new EnumMap<>(EventHandlerPeeredMode.class);
  55
  56     // The number of events sent
  57     private int eventsSent = 0;
  58
  59     /*
  60      * (non-Javadoc)
  61      *
  62      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#init(java.lang.String,
  63      * org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters)
  64      */
  65     @Override
  66     public void init(final String producerName, final EventHandlerParameters producerParameters)
  67             throws ApexEventException {
  68         this.name = producerName;
  69
  70         // Check and get the producer Properties
  71         if (!(producerParameters
  72                 .getCarrierTechnologyParameters() instanceof EventRequestorCarrierTechnologyParameters)) {
  73             final String errorMessage =
  74                     "specified consumer properties are not applicable to event requestor producer (" + this.name + ")";
  75             LOGGER.warn(errorMessage);
  76             throw new ApexEventException(errorMessage);
  77         }
  78
  79         // Check if we are in peered mode
  80         if (!producerParameters.isPeeredMode(EventHandlerPeeredMode.REQUESTOR)) {
  81             final String errorMessage = "Event Requestor producer (" + this.name
  82                     + ") must run in peered requestor mode with a Event Requestor consumer";
  83             LOGGER.warn(errorMessage);
  84             throw new ApexEventException(errorMessage);
  85         }
  86     }
  87
  88     /*
  89      * (non-Javadoc)
  90      *
  91      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#getName()
  92      */
  93     @Override
  94     public String getName() {
  95         return name;
  96     }
  97
  98     /**
  99      * Get the number of events sent to date.
 100      *
 101      * @return the number of events received
 102      */
 103     public int getEventsSent() {
 104         return eventsSent;
 105     }
 106
 107     /**
 108      * {@inheritDoc}.
 109      */
 110     @Override
 111     public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) {
 112         return peerReferenceMap.get(peeredMode);
 113     }
 114
 115     /**
 116      * {@inheritDoc}.
 117      */
 118     @Override
 119     public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {
 120         peerReferenceMap.put(peeredMode, peeredReference);
 121     }
 122
 123     /**
 124      * {@inheritDoc}.
 125      */
 126     @Override
 127     public void sendEvent(final long executionId, final Properties executorProperties, final String eventName,
 128             final Object eventObject) {
 129         // Check if this is a synchronized event, if so we have received a reply
 130         final SynchronousEventCache synchronousEventCache =
 131                 (SynchronousEventCache) peerReferenceMap.get(EventHandlerPeeredMode.SYNCHRONOUS);
 132         if (synchronousEventCache != null) {
 133             synchronousEventCache.removeCachedEventToApexIfExists(executionId);
 134         }
 135
 136         // Find the peered consumer for this producer
 137         final PeeredReference peeredRequestorReference = peerReferenceMap.get(EventHandlerPeeredMode.REQUESTOR);
 138         if (peeredRequestorReference != null) {
 139             // Find the event Response Consumer that will handle this request
 140             final ApexEventConsumer consumer = peeredRequestorReference.getPeeredConsumer();
 141             if (!(consumer instanceof EventRequestorConsumer)) {
 142                 final String errorMessage = "send of event to event consumer \""
 143                         + peeredRequestorReference.getPeeredConsumer() + "\" failed,"
 144                         + " event response consumer is not an instance of EventRequestorConsumer\n" + eventObject;
 145                 LOGGER.warn(errorMessage);
 146                 throw new ApexEventRuntimeException(errorMessage);
 147             }
 148
 149             // Use the consumer to handle this event
 150             final EventRequestorConsumer eventRequstConsumer = (EventRequestorConsumer) consumer;
 151             eventRequstConsumer.processEvent(eventObject);
 152
 153             eventsSent++;
 154         } else {
 155             // No peered consumer defined
 156             final String errorMessage = "send of event failed, event response consumer is not defined\n" + eventObject;
 157             LOGGER.warn(errorMessage);
 158             throw new ApexEventRuntimeException(errorMessage);
 159         }
 160     }
 161
 162     /**
 163      * {@inheritDoc}.
 164      */
 165     @Override
 166     public void stop() {
 167         // For event requestor, all the implementation is in the consumer
 168     }
 169 }