org.mule.jms.commons.internal.operation

Class JmsConsume

java.lang.Object

org.mule.jms.commons.internal.operation.JmsConsume

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Disposable

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

Operation that allows the user to consume a single Message from a given Destination

Since:

1.0

Field Summary

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
JmsConsume(JmsSessionManager sessionManager, org.mule.runtime.api.scheduler.SchedulerService schedulerService)

Method Summary

Modifier and Type	Method and Description
void	consume(JmsConfig config, JmsTransactionalConnection connection, String destination, ConsumerType consumerType, JmsAckMode ackMode, String selector, String contentType, String encoding, Long maximumWait, TimeUnit maximumWaitUnit, org.mule.runtime.extension.api.tx.OperationTransactionalAction transactionalAction, org.mule.runtime.extension.api.runtime.process.CompletionCallback<Object,JmsAttributes> completionCallback)
void	dispose()

Methods inherited from class java.lang.Object

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

Constructor Detail

JmsConsume

public JmsConsume(JmsSessionManager sessionManager,
                  org.mule.runtime.api.scheduler.SchedulerService schedulerService)

Method Detail

consume

@OutputResolver(output=JmsOutputResolver.class)
 @Throws(value=JmsConsumeErrorTypeProvider.class)
public void consume(@Config
                                                                                                                      JmsConfig config,
                                                                                                                      @Connection
                                                                                                                      JmsTransactionalConnection connection,
                                                                                                                      @Summary(value="The name of the Destination from where the Message should be consumed")
                                                                                                                      String destination,
                                                                                                                      @ConfigOverride @Summary(value="The Type of the Consumer that should be used for the provided destination")
                                                                                                                      ConsumerType consumerType,
                                                                                                                      @Optional @Summary(value="The Session ACK mode to use when consuming a message")
                                                                                                                      JmsAckMode ackMode,
                                                                                                                      @ConfigOverride @Summary(value="The JMS selector to be used for filtering incoming messages")
                                                                                                                      String selector,
                                                                                                                      @Optional @Summary(value="The content type of the message body") @Example(value="application/json")
                                                                                                                      String contentType,
                                                                                                                      @Optional @Summary(value="The encoding of the message body") @Example(value="UTF-8")
                                                                                                                      String encoding,
                                                                                                                      @Optional(defaultValue="10000") @Summary(value="Maximum time to wait for a message to arrive before timeout")
                                                                                                                      Long maximumWait,
                                                                                                                      @Optional(defaultValue="MILLISECONDS") @Example(value="MILLISECONDS") @Summary(value="Time unit to be used in the maximumWaitTime configuration")
                                                                                                                      TimeUnit maximumWaitUnit,
                                                                                                                      org.mule.runtime.extension.api.tx.OperationTransactionalAction transactionalAction,
                                                                                                                      org.mule.runtime.extension.api.runtime.process.CompletionCallback<Object,JmsAttributes> completionCallback)
                                                                                                               throws JmsExtensionException

Throws:

JmsExtensionException

dispose

public void dispose()

Specified by:

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