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.mq.pm;
23:
24: import javax.jms.JMSException;
25: import org.jboss.mq.SpyMessage;
26: import org.jboss.mq.server.MessageReference;
27:
28: /**
29: * A cache store.
30: *
31: * @author Hiram Chirino (Cojonudo14@hotmail.com)
32: * @author Paul Kendall (paul.kendall@orion.co.nz)
33: * @author <a href="mailto:adrian@jboss.org">Adrian Brock</a>
34: * @version $Revision: 57198 $
35: */
36: public interface CacheStore {
37: // Constants -----------------------------------------------------
38:
39: // Public --------------------------------------------------------
40:
41: /**
42: * Reads the message refered to by the MessagReference back as a SpyMessage
43: *
44: * @param mh the message reference
45: * @return the message
46: * @throws JMSException for any error
47: */
48: SpyMessage loadFromStorage(MessageReference mh) throws JMSException;
49:
50: /**
51: * Stores the given message to secondary storeage. You should be able to use
52: * the MessagReference to load the message back later.
53: *
54: * @param mh the message reference
55: * @param message the message
56: * @throws JMSException for any error
57: */
58: void saveToStorage(MessageReference mh, SpyMessage message)
59: throws JMSException;
60:
61: /**
62: * Removes the message that was stored in secondary storage.
63: *
64: * @param mh the message reference
65: * @throws JMSException for any error
66: */
67: void removeFromStorage(MessageReference mh) throws JMSException;
68: }
|