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.restrequestor;
  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 requestor that manages the producer side of a REST request.
  39  *
  40  * @author Liam Fallon (liam.fallon@ericsson.com)
  41  *
  42  */
  43 public class ApexRestRequestorProducer implements ApexEventProducer {
  44     private static final Logger LOGGER = LoggerFactory.getLogger(ApexRestRequestorProducer.class);
  45
  46     // The REST carrier properties
  47     private RestRequestorCarrierTechnologyParameters restProducerProperties;
  48
  49     // The name for this producer
  50     private String name = null;
  51
  52     // The peer references for this event handler
  53     private Map<EventHandlerPeeredMode, PeeredReference> peerReferenceMap = new EnumMap<>(EventHandlerPeeredMode.class);
  54
  55     // The number of events sent
  56     private int eventsSent = 0;
  57
  58     /*
  59      * (non-Javadoc)
  60      *
  61      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#init(java.lang.String,
  62      * org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters)
  63      */
  64     @Override
  65     public void init(final String producerName, final EventHandlerParameters producerParameters)
  66             throws ApexEventException {
  67         this.name = producerName;
  68
  69         // Check and get the REST Properties
  70         if (!(producerParameters
  71                 .getCarrierTechnologyParameters() instanceof RestRequestorCarrierTechnologyParameters)) {
  72             final String errorMessage =
  73                     "specified consumer properties are not applicable to REST requestor producer (" + this.name + ")";
  74             LOGGER.warn(errorMessage);
  75             throw new ApexEventException(errorMessage);
  76         }
  77         restProducerProperties =
  78                 (RestRequestorCarrierTechnologyParameters) producerParameters.getCarrierTechnologyParameters();
  79
  80         // Check if we are in peered mode
  81         if (!producerParameters.isPeeredMode(EventHandlerPeeredMode.REQUESTOR)) {
  82             final String errorMessage = "REST Requestor producer (" + this.name
  83                     + ") must run in peered requestor mode with a REST Requestor consumer";
  84             LOGGER.warn(errorMessage);
  85             throw new ApexEventException(errorMessage);
  86         }
  87
  88         // Check if the HTTP URL has been set
  89         if (restProducerProperties.getUrl() != null) {
  90             final String errorMessage = "URL may not be specified on REST Requestor producer (" + this.name + ")";
  91             LOGGER.warn(errorMessage);
  92             throw new ApexEventException(errorMessage);
  93         }
  94
  95         // Check if the HTTP method has been set
  96         if (restProducerProperties.getHttpMethod() != null) {
  97             final String errorMessage =
  98                     "HTTP method may not be specified on REST Requestor producer (" + this.name + ")";
  99             LOGGER.warn(errorMessage);
 100             throw new ApexEventException(errorMessage);
 101         }
 102     }
 103
 104     /*
 105      * (non-Javadoc)
 106      *
 107      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#getName()
 108      */
 109     @Override
 110     public String getName() {
 111         return name;
 112     }
 113
 114     /**
 115      * Get the number of events sent to date.
 116      *
 117      * @return the number of events received
 118      */
 119     public int getEventsSent() {
 120         return eventsSent;
 121     }
 122
 123     /*
 124      * (non-Javadoc)
 125      *
 126      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#getPeeredReference(org.onap.policy.apex.service.
 127      * parameters.eventhandler.EventHandlerPeeredMode)
 128      */
 129     @Override
 130     public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) {
 131         return peerReferenceMap.get(peeredMode);
 132     }
 133
 134     /*
 135      * (non-Javadoc)
 136      *
 137      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#setPeeredReference(org.onap.policy.apex.service.
 138      * parameters.eventhandler.EventHandlerPeeredMode, org.onap.policy.apex.service.engine.event.PeeredReference)
 139      */
 140     @Override
 141     public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {
 142         peerReferenceMap.put(peeredMode, peeredReference);
 143     }
 144
 145     /*
 146      * (non-Javadoc)
 147      *
 148      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#sendEvent(long, java.lang. String,
 149      * java.lang.Object)
 150      */
 151     @Override
 152     public void sendEvent(final long executionId, final String eventName, final Object event) {
 153         // Check if this is a synchronized event, if so we have received a reply
 154         final SynchronousEventCache synchronousEventCache =
 155                 (SynchronousEventCache) peerReferenceMap.get(EventHandlerPeeredMode.SYNCHRONOUS);
 156         if (synchronousEventCache != null) {
 157             synchronousEventCache.removeCachedEventToApexIfExists(executionId);
 158         }
 159
 160         // Find the peered consumer for this producer
 161         final PeeredReference peeredRequestorReference = peerReferenceMap.get(EventHandlerPeeredMode.REQUESTOR);
 162         if (peeredRequestorReference != null) {
 163             // Find the REST Response Consumer that will handle this request
 164             final ApexEventConsumer consumer = peeredRequestorReference.getPeeredConsumer();
 165             if (!(consumer instanceof ApexRestRequestorConsumer)) {
 166                 final String errorMessage = "send of event to URL \"" + restProducerProperties.getUrl() + "\" failed,"
 167                         + " REST response consumer is not an instance of ApexRestRequestorConsumer\n" + event;
 168                 LOGGER.warn(errorMessage);
 169                 throw new ApexEventRuntimeException(errorMessage);
 170             }
 171
 172             // Use the consumer to handle this event
 173             final ApexRestRequestorConsumer restRequstConsumer = (ApexRestRequestorConsumer) consumer;
 174             restRequstConsumer.processRestRequest(new ApexRestRequest(executionId, eventName, event));
 175
 176             eventsSent++;
 177         } else {
 178             // No peered consumer defined
 179             final String errorMessage = "send of event to URL \"" + restProducerProperties.getUrl() + "\" failed,"
 180                     + " REST response consumer is not defined\n" + event;
 181             LOGGER.warn(errorMessage);
 182             throw new ApexEventRuntimeException(errorMessage);
 183         }
 184     }
 185
 186     /*
 187      * (non-Javadoc)
 188      *
 189      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#stop()
 190      */
 191     @Override
 192     public void stop() {
 193         // For REST requestor, all the implementation is in the consumer
 194     }
 195 }