org.mule.extensions.jms.api.operation

Class JmsPublishConsume

java.lang.Object

org.mule.extensions.jms.api.operation.JmsPublishConsume

public class JmsPublishConsume
extends Object

Operation that allows the user to send a message to a JMS Destination and waits for a response either to the provided ReplyTo destination or to a temporary Destination created dynamically

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
JmsPublishConsume()

Method Summary

Modifier and Type

Method and Description

org.mule.runtime.extension.api.runtime.operation.Result<Object,JmsAttributes>

publishConsume(JmsConfig config, JmsConnection connection, String destination, MessageBuilder messageBuilder, Boolean persistentDelivery, Integer priority, Long timeToLive, TimeUnit timeToLiveUnit, Long maximumWaitTime, TimeUnit waitTimeUnit, AckMode ackMode, Long deliveryDelay, TimeUnit deliveryDelayUnit) Operation that allows the user to send a message to a JMS Destination and waits for a response either to the provided ReplyTo destination or to a temporary Destination created dynamically

Methods inherited from class java.lang.Object

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

Constructor Detail

JmsPublishConsume

public JmsPublishConsume()

Method Detail

publishConsume

@OutputResolver(output=JmsOutputResolver.class)
public org.mule.runtime.extension.api.runtime.operation.Result<Object,JmsAttributes> publishConsume(@UseConfig
                                                                                                                                                    JmsConfig config,
                                                                                                                                                    @Connection
                                                                                                                                                    JmsConnection connection,
                                                                                                                                                    @XmlHints(allowReferences=false) @Summary(value="The name of the Destination where the Message should be sent")
                                                                                                                                                    String destination,
                                                                                                                                                    @Optional @NullSafe @Summary(value="A builder for the message that will be published")
                                                                                                                                                    MessageBuilder messageBuilder,
                                                                                                                                                    @Optional @Summary(value="If true, the Message will be sent using the PERSISTENT JMSDeliveryMode")
                                                                                                                                                    Boolean persistentDelivery,
                                                                                                                                                    @Optional @Summary(value="The default JMSPriority value to be used when sending the message")
                                                                                                                                                    Integer priority,
                                                                                                                                                    @Optional @Summary(value="Defines the default time the message will be in the broker before it expires and is discarded")
                                                                                                                                                    Long timeToLive,
                                                                                                                                                    @Optional @Summary(value="Time unit to be used in the timeToLive configuration")
                                                                                                                                                    TimeUnit timeToLiveUnit,
                                                                                                                                                    @Optional(defaultValue="10000") @Summary(value="Maximum time to wait for a response before timeout")
                                                                                                                                                    Long maximumWaitTime,
                                                                                                                                                    @Optional(defaultValue="MILLISECONDS") @Summary(value="Time unit to be used in the maximumWaitTime configuration")
                                                                                                                                                    TimeUnit waitTimeUnit,
                                                                                                                                                    @Optional
                                                                                                                                                    AckMode ackMode,
                                                                                                                                                    @Optional @Summary(value="Only used by JMS 2.0. Sets the delivery delay to be applied in order to postpone the Message delivery")
                                                                                                                                                    Long deliveryDelay,
                                                                                                                                                    @Optional @Summary(value="Time unit to be used in the deliveryDelay configurations")
                                                                                                                                                    TimeUnit deliveryDelayUnit)
                                                                                                                                             throws JmsExtensionException

Operation that allows the user to send a message to a JMS Destination and waits for a response either to the provided ReplyTo destination or to a temporary Destination created dynamically

Parameters:

config - the current JmsProducerConfig

connection - the current JmsConnection

destination - the name of the Destination where the Message should be sent

messageBuilder - the MessageBuilder used to create the Message to be sent

messageBuilder - the MessageBuilder used to create the Message to be sent

persistentDelivery - true if DeliveryMode.PERSISTENT should be used

priority - the Message.getJMSPriority() to be set

timeToLive - the time the message will be in the broker before it expires and is discarded

timeToLiveUnit - unit to be used in the timeToLive configurations

ackMode - the AckMode that will be configured over the Message and Session

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

deliveryDelayUnit - Time unit to be used in the deliveryDelay configurations

Returns:

a Result with the reply Message content as Result.getOutput() and its properties and headers as Result.getAttributes()

Throws:

JmsExtensionException - if an error occurs