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.broker.BrokerClient;
    21  import org.codehaus.activemq.filter.Filter;
    22  import org.codehaus.activemq.message.ConsumerInfo;
    23
    24  import javax.jms.JMSException;
    25  import java.util.Iterator;
    26
    27  /***
    28   * Represents a possibly persistent container of subscription objects
    29   *
    30   * @version $Revision: 1.4 $
    31   */
    32  public interface SubscriptionContainer {
    33
    34      /***
    35       * Gets the current subscription for the given consumerId if it is available
    36       *
    37       * @param consumerId
    38       * @return
    39       */
    40      public Subscription getSubscription(String consumerId);
    41
    42      public Subscription removeSubscription(String consumerId);
    43
    44      /***
    45       * @return an iterator through the subscriptions
    46       */
    47      public Iterator subscriptionIterator();
    48
    49
    50      /***
    51       * Creates a subscription (which could be a previous subscription
    52       * reconecting) and adds it to this container
    53       *
    54       * @param dispatcher
    55       * @param info
    56       * @param filter
    57       * @return
    58       */
    59      public Subscription makeSubscription(Dispatcher dispatcher, ConsumerInfo info, Filter filter);
    60
    61      /***
    62       * There is only meant to be a single durable subscription open for a given clientID and subscriber name;
    63       * this method will check to ensure that a user doesn't try to subscribe twice for the same clientID
    64       * and subscriber name.
    65       *
    66       * @param client
    67       * @param info
    68       */
    69      public void checkForDuplicateDurableSubscription(BrokerClient client, ConsumerInfo info) throws JMSException;
    70  }