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

   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.plugins.event.carrier.restclient;
  23
  24 import java.util.EnumMap;
  25 import java.util.Map;
  26 import java.util.Properties;
  27
  28 import java.util.regex.Matcher;
  29 import java.util.regex.Pattern;
  30 import javax.ws.rs.client.Client;
  31 import javax.ws.rs.client.ClientBuilder;
  32 import javax.ws.rs.core.Response;
  33
  34 import org.apache.commons.lang3.StringUtils;
  35 import org.onap.policy.apex.core.infrastructure.threading.ApplicationThreadFactory;
  36 import org.onap.policy.apex.core.infrastructure.threading.ThreadUtilities;
  37 import org.onap.policy.apex.service.engine.event.ApexEventConsumer;
  38 import org.onap.policy.apex.service.engine.event.ApexEventException;
  39 import org.onap.policy.apex.service.engine.event.ApexEventReceiver;
  40 import org.onap.policy.apex.service.engine.event.ApexEventRuntimeException;
  41 import org.onap.policy.apex.service.engine.event.PeeredReference;
  42 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
  43 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerPeeredMode;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46
  47 /**
  48  * This class implements an Apex event consumer that receives events from a REST server.
  49  *
  50  * @author Liam Fallon (liam.fallon@ericsson.com)
  51  */
  52 public class ApexRestClientConsumer implements ApexEventConsumer, Runnable {
  53     // Get a reference to the logger
  54     private static final Logger LOGGER = LoggerFactory.getLogger(ApexRestClientConsumer.class);
  55
  56     // The amount of time to wait in milliseconds between checks that the consumer thread has stopped
  57     private static final long REST_CLIENT_WAIT_SLEEP_TIME = 50;
  58
  59     // The Key for property
  60     private static final String HTTP_CODE_STATUS = "HTTP_CODE_STATUS";
  61
  62     // The REST parameters read from the parameter service
  63     private RestClientCarrierTechnologyParameters restConsumerProperties;
  64
  65     // The event receiver that will receive events from this consumer
  66     private ApexEventReceiver eventReceiver;
  67
  68     // The HTTP client that makes a REST call to get an input event for Apex
  69     private Client client;
  70
  71     // The name for this consumer
  72     private String name = null;
  73
  74     // The peer references for this event handler
  75     private Map<EventHandlerPeeredMode, PeeredReference> peerReferenceMap = new EnumMap<>(EventHandlerPeeredMode.class);
  76
  77     // The pattern for filtering status code
  78     private Pattern httpCodeFilterPattern = null;
  79
  80     // The consumer thread and stopping flag
  81     private Thread consumerThread;
  82     private boolean stopOrderedFlag = false;
  83
  84     @Override
  85     public void init(final String consumerName, final EventHandlerParameters consumerParameters,
  86             final ApexEventReceiver incomingEventReceiver) throws ApexEventException {
  87         this.eventReceiver = incomingEventReceiver;
  88         this.name = consumerName;
  89
  90         // Check and get the REST Properties
  91         if (!(consumerParameters.getCarrierTechnologyParameters() instanceof RestClientCarrierTechnologyParameters)) {
  92             final String errorMessage =
  93                     "specified consumer properties are not applicable to REST client consumer (" + this.name + ")";
  94             LOGGER.warn(errorMessage);
  95             throw new ApexEventException(errorMessage);
  96         }
  97         restConsumerProperties =
  98                 (RestClientCarrierTechnologyParameters) consumerParameters.getCarrierTechnologyParameters();
  99
 100         this.httpCodeFilterPattern = Pattern.compile(restConsumerProperties.getHttpCodeFilter());
 101
 102         // Check if the HTTP method has been set
 103         if (restConsumerProperties.getHttpMethod() == null) {
 104             restConsumerProperties.setHttpMethod(RestClientCarrierTechnologyParameters.HttpMethod.GET);
 105         }
 106
 107         if (!RestClientCarrierTechnologyParameters.HttpMethod.GET.equals(restConsumerProperties.getHttpMethod())) {
 108             final String errorMessage = "specified HTTP method of \"" + restConsumerProperties.getHttpMethod()
 109                     + "\" is invalid, only HTTP method \"GET\" "
 110                     + "is supported for event reception on REST client consumer (" + this.name + ")";
 111             LOGGER.warn(errorMessage);
 112             throw new ApexEventException(errorMessage);
 113         }
 114
 115         // Initialize the HTTP client
 116         client = ClientBuilder.newClient();
 117     }
 118
 119     /**
 120      * {@inheritDoc}.
 121      */
 122     @Override
 123     public void start() {
 124         // Configure and start the event reception thread
 125         final String threadName = this.getClass().getName() + ":" + this.name;
 126         consumerThread = new ApplicationThreadFactory(threadName).newThread(this);
 127         consumerThread.setDaemon(true);
 128         consumerThread.start();
 129     }
 130
 131     /**
 132      * {@inheritDoc}.
 133      */
 134     @Override
 135     public String getName() {
 136         return name;
 137     }
 138
 139     /**
 140      * {@inheritDoc}.
 141      */
 142     @Override
 143     public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) {
 144         return peerReferenceMap.get(peeredMode);
 145     }
 146
 147     /**
 148      * {@inheritDoc}.
 149      */
 150     @Override
 151     public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {
 152         peerReferenceMap.put(peeredMode, peeredReference);
 153     }
 154
 155     /**
 156      * {@inheritDoc}.
 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      * {@inheritDoc}.
 179      */
 180     @Override
 181     public void stop() {
 182         stopOrderedFlag = true;
 183
 184         while (consumerThread.isAlive()) {
 185             ThreadUtilities.sleep(REST_CLIENT_WAIT_SLEEP_TIME);
 186         }
 187     }
 188
 189     /**
 190      * This class is used to start a thread for each request issued.
 191      *
 192      * @author Liam Fallon (liam.fallon@ericsson.com)
 193      */
 194     private class RequestRunner implements Runnable {
 195         /**
 196          * {@inheritDoc}.
 197          */
 198         @Override
 199         public void run() {
 200             try {
 201                 final Response response = client.target(restConsumerProperties.getUrl()).request("application/json")
 202                         .headers(restConsumerProperties.getHttpHeadersAsMultivaluedMap()).get();
 203
 204                 // Match the return code
 205                 Matcher isPass = httpCodeFilterPattern.matcher(String.valueOf(response.getStatus()));
 206
 207                 // Check that status code
 208                 if (!isPass.matches()) {
 209                     final String errorMessage = "reception of event from URL \"" + restConsumerProperties.getUrl()
 210                             + "\" failed with status code " + response.getStatus() + " and message \""
 211                             + response.readEntity(String.class) + "\"";
 212                     LOGGER.warn(errorMessage);
 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 (StringUtils.isBlank(eventJsonString)) {
 221                     final String errorMessage =
 222                             "received an empty event from URL \"" + restConsumerProperties.getUrl() + "\"";
 223                     throw new ApexEventRuntimeException(errorMessage);
 224                 }
 225
 226                 // build a key and value property in excutionProperties
 227                 Properties executionProperties = new Properties();
 228                 executionProperties.put(HTTP_CODE_STATUS, response.getStatus());
 229
 230                 // Send the event into Apex
 231                 eventReceiver.receiveEvent(executionProperties, eventJsonString);
 232             } catch (final Exception e) {
 233                 LOGGER.warn("error receiving events on thread {}", consumerThread.getName(), e);
 234             }
 235         }
 236     }
 237
 238     /**
 239      * Hook for unit test mocking of HTTP client.
 240      *
 241      * @param client the mocked client
 242      */
 243     protected void setClient(final Client client) {
 244         this.client = client;
 245     }
 246 }