001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.activemq.broker.region.policy;
018    
019    import org.apache.activemq.broker.Broker;
020    import org.apache.activemq.broker.region.DurableTopicSubscription;
021    import org.apache.activemq.broker.region.Subscription;
022    import org.apache.activemq.broker.region.cursors.PendingMessageCursor;
023    
024    /**
025     * Abstraction to allow different policies for holding messages awaiting
026     * dispatch to active clients
027     * 
028     * 
029     */
030    public interface PendingDurableSubscriberMessageStoragePolicy {
031    
032        /**
033         * Retrieve the configured pending message storage cursor;
034         * @param broker 
035         * 
036         * @param clientId
037         * @param name
038         * @param maxBatchSize
039         * @param sub 
040         * @return the Pending Message cursor
041         */
042        PendingMessageCursor getSubscriberPendingMessageCursor(Broker broker,String clientId, String name, int maxBatchSize, DurableTopicSubscription sub);
043    }