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.broker.BrokerClient;
21 import org.codehaus.activemq.filter.Filter;
22 import org.codehaus.activemq.message.ActiveMQDestination;
23 import org.codehaus.activemq.message.ConsumerInfo;
24
25 import java.util.Iterator;
26 import java.util.Set;
27
28 /***
29 * Represents a possibly persistent container of subscription objects
30 *
31 * @version $Revision: 1.8 $
32 */
33 public interface SubscriptionContainer {
34
35 /***
36 * Gets the current subscription for the given consumerId if it is available
37 *
38 * @param consumerId
39 * @return
40 */
41 public Subscription getSubscription(String consumerId);
42
43 public Subscription removeSubscription(String consumerId);
44
45 /***
46 * @return an iterator through the subscriptions
47 */
48 public Iterator subscriptionIterator();
49
50
51 /***
52 * Creates a subscription (which could be a previous subscription
53 * reconecting) and adds it to this container
54 *
55 * @param dispatcher
56 * @param client
57 * @param info
58 * @param filter
59 * @return
60 */
61 public Subscription makeSubscription(Dispatcher dispatcher, BrokerClient client,ConsumerInfo info, Filter filter);
62
63 /***
64 * @param destination
65 * @return a collection of subscriptions for the given destination
66 */
67 public Set getSubscriptions(ActiveMQDestination destination);
68 }