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.jms;
  23
  24 import java.util.EnumMap;
  25 import java.util.Map;
  26 import java.util.Properties;
  27
  28 import javax.jms.Connection;
  29 import javax.jms.ConnectionFactory;
  30 import javax.jms.Message;
  31 import javax.jms.MessageConsumer;
  32 import javax.jms.MessageListener;
  33 import javax.jms.Session;
  34 import javax.jms.Topic;
  35 import javax.naming.InitialContext;
  36
  37 import org.onap.policy.apex.core.infrastructure.threading.ApplicationThreadFactory;
  38 import org.onap.policy.apex.core.infrastructure.threading.ThreadUtilities;
  39 import org.onap.policy.apex.service.engine.event.ApexEventConsumer;
  40 import org.onap.policy.apex.service.engine.event.ApexEventException;
  41 import org.onap.policy.apex.service.engine.event.ApexEventReceiver;
  42 import org.onap.policy.apex.service.engine.event.ApexEventRuntimeException;
  43 import org.onap.policy.apex.service.engine.event.PeeredReference;
  44 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
  45 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerPeeredMode;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48
  49 /**
  50  * This class implements an Apex event consumer that receives events using JMS.
  51  *
  52  * @author Liam Fallon (liam.fallon@ericsson.com)
  53  */
  54 public class ApexJmsConsumer implements MessageListener, ApexEventConsumer, Runnable {
  55     // Get a reference to the logger
  56     private static final Logger LOGGER = LoggerFactory.getLogger(ApexJmsConsumer.class);
  57
  58     // The Apex and JMS parameters read from the parameter service
  59     private JmsCarrierTechnologyParameters jmsConsumerProperties;
  60
  61     // The event receiver that will receive events from this consumer
  62     private ApexEventReceiver eventReceiver;
  63
  64     // The consumer thread and stopping flag
  65     private Thread consumerThread;
  66     private boolean stopOrderedFlag = false;
  67
  68     // The connection to the JMS server
  69     private Connection connection;
  70
  71     // The topic on which we receive events from JMS
  72     private Topic jmsIncomingTopic;
  73
  74     // The name for this consumer
  75     private String name = null;
  76
  77     // The peer references for this event handler
  78     private Map<EventHandlerPeeredMode, PeeredReference> peerReferenceMap = new EnumMap<>(EventHandlerPeeredMode.class);
  79
  80     @Override
  81     public void init(final String consumerName, final EventHandlerParameters consumerParameters,
  82             final ApexEventReceiver incomingEventReceiver) throws ApexEventException {
  83         this.eventReceiver = incomingEventReceiver;
  84
  85         this.name = consumerName;
  86
  87         // Check and get the JMS Properties
  88         if (!(consumerParameters.getCarrierTechnologyParameters() instanceof JmsCarrierTechnologyParameters)) {
  89             final String errorMessage = "specified consumer properties of type \""
  90                     + consumerParameters.getCarrierTechnologyParameters().getClass().getCanonicalName()
  91                     + "\" are not applicable to a JMS consumer";
  92             LOGGER.warn(errorMessage);
  93             throw new ApexEventException(errorMessage);
  94         }
  95         jmsConsumerProperties = (JmsCarrierTechnologyParameters) consumerParameters.getCarrierTechnologyParameters();
  96
  97         // Look up the JMS connection factory
  98         InitialContext jmsContext = null;
  99         ConnectionFactory connectionFactory = null;
 100         try {
 101             jmsContext = new InitialContext(jmsConsumerProperties.getJmsConsumerProperties());
 102             connectionFactory = (ConnectionFactory) jmsContext.lookup(jmsConsumerProperties.getConnectionFactory());
 103
 104             // Check if we actually got a connection factory
 105             if (connectionFactory == null) {
 106                 throw new IllegalArgumentException(
 107                         "JMS context lookup of \"" + jmsConsumerProperties.getConnectionFactory() + "\" returned null");
 108             }
 109         } catch (final Exception e) {
 110             final String errorMessage = "lookup of JMS connection factory  \""
 111                     + jmsConsumerProperties.getConnectionFactory() + "\" failed for JMS consumer properties \""
 112                     + jmsConsumerProperties.getJmsConsumerProperties() + "\"";
 113             LOGGER.warn(errorMessage, e);
 114             throw new ApexEventException(errorMessage, e);
 115         }
 116
 117         // Lookup the topic on which we will receive events
 118         try {
 119             jmsIncomingTopic = (Topic) jmsContext.lookup(jmsConsumerProperties.getConsumerTopic());
 120
 121             // Check if we actually got a topic
 122             if (jmsIncomingTopic == null) {
 123                 throw new IllegalArgumentException(
 124                         "JMS context lookup of \"" + jmsConsumerProperties.getConsumerTopic() + "\" returned null");
 125             }
 126         } catch (final Exception e) {
 127             final String errorMessage = "lookup of JMS topic  \"" + jmsConsumerProperties.getConsumerTopic()
 128                     + "\" failed for JMS consumer properties \"" + jmsConsumerProperties.getJmsConsumerProperties()
 129                     + "\"";
 130             LOGGER.warn(errorMessage, e);
 131             throw new ApexEventException(errorMessage, e);
 132         }
 133
 134         // Create and start a connection to the JMS server
 135         try {
 136             connection = connectionFactory.createConnection(jmsConsumerProperties.getSecurityPrincipal(),
 137                     jmsConsumerProperties.getSecurityCredentials());
 138             connection.start();
 139         } catch (final Exception e) {
 140             final String errorMessage = "connection to the JMS server failed for JMS properties \""
 141                     + jmsConsumerProperties.getJmsConsumerProperties() + "\"";
 142             LOGGER.warn(errorMessage, e);
 143             throw new ApexEventException(errorMessage, e);
 144         }
 145     }
 146
 147     /**
 148      * {@inheritDoc}.
 149      */
 150     @Override
 151     public void start() {
 152         // Configure and start the event reception thread
 153         final String threadName = this.getClass().getName() + ":" + this.name;
 154         consumerThread = new ApplicationThreadFactory(threadName).newThread(this);
 155         consumerThread.setDaemon(true);
 156         consumerThread.start();
 157     }
 158
 159     /**
 160      * {@inheritDoc}.
 161      */
 162     @Override
 163     public String getName() {
 164         return name;
 165     }
 166
 167     /**
 168      * {@inheritDoc}.
 169      */
 170     @Override
 171     public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) {
 172         return peerReferenceMap.get(peeredMode);
 173     }
 174
 175     /**
 176      * {@inheritDoc}.
 177      */
 178     @Override
 179     public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {
 180         peerReferenceMap.put(peeredMode, peeredReference);
 181     }
 182
 183     /**
 184      * {@inheritDoc}.
 185      */
 186     @Override
 187     public void run() {
 188         // JMS session and message consumer for receiving messages
 189         try (final Session jmsSession = connection.createSession(false, Session.AUTO_ACKNOWLEDGE)) {
 190             // Create a message consumer for reception of messages and set this class as a message listener
 191             createMessageConsumer(jmsSession);
 192         } catch (final Exception e) {
 193             final String errorMessage = "failed to create a JMS session towards the JMS server for receiving messages";
 194             LOGGER.warn(errorMessage, e);
 195             throw new ApexEventRuntimeException(errorMessage, e);
 196         }
 197         // Everything is now set up
 198         if (LOGGER.isDebugEnabled()) {
 199             LOGGER.debug("event receiver " + this.getClass().getName() + ":" + this.name + " subscribed to JMS topic: "
 200                     + jmsConsumerProperties.getConsumerTopic());
 201         }
 202     }
 203
 204     /**
 205      * The helper function to create a message consumer from a given JMS session.
 206      *
 207      * @param jmsSession a JMS session
 208      */
 209     private void createMessageConsumer(final Session jmsSession) {
 210         try (final MessageConsumer messageConsumer = jmsSession.createConsumer(jmsIncomingTopic)) {
 211             messageConsumer.setMessageListener(this);
 212
 213             // The endless loop that receives events over JMS
 214             while (consumerThread.isAlive() && !stopOrderedFlag) {
 215                 ThreadUtilities.sleep(jmsConsumerProperties.getConsumerWaitTime());
 216             }
 217         } catch (final Exception e) {
 218             final String errorMessage = "failed to create a JMS message consumer for receiving messages";
 219             LOGGER.warn(errorMessage, e);
 220             throw new ApexEventRuntimeException(errorMessage, e);
 221         }
 222     }
 223
 224     /**
 225      * {@inheritDoc}.
 226      */
 227     @Override
 228     public void onMessage(final Message jmsMessage) {
 229         try {
 230             if (LOGGER.isTraceEnabled()) {
 231                 LOGGER.trace("event received for {} for forwarding to Apex engine : {} {}",
 232                         this.getClass().getName() + ":" + this.name, jmsMessage.getJMSMessageID(),
 233                         jmsMessage.getJMSType());
 234             }
 235
 236             eventReceiver.receiveEvent(new Properties(), jmsMessage);
 237         } catch (final Exception e) {
 238             final String errorMessage = "failed to receive message from JMS";
 239             LOGGER.warn(errorMessage, e);
 240             throw new ApexEventRuntimeException(errorMessage, e);
 241         }
 242     }
 243
 244     /**
 245      * {@inheritDoc}.
 246      */
 247     @Override
 248     public void stop() {
 249         stopOrderedFlag = true;
 250
 251         while (consumerThread.isAlive()) {
 252             ThreadUtilities.sleep(jmsConsumerProperties.getConsumerWaitTime());
 253         }
 254
 255         // Close the connection to the JMS server
 256         try {
 257             if (connection != null) {
 258                 connection.close();
 259             }
 260         } catch (final Exception e) {
 261             final String errorMessage = "close of connection to the JMS server failed";
 262             LOGGER.warn(errorMessage, e);
 263         }
 264     }
 265
 266 }