Package org.mule.jms.commons.internal.source

Class DefaultJmsResponseMessageBuilder

java.lang.Object

org.mule.jms.commons.api.message.DefaultJmsMessageBuilder<DefaultJmsDestination>

org.mule.jms.commons.internal.source.DefaultJmsResponseMessageBuilder

All Implemented Interfaces:

JmsMessageBuilder<DefaultJmsDestination>, PublisherParameters, JmsResponseMessageBuilder<DefaultJmsDestination>

public class DefaultJmsResponseMessageBuilder
extends DefaultJmsMessageBuilder<DefaultJmsDestination>
implements JmsResponseMessageBuilder<DefaultJmsDestination>

Enables the creation of an outgoing Message along with the response configuration. Users must use this builder to create a message response instance.

Since:

1.0

Field Summary

Fields inherited from class org.mule.jms.commons.api.message.DefaultJmsMessageBuilder

BODY_CONTENT_TYPE_JMS_PROPERTY, BODY_ENCODING_JMS_PROPERTY

Constructor Summary

Constructors

Constructor	Description
DefaultJmsResponseMessageBuilder()

Method Summary

Modifier and Type	Method	Description
Long	getDeliveryDelay()	Only used by JMS 2.0.
TimeUnit	getDeliveryDelayUnit()	Time unit to be used in the deliveryDelay configurations
Integer	getPriority()	The default JMSPriority value to be used when sending the message
RequestReplyPattern	getRequestReplyPattern()	Returns the Request Reply Pattern to use
org.mule.runtime.extension.api.runtime.parameter.OutboundCorrelationStrategy	getSendCorrelationId()	Options on whether to include an outbound correlation id or not
Long	getTimeToLive()	Defines the default time the message will be in the broker before it expires and is discarded
TimeUnit	getTimeToLiveUnit()	Time unit to be used in the timeToLive configurations
boolean	isDisableMessageId()	If true; the Message will be flagged to avoid generating its MessageID
boolean	isDisableMessageTimestamp()	If true; the Message will be flagged to avoid generating its sent Timestamp
boolean	isPersistentDelivery()	Whether or not the delivery should be done with a persistent configuration
boolean	isReplyToIgnored()	If true no automatic response will be sent in case of Jms replyTo header presence.

Methods inherited from class org.mule.jms.commons.api.message.DefaultJmsMessageBuilder

build, getBody, getCorrelationId, getJmsType, getJmsxProperties, getOutboundContentType, getOutboundEncoding, getProperties, getReplyTo, isSendContentType, isSendEncoding, setBody, setCorrelationId, setJmsType, setJmsxProperties, setOutboundContentType, setOutboundEncoding, setProperties, setReplyTo, setSendContentType, setSendEncoding

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.jms.commons.api.message.JmsMessageBuilder

build, getBody, getCorrelationId, getJmsType, getJmsxProperties, getOutboundContentType, getOutboundEncoding, getProperties, getReplyTo, isSendContentType, isSendEncoding

Constructor Details

DefaultJmsResponseMessageBuilder

public DefaultJmsResponseMessageBuilder()

Method Details

isPersistentDelivery

public boolean isPersistentDelivery()

Description copied from interface: JmsResponseMessageBuilder

Whether or not the delivery should be done with a persistent configuration

Specified by:

isPersistentDelivery in interface JmsResponseMessageBuilder<DefaultJmsDestination>

Specified by:

isPersistentDelivery in interface PublisherParameters

getPriority

public Integer getPriority()

Description copied from interface: JmsResponseMessageBuilder

The default JMSPriority value to be used when sending the message

Specified by:

getPriority in interface JmsResponseMessageBuilder<DefaultJmsDestination>

Specified by:

getPriority in interface PublisherParameters

getTimeToLive

public Long getTimeToLive()

Description copied from interface: JmsResponseMessageBuilder

Defines the default time the message will be in the broker before it expires and is discarded

Specified by:

getTimeToLive in interface JmsResponseMessageBuilder<DefaultJmsDestination>

Specified by:

getTimeToLive in interface PublisherParameters

getTimeToLiveUnit

public TimeUnit getTimeToLiveUnit()

Description copied from interface: JmsResponseMessageBuilder

Time unit to be used in the timeToLive configurations

Specified by:

getTimeToLiveUnit in interface JmsResponseMessageBuilder<DefaultJmsDestination>

Specified by:

getTimeToLiveUnit in interface PublisherParameters

isDisableMessageId

public boolean isDisableMessageId()

Description copied from interface: JmsResponseMessageBuilder

If true; the Message will be flagged to avoid generating its MessageID

Specified by:

isDisableMessageId in interface JmsResponseMessageBuilder<DefaultJmsDestination>

Specified by:

isDisableMessageId in interface PublisherParameters

isDisableMessageTimestamp

public boolean isDisableMessageTimestamp()

Description copied from interface: JmsResponseMessageBuilder

If true; the Message will be flagged to avoid generating its sent Timestamp

Specified by:

isDisableMessageTimestamp in interface JmsResponseMessageBuilder<DefaultJmsDestination>

Specified by:

isDisableMessageTimestamp in interface PublisherParameters

getDeliveryDelay

public Long getDeliveryDelay()

Description copied from interface: JmsResponseMessageBuilder

Only used by JMS 2.0. Sets the delivery delay to be applied in order to postpone the Message delivery

Specified by:

getDeliveryDelay in interface JmsResponseMessageBuilder<DefaultJmsDestination>

Specified by:

getDeliveryDelay in interface PublisherParameters

getDeliveryDelayUnit

public TimeUnit getDeliveryDelayUnit()

Description copied from interface: JmsResponseMessageBuilder

Time unit to be used in the deliveryDelay configurations

Specified by:

getDeliveryDelayUnit in interface JmsResponseMessageBuilder<DefaultJmsDestination>

Specified by:

getDeliveryDelayUnit in interface PublisherParameters

getSendCorrelationId

public org.mule.runtime.extension.api.runtime.parameter.OutboundCorrelationStrategy getSendCorrelationId()

Description copied from interface: JmsResponseMessageBuilder

Options on whether to include an outbound correlation id or not

Specified by:

getSendCorrelationId in interface JmsResponseMessageBuilder<DefaultJmsDestination>

getRequestReplyPattern

public RequestReplyPattern getRequestReplyPattern()

Description copied from interface: JmsResponseMessageBuilder

Returns the Request Reply Pattern to use

Specified by:

getRequestReplyPattern in interface JmsResponseMessageBuilder<DefaultJmsDestination>

isReplyToIgnored

public boolean isReplyToIgnored()

Description copied from interface: JmsResponseMessageBuilder

If true no automatic response will be sent in case of Jms replyTo header presence.

Specified by:

isReplyToIgnored in interface JmsResponseMessageBuilder<DefaultJmsDestination>

Returns:

status of the Jms replyTo ignore flag.