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