org.mule.jms.commons.internal.operation

Class JmsPublish

java.lang.Object

org.mule.jms.commons.internal.operation.JmsPublish

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Disposable

public final class JmsPublish
extends Object
implements org.mule.runtime.api.lifecycle.Disposable

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

Since:

1.0

Field Summary

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
JmsPublish(JmsSessionManager jmsSessionManager, org.mule.runtime.api.scheduler.SchedulerService schedulerService)

Method Summary

Modifier and Type	Method and Description
void	dispose()
void	publish(JmsConfig config, JmsTransactionalConnection connection, String destination, DestinationTypeDescriptor destinationType, JmsMessageBuilder messageBuilder, PublisherParameters overrides, org.mule.runtime.extension.api.tx.OperationTransactionalAction transactionalAction, org.mule.runtime.extension.api.runtime.parameter.OutboundCorrelationStrategy sendCorrelationId, org.mule.runtime.extension.api.runtime.parameter.CorrelationInfo correlationInfo, org.mule.runtime.extension.api.runtime.process.CompletionCallback<Void,Void> completionCallback) Operation that allows the user to send a Message to a JMS Destination

Methods inherited from class java.lang.Object

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

Constructor Detail

JmsPublish

public JmsPublish(JmsSessionManager jmsSessionManager,
                  org.mule.runtime.api.scheduler.SchedulerService schedulerService)

Method Detail

publish

@Throws(value=JmsPublisherErrorTypeProvider.class)
public void publish(@Config
                                                                       JmsConfig config,
                                                                       @Connection
                                                                       JmsTransactionalConnection connection,
                                                                       @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")
                                                                       DestinationTypeDescriptor destinationType,
                                                                       @Summary(value="A builder for the message that will be published") @ParameterGroup(name="Message",showInDsl=true)
                                                                       JmsMessageBuilder messageBuilder,
                                                                       @ParameterGroup(name="Publish Configuration")
                                                                       PublisherParameters overrides,
                                                                       org.mule.runtime.extension.api.tx.OperationTransactionalAction transactionalAction,
                                                                       @ConfigOverride
                                                                       org.mule.runtime.extension.api.runtime.parameter.OutboundCorrelationStrategy sendCorrelationId,
                                                                       org.mule.runtime.extension.api.runtime.parameter.CorrelationInfo correlationInfo,
                                                                       org.mule.runtime.extension.api.runtime.process.CompletionCallback<Void,Void> completionCallback)
                                                                throws JmsExtensionException

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

Parameters:

config - the current DefaultJmsProducerConfig

connection - the current JmsConnection

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

destinationType - the DestinationType of the destination

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

overrides - Parameter Group with overriding parameters from the configuration

transactionalAction - Transactional Action for the operation. Indicates if the publish must be executed or not in a transaction.

sendCorrelationId - options on whether to include an outbound correlation id or not

correlationInfo - the current message's correlation info

Throws:

JmsExtensionException - if an error occurs trying to publish a message

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable