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 tma@netspace.net.au.
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 2001-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: AbstractMessagePopulator.java,v 1.3 2004/01/31 13:44:24 tanderson Exp $
44 */
45 package org.exolab.jmscts.core;
46
47 import javax.jms.BytesMessage;
48 import javax.jms.MapMessage;
49 import javax.jms.Message;
50 import javax.jms.ObjectMessage;
51 import javax.jms.StreamMessage;
52 import javax.jms.TextMessage;
53
54
55 /***
56 * A helper class for populating messages. This class provides no message
57 * populating functionality - that is left to sublasses.
58 *
59 * @version $Revision: 1.3 $ $Date: 2004/01/31 13:44:24 $
60 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
61 */
62 public abstract class AbstractMessagePopulator implements MessagePopulator {
63
64 /***
65 * Populate a message with data. This method delegates the message to
66 * the appropriate populator method.
67 *
68 * @param message the message to populate
69 * @throws Exception for any error
70 */
71 public void populate(Message message) throws Exception {
72 if (message instanceof BytesMessage) {
73 populateBytesMessage((BytesMessage) message);
74 } else if (message instanceof MapMessage) {
75 populateMapMessage((MapMessage) message);
76 } else if (message instanceof ObjectMessage) {
77 populateObjectMessage((ObjectMessage) message);
78 } else if (message instanceof StreamMessage) {
79 populateStreamMessage((StreamMessage) message);
80 } else if (message instanceof TextMessage) {
81 populateTextMessage((TextMessage) message);
82 } else {
83 populateMessage(message);
84 }
85 }
86
87 /***
88 * Populate a Message instance with data. This method throws
89 * UnsupportedOperationException if invoked. Subclasses needing the
90 * functionality must implement it.
91 *
92 * @param message the message to populate
93 * @throws Exception for any error
94 */
95 public void populateMessage(Message message) throws Exception {
96 throw new UnsupportedOperationException(
97 "populateMessage() not implemented by " + getClass().getName());
98 }
99
100 /***
101 * Populate a BytesMessage instance with data. This method throws
102 * UnsupportedOperationException if invoked. Subclasses needing the
103 * functionality must implement it.
104 *
105 * @param message the message to populate
106 * @throws Exception for any error
107 */
108 public void populateBytesMessage(BytesMessage message) throws Exception {
109 throw new UnsupportedOperationException(
110 "populateBytesMessage() not implemented by "
111 + getClass().getName());
112 }
113
114 /***
115 * Populate a MapMessage instance with data. This method throws
116 * UnsupportedOperationException if invoked. Subclasses needing the
117 * functionality must implement it.
118 *
119 * @param message the message to populate
120 * @throws Exception for any error
121 */
122 public void populateMapMessage(MapMessage message) throws Exception {
123 throw new UnsupportedOperationException(
124 "populateMapMessage() not implemented by " + getClass().getName());
125 }
126
127 /***
128 * Populate an ObjectMessage instance with data. This method throws
129 * UnsupportedOperationException if invoked. Subclasses needing the
130 * functionality must implement it.
131 *
132 * @param message the message to populate
133 * @throws Exception for any error
134 */
135 public void populateObjectMessage(ObjectMessage message) throws Exception {
136 throw new UnsupportedOperationException(
137 "populateObjectMessage() not implemented by "
138 + getClass().getName());
139 }
140
141 /***
142 * Populate a StreamMessage instance with data. This method throws
143 * UnsupportedOperationException if invoked. Subclasses needing the
144 * functionality must implement it.
145 *
146 * @param message the message to populate
147 * @throws Exception for any error
148 */
149 public void populateStreamMessage(StreamMessage message) throws Exception {
150 throw new UnsupportedOperationException(
151 "populateStreamMessage() not implemented by "
152 + getClass().getName());
153 }
154
155 /***
156 * Populate a TextMessage instance with data. This method throws
157 * UnsupportedOperationException if invoked. Subclasses needing the
158 * functionality must implement it.
159 *
160 * @param message the message to populate
161 * @throws Exception for any error
162 */
163 public void populateTextMessage(TextMessage message) throws Exception {
164 throw new UnsupportedOperationException(
165 "populateTextMessage() not implemented by "
166 + getClass().getName());
167 }
168
169 }
This page was automatically generated by Maven