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.region.MessageReference;
020import org.apache.activemq.broker.region.Subscription;
021import org.apache.activemq.command.ActiveMQDestination;
022import org.apache.activemq.command.Message;
023
024/**
025 * A strategy for choosing which destination is used for dead letter queue messages.
026 * 
027 * 
028 */
029public interface DeadLetterStrategy {
030    
031    /**
032     * Allow pluggable strategy for deciding if message should be sent to a dead letter queue
033     * for example, you might not want to ignore expired or non-persistent messages
034     * @param message
035     * @return true if message should be sent to a dead letter queue
036     */
037    boolean isSendToDeadLetterQueue(Message message);
038
039    /**
040     * Returns the dead letter queue for the given message and subscription.
041     */
042    ActiveMQDestination getDeadLetterQueueFor(Message message, Subscription subscription);
043
044    /**
045     * @return true if processes expired messages
046     */
047    public boolean isProcessExpired() ;
048
049    /**
050     * @param processExpired the processExpired to set
051     */
052    public void setProcessExpired(boolean processExpired);
053
054    /**
055     * @return the processNonPersistent
056     */
057    public boolean isProcessNonPersistent();
058
059    /**
060     * @param processNonPersistent the processNonPersistent to set
061     */
062    public void setProcessNonPersistent(boolean processNonPersistent);
063
064}