View Javadoc

1   /*
2    * $Id: JmsMessageReceiver.java 19191 2010-08-25 21:05:23Z tcarlson $
3    * --------------------------------------------------------------------------------------
4    * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
5    *
6    * The software in this package is published under the terms of the CPAL v1.0
7    * license, a copy of which has been included with this distribution in the
8    * LICENSE.txt file.
9    */
10  
11  package org.mule.transport.jms;
12  
13  import org.mule.api.MuleException;
14  import org.mule.api.construct.FlowConstruct;
15  import org.mule.api.endpoint.InboundEndpoint;
16  import org.mule.api.lifecycle.CreateException;
17  import org.mule.api.lifecycle.LifecycleException;
18  import org.mule.api.transaction.Transaction;
19  import org.mule.api.transaction.TransactionException;
20  import org.mule.api.transport.Connector;
21  import org.mule.transport.AbstractMessageReceiver;
22  import org.mule.transport.AbstractReceiverWorker;
23  import org.mule.transport.ConnectException;
24  import org.mule.transport.jms.filters.JmsSelectorFilter;
25  import org.mule.util.ClassUtils;
26  
27  import java.util.ArrayList;
28  import java.util.List;
29  
30  import javax.jms.Destination;
31  import javax.jms.JMSException;
32  import javax.jms.Message;
33  import javax.jms.MessageConsumer;
34  import javax.jms.MessageListener;
35  import javax.jms.Session;
36  import javax.jms.Topic;
37  
38  /**
39   * Registers a single JmsMessage listener but uses a thread pool to process incoming
40   * messages.
41   * @deprecated use {@link org.mule.transport.jms.MultiConsumerJmsMessageReceiver} (set by default).
42   */
43  @Deprecated
44  public class JmsMessageReceiver extends AbstractMessageReceiver implements MessageListener
45  {
46  
47      protected JmsConnector connector;
48      protected RedeliveryHandler redeliveryHandler;
49      protected MessageConsumer consumer;
50      protected Session session;
51      protected boolean startOnConnect = false;
52  
53      public JmsMessageReceiver(Connector connector, FlowConstruct flowConstruct, InboundEndpoint endpoint)
54              throws CreateException
55      {
56          super(connector, flowConstruct, endpoint);
57          this.connector = (JmsConnector) connector;
58  
59          try
60          {
61              redeliveryHandler = this.connector.getRedeliveryHandlerFactory().create();
62              redeliveryHandler.setConnector(this.connector);
63          }
64          catch (Exception e)
65          {
66              throw new CreateException(e, this);
67          }
68      }
69  
70      protected void doConnect() throws Exception
71      {
72          createConsumer();
73          if (startOnConnect)
74          {
75              doStart();
76          }
77      }
78  
79      protected void doDisconnect() throws Exception
80      {
81          closeConsumer();
82      }
83  
84      public void onMessage(Message message)
85      {
86          try
87          {
88              getWorkManager().scheduleWork(new JmsWorker(message, this));
89          }
90          catch (Exception e)
91          {
92              getConnector().getMuleContext().getExceptionListener().handleException(e);
93          }
94      }
95  
96      protected  class JmsWorker extends AbstractReceiverWorker
97      {
98          public JmsWorker(Message message, AbstractMessageReceiver receiver)
99          {
100             super(new ArrayList(1), receiver);
101             messages.add(message);
102         }
103 
104         public JmsWorker(List messages, AbstractMessageReceiver receiver)
105         {
106             super(messages, receiver);
107         }
108 
109         @Override
110         protected Object preProcessMessage(Object message) throws Exception
111         {
112             Message m = (Message) message;
113 
114             if (logger.isDebugEnabled())
115             {
116                 logger.debug("Message received it is of type: " +
117                         ClassUtils.getSimpleName(message.getClass()));
118                 if (m.getJMSDestination() != null)
119                 {
120                     logger.debug("Message received on " + m.getJMSDestination() + " ("
121                             + m.getJMSDestination().getClass().getName() + ")");
122                 }
123                 else
124                 {
125                     logger.debug("Message received on unknown destination");
126                 }
127                 logger.debug("Message CorrelationId is: " + m.getJMSCorrelationID());
128                 logger.debug("Jms Message Id is: " + m.getJMSMessageID());
129             }
130 
131             if (m.getJMSRedelivered() && redeliveryHandler != null)
132             {
133                 if (logger.isDebugEnabled())
134                 {
135                     logger.debug("Message with correlationId: " + m.getJMSCorrelationID()
136                             + " has redelivered flag set, handing off to Exception Handler");
137                 }
138                 redeliveryHandler.handleRedelivery(m);
139             }
140             return m;
141 
142         }
143 
144         protected void bindTransaction(Transaction tx) throws TransactionException
145         {
146             if(tx instanceof JmsTransaction)
147             {
148                 tx.bindResource(connector.getConnection(), session);
149             }
150             else if(tx instanceof JmsClientAcknowledgeTransaction)
151             {
152                 //We should still bind the session to the transaction, but we also need the message itself
153                 //since that is the object that gets Acknowledged
154                 tx.bindResource(connector.getConnection(), session);
155                 ((JmsClientAcknowledgeTransaction)tx).setMessage((Message)messages.get(0));
156             }
157         }
158     }
159 
160     protected void doStart() throws MuleException
161     {
162         try
163         {
164             // We ned to register the listener when start is called in order to only
165             // start receiving messages after
166             // start/
167             // If the consumer is null it means that the connection strategy is being
168             // run in a separate thread
169             // And hasn't managed to connect yet.
170             if (consumer == null)
171             {
172                 startOnConnect = true;
173             }
174             else
175             {
176                 startOnConnect = false;
177                 consumer.setMessageListener(this);
178             }
179         }
180         catch (JMSException e)
181         {
182             throw new LifecycleException(e, this);
183         }
184     }
185 
186     protected void doStop() throws MuleException
187     {
188         try
189         {
190             if (consumer != null)
191             {
192                 consumer.setMessageListener(null);
193             }
194         }
195         catch (JMSException e)
196         {
197             throw new LifecycleException(e, this);
198         }
199     }
200 
201     protected void doDispose()
202     {
203         // template method
204     }
205 
206     protected void closeConsumer()
207     {
208         connector.closeQuietly(consumer);
209         consumer = null;
210         connector.closeQuietly(session);
211         session = null;
212     }
213 
214     /**
215      * Create a consumer for the jms destination
216      *
217      * @throws Exception
218      */
219     protected void createConsumer() throws Exception
220     {
221         try
222         {
223             JmsSupport jmsSupport = this.connector.getJmsSupport();
224             // Create session if none exists
225             if (session == null)
226             {
227                 session = this.connector.getSession(endpoint);
228             }
229 
230             boolean topic = connector.getTopicResolver().isTopic(endpoint);
231 
232             // Create destination
233             Destination dest = jmsSupport.createDestination(session, endpoint);
234 
235             // Extract jms selector
236             String selector = null;
237             if (endpoint.getFilter() != null && endpoint.getFilter() instanceof JmsSelectorFilter)
238             {
239                 selector = ((JmsSelectorFilter) endpoint.getFilter()).getExpression();
240             }
241             else if (endpoint.getProperties() != null)
242             {
243                 // still allow the selector to be set as a property on the endpoint
244                 // to be backward compatable
245                 selector = (String) endpoint.getProperties().get(JmsConstants.JMS_SELECTOR_PROPERTY);
246             }
247             String tempDurable = (String) endpoint.getProperties().get(JmsConstants.DURABLE_PROPERTY);
248             boolean durable = connector.isDurable();
249             if (tempDurable != null)
250             {
251                 durable = Boolean.valueOf(tempDurable).booleanValue();
252             }
253 
254             // Get the durable subscriber name if there is one
255             String durableName = (String) endpoint.getProperties().get(JmsConstants.DURABLE_NAME_PROPERTY);
256             if (durableName == null && durable && dest instanceof Topic)
257             {
258                 durableName = "mule." + connector.getName() + "." + endpoint.getEndpointURI().getAddress();
259                 logger.debug("Jms Connector for this receiver is durable but no durable name has been specified. Defaulting to: "
260                         + durableName);
261             }
262 
263             // Create consumer
264             consumer = jmsSupport.createConsumer(session, dest, selector, connector.isNoLocal(), durableName,
265                     topic, endpoint);
266         }
267         catch (JMSException e)
268         {
269             throw new ConnectException(e, this);
270         }
271     }
272 
273 }