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.HttpMethod.GET);
  92         }
  93
  94         if (!RestClientCarrierTechnologyParameters.HttpMethod.GET.equals(restConsumerProperties.getHttpMethod())) {
  95             final String errorMessage = "specified HTTP method of \"" + restConsumerProperties.getHttpMethod()
  96                 + "\" is invalid, only HTTP method \"GET\" "
  97                 + "is supported for event reception on REST client consumer (" + this.name + ")";
  98             LOGGER.warn(errorMessage);
  99             throw new ApexEventException(errorMessage);
 100         }
 101
 102         // Initialize the HTTP client
 103         client = ClientBuilder.newClient();
 104     }
 105
 106     /**
 107      * {@inheritDoc}.
 108      */
 109     @Override
 110     public void start() {
 111         // Configure and start the event reception thread
 112         final String threadName = this.getClass().getName() + ":" + this.name;
 113         consumerThread = new ApplicationThreadFactory(threadName).newThread(this);
 114         consumerThread.setDaemon(true);
 115         consumerThread.start();
 116     }
 117
 118     /**
 119      * {@inheritDoc}.
 120      */
 121     @Override
 122     public String getName() {
 123         return name;
 124     }
 125
 126     /**
 127      * {@inheritDoc}.
 128      */
 129     @Override
 130     public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) {
 131         return peerReferenceMap.get(peeredMode);
 132     }
 133
 134     /**
 135      * {@inheritDoc}.
 136      */
 137     @Override
 138     public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {
 139         peerReferenceMap.put(peeredMode, peeredReference);
 140     }
 141
 142     /**
 143      * {@inheritDoc}.
 144      */
 145     @Override
 146     public void run() {
 147         // The RequestRunner thread runs the get request for the event
 148         Thread requestRunnerThread = null;
 149
 150         // The endless loop that receives events using REST calls
 151         while (consumerThread.isAlive() && !stopOrderedFlag) {
 152             // Create a new request if one is not in progress
 153             if (requestRunnerThread == null || !requestRunnerThread.isAlive()) {
 154                 requestRunnerThread = new Thread(new RequestRunner());
 155                 requestRunnerThread.start();
 156             }
 157
 158             ThreadUtilities.sleep(REST_CLIENT_WAIT_SLEEP_TIME);
 159         }
 160
 161         client.close();
 162     }
 163
 164     /**
 165      * {@inheritDoc}.
 166      */
 167     @Override
 168     public void stop() {
 169         stopOrderedFlag = true;
 170
 171         while (consumerThread.isAlive()) {
 172             ThreadUtilities.sleep(REST_CLIENT_WAIT_SLEEP_TIME);
 173         }
 174     }
 175
 176     /**
 177      * This class is used to start a thread for each request issued.
 178      *
 179      * @author Liam Fallon (liam.fallon@ericsson.com)
 180      */
 181     private class RequestRunner implements Runnable {
 182         /**
 183          * {@inheritDoc}.
 184          */
 185         @Override
 186         public void run() {
 187             try {
 188                 final Response response = client.target(restConsumerProperties.getUrl()).request("application/json")
 189                     .headers(restConsumerProperties.getHttpHeadersAsMultivaluedMap()).get();
 190
 191                 // Check that the event request worked
 192                 if (!Response.Status.Family.familyOf(response.getStatus()).equals(Response.Status.Family.SUCCESSFUL)) {
 193                     final String errorMessage = "reception of event from URL \"" + restConsumerProperties.getUrl()
 194                         + "\" failed with status code " + response.getStatus() + " and message \""
 195                         + response.readEntity(String.class) + "\"";
 196                     throw new ApexEventRuntimeException(errorMessage);
 197                 }
 198
 199                 // Get the event we received
 200                 final String eventJsonString = response.readEntity(String.class);
 201
 202                 // Check there is content
 203                 if (eventJsonString == null || eventJsonString.trim().length() == 0) {
 204                     final String errorMessage = "received an empty event from URL \"" + restConsumerProperties.getUrl()
 205                         + "\"";
 206                     throw new ApexEventRuntimeException(errorMessage);
 207                 }
 208
 209                 // Send the event into Apex
 210                 eventReceiver.receiveEvent(null, eventJsonString);
 211             } catch (final Exception e) {
 212                 LOGGER.warn("error receiving events on thread {}", consumerThread.getName(), e);
 213             }
 214         }
 215     }
 216
 217     /**
 218      * Hook for unit test mocking of HTTP client.
 219      *
 220      * @param client the mocked client
 221      */
 222     protected void setClient(final Client client) {
 223         this.client = client;
 224     }
 225 }