Module org.mule.sdk.api

Package org.mule.sdk.api.queue

Interface QueueManager

@NoImplement
public interface QueueManager

A Queue manager is responsible for managing one or more Queue resources and providing common support for transactions and persistence.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OBJECT_QUEUE_MANAGER

Method Summary

Modifier and Type	Method	Description
void	configureQueue(String queueName, int maxOutstandingMessages, boolean persistent)	Configures the defined queue.
Optional<QueueConfiguration>	getQueueConfiguration(String queueName)	Returns the configuration of the Queue of the given queueName
QueueSession	getQueueSession()	Returns a new instance of QueueSession bounded to this QueueManager

Field Details

OBJECT_QUEUE_MANAGER

static final String OBJECT_QUEUE_MANAGER

See Also:

• Constant Field Values

Method Details

getQueueSession

QueueSession getQueueSession()

Returns a new instance of QueueSession bounded to this QueueManager

Returns:

session for retrieving queues and handle transactions

getQueueConfiguration

Optional<QueueConfiguration> getQueueConfiguration(String queueName)

Returns the configuration of the Queue of the given queueName

Parameters:

queueName - the name of a configured queue

Returns:

the queue's configuration or Optional.empty() if no such queue

configureQueue

void configureQueue(String queueName,
 int maxOutstandingMessages,
 boolean persistent)

Configures the defined queue.

Parameters:

queueName - the name of a queue to be configured.

maxOutstandingMessages - the max outstanding messages to be set for the configuration.

persistent - if the queue should be configured to be persistent.