com.mule.extensions.amqp.internal.operation

Class AmqpConsume

java.lang.Object

com.mule.extensions.amqp.internal.operation.AmqpConsume

public final class AmqpConsume
extends Object

Operation that allows the user to consume a single AmqpMessage from a given queue.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
AmqpConsume()

Method Summary

Modifier and Type

Method and Description

org.mule.runtime.extension.api.runtime.operation.Result<InputStream,AmqpAttributes>

consume(AmqpConfig config, AmqpTransactionalConnection connection, String queueName, String contentType, String encoding, QueueDefinition fallbackQueueDefinition, ConsumerAckMode ackMode, String consumerTag, Long maximumWait, TimeUnit maximumWaitUnit, boolean createFallbackQueue, org.mule.runtime.extension.api.tx.OperationTransactionalAction transactionalAction) Operation that allows the user to consume a single AmqpMessage from a given AMQP.Queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

AmqpConsume

public AmqpConsume()

Method Detail

consume

@OutputResolver(output=AmqpOutputResolver.class)
 @Throws(value=AmqpConsumerErrorTypeProvider.class)
 @MediaType(value="*/*",
           strict=false)
public org.mule.runtime.extension.api.runtime.operation.Result<InputStream,AmqpAttributes> consume(@Config
                                                                                                                                                                                                                                                          AmqpConfig config,
                                                                                                                                                                                                                                                          @Connection
                                                                                                                                                                                                                                                          AmqpTransactionalConnection connection,
                                                                                                                                                                                                                                                          @Summary(value="The name of the queue from where the Message should be consumed")
                                                                                                                                                                                                                                                          String queueName,
                                                                                                                                                                                                                                                          @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 @Summary(value="The queue definition to use for queue declaration in case there is no queue with the queueName") @Expression(value=NOT_SUPPORTED)
                                                                                                                                                                                                                                                          QueueDefinition fallbackQueueDefinition,
                                                                                                                                                                                                                                                          @Optional @Summary(value="The ACK mode to use when consuming a message")
                                                                                                                                                                                                                                                          ConsumerAckMode ackMode,
                                                                                                                                                                                                                                                          @Optional @Summary(value="The consumer tag to use for the consumer involved in the operation")
                                                                                                                                                                                                                                                          String consumerTag,
                                                                                                                                                                                                                                                          @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,
                                                                                                                                                                                                                                                          @ConfigOverride
                                                                                                                                                                                                                                                          boolean createFallbackQueue,
                                                                                                                                                                                                                                                          org.mule.runtime.extension.api.tx.OperationTransactionalAction transactionalAction)
                                                                                                                                                                                                                                                   throws AmqpExtensionException

Operation that allows the user to consume a single AmqpMessage from a given AMQP.Queue.

Parameters:

config - the current AmqpConfig

connection - the current AmqpTransactionalConnection

queueName - The name of the queue from where the Message should be consumed

contentType - The content type of the message body

encoding - The encoding of the message body

fallbackQueueDefinition - The queue definition to use for queue declaration in case there is no queue with the queueName

ackMode - The ACK mode to use when consuming a message

consumerTag - The consumer tag to use for the consumer involved in the operation

maximumWait - Maximum time to wait for a message to arrive before timeout

maximumWaitUnit - Time unit to be used in the maximumWaitTime configuration

transactionalAction - information of the current transaction in case it exists

Returns:

Throws:

AmqpExtensionException - if an error occurs