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      * {@inheritDoc}.
  61      */
  62     @Override
  63     public void init(final String producerName, final EventHandlerParameters producerParameters)
  64             throws ApexEventException {
  65         this.name = producerName;
  66
  67         // Check and get the producer Properties
  68         if (!(producerParameters
  69                 .getCarrierTechnologyParameters() instanceof EventRequestorCarrierTechnologyParameters)) {
  70             final String errorMessage =
  71                     "specified consumer properties are not applicable to event requestor producer (" + this.name + ")";
  72             LOGGER.warn(errorMessage);
  73             throw new ApexEventException(errorMessage);
  74         }
  75
  76         // Check if we are in peered mode
  77         if (!producerParameters.isPeeredMode(EventHandlerPeeredMode.REQUESTOR)) {
  78             final String errorMessage = "Event Requestor producer (" + this.name
  79                     + ") must run in peered requestor mode with a Event Requestor consumer";
  80             LOGGER.warn(errorMessage);
  81             throw new ApexEventException(errorMessage);
  82         }
  83     }
  84
  85     /**
  86      * {@inheritDoc}.
  87      */
  88     @Override
  89     public String getName() {
  90         return name;
  91     }
  92
  93     /**
  94      * Get the number of events sent to date.
  95      *
  96      * @return the number of events received
  97      */
  98     public int getEventsSent() {
  99         return eventsSent;
 100     }
 101
 102     /**
 103      * {@inheritDoc}.
 104      */
 105     @Override
 106     public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) {
 107         return peerReferenceMap.get(peeredMode);
 108     }
 109
 110     /**
 111      * {@inheritDoc}.
 112      */
 113     @Override
 114     public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {
 115         peerReferenceMap.put(peeredMode, peeredReference);
 116     }
 117
 118     /**
 119      * {@inheritDoc}.
 120      */
 121     @Override
 122     public void sendEvent(final long executionId, final Properties executorProperties, final String eventName,
 123             final Object eventObject) {
 124         // Check if this is a synchronized event, if so we have received a reply
 125         final SynchronousEventCache synchronousEventCache =
 126                 (SynchronousEventCache) peerReferenceMap.get(EventHandlerPeeredMode.SYNCHRONOUS);
 127         if (synchronousEventCache != null) {
 128             synchronousEventCache.removeCachedEventToApexIfExists(executionId);
 129         }
 130
 131         // Find the peered consumer for this producer
 132         final PeeredReference peeredRequestorReference = peerReferenceMap.get(EventHandlerPeeredMode.REQUESTOR);
 133         if (peeredRequestorReference != null) {
 134             // Find the event Response Consumer that will handle this request
 135             final ApexEventConsumer consumer = peeredRequestorReference.getPeeredConsumer();
 136             if (!(consumer instanceof EventRequestorConsumer)) {
 137                 final String errorMessage = "send of event to event consumer \""
 138                         + peeredRequestorReference.getPeeredConsumer() + "\" failed,"
 139                         + " event response consumer is not an instance of EventRequestorConsumer\n" + eventObject;
 140                 LOGGER.warn(errorMessage);
 141                 throw new ApexEventRuntimeException(errorMessage);
 142             }
 143
 144             // Use the consumer to handle this event
 145             final EventRequestorConsumer eventRequstConsumer = (EventRequestorConsumer) consumer;
 146             eventRequstConsumer.processEvent(eventObject);
 147
 148             eventsSent++;
 149         } else {
 150             // No peered consumer defined
 151             final String errorMessage = "send of event failed, event response consumer is not defined\n" + eventObject;
 152             LOGGER.warn(errorMessage);
 153             throw new ApexEventRuntimeException(errorMessage);
 154         }
 155     }
 156
 157     /**
 158      * {@inheritDoc}.
 159      */
 160     @Override
 161     public void stop() {
 162         // For event requestor, all the implementation is in the consumer
 163     }
 164 }