01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package org.jboss.messaging.interfaces;
23:
24: /**
25: * A message reference provides basic information about a message.
26: *
27: * @author <a href="mailto:adrian@jboss.org">Adrian Brock</a>
28: * @version $Revision: 57195 $
29: */
30: public interface MessageReference {
31: // Constants -----------------------------------------------------
32:
33: // Public --------------------------------------------------------
34:
35: /**
36: * Get the message id
37: *
38: * @return the message id
39: */
40: Comparable getMessageID();
41:
42: /**
43: * Get the message priority
44: *
45: * @return the priority
46: */
47: int getMessagePriority();
48:
49: /**
50: * Get the message address
51: *
52: * @return the address
53: */
54: MessageAddress getMessageAddress();
55:
56: /**
57: * Does the message require guaranteed delivery?
58: *
59: * @return true for guaranteed delivery, false otherwise
60: */
61: boolean isGuaranteed();
62:
63: /**
64: * Release a reference that is no longer used
65: */
66: void release();
67:
68: // Inner Classes --------------------------------------------------
69: }
|