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 */
017package org.apache.activemq.broker.region.policy;
018
019import org.apache.activemq.broker.Broker;
020import org.apache.activemq.broker.region.Subscription;
021import org.apache.activemq.broker.region.cursors.AbstractPendingMessageCursor;
022import org.apache.activemq.broker.region.cursors.FilePendingMessageCursor;
023import org.apache.activemq.broker.region.cursors.PendingMessageCursor;
024
025/**
026 * Creates a PendIngMessageCursor for Durable subscribers *
027 * 
028 * @org.apache.xbean.XBean element="fileCursor" description="Pending messages
029 *                         for durable subscribers held in temporary files"
030 * 
031 * 
032 */
033public class FilePendingSubscriberMessageStoragePolicy implements PendingSubscriberMessageStoragePolicy {
034
035    /**
036     * @param broker
037     * @param name
038     * @param maxBatchSize
039     * @return a Cursor
040     * @see org.apache.activemq.broker.region.policy.PendingSubscriberMessageStoragePolicy#getSubscriberPendingMessageCursor(java.lang.String,
041     *      org.apache.activemq.kaha.Store, int)
042     */
043    public PendingMessageCursor getSubscriberPendingMessageCursor(Broker broker, String name, int maxBatchSize,
044            Subscription subs) {
045        return new FilePendingMessageCursor(broker, "PendingCursor:" + name, AbstractPendingMessageCursor
046                .isPrioritizedMessageSubscriber(broker, subs));
047    }
048}