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.plugins.event.carrier.restserver;
  22
  23 import java.util.EnumMap;
  24 import java.util.Map;
  25 import java.util.Properties;
  26
  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.PeeredReference;
  30 import org.onap.policy.apex.service.engine.event.SynchronousEventCache;
  31 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
  32 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerPeeredMode;
  33 import org.slf4j.Logger;
  34 import org.slf4j.LoggerFactory;
  35
  36 /**
  37  * Concrete implementation of an Apex event producer that sends events using REST.
  38  *
  39  * @author Liam Fallon (liam.fallon@ericsson.com)
  40  *
  41  */
  42 public class ApexRestServerProducer implements ApexEventProducer {
  43     private static final Logger LOGGER = LoggerFactory.getLogger(ApexRestServerProducer.class);
  44
  45     // The name for this producer
  46     private String name = null;
  47
  48     // The peer references for this event handler
  49     private Map<EventHandlerPeeredMode, PeeredReference> peerReferenceMap = new EnumMap<>(EventHandlerPeeredMode.class);
  50
  51     /*
  52      * (non-Javadoc)
  53      *
  54      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#init(java.lang.String,
  55      * org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters)
  56      */
  57     @Override
  58     public void init(final String producerName, final EventHandlerParameters producerParameters)
  59             throws ApexEventException {
  60         this.name = producerName;
  61
  62         // Check and get the REST Properties
  63         if (!(producerParameters.getCarrierTechnologyParameters() instanceof RestServerCarrierTechnologyParameters)) {
  64             final String errorMessage =
  65                     "specified producer properties are not applicable to REST Server producer (" + this.name + ")";
  66             LOGGER.warn(errorMessage);
  67             throw new ApexEventException(errorMessage);
  68         }
  69
  70         // The REST carrier properties
  71         RestServerCarrierTechnologyParameters restProducerProperties =
  72                 (RestServerCarrierTechnologyParameters) producerParameters.getCarrierTechnologyParameters();
  73
  74         // Check if host and port are defined
  75         if (restProducerProperties.getHost() != null || restProducerProperties.getPort() != -1
  76                 || restProducerProperties.isStandalone()) {
  77             final String errorMessage =
  78                     "the parameters \"host\", \"port\", and \"standalone\" are illegal on REST Server producer ("
  79                             + this.name + ")";
  80             LOGGER.warn(errorMessage);
  81             throw new ApexEventException(errorMessage);
  82         }
  83
  84         // Check if we are in synchronous mode
  85         if (!producerParameters.isPeeredMode(EventHandlerPeeredMode.SYNCHRONOUS)) {
  86             final String errorMessage =
  87                     "REST Server producer (" + this.name + ") must run in synchronous mode with a REST Server consumer";
  88             LOGGER.warn(errorMessage);
  89             throw new ApexEventException(errorMessage);
  90         }
  91     }
  92
  93     /*
  94      * (non-Javadoc)
  95      *
  96      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#getName()
  97      */
  98     @Override
  99     public String getName() {
 100         return name;
 101     }
 102
 103     /*
 104      * (non-Javadoc)
 105      *
 106      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#getPeeredReference(org.onap.policy.apex.service.
 107      * parameters. eventhandler.EventHandlerPeeredMode)
 108      */
 109     @Override
 110     public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) {
 111         return peerReferenceMap.get(peeredMode);
 112     }
 113
 114     /*
 115      * (non-Javadoc)
 116      *
 117      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#setPeeredReference(org.onap.policy.apex.service.
 118      * parameters. eventhandler.EventHandlerPeeredMode, org.onap.policy.apex.service.engine.event.PeeredReference)
 119      */
 120     @Override
 121     public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {
 122         peerReferenceMap.put(peeredMode, peeredReference);
 123     }
 124
 125     /*
 126      * (non-Javadoc)
 127      *
 128      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#sendEvent(long, java.lang. String,
 129      * java.lang.Object)
 130      */
 131     @Override
 132     public void sendEvent(final long executionId, final Properties executionProperties, final String eventName,
 133             final Object event) {
 134         if (LOGGER.isDebugEnabled()) {
 135             String message = name + ": event " + executionId + ':' + eventName + " recevied from Apex, event=" + event;
 136             LOGGER.debug(message);
 137         }
 138
 139         // If we are not synchronized, then exit
 140         final SynchronousEventCache synchronousEventCache =
 141                 (SynchronousEventCache) peerReferenceMap.get(EventHandlerPeeredMode.SYNCHRONOUS);
 142         if (synchronousEventCache == null) {
 143             return;
 144         }
 145
 146         // We see all events on the receiver, even those that are not replies to events sent by the synchronized
 147         // consumer of this producer, ignore those
 148         // events
 149         if (!synchronousEventCache.existsEventToApex(executionId)) {
 150             return;
 151         }
 152
 153         if (LOGGER.isDebugEnabled()) {
 154             LOGGER.debug(name + ": event " + executionId + ':' + eventName + " is a reply to a REST server call from "
 155                     + name);
 156         }
 157
 158         // Add the event to the received event cache
 159         synchronousEventCache.cacheSynchronizedEventFromApex(executionId, event);
 160     }
 161
 162     /*
 163      * (non-Javadoc)
 164      *
 165      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#stop()
 166      */
 167     @Override
 168     public void stop() {
 169         // Implementation not required on this class
 170     }
 171 }