gerrit.onap Code Review - policy/apex-pdp.git/blob

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