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;
018    
019    import org.apache.activemq.broker.ConnectionContext;
020    import org.apache.activemq.command.ActiveMQDestination;
021    
022    /**
023     * An interface for recoverying transient messages held by the broker for
024     * retractive recovery for subscribers
025     * 
026     * 
027     */
028    public interface SubscriptionRecovery {
029    
030        /**
031         * Add a message to the SubscriptionRecovery
032         * 
033         * @param context
034         * @param message
035         * @return true if the message is accepted
036         * @throws Exception
037         */
038        boolean addRecoveredMessage(ConnectionContext context, MessageReference message) throws Exception;
039    
040        /**
041         * @return the Destination associated with this Subscription
042         */
043        ActiveMQDestination getActiveMQDestination();
044    
045    }