1 /*** 2 * 3 * Copyright 2004 Hiram Chirino 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 * 17 **/ 18 package org.codehaus.activemq.store.cache; 19 20 import org.codehaus.activemq.message.ActiveMQMessage; 21 22 /*** 23 * Defines the interface used to cache messages. 24 * 25 * @version $Revision: 1.1 $ 26 */ 27 public interface MessageCache { 28 /*** 29 * Gets a message that was previously <code>put</code> into this object. 30 * 31 * @param msgid 32 * @return null if the message was not previously put or if the message has expired out of the cache. 33 */ 34 public ActiveMQMessage get(String msgid); 35 36 /*** 37 * Puts a message into the cache. 38 * 39 * @param messageID 40 * @param message 41 */ 42 public void put(String messageID, ActiveMQMessage message); 43 44 /*** 45 * Remvoes a message from the cache. 46 * 47 * @param messageID 48 */ 49 public void remove(String messageID); 50 51 }