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

Class HeaderMessageInterceptorStrategy

java.lang.Object

org.apache.activemq.broker.region.policy.HeaderMessageInterceptorStrategy

All Implemented Interfaces:

MessageInterceptorStrategy

public class HeaderMessageInterceptorStrategy
extends Object
implements MessageInterceptorStrategy

Enforce message policies for JMS Header values

Constructor Summary

Constructors

Constructor	Description
HeaderMessageInterceptorStrategy()

Method Summary

Modifier and Type	Method	Description
boolean	isForceDeliveryMode()
boolean	isForceExpiration()
boolean	isPersistent()
boolean	isProcessNetworkMessages()
void	process(ProducerBrokerExchange producerBrokerExchange, org.apache.activemq.command.Message message)	When a PolicyEntry is configured with a MessageInterceptorStrategy, the process method is invoked with the current ProducerBrokerExchange and Message before the message is stored in any destination cache or persistence store.
void	setExpirationCeiling(long expirationCeiling)	setter method for expirationCeiling
void	setForceDeliveryMode(boolean forceDeliveryMode)
void	setForceExpiration(boolean forceExpiration)
void	setFutureOnly(boolean futureOnly)
void	setPersistent(boolean persistent)
void	setProcessNetworkMessages(boolean processNetworkMessages)
void	setProcessNetworkMessages(Boolean processNetworkMessages)
void	setZeroExpirationOverride(long ttl)	setter method for zeroExpirationOverride

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderMessageInterceptorStrategy

public HeaderMessageInterceptorStrategy()

Method Detail

setZeroExpirationOverride

public void setZeroExpirationOverride(long ttl)

setter method for zeroExpirationOverride

setExpirationCeiling

public void setExpirationCeiling(long expirationCeiling)

setter method for expirationCeiling

setFutureOnly

public void setFutureOnly(boolean futureOnly)

setProcessNetworkMessages

public void setProcessNetworkMessages(Boolean processNetworkMessages)

process

public void process(ProducerBrokerExchange producerBrokerExchange,
                    org.apache.activemq.command.Message message)
             throws javax.jms.MessageFormatRuntimeException

Description copied from interface: MessageInterceptorStrategy

When a PolicyEntry is configured with a MessageInterceptorStrategy, the process method is invoked with the current ProducerBrokerExchange and Message before the message is stored in any destination cache or persistence store. Implementations may reference data from the ProducerBrokerExchange and may check or modify headers, properties, body or other metadata on the Message. Any change to the message must adhere to OpenWire and ActiveMQ requirements or risk issues with memory usage, compatibility, and general correct functioning. Implementations shall not copy, or clone the message. Implementations may throw a MessageFormatRuntimeException that is returned to the client to indicate a message should not be added to the queue.

Specified by:

process in interface MessageInterceptorStrategy

Throws:

javax.jms.MessageFormatRuntimeException

setForceDeliveryMode

public void setForceDeliveryMode(boolean forceDeliveryMode)

isForceDeliveryMode

public boolean isForceDeliveryMode()

setForceExpiration

public void setForceExpiration(boolean forceExpiration)

isForceExpiration

public boolean isForceExpiration()

setPersistent

public void setPersistent(boolean persistent)

isPersistent

public boolean isPersistent()

setProcessNetworkMessages

public void setProcessNetworkMessages(boolean processNetworkMessages)

isProcessNetworkMessages

public boolean isProcessNetworkMessages()