org.mule.extensions.jms.api.operation

Class JmsPublish

java.lang.Object

org.mule.extensions.jms.api.operation.JmsPublish

public final class JmsPublish
extends Object

Operation that allows the user to send a message to a JMS Destination

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
JmsPublish()

Method Summary

Modifier and Type	Method and Description
void	publish(JmsConfig config, JmsConnection connection, String destination, DestinationType destinationType, MessageBuilder messageBuilder, Boolean persistentDelivery, Integer priority, Long timeToLive, TimeUnit timeToLiveUnit, Long deliveryDelay, TimeUnit deliveryDelayUnit) Operation that allows the user to send a Message to a JMS {@link Destination

Methods inherited from class java.lang.Object

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

Constructor Detail

JmsPublish

public JmsPublish()

Method Detail

publish

public void publish(@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(defaultValue="QUEUE") @Summary(value="The type of the Destination")
                    DestinationType destinationType,
                    @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 configurations")
                    TimeUnit timeToLiveUnit,
                    @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 {@link Destination

Parameters:

config - the current JmsProducerConfig

connection - the current JmsConnection

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

type - the DestinationType of the destination

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

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

Throws:

JmsExtensionException - if an error occurs