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.plugin;
018    
019    import java.io.File;
020    
021    import org.apache.activemq.broker.Broker;
022    import org.apache.activemq.broker.BrokerPlugin;
023    
024    /**
025     * A plugin which allows the caching of the selector from a subscription queue.
026     * <p/>
027     * This stops the build-up of unwanted messages, especially when consumers may
028     * disconnect from time to time when using virtual destinations.
029     * <p/>
030     * This is influenced by code snippets developed by Maciej Rakowicz
031     *
032     * @author Roelof Naude roelof(dot)naude(at)gmail.com
033     *@org.apache.xbean.XBean element="virtualSelectorCacheBrokerPlugin"
034     */
035    public class SubQueueSelectorCacheBrokerPlugin implements BrokerPlugin {
036    
037    
038        private File persistFile;
039    
040        @Override
041        public Broker installPlugin(Broker broker) throws Exception {
042            return new SubQueueSelectorCacheBroker(broker, persistFile);
043        }
044    
045        /**
046         * Sets the location of the persistent cache
047         */
048        public void setPersistFile(File persistFile) {
049            this.persistFile = persistFile;
050        }
051    
052        public File getPersistFile() {
053            return persistFile;
054        }
055    }