View Javadoc

1   /*** 
2    * 
3    * Copyright 2004 Protique Ltd
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.service;
19  
20  import org.codehaus.activemq.message.ConsumerInfo;
21  
22  import javax.jms.JMSException;
23  
24  
25  /***
26   * A Topic based {@link MessageContainer}
27   *
28   * @version $Revision: 1.6 $
29   */
30  public interface TopicMessageContainer extends MessageContainer {
31  
32  
33      /***
34       * Sets the last acknowleged message ID for the given subscriber in this
35       * container so that if we shut down and recover we know where to start
36       * replaying messages from.
37       *
38       * @param subscription
39       * @param messageIdentity
40       */
41      public void setLastAcknowledgedMessageID(Subscription subscription, MessageIdentity messageIdentity) throws JMSException;
42  
43      /***
44       * A durable subscription has started so recovery any messages that are required.
45       * This method should find the last acknowledged message for the given subscription
46       * and then iterate through any further messages and those that match the subscription
47       * should be dispatched to this subscription so that they can be dispatched in the future
48       *
49       * @param subscription
50       */
51      public void recoverSubscription(Subscription subscription) throws JMSException;
52  
53      /***
54       * Stores the persistence details in the database
55       *
56       * @param info
57       * @param subscription
58       */
59      public void storeSubscription(ConsumerInfo info, Subscription subscription) throws JMSException;
60  }