org.mule.jms.commons.api.message

Class JmsxProperties

java.lang.Object

org.mule.jms.commons.api.message.JmsxProperties

All Implemented Interfaces:

Serializable

public class JmsxProperties
extends Object
implements Serializable

JMS reserves the 'JMSX' property name prefix for JMS defined properties. Here we define the set of 'well known' properties of JMS. JMSX properties 'set by provider on send' are available to both the producer and the consumers of the message. If they are not present in a message, they are treated like any other absent property.

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JmsxProperties()
JmsxProperties(String JMSXUserID, String JMSXAppID, Integer JMSXDeliveryCount, String JMSXGroupID, Integer JMSXGroupSeq, String JMSXProducerTXID, String JMSXConsumerTXID, Long JMSXRcvTimestamp)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap()
String	getJmsxAppID()
String	getJmsxConsumerTXID()
Integer	getJmsxDeliveryCount()
String	getJmsxGroupID()
Integer	getJmsxGroupSeq()
String	getJmsxProducerTXID()
Long	getJmsxRcvTimestamp()
String	getJmsxUserID()
void	setJmsxAppID(String jmsxAppID)
void	setJmsxConsumerTXID(String jmsxConsumerTXID)
void	setJmsxDeliveryCount(Integer jmsxDeliveryCount)
void	setJmsxGroupID(String jmsxGroupID)
void	setJmsxGroupSeq(Integer jmsxGroupSeq)
void	setJmsxProducerTXID(String jmsxProducerTXID)
void	setJmsxRcvTimestamp(Long jmsxRcvTimestamp)
void	setJmsxUserID(String jmsxUserID)

Methods inherited from class java.lang.Object

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

Constructor Detail

JmsxProperties

public JmsxProperties()

JmsxProperties

public JmsxProperties(String JMSXUserID,
                      String JMSXAppID,
                      Integer JMSXDeliveryCount,
                      String JMSXGroupID,
                      Integer JMSXGroupSeq,
                      String JMSXProducerTXID,
                      String JMSXConsumerTXID,
                      Long JMSXRcvTimestamp)

Method Detail

asMap

public Map<String,Object> asMap()

Returns:

all the JMSX properties in a plain Map representation using the corresponding keys as defined in JMSXDefinedPropertiesNames

getJmsxUserID

public String getJmsxUserID()

Returns:

the JMSXUserID Message property

getJmsxAppID

public String getJmsxAppID()

Returns:

the JMSXAppID Message property

getJmsxDeliveryCount

public Integer getJmsxDeliveryCount()

Returns:

the JMSXDeliveryCount Message property

getJmsxGroupID

public String getJmsxGroupID()

Returns:

the JMSXGroupID Message property

getJmsxGroupSeq

public Integer getJmsxGroupSeq()

Returns:

the JMSXGroupSeq Message property

getJmsxProducerTXID

public String getJmsxProducerTXID()

Returns:

the JMSXProducerTXID Message property

getJmsxConsumerTXID

public String getJmsxConsumerTXID()

Returns:

the JMSXConsumerTXID Message property

getJmsxRcvTimestamp

public Long getJmsxRcvTimestamp()

Returns:

the JMSXRcvTimestamp

setJmsxUserID

public void setJmsxUserID(String jmsxUserID)

setJmsxAppID

public void setJmsxAppID(String jmsxAppID)

setJmsxDeliveryCount

public void setJmsxDeliveryCount(Integer jmsxDeliveryCount)

setJmsxGroupID

public void setJmsxGroupID(String jmsxGroupID)

setJmsxGroupSeq

public void setJmsxGroupSeq(Integer jmsxGroupSeq)

setJmsxProducerTXID

public void setJmsxProducerTXID(String jmsxProducerTXID)

setJmsxConsumerTXID

public void setJmsxConsumerTXID(String jmsxConsumerTXID)

setJmsxRcvTimestamp

public void setJmsxRcvTimestamp(Long jmsxRcvTimestamp)