org.soitoolkit.commons.mule.test.AbstractJmsTestUtil Maven / Gradle / Ivy
/*
* Licensed to the soi-toolkit project under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The soi-toolkit project licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.soitoolkit.commons.mule.test;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import javax.jms.JMSException;
import javax.jms.Message;
import javax.jms.MessageConsumer;
import javax.jms.MessageProducer;
import javax.jms.QueueBrowser;
import javax.jms.QueueConnection;
import javax.jms.QueueConnectionFactory;
import javax.jms.QueueSession;
import javax.jms.Session;
import javax.jms.TextMessage;
import javax.jms.Topic;
import javax.jms.TopicConnection;
import javax.jms.TopicConnectionFactory;
import javax.jms.TopicSession;
import javax.jms.TopicSubscriber;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Base class for JMS utility methods, relies on specializations that creates JMS provider specific ConnectionFactories...
*
* @author Magnus Larsson
*
*/
public abstract class AbstractJmsTestUtil {
protected QueueConnection connection = null;
protected QueueSession session = null;
protected TopicConnection topicConnection = null;
protected TopicSession topicSession = null;
protected static final Logger logger = LoggerFactory.getLogger(AbstractJmsTestUtil.class);
/*
* Methods to be implemented by a provider specific implementation
*/
protected abstract QueueConnectionFactory createQueueConnectionFactory() throws Exception;
protected abstract TopicConnectionFactory createTopicConnectionFactory() throws Exception;
protected abstract String getUsername();
protected abstract String getPassword();
public abstract int getNoOfMsgsIncludingPendingForRetry(String queue);
/**
* @return
*/
public QueueSession getSession() {
return session;
}
/**
* @return
*/
public TopicSession getTopicSession() {
return topicSession;
}
/**
* Sends a text messages to a queue.
*
* @param queueName
* @param the messages
*/
public void sendOneTextMessage(String queueName, String message) {
sendOneTextMessage(queueName, message, null);
}
/**
* Sends a text messages to a queue with custom headers.
*
* @param queueName
* @param message
* @param headers
*/
public void sendOneTextMessage(String queueName, String message, Map headers) {
MessageProducer publisher = null;
try {
publisher = session.createProducer(session.createQueue(queueName));
TextMessage textMessage = session.createTextMessage(message);
if (headers != null) {
for (Entry entry : headers.entrySet()) {
textMessage.setStringProperty(entry.getKey(), entry.getValue());
}
}
publisher.send(textMessage);
} catch (JMSException e) {
throw new RuntimeException(e);
} finally {
try {
if (publisher != null) publisher.close();
} catch (JMSException e) {}
}
}
/**
* Browse messages on a queue.
*
* @param queueName
* @return the messages
*/
@SuppressWarnings("rawtypes")
public List browseMessagesOnQueue(String queueName) {
QueueBrowser browser = null;
try {
browser = session.createBrowser(session.createQueue(queueName));
List result = new ArrayList();
Enumeration messages = browser.getEnumeration();
while (messages.hasMoreElements()) {
Message message = (Message)messages.nextElement();
result.add(message);
}
return result;
} catch (JMSException e) {
throw new RuntimeException(e);
} finally {
try {
if (browser != null) browser.close();
} catch (JMSException e) {}
}
}
/**
* Consume messages on a queue.
*
* @param queueName
* @return the messages
*/
public List consumeMessagesOnQueue(String queueName) {
MessageConsumer consumer = null;
try {
consumer = session.createConsumer(session.createQueue(queueName));
List result = new ArrayList();
Message message = null;
while ((message = consumer.receive(100)) != null) {
result.add(message);
}
return result;
} catch (JMSException e) {
throw new RuntimeException(e);
} finally {
try {
if (consumer != null) consumer.close();
} catch (JMSException e) {}
}
}
/**
* Consumes one messages on a queue and waits specified time if none exists up front.
*
* @param queueName
* @param timeout
* @return the text message, null if none was consumed during the specified time period
*/
public String consumeOneTextMessage(String queueName, long timeout) {
String textMessage = null;
Message msg = consumeOneMessage(queueName, timeout);
if (msg != null) {
try {
textMessage = ((TextMessage)msg).getText();
} catch (JMSException e) {
throw new RuntimeException(e);
}
}
return textMessage;
}
/**
* Consumes one messages on a queue and waits specified time if none exists up front.
*
* @param queueName
* @param timeout
* @return the message, null if none was consumed during the specified time period
*/
public Message consumeOneMessage(String queueName, long timeout) {
MessageConsumer consumer = null;
try {
consumer = session.createConsumer(session.createQueue(queueName));
return consumer.receive(timeout);
} catch (JMSException e) {
throw new RuntimeException(e);
} finally {
try {
if (consumer != null) consumer.close();
} catch (JMSException e) {}
}
}
/**
* Clears a number of queues, i.e. consume all messages in the queues.
*
* @param queueName...
* @return
*/
public void clearQueues(String... queueNames) {
if (logger.isInfoEnabled()) {
StringBuffer queues = new StringBuffer();
for (int i = 0; i < queueNames.length; i++) {
queues.append(queueNames[i]);
queues.append(' ');
}
logger.info("Clearing messages on queues: {}", queues);
}
for (int i = 0; i < queueNames.length; i++) {
logger.debug("Start to consume messages from queue {}", queueNames[i]);
List messages = consumeMessagesOnQueue(queueNames[i]);
logger.debug("CONSUMED {} MESSAGES FROM QUEUE {}", messages.size(), queueNames[i]);
}
}
/**
* Consumes one messages on a topic and waits specified time if none exists up front.
*
* @param topic
* @param subscription name
* @param timeout
* @return the message, null if none was consumed during the specified time period
*/
public Message consumeMessageOnTopic(String topicName, String subName, int timeout) {
TopicSubscriber topicSubscriber = null;
try {
topicSubscriber = createDurableSubscriber(topicName, subName);
return topicSubscriber.receive(timeout);
} catch (JMSException e) {
throw new RuntimeException(e);
} finally {
try {
if (topicSubscriber != null) topicSubscriber.close();
} catch (JMSException e) {}
}
}
/**
* Consumes all messages on a topic and waits specified time if none exists up front.
*
* @param topic
* @param subscription name
* @param timeout
* @return the message, null if none was consumed during the specified time period
*/
public List consumeMessagesOnTopic(String topicName, String subName, int timeout) {
List result = new ArrayList();
TopicSubscriber topicSubscriber = null;
try {
topicSubscriber = createDurableSubscriber(topicName, subName);
Message message = null;
while ((message = topicSubscriber.receive(timeout)) != null) {
result.add(message);
}
return result;
} catch (JMSException e) {
throw new RuntimeException(e);
} finally {
try {
if (topicSubscriber != null) topicSubscriber.close();
} catch (JMSException e) {}
}
}
/**
* Creation of a TopicSubscriber (durable)
*
* @param topic
* @param subscription name
* @return the topicSubscriber.
*/
public TopicSubscriber createDurableSubscriber(String topicName, String subName) {
TopicSubscriber topicSubscriber = null;
try {
Topic topic = topicSession.createTopic(topicName);
topicSubscriber = topicSession.createDurableSubscriber(topic,subName);
} catch (JMSException e) {
throw new RuntimeException(e);
}
finally {
}
return topicSubscriber;
}
/**
* Clear all the messages published on a specific topic.
*
* @param topic
* @param subscription name
* @return the topicSubscriber, null if not successful.
*/
public void clearTopic(String topicName, String... subNames) {
for(String subName : subNames) {
if (logger.isInfoEnabled()) {
logger.info("Clearing messages on topic: {} and subscription: {}", topicName, subName);
}
TopicSubscriber topicSubscriber = null;
try {
topicSubscriber = createDurableSubscriber(topicName, subName);
while(topicSubscriber != null && topicSubscriber.receiveNoWait() != null);
} catch (JMSException e) {
throw new RuntimeException(e);
}
finally {
try {
if (topicSubscriber != null) {
topicSubscriber.close();
}
} catch (JMSException e) {}
}
}
}
//
// To be called from the specializations constructors...
//
protected void init(String clientId) {
boolean ok = false;
try {
QueueConnectionFactory connectionFactory = createQueueConnectionFactory();
String username = getUsername();
if (username == null) {
connection = connectionFactory.createQueueConnection();
} else {
connection = connectionFactory.createQueueConnection(username, getPassword());
}
connection.start();
session = connection.createQueueSession(false, Session.AUTO_ACKNOWLEDGE);
ok = true;
} catch (Exception e) {
throw new RuntimeException(e);
} finally {
if (!ok) cleanup();
}
if (clientId != null) {
try {
TopicConnectionFactory topicConnectionFactory = createTopicConnectionFactory();
String username = getUsername();
if (username == null) {
topicConnection = topicConnectionFactory.createTopicConnection();
} else {
topicConnection = topicConnectionFactory.createTopicConnection(username, getPassword());
}
topicConnection.setClientID(clientId);
topicConnection.start();
topicSession = topicConnection.createTopicSession(false, Session.AUTO_ACKNOWLEDGE);
ok = true;
} catch (Exception e) {
throw new RuntimeException(e);
} finally {
if (!ok) cleanup();
}
}
}
/**
* TODO: ML FIX
*/
public void cleanup() {
try {
if (session != null) session.close();
if (connection != null) {
connection.stop();
connection.close();
}
} catch (JMSException e) {
throw new RuntimeException(e);
}
try {
if (topicSession != null) topicSession.close();
if (topicConnection != null) {
topicConnection.stop();
topicConnection.close();
}
} catch (JMSException e) {
throw new RuntimeException(e);
}
}
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy