View Javadoc

1   /***
2    * Redistribution and use of this software and associated documentation
3    * ("Software"), with or without modification, are permitted provided
4    * that the following conditions are met:
5    *
6    * 1. Redistributions of source code must retain copyright
7    *    statements and notices.  Redistributions must also contain a
8    *    copy of this document.
9    *
10   * 2. Redistributions in binary form must reproduce the
11   *    above copyright notice, this list of conditions and the
12   *    following disclaimer in the documentation and/or other
13   *    materials provided with the distribution.
14   *
15   * 3. The name "Exolab" must not be used to endorse or promote
16   *    products derived from this Software without prior written
17   *    permission of Exoffice Technologies.  For written permission,
18   *    please contact info@exolab.org.
19   *
20   * 4. Products derived from this Software may not be called "Exolab"
21   *    nor may "Exolab" appear in their names without prior written
22   *    permission of Exoffice Technologies. Exolab is a registered
23   *    trademark of Exoffice Technologies.
24   *
25   * 5. Due credit should be given to the Exolab Project
26   *    (http://www.exolab.org/).
27   *
28   * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29   * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
32   * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39   * OF THE POSSIBILITY OF SUCH DAMAGE.
40   *
41   * Copyright 2003 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: AbstractMessageConverter.java,v 1.1 2004/11/26 01:50:42 tanderson Exp $
44   */
45  
46  package org.exolab.jms.message;
47  
48  import java.util.Enumeration;
49  
50  import javax.jms.Destination;
51  import javax.jms.JMSException;
52  import javax.jms.Message;
53  
54  import org.exolab.jms.client.JmsDestination;
55  
56  
57  /***
58   * Convert messages to OpenJMS implementations
59   *
60   * @version     $Revision: 1.1 $ $Date: 2004/11/26 01:50:42 $
61   * @author      <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
62   * @see         MessageConverterFactory
63   */
64  abstract class AbstractMessageConverter implements MessageConverter {
65  
66      /***
67       * Convert a message to its corresponding OpenJMS implementation
68       * 
69       * @param message the message to convert
70       * @return the converted message
71       * @throws JMSException for any error
72       */
73      public Message convert(Message message) throws JMSException {
74          Message result = create();
75          populate(message, result);
76          return result;
77      }
78  
79      /***
80       * Construct an OpenJMS implementation of a message
81       *
82       * @return the OpenJMS implementation of the message
83       * @throws JMSException if the message cannot be created
84       */
85      protected abstract Message create() throws JMSException;
86  
87      /***
88       * Populate an OpenJMS message from another message of the same type
89       *
90       * @param source the message to convert
91       * @param target the message to populate
92       * @throws JMSException for any error
93       */
94      protected void populate(Message source, Message target) 
95          throws JMSException {
96  
97          target.setJMSMessageID(source.getJMSMessageID());
98          target.setJMSDestination(source.getJMSDestination());
99          target.setJMSTimestamp(source.getJMSTimestamp());
100         target.setJMSPriority(source.getJMSPriority());
101         target.setJMSExpiration(source.getJMSExpiration());
102         target.setJMSDeliveryMode(source.getJMSDeliveryMode());
103         target.setJMSCorrelationID(source.getJMSCorrelationID());
104         target.setJMSType(source.getJMSType());
105 
106         Destination replyTo = source.getJMSReplyTo();
107         if (replyTo instanceof JmsDestination) {
108             target.setJMSReplyTo(replyTo);
109         }
110         
111         // populate properties
112         Enumeration iterator = source.getPropertyNames();
113         while (iterator.hasMoreElements()) {
114             String name = (String) iterator.nextElement();
115             if (!name.startsWith("JMSX") || name.equals("JMSXGroupID")
116                 || name.equals("JMSXGroupSeq")) {
117                 // only populate user and supported JMSX properties
118 
119                 Object value = (Object) source.getObjectProperty(name);
120                 target.setObjectProperty(name, value);
121             }
122         }
123     }
124 
125 }