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