services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/impl/filecarrierplugin/consumer/ApexFileEventConsumer.java

   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.service.engine.event.impl.filecarrierplugin.consumer;
  22
  23 import java.io.FileInputStream;
  24 import java.io.IOException;
  25 import java.io.InputStream;
  26 import java.util.EnumMap;
  27 import java.util.Map;
  28 import java.util.Properties;
  29 import java.util.concurrent.atomic.AtomicLong;
  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.PeeredReference;
  36 import org.onap.policy.apex.service.engine.event.impl.filecarrierplugin.FileCarrierTechnologyParameters;
  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  * Concrete implementation an Apex event consumer that reads events from a file. This consumer also implements
  44  * ApexEventProducer and therefore can be used as a synchronous consumer.
  45  *
  46  * @author Liam Fallon (liam.fallon@ericsson.com)
  47  */
  48 public class ApexFileEventConsumer implements ApexEventConsumer, Runnable {
  49     // Get a reference to the logger
  50     private static final Logger LOGGER = LoggerFactory.getLogger(ApexFileEventConsumer.class);
  51
  52     // Recurring string constants
  53     private static final String APEX_FILE_CONSUMER_PREAMBLE = "ApexFileConsumer \"";
  54
  55     // The input stream to read events from
  56     private InputStream eventInputStream;
  57
  58     // The text block reader that will read text blocks from the contents of the file
  59     private TextBlockReader textBlockReader;
  60
  61     // The event receiver that will receive asynchronous events from this consumer
  62     private ApexEventReceiver eventReceiver = null;
  63
  64     // The consumer thread and stopping flag
  65     private Thread consumerThread;
  66
  67     // The name for this consumer
  68     private String consumerName = null;
  69
  70     // The specific carrier technology parameters for this consumer
  71     private FileCarrierTechnologyParameters fileCarrierTechnologyParameters;
  72
  73     // The peer references for this event handler
  74     private final Map<EventHandlerPeeredMode, PeeredReference> peerReferenceMap = new EnumMap<>(
  75                     EventHandlerPeeredMode.class);
  76
  77     // Holds the next identifier for event execution.
  78     private static AtomicLong nextExecutionID = new AtomicLong(0L);
  79
  80     /**
  81      * Private utility to get the next candidate value for a Execution ID. This value will always be unique in a single
  82      * JVM
  83      *
  84      * @return the next candidate value for a Execution ID
  85      */
  86     private static synchronized long getNextExecutionId() {
  87         return nextExecutionID.getAndIncrement();
  88     }
  89
  90     /**
  91      * {@inheritDoc}.
  92      */
  93     @Override
  94     public void init(final String name, final EventHandlerParameters consumerParameters,
  95                     final ApexEventReceiver incomingEventReceiver) throws ApexEventException {
  96         this.eventReceiver = incomingEventReceiver;
  97         this.consumerName = name;
  98
  99         // Get and check the Apex parameters from the parameter service
 100         if (consumerParameters == null) {
 101             final String errorMessage = "Consumer parameters for ApexFileConsumer \"" + consumerName + "\" is null";
 102             LOGGER.warn(errorMessage);
 103             throw new ApexEventException(errorMessage);
 104         }
 105
 106         // Check and get the file Properties
 107         if (!(consumerParameters.getCarrierTechnologyParameters() instanceof FileCarrierTechnologyParameters)) {
 108             final String errorMessage = "specified consumer properties for ApexFileConsumer \"" + consumerName
 109                             + "\" are not applicable to a File consumer";
 110             LOGGER.warn(errorMessage);
 111             throw new ApexEventException(errorMessage);
 112         }
 113         fileCarrierTechnologyParameters = (FileCarrierTechnologyParameters) consumerParameters
 114                         .getCarrierTechnologyParameters();
 115
 116         // Open the file producing events
 117         try {
 118             if (fileCarrierTechnologyParameters.isStandardIo()) {
 119                 eventInputStream = System.in;
 120             } else {
 121                 eventInputStream = new FileInputStream(fileCarrierTechnologyParameters.getFileName());
 122             }
 123
 124             // Get an event composer for our event source
 125             textBlockReader = new TextBlockReaderFactory().getTaggedReader(eventInputStream,
 126                             consumerParameters.getEventProtocolParameters());
 127         } catch (final IOException e) {
 128             final String errorMessage = APEX_FILE_CONSUMER_PREAMBLE + consumerName
 129                             + "\" failed to open file for reading: \"" + fileCarrierTechnologyParameters.getFileName()
 130                             + "\"";
 131             LOGGER.warn(errorMessage, e);
 132             throw new ApexEventException(errorMessage, e);
 133         }
 134
 135         if (fileCarrierTechnologyParameters.getStartDelay() > 0) {
 136             ThreadUtilities.sleep(fileCarrierTechnologyParameters.getStartDelay());
 137         }
 138     }
 139
 140     /**
 141      * {@inheritDoc}.
 142      */
 143     @Override
 144     public String getName() {
 145         return consumerName;
 146     }
 147
 148     /**
 149      * {@inheritDoc}.
 150      */
 151     @Override
 152     public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) {
 153         return peerReferenceMap.get(peeredMode);
 154     }
 155
 156     /**
 157      * {@inheritDoc}.
 158      */
 159     @Override
 160     public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {
 161         peerReferenceMap.put(peeredMode, peeredReference);
 162     }
 163
 164     /**
 165      * {@inheritDoc}.
 166      */
 167     @Override
 168     public void start() {
 169         // Configure and start the event reception thread
 170         final String threadName = this.getClass().getName() + " : " + consumerName;
 171         consumerThread = new ApplicationThreadFactory(threadName).newThread(this);
 172         consumerThread.setDaemon(true);
 173         consumerThread.start();
 174     }
 175
 176     /**
 177      * {@inheritDoc}.
 178      */
 179     @Override
 180     public void run() {
 181         // Check that we have been initialized in async or sync mode
 182         if (eventReceiver == null) {
 183             LOGGER.warn("\"{}\" has not been initilaized for either asynchronous or synchronous event handling",
 184                             consumerName);
 185             return;
 186         }
 187
 188         // Read the events from the file while there are still events in the file
 189         try {
 190             // Read all the text blocks
 191             TextBlock textBlock;
 192             do {
 193                 // Read the text block
 194                 textBlock = textBlockReader.readTextBlock();
 195
 196                 // Process the event from the text block if there is one there
 197                 if (textBlock.getText() != null) {
 198                     eventReceiver.receiveEvent(getNextExecutionId(), new Properties(), textBlock.getText());
 199                 }
 200             } while (!textBlock.isEndOfText());
 201         } catch (final Exception e) {
 202             LOGGER.warn("\"" + consumerName + "\" failed to read event from file: \""
 203                             + fileCarrierTechnologyParameters.getFileName() + "\"", e);
 204         } finally {
 205             try {
 206                 eventInputStream.close();
 207             } catch (final IOException e) {
 208                 LOGGER.warn(APEX_FILE_CONSUMER_PREAMBLE + consumerName + "\" failed to close file: \""
 209                                 + fileCarrierTechnologyParameters.getFileName() + "\"", e);
 210             }
 211         }
 212
 213     }
 214
 215     /**
 216      * {@inheritDoc}.
 217      */
 218     @Override
 219     public void stop() {
 220         try {
 221             eventInputStream.close();
 222         } catch (final IOException e) {
 223             LOGGER.warn(APEX_FILE_CONSUMER_PREAMBLE + consumerName + "\" failed to close file for reading: \""
 224                             + fileCarrierTechnologyParameters.getFileName() + "\"", e);
 225         }
 226
 227         if (consumerThread.isAlive() && !consumerThread.isInterrupted()) {
 228             consumerThread.interrupt();
 229         }
 230     }
 231 }