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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.apex.plugins.event.carrier.jms;
23 import java.io.Serializable;
24 import java.util.EnumMap;
27 import javax.jms.Connection;
28 import javax.jms.ConnectionFactory;
29 import javax.jms.Message;
30 import javax.jms.MessageProducer;
31 import javax.jms.Session;
32 import javax.jms.Topic;
33 import javax.naming.InitialContext;
35 import org.onap.policy.apex.service.engine.event.ApexEventException;
36 import org.onap.policy.apex.service.engine.event.ApexEventProducer;
37 import org.onap.policy.apex.service.engine.event.ApexEventRuntimeException;
38 import org.onap.policy.apex.service.engine.event.PeeredReference;
39 import org.onap.policy.apex.service.engine.event.SynchronousEventCache;
40 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
41 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerPeeredMode;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
46 * Concrete implementation of an Apex event producer that sends events using JMS.
48 * @author Liam Fallon (liam.fallon@ericsson.com)
50 public class ApexJmsProducer implements ApexEventProducer {
51 // Get a reference to the logger
52 private static final Logger LOGGER = LoggerFactory.getLogger(ApexJmsProducer.class);
54 // Recurring string constants
55 private static final String COULD_NOT_SEND_PREFIX = "could not send event \"";
56 private static final String FOR_PRODUCER_TAG = "\" for producer (";
57 private static final String JMS_MESSAGE_PRODUCER_TAG = "\" on JMS message producer ";
59 // The JMS parameters read from the parameter service
60 private JmsCarrierTechnologyParameters jmsProducerProperties;
62 // The connection to the JMS server
63 private Connection connection;
65 // The JMS session on which we will send events
66 private Session jmsSession;
68 // The producer on which we will send events
69 private MessageProducer messageProducer;
71 // The name for this producer
72 private String name = null;
74 // The peer references for this event handler
75 private Map<EventHandlerPeeredMode, PeeredReference> peerReferenceMap = new EnumMap<>(EventHandlerPeeredMode.class);
80 * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#init(java.lang.String,
81 * org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters)
84 public void init(final String producerName, final EventHandlerParameters producerParameters)
85 throws ApexEventException {
86 this.name = producerName;
88 // Check and get the JMS Properties
89 if (!(producerParameters.getCarrierTechnologyParameters() instanceof JmsCarrierTechnologyParameters)) {
90 final String errorMessage = "specified producer properties are not applicable to a JMS producer ("
92 LOGGER.warn(errorMessage);
93 throw new ApexEventException(errorMessage);
95 jmsProducerProperties = (JmsCarrierTechnologyParameters) producerParameters.getCarrierTechnologyParameters();
97 // Look up the JMS connection factory
98 InitialContext jmsContext = null;
99 ConnectionFactory connectionFactory = null;
101 jmsContext = new InitialContext(jmsProducerProperties.getJmsProducerProperties());
102 connectionFactory = (ConnectionFactory) jmsContext.lookup(jmsProducerProperties.getConnectionFactory());
104 // Check if we actually got a connection factory
105 if (connectionFactory == null) {
106 throw new IllegalArgumentException("JMS context lookup of \"" + jmsProducerProperties.getConnectionFactory()
107 + "\" returned null for producer (" + this.name + ")");
109 } catch (final Exception e) {
110 final String errorMessage = "lookup of JMS connection factory \""
111 + jmsProducerProperties.getConnectionFactory() + "\" failed for JMS producer properties \""
112 + jmsProducerProperties.getJmsConsumerProperties() + FOR_PRODUCER_TAG + this.name + ")";
113 LOGGER.warn(errorMessage, e);
114 throw new ApexEventException(errorMessage, e);
117 // Lookup the topic on which we will send events
118 Topic jmsOutgoingTopic;
120 jmsOutgoingTopic = (Topic) jmsContext.lookup(jmsProducerProperties.getProducerTopic());
122 // Check if we actually got a topic
123 if (jmsOutgoingTopic == null) {
124 throw new IllegalArgumentException("JMS context lookup of \"" + jmsProducerProperties.getProducerTopic()
125 + "\" returned null for producer (" + this.name + ")");
127 } catch (final Exception e) {
128 final String errorMessage = "lookup of JMS topic \"" + jmsProducerProperties.getProducerTopic()
129 + "\" failed for JMS producer properties \""
130 + jmsProducerProperties.getJmsProducerProperties() + FOR_PRODUCER_TAG + this.name + ")";
131 LOGGER.warn(errorMessage, e);
132 throw new ApexEventException(errorMessage, e);
135 // Create and start a connection to the JMS server
137 connection = connectionFactory.createConnection(jmsProducerProperties.getSecurityPrincipal(),
138 jmsProducerProperties.getSecurityCredentials());
140 } catch (final Exception e) {
141 final String errorMessage = "connection to JMS server failed for JMS properties \""
142 + jmsProducerProperties.getJmsConsumerProperties() + FOR_PRODUCER_TAG + this.name + ")";
143 LOGGER.warn(errorMessage, e);
144 throw new ApexEventException(errorMessage, e);
147 // Create a JMS session for sending events
149 jmsSession = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
150 } catch (final Exception e) {
151 final String errorMessage = "creation of session to JMS server failed for JMS properties \""
152 + jmsProducerProperties.getJmsConsumerProperties() + FOR_PRODUCER_TAG + this.name + ")";
153 LOGGER.warn(errorMessage, e);
154 throw new ApexEventException(errorMessage, e);
157 // Create a JMS message producer for sending events
159 messageProducer = jmsSession.createProducer(jmsOutgoingTopic);
160 } catch (final Exception e) {
161 final String errorMessage = "creation of producer for sending events "
162 + "to JMS server failed for JMS properties \""
163 + jmsProducerProperties.getJmsConsumerProperties() + "\"";
164 LOGGER.warn(errorMessage, e);
165 throw new ApexEventException(errorMessage, e);
172 * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#getName()
175 public String getName() {
182 * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#getPeeredReference(org.onap.policy.apex.service.
183 * parameters. eventhandler.EventHandlerPeeredMode)
186 public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) {
187 return peerReferenceMap.get(peeredMode);
193 * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#setPeeredReference(org.onap.policy.apex.service.
194 * parameters. eventhandler.EventHandlerPeeredMode, org.onap.policy.apex.service.engine.event.PeeredReference)
197 public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {
198 peerReferenceMap.put(peeredMode, peeredReference);
204 * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#sendEvent(long, java.lang.String,
208 public void sendEvent(final long executionId, final String eventname, final Object eventObject) {
209 // Check if this is a synchronized event, if so we have received a reply
210 final SynchronousEventCache synchronousEventCache = (SynchronousEventCache) peerReferenceMap
211 .get(EventHandlerPeeredMode.SYNCHRONOUS);
212 if (synchronousEventCache != null) {
213 synchronousEventCache.removeCachedEventToApexIfExists(executionId);
216 // Check if the object to be sent is serializable
217 if (!Serializable.class.isAssignableFrom(eventObject.getClass())) {
218 final String errorMessage = COULD_NOT_SEND_PREFIX + eventname + JMS_MESSAGE_PRODUCER_TAG + this.name
219 + ", object of type \"" + eventObject.getClass().getCanonicalName()
220 + "\" is not serializable";
221 LOGGER.warn(errorMessage);
222 throw new ApexEventRuntimeException(errorMessage);
225 // The JMS message to send is constructed using the JMS session
226 Message jmsMessage = null;
228 // Check the type of JMS message to send
229 if (jmsProducerProperties.isObjectMessageSending()) {
230 // We should send a JMS Object Message
232 jmsMessage = jmsSession.createObjectMessage((Serializable) eventObject);
233 } catch (final Exception e) {
234 final String errorMessage = COULD_NOT_SEND_PREFIX + eventname + JMS_MESSAGE_PRODUCER_TAG
235 + this.name + ", could not create JMS Object Message for object \"" + eventObject;
236 LOGGER.warn(errorMessage, e);
237 throw new ApexEventRuntimeException(errorMessage);
240 // We should send a JMS Text Message
242 jmsMessage = jmsSession.createTextMessage(eventObject.toString());
243 } catch (final Exception e) {
244 final String errorMessage = COULD_NOT_SEND_PREFIX + eventname + JMS_MESSAGE_PRODUCER_TAG
245 + this.name + ", could not create JMS Text Message for object \"" + eventObject;
246 LOGGER.warn(errorMessage, e);
247 throw new ApexEventRuntimeException(errorMessage);
252 messageProducer.send(jmsMessage);
253 } catch (final Exception e) {
254 final String errorMessage = COULD_NOT_SEND_PREFIX + eventname + JMS_MESSAGE_PRODUCER_TAG + this.name
255 + ", send failed for object \"" + eventObject;
256 LOGGER.warn(errorMessage, e);
257 throw new ApexEventRuntimeException(errorMessage);
264 * @see org.onap.policy.apex.apps.uservice.producer.ApexEventProducer#stop()
268 // Close the message producer
270 messageProducer.close();
271 } catch (final Exception e) {
272 final String errorMessage = "failed to close JMS message producer " + this.name + " for sending messages";
273 LOGGER.warn(errorMessage, e);
279 } catch (final Exception e) {
280 final String errorMessage = "failed to close the JMS session for " + this.name + " for sending messages";
281 LOGGER.warn(errorMessage, e);
284 // Close the connection to the JMS server
287 } catch (final Exception e) {
288 final String errorMessage = "close of connection to the JMS server for " + this.name + " failed";
289 LOGGER.warn(errorMessage, e);