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 2000 (C) Exoffice Technologies Inc. All Rights Reserved.
42   */
43  
44  package org.exolab.jms.util;
45  
46  
47  /***
48   * Helper class for manipulating JMSMessageIDs
49   *
50   * @version     $Revision: 1.1 $ $Date: 2004/11/26 01:51:02 $
51   * @author      <a href="mailto:tima@intalio.com">Tim Anderson</a>
52   **/
53  public class MessageIdHelper {
54  
55      /***
56       * Return the 'null' JMSMessageID.
57       * This is the first Id recognised by OpenJMS, but not assigned
58       * to messages.
59       *
60       * @return      String              the 'null' message Id
61       */
62      public static String getNull() {
63          return NULL_ID;
64      }
65  
66      /***
67       * Generate a JMSMessageID
68       *
69       * @param       Id                 numeric representation of the Id
70       * @return      String             the generated JMSMessageID
71       */
72      public static String generate(long Id) {
73          return ID_PREFIX + Id;
74      }
75  
76      /***
77       * Convert a JMSMessageID to its long value
78       *
79       * @param       messageId           JMSMessageID to convert
80       * @return      long                value of the JMSMessageID
81       */
82      public static long convert(String messageId) {
83          // strip off 'ID:' prefix
84          return Long.parseLong(messageId.substring(ID_PREFIX.length()));
85      }
86  
87      private static final String ID_PREFIX = "ID:";
88      private static final String NULL_ID = "ID:0";
89  }