Package org.apache.activemq.broker.region.policy

Class AbstractDeadLetterStrategy

java.lang.Object

org.apache.activemq.broker.region.policy.AbstractDeadLetterStrategy

All Implemented Interfaces:

DeadLetterStrategy

Direct Known Subclasses:

IndividualDeadLetterStrategy, SharedDeadLetterStrategy

public abstract class AbstractDeadLetterStrategy
extends Object
implements DeadLetterStrategy

A strategy for choosing which destination is used for dead letter queue messages.

Constructor Summary

Constructors

Constructor	Description
AbstractDeadLetterStrategy()

Method Summary

Modifier and Type	Method	Description
long	getExpiration()
int	getMaxAuditDepth()
int	getMaxProducersToAudit()
boolean	isEnableAudit()
boolean	isProcessExpired()
boolean	isProcessNonPersistent()
boolean	isSendToDeadLetterQueue(Message message)	Allow pluggable strategy for deciding if message should be sent to a dead letter queue for example, you might not want to ignore expired or non-persistent messages
void	rollback(Message message)	Allows for a Message that was already processed by a DLQ to be rolled back in case of a move or a retry of that message, otherwise the Message would be considered a duplicate if this strategy is doing Message Auditing.
void	setEnableAudit(boolean enableAudit)
void	setExpiration(long expiration)	The expiration value to use on messages sent to the DLQ, default 0
void	setMaxAuditDepth(int maxAuditDepth)
void	setMaxProducersToAudit(int maxProducersToAudit)
void	setProcessExpired(boolean processExpired)
void	setProcessNonPersistent(boolean processNonPersistent)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.activemq.broker.region.policy.DeadLetterStrategy

getDeadLetterQueueFor

Constructor Detail

AbstractDeadLetterStrategy

public AbstractDeadLetterStrategy()

Method Detail

rollback

public void rollback(Message message)

Description copied from interface: DeadLetterStrategy

Allows for a Message that was already processed by a DLQ to be rolled back in case of a move or a retry of that message, otherwise the Message would be considered a duplicate if this strategy is doing Message Auditing.

Specified by:

rollback in interface DeadLetterStrategy

isSendToDeadLetterQueue

public boolean isSendToDeadLetterQueue(Message message)

Description copied from interface: DeadLetterStrategy

Allow pluggable strategy for deciding if message should be sent to a dead letter queue for example, you might not want to ignore expired or non-persistent messages

Specified by:

isSendToDeadLetterQueue in interface DeadLetterStrategy

Returns:

true if message should be sent to a dead letter queue

isProcessExpired

public boolean isProcessExpired()

Specified by:

isProcessExpired in interface DeadLetterStrategy

Returns:

the processExpired

setProcessExpired

public void setProcessExpired(boolean processExpired)

Specified by:

setProcessExpired in interface DeadLetterStrategy

Parameters:

processExpired - the processExpired to set

isProcessNonPersistent

public boolean isProcessNonPersistent()

Specified by:

isProcessNonPersistent in interface DeadLetterStrategy

Returns:

the processNonPersistent

setProcessNonPersistent

public void setProcessNonPersistent(boolean processNonPersistent)

Specified by:

setProcessNonPersistent in interface DeadLetterStrategy

Parameters:

processNonPersistent - the processNonPersistent to set

isEnableAudit

public boolean isEnableAudit()

setEnableAudit

public void setEnableAudit(boolean enableAudit)

getExpiration

public long getExpiration()

Specified by:

getExpiration in interface DeadLetterStrategy

setExpiration

public void setExpiration(long expiration)

Description copied from interface: DeadLetterStrategy

The expiration value to use on messages sent to the DLQ, default 0

Specified by:

setExpiration in interface DeadLetterStrategy

getMaxProducersToAudit

public int getMaxProducersToAudit()

setMaxProducersToAudit

public void setMaxProducersToAudit(int maxProducersToAudit)

setMaxAuditDepth

public void setMaxAuditDepth(int maxAuditDepth)

getMaxAuditDepth

public int getMaxAuditDepth()