/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF 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.apache.servicemix.jbi.nmr.flow.jms;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArraySet;
import java.util.concurrent.atomic.AtomicBoolean;
import javax.jbi.JBIException;
import javax.jbi.messaging.MessageExchange;
import javax.jbi.messaging.MessageExchange.Role;
import javax.jbi.messaging.MessagingException;
import javax.jbi.servicedesc.ServiceEndpoint;
import javax.jms.Connection;
import javax.jms.ConnectionFactory;
import javax.jms.DeliveryMode;
import javax.jms.JMSException;
import javax.jms.Message;
import javax.jms.MessageConsumer;
import javax.jms.MessageListener;
import javax.jms.MessageProducer;
import javax.jms.ObjectMessage;
import javax.jms.Queue;
import javax.jms.Session;
import javax.jms.Topic;
import org.apache.activemq.pool.PooledConnectionFactory;
import org.apache.servicemix.JbiConstants;
import org.apache.servicemix.executors.Executor;
import org.apache.servicemix.jbi.event.ComponentAdapter;
import org.apache.servicemix.jbi.event.ComponentEvent;
import org.apache.servicemix.jbi.event.ComponentListener;
import org.apache.servicemix.jbi.event.EndpointAdapter;
import org.apache.servicemix.jbi.event.EndpointEvent;
import org.apache.servicemix.jbi.event.EndpointListener;
import org.apache.servicemix.jbi.framework.ComponentMBeanImpl;
import org.apache.servicemix.jbi.messaging.MessageExchangeImpl;
import org.apache.servicemix.jbi.nmr.Broker;
import org.apache.servicemix.jbi.nmr.flow.AbstractFlow;
import org.apache.servicemix.jbi.servicedesc.EndpointSupport;
import org.apache.servicemix.jbi.servicedesc.InternalEndpoint;
/**
* Use for message routing among a network of containers. All
* routing/registration happens automatically.
*
*/
public abstract class AbstractJMSFlow extends AbstractFlow implements MessageListener {
private static final String INBOUND_PREFIX = "org.apache.servicemix.jms.";
protected ConnectionFactory connectionFactory;
protected Connection connection;
protected AtomicBoolean started = new AtomicBoolean(false);
protected MessageConsumer monitorMessageConsumer;
protected Set<String> subscriberSet = new CopyOnWriteArraySet<String>();
private String userName;
private String password;
private String broadcastDestinationName = "org.apache.servicemix.JMSFlow";
private MessageConsumer broadcastConsumer;
private Map<String, MessageConsumerSession> consumerMap = new ConcurrentHashMap<String, MessageConsumerSession>();
private EndpointListener endpointListener;
private ComponentListener componentListener;
private Executor executor;
private String jmsURL = "peer://org.apache.servicemix?persistent=false";
/**
* The type of Flow
*
* @return the type
*/
public String getDescription() {
return "jms";
}
/**
* @return Returns the password.
*/
public String getPassword() {
return password;
}
/**
* @param password
* The password to set.
*/
public void setPassword(String password) {
this.password = password;
}
/**
* @return Returns the userName.
*/
public String getUserName() {
return userName;
}
/**
* @param userName
* The userName to set.
*/
public void setUserName(String userName) {
this.userName = userName;
}
/**
* @return Returns the connectionFactory.
*/
public ConnectionFactory getConnectionFactory() {
return connectionFactory;
}
/**
* @param connectionFactory
* The connectionFactory to set.
*/
public void setConnectionFactory(ConnectionFactory connectionFactory) {
this.connectionFactory = connectionFactory;
}
/**
* @return Returns the broadcastDestinationName.
*/
public String getBroadcastDestinationName() {
return broadcastDestinationName;
}
/**
* @param broadcastDestinationName
* The broadcastDestinationName to set.
*/
public void setBroadcastDestinationName(String broadcastDestinationName) {
this.broadcastDestinationName = broadcastDestinationName;
}
/**
* Check if the flow can support the requested QoS for this exchange
*
* @param me
* the exchange to check
* @return true if this flow can handle the given exchange
*/
public boolean canHandle(MessageExchange me) {
if (isTransacted(me)) {
return false;
}
return true;
}
/**
* Initialize the Region
*
* @param broker
* @throws JBIException
*/
public void init(Broker broker) throws JBIException {
LOGGER.debug(broker.getContainer().getName() + ": Initializing jms flow");
super.init(broker);
// Find executor
executor = broker.getContainer().getExecutorFactory().createExecutor("flow.jms");
// Create and register endpoint listener
endpointListener = new EndpointAdapter() {
public void internalEndpointRegistered(EndpointEvent event) {
onInternalEndpointRegistered(event, true);
}
public void internalEndpointUnregistered(EndpointEvent event) {
onInternalEndpointUnregistered(event, true);
}
};
broker.getContainer().addListener(endpointListener);
// Create and register component listener
componentListener = new ComponentAdapter() {
public void componentStarted(ComponentEvent event) {
onComponentStarted(event);
}
public void componentStopped(ComponentEvent event) {
onComponentStopped(event);
}
};
broker.getContainer().addListener(componentListener);
try {
if (connectionFactory == null) {
connectionFactory = createConnectionFactoryFromUrl(jmsURL);
}
if (userName != null) {
connection = connectionFactory.createConnection(userName, password);
} else {
connection = connectionFactory.createConnection();
}
connection.setClientID(broker.getContainer().getName());
connection.start();
Session inboundSession = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
Queue queue = inboundSession.createQueue(INBOUND_PREFIX + broker.getContainer().getName());
MessageConsumer inboundQueue = inboundSession.createConsumer(queue);
inboundQueue.setMessageListener(this);
} catch (JMSException e) {
LOGGER.error("Failed to initialize JMSFlow", e);
throw new JBIException(e);
}
}
protected abstract ConnectionFactory createConnectionFactoryFromUrl(String url);
/*
* The following abstract methods have to be implemented by specialized JMS
* Flow providers to monitor consumers on the broadcast topic.
*/
protected abstract void onConsumerMonitorMessage(Message message);
public abstract void startConsumerMonitor() throws JMSException;
public void stopConsumerMonitor() throws JMSException {
monitorMessageConsumer.close();
}
/**
* start the flow
*
* @throws JBIException
*/
public void start() throws JBIException {
if (started.compareAndSet(false, true)) {
LOGGER.debug(broker.getContainer().getName() + ": Starting jms flow");
super.start();
try {
Session broadcastSession = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
Topic broadcastTopic = broadcastSession.createTopic(broadcastDestinationName);
broadcastConsumer = broadcastSession.createConsumer(broadcastTopic, null, true);
broadcastConsumer.setMessageListener(new MessageListener() {
public void onMessage(Message message) {
try {
Object obj = ((ObjectMessage) message).getObject();
if (obj instanceof EndpointEvent) {
EndpointEvent event = (EndpointEvent) obj;
String container = ((InternalEndpoint) event.getEndpoint()).getComponentNameSpace()
.getContainerName();
if (!getBroker().getContainer().getName().equals(container)) {
if (event.getEventType() == EndpointEvent.INTERNAL_ENDPOINT_REGISTERED) {
onRemoteEndpointRegistered(event);
} else if (event.getEventType() == EndpointEvent.INTERNAL_ENDPOINT_UNREGISTERED) {
onRemoteEndpointUnregistered(event);
}
}
}
} catch (Exception e) {
LOGGER.error("Error processing incoming broadcast message", e);
}
}
});
// Start queue consumers for all components
for (ComponentMBeanImpl cmp : broker.getContainer().getRegistry().getComponents()) {
if (cmp.isStarted()) {
onComponentStarted(new ComponentEvent(cmp, ComponentEvent.COMPONENT_STARTED));
}
}
// Start queue consumers for all endpoints
ServiceEndpoint[] endpoints = broker.getContainer().getRegistry().getEndpointsForInterface(null);
for (int i = 0; i < endpoints.length; i++) {
if (endpoints[i] instanceof InternalEndpoint && ((InternalEndpoint) endpoints[i]).isLocal()) {
onInternalEndpointRegistered(new EndpointEvent(endpoints[i],
EndpointEvent.INTERNAL_ENDPOINT_REGISTERED), false);
}
}
startConsumerMonitor();
} catch (JMSException e) {
JBIException jbiEx = new JBIException("JMSException caught in start: " + e.getMessage());
throw jbiEx;
}
}
}
/**
* stop the flow
*
* @throws JBIException
*/
public void stop() throws JBIException {
if (started.compareAndSet(true, false)) {
LOGGER.debug(broker.getContainer().getName() + ": Stopping jms flow");
super.stop();
for (String id : subscriberSet) {
removeAllPackets(id);
}
subscriberSet.clear();
try {
stopConsumerMonitor();
broadcastConsumer.close();
} catch (JMSException e) {
LOGGER.debug("JMSException caught in stop", e);
}
}
}
public void shutDown() throws JBIException {
super.shutDown();
stop();
// Remove endpoint listener
broker.getContainer().removeListener(endpointListener);
// Remove component listener
broker.getContainer().removeListener(componentListener);
if (this.connection != null) {
try {
this.connection.close();
} catch (JMSException e) {
LOGGER.warn("Error closing JMS Connection", e);
}
}
}
/**
* useful for testing
*
* @return number of containers in the network
*/
public int numberInNetwork() {
return subscriberSet.size();
}
public void onInternalEndpointRegistered(EndpointEvent event, boolean broadcast) {
if (!started.get()) {
return;
}
try {
String key = EndpointSupport.getKey(event.getEndpoint());
if (!consumerMap.containsKey(key)) {
consumerMap.put(key, new MessageConsumerSession(key, this));
}
if (broadcast) {
broadcast(event);
}
} catch (Exception e) {
LOGGER.error("Cannot create consumer for " + event.getEndpoint(), e);
}
}
public void onInternalEndpointUnregistered(EndpointEvent event, boolean broadcast) {
try {
String key = EndpointSupport.getKey(event.getEndpoint());
MessageConsumerSession consumer = consumerMap.remove(key);
if (consumer != null) {
consumer.close();
}
if (broadcast) {
broadcast(event);
}
} catch (Exception e) {
LOGGER.error("Cannot destroy consumer for " + event, e);
}
}
protected void broadcast(EndpointEvent event) throws Exception {
if (LOGGER.isDebugEnabled()) {
LOGGER.debug(broker.getContainer().getName() + ": broadcasting info for " + event);
}
Session broadcastSession = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
try {
ObjectMessage msg = broadcastSession.createObjectMessage(event);
Topic broadcastTopic = broadcastSession.createTopic(broadcastDestinationName);
MessageProducer topicProducer = broadcastSession.createProducer(broadcastTopic);
topicProducer.setDeliveryMode(DeliveryMode.NON_PERSISTENT);
topicProducer.send(msg);
} finally {
broadcastSession.close();
}
}
public void onComponentStarted(ComponentEvent event) {
if (!started.get()) {
return;
}
try {
String key = event.getComponent().getName();
if (!consumerMap.containsKey(key)) {
consumerMap.put(key, new MessageConsumerSession(key, this));
}
} catch (Exception e) {
LOGGER.error("Cannot create consumer for component " + event.getComponent().getName(), e);
}
}
public void onComponentStopped(ComponentEvent event) {
try {
String key = event.getComponent().getName();
MessageConsumerSession consumer = consumerMap.remove(key);
if (consumer != null) {
consumer.close();
}
} catch (Exception e) {
LOGGER.error("Cannot destroy consumer for component " + event.getComponent().getName(), e);
}
}
public void onRemoteEndpointRegistered(EndpointEvent event) {
LOGGER.debug(broker.getContainer().getName() + ": adding remote endpoint: " + event.getEndpoint());
broker.getContainer().getRegistry().registerRemoteEndpoint(event.getEndpoint());
}
public void onRemoteEndpointUnregistered(EndpointEvent event) {
LOGGER.debug(broker.getContainer().getName() + ": removing remote endpoint: " + event.getEndpoint());
broker.getContainer().getRegistry().unregisterRemoteEndpoint(event.getEndpoint());
}
/**
* Distribute an ExchangePacket
*
* @param me
* @throws MessagingException
*/
protected void doSend(MessageExchangeImpl me) throws MessagingException {
doRouting(me);
}
/**
* Distribute an ExchangePacket
*
* @param me
* @throws MessagingException
*/
public void doRouting(MessageExchangeImpl me) throws MessagingException {
// let ActiveMQ do the routing ...
try {
String destination;
if (me.getRole() == Role.PROVIDER) {
if (me.getDestinationId() == null) {
destination = INBOUND_PREFIX + EndpointSupport.getKey(me.getEndpoint());
} else if (Boolean.TRUE.equals(me.getProperty(JbiConstants.STATELESS_PROVIDER)) && !isSynchronous(me)) {
destination = INBOUND_PREFIX + me.getDestinationId().getName();
} else {
destination = INBOUND_PREFIX + me.getDestinationId().getContainerName();
}
} else {
if (me.getSourceId() == null) {
throw new IllegalStateException("No sourceId set on the exchange");
} else if (Boolean.TRUE.equals(me.getProperty(JbiConstants.STATELESS_CONSUMER)) && !isSynchronous(me)) {
// If the consumer is stateless and has specified a sender
// endpoint,
// this exchange will be sent to the given endpoint queue,
// so that
// fail-over and load-balancing can be achieved
// This property must have been created using
// EndpointSupport.getKey
if (me.getProperty(JbiConstants.SENDER_ENDPOINT) != null) {
destination = INBOUND_PREFIX + me.getProperty(JbiConstants.SENDER_ENDPOINT);
} else {
destination = INBOUND_PREFIX + me.getSourceId().getName();
}
} else {
destination = INBOUND_PREFIX + me.getSourceId().getContainerName();
}
}
Connection cnx = connection;
// with a PooledConnectionFactory get a new connection from the pool
boolean useConnectionFromPool = (connectionFactory instanceof PooledConnectionFactory)
&& ((PooledConnectionFactory)connectionFactory).getMaxConnections() > 1;
if (useConnectionFromPool) {
cnx = connectionFactory.createConnection();
cnx.start();
}
Session inboundSession = cnx.createSession(false, Session.AUTO_ACKNOWLEDGE);
try {
Queue queue = inboundSession.createQueue(destination);
ObjectMessage msg = inboundSession.createObjectMessage(me);
// Set message priority.
Integer priority = (Integer) me.getProperty(JbiConstants.MESSAGE_PRIORITY);
if (null != priority) {
msg.setJMSPriority(priority);
}
MessageProducer queueProducer = inboundSession.createProducer(queue);
queueProducer.send(msg);
} finally {
inboundSession.close();
}
} catch (JMSException e) {
LOGGER.error("Failed to send exchange: " + me + " internal JMS Network", e);
throw new MessagingException(e);
}
}
/**
* MessageListener implementation
*
* @param message
*/
public void onMessage(final Message message) {
try {
if (message != null && started.get()) {
ObjectMessage objMsg = (ObjectMessage) message;
final MessageExchangeImpl me = (MessageExchangeImpl) objMsg.getObject();
// Dispatch the message in another thread so as to free the jms
// session
// else if a component do a sendSync into the jms flow, the
// whole
// flow is deadlocked
executor.execute(new Runnable() {
public void run() {
try {
if (me.getDestinationId() == null) {
ServiceEndpoint se = me.getEndpoint();
se = broker.getContainer().getRegistry().getInternalEndpoint(se.getServiceName(),
se.getEndpointName());
me.setEndpoint(se);
me.setDestinationId(((InternalEndpoint) se).getComponentNameSpace());
}
AbstractJMSFlow.super.doRouting(me);
} catch (Throwable e) {
LOGGER.error("Caught an exception routing ExchangePacket: ", e);
}
}
});
}
} catch (JMSException jmsEx) {
LOGGER.error("Caught an exception unpacking JMS Message: ", jmsEx);
}
}
/**
* A new cluster node is announced. Add this node to the subscriber set and
* send all our local internal endpoints to this node.
*
* @param connectionId
*/
protected void addClusterNode(String connectionId) {
subscriberSet.add(connectionId);
ServiceEndpoint[] endpoints = broker.getContainer().getRegistry().getEndpointsForInterface(null);
for (int i = 0; i < endpoints.length; i++) {
if (endpoints[i] instanceof InternalEndpoint && ((InternalEndpoint) endpoints[i]).isLocal()) {
onInternalEndpointRegistered(
new EndpointEvent(endpoints[i], EndpointEvent.INTERNAL_ENDPOINT_REGISTERED), true);
}
}
}
/**
* A cluster node leaves the cluster. Remove this node from the subscriber
* set and remove all packets waiting to be delivered to this node
*
* @param connectionId
*/
protected void removeClusterNode(String connectionId) {
subscriberSet.remove(connectionId);
removeAllPackets(connectionId);
}
protected void removeAllPackets(String containerName) {
// TODO: broker.getRegistry().unregisterRemoteEndpoints(containerName);
}
public String getJmsURL() {
return jmsURL;
}
public void setJmsURL(String jmsURL) {
this.jmsURL = jmsURL;
}
/*
* Creates a message consumer and holds on to both consumer and session
* to allow closing both of them together.
*/
private final class MessageConsumerSession {
private Session session;
private MessageConsumer consumer;
private MessageConsumerSession(String key, MessageListener listener) throws JMSException {
session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
Queue queue = session.createQueue(INBOUND_PREFIX + key);
consumer = session.createConsumer(queue);
consumer.setMessageListener(listener);
}
private void close() throws JMSException {
if (consumer != null) {
consumer.close();
}
if (session != null) {
session.close();
}
}
}
}