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: SequencePropertyPopulator.java,v 1.2 2004/01/31 13:44:24 tanderson Exp $
44 */
45 package org.exolab.jmscts.core;
46
47 import javax.jms.Message;
48
49
50 /***
51 * A message populator that populates the 'JMSXGroupID' and 'JMSXGroupSeq'
52 * properties of a message. The sequence is incremented with each invocation,
53 * starting at 1.
54 *
55 * @version $Revision: 1.2 $ $Date: 2004/01/31 13:44:24 $
56 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
57 */
58 public class SequencePropertyPopulator implements MessagePopulator {
59
60 /***
61 * The JMSX group identifier property name
62 */
63 public static final String GROUP_ID = "JMSXGroupID";
64
65 /***
66 * The JMSX sequence number property name
67 */
68 public static final String GROUP_SEQ = "JMSXGroupSeq";
69
70 /***
71 * The group identifier
72 */
73 private final String _group;
74
75 /***
76 * The sequence number
77 */
78 private int _sequence = 0;
79
80
81 /***
82 * Create an instance of this class, with the default group name to
83 * populate the JMSXGroupID property with
84 */
85 public SequencePropertyPopulator() {
86 this("default");
87 }
88
89 /***
90 * Create an instance of this class, with the group name to populate the
91 * JMSXGroupID property with
92 *
93 * @param group the value to populate the JMSXGroupID property with
94 */
95 public SequencePropertyPopulator(String group) {
96 if (group == null) {
97 throw new IllegalArgumentException("Argument 'group' is null");
98 }
99 _group = group;
100 }
101
102 /***
103 * Populate the JMSXGroupID and JMSXGroupSeq property of a message.
104 * The sequence is incremented with each invocation.
105 *
106 * @param message the message to populate
107 * @throws Exception for any error
108 */
109 public synchronized void populate(Message message) throws Exception {
110 message.setStringProperty(GROUP_ID, _group);
111 message.setIntProperty(GROUP_SEQ, ++_sequence);
112 }
113
114 }
This page was automatically generated by Maven