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