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.restclient;
  22
  23 import java.util.EnumMap;
  24 import java.util.Map;
  25
  26 import javax.ws.rs.client.Client;
  27 import javax.ws.rs.client.ClientBuilder;
  28 import javax.ws.rs.core.Response;
  29
  30 import org.onap.policy.apex.core.infrastructure.threading.ApplicationThreadFactory;
  31 import org.onap.policy.apex.core.infrastructure.threading.ThreadUtilities;
  32 import org.onap.policy.apex.service.engine.event.ApexEventConsumer;
  33 import org.onap.policy.apex.service.engine.event.ApexEventException;
  34 import org.onap.policy.apex.service.engine.event.ApexEventReceiver;
  35 import org.onap.policy.apex.service.engine.event.ApexEventRuntimeException;
  36 import org.onap.policy.apex.service.engine.event.PeeredReference;
  37 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
  38 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerPeeredMode;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 /**
  43  * This class implements an Apex event consumer that receives events from a REST server.
  44  *
  45  * @author Liam Fallon (liam.fallon@ericsson.com)
  46  */
  47 public class ApexRestClientConsumer implements ApexEventConsumer, Runnable {
  48     // Get a reference to the logger
  49     private static final Logger LOGGER = LoggerFactory.getLogger(ApexRestClientConsumer.class);
  50
  51     // The amount of time to wait in milliseconds between checks that the consumer thread has stopped
  52     private static final long REST_CLIENT_WAIT_SLEEP_TIME = 50;
  53
  54     // The REST parameters read from the parameter service
  55     private RestClientCarrierTechnologyParameters restConsumerProperties;
  56
  57     // The event receiver that will receive events from this consumer
  58     private ApexEventReceiver eventReceiver;
  59
  60     // The HTTP client that makes a REST call to get an input event for Apex
  61     private Client client;
  62
  63     // The name for this consumer
  64     private String name = null;
  65
  66     // The peer references for this event handler
  67     private Map<EventHandlerPeeredMode, PeeredReference> peerReferenceMap = new EnumMap<>(EventHandlerPeeredMode.class);
  68
  69     // The consumer thread and stopping flag
  70     private Thread consumerThread;
  71     private boolean stopOrderedFlag = false;
  72
  73     @Override
  74     public void init(final String consumerName, final EventHandlerParameters consumerParameters,
  75                     final ApexEventReceiver incomingEventReceiver) throws ApexEventException {
  76         this.eventReceiver = incomingEventReceiver;
  77         this.name = consumerName;
  78
  79         // Check and get the REST Properties
  80         if (!(consumerParameters.getCarrierTechnologyParameters() instanceof RestClientCarrierTechnologyParameters)) {
  81             final String errorMessage = "specified consumer properties are not applicable to REST client consumer ("
  82                             + this.name + ")";
  83             LOGGER.warn(errorMessage);
  84             throw new ApexEventException(errorMessage);
  85         }
  86         restConsumerProperties = (RestClientCarrierTechnologyParameters) consumerParameters
  87                         .getCarrierTechnologyParameters();
  88
  89         // Check if the HTTP method has been set
  90         if (restConsumerProperties.getHttpMethod() == null) {
  91             restConsumerProperties.setHttpMethod(RestClientCarrierTechnologyParameters.CONSUMER_HTTP_METHOD);
  92         }
  93
  94         if (!restConsumerProperties.getHttpMethod()
  95                         .equalsIgnoreCase(RestClientCarrierTechnologyParameters.CONSUMER_HTTP_METHOD)) {
  96             final String errorMessage = "specified HTTP method of \"" + restConsumerProperties.getHttpMethod()
  97                             + "\" is invalid, only HTTP method \"GET\" "
  98                             + "is supported for event reception on REST client consumer (" + this.name + ")";
  99             LOGGER.warn(errorMessage);
 100             throw new ApexEventException(errorMessage);
 101         }
 102
 103         // Initialize the HTTP client
 104         client = ClientBuilder.newClient();
 105     }
 106
 107     /*
 108      * (non-Javadoc)
 109      *
 110      * @see org.onap.policy.apex.service.engine.event.ApexEventConsumer#start()
 111      */
 112     @Override
 113     public void start() {
 114         // Configure and start the event reception thread
 115         final String threadName = this.getClass().getName() + ":" + this.name;
 116         consumerThread = new ApplicationThreadFactory(threadName).newThread(this);
 117         consumerThread.setDaemon(true);
 118         consumerThread.start();
 119     }
 120
 121     /*
 122      * (non-Javadoc)
 123      *
 124      * @see org.onap.policy.apex.service.engine.event.ApexEventConsumer#getName()
 125      */
 126     @Override
 127     public String getName() {
 128         return name;
 129     }
 130
 131     /*
 132      * (non-Javadoc)
 133      *
 134      * @see org.onap.policy.apex.service.engine.event.ApexEventConsumer#getPeeredReference(org.onap.policy.apex.service.
 135      * parameters. eventhandler.EventHandlerPeeredMode)
 136      */
 137     @Override
 138     public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) {
 139         return peerReferenceMap.get(peeredMode);
 140     }
 141
 142     /*
 143      * (non-Javadoc)
 144      *
 145      * @see org.onap.policy.apex.service.engine.event.ApexEventConsumer#setPeeredReference(org.onap.policy.apex.service.
 146      * parameters. eventhandler.EventHandlerPeeredMode, org.onap.policy.apex.service.engine.event.PeeredReference)
 147      */
 148     @Override
 149     public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {
 150         peerReferenceMap.put(peeredMode, peeredReference);
 151     }
 152
 153     /*
 154      * (non-Javadoc)
 155      *
 156      * @see java.lang.Runnable#run()
 157      */
 158     @Override
 159     public void run() {
 160         // The RequestRunner thread runs the get request for the event
 161         Thread requestRunnerThread = null;
 162
 163         // The endless loop that receives events using REST calls
 164         while (consumerThread.isAlive() && !stopOrderedFlag) {
 165             // Create a new request if one is not in progress
 166             if (requestRunnerThread == null || !requestRunnerThread.isAlive()) {
 167                 requestRunnerThread = new Thread(new RequestRunner());
 168                 requestRunnerThread.start();
 169             }
 170
 171             ThreadUtilities.sleep(REST_CLIENT_WAIT_SLEEP_TIME);
 172         }
 173
 174         client.close();
 175     }
 176
 177     /*
 178      * (non-Javadoc)
 179      *
 180      * @see org.onap.policy.apex.apps.uservice.producer.ApexEventConsumer#stop()
 181      */
 182     @Override
 183     public void stop() {
 184         stopOrderedFlag = true;
 185
 186         while (consumerThread.isAlive()) {
 187             ThreadUtilities.sleep(REST_CLIENT_WAIT_SLEEP_TIME);
 188         }
 189     }
 190
 191     /**
 192      * This class is used to start a thread for each request issued.
 193      *
 194      * @author Liam Fallon (liam.fallon@ericsson.com)
 195      */
 196     private class RequestRunner implements Runnable {
 197         /*
 198          * (non-Javadoc)
 199          *
 200          * @see java.lang.Runnable#run()
 201          */
 202         @Override
 203         public void run() {
 204             try {
 205                 final Response response = client.target(restConsumerProperties.getUrl()).request("application/json")
 206                                 .get();
 207
 208                 // Check that the event request worked
 209                 if (response.getStatus() != Response.Status.OK.getStatusCode()) {
 210                     final String errorMessage = "reception of event from URL \"" + restConsumerProperties.getUrl()
 211                                     + "\" failed with status code " + response.getStatus() + " and message \""
 212                                     + response.readEntity(String.class) + "\"";
 213                     throw new ApexEventRuntimeException(errorMessage);
 214                 }
 215
 216                 // Get the event we received
 217                 final String eventJsonString = response.readEntity(String.class);
 218
 219                 // Check there is content
 220                 if (eventJsonString == null || eventJsonString.trim().length() == 0) {
 221                     final String errorMessage = "received an empty event from URL \"" + restConsumerProperties.getUrl()
 222                                     + "\"";
 223                     throw new ApexEventRuntimeException(errorMessage);
 224                 }
 225
 226                 // Send the event into Apex
 227                 eventReceiver.receiveEvent(eventJsonString);
 228             } catch (final Exception e) {
 229                 LOGGER.warn("error receiving events on thread {}", consumerThread.getName(), e);
 230             }
 231         }
 232     }
 233 }