com.hcl.domino.mq

Interface MessageQueues

public interface MessageQueues

Author:

t.b.d

Method Summary

Modifier and Type	Method and Description
MessageQueue	createAndOpen(String queueName, int quota) Create a message queue with the specified name.
boolean	hasQueue(String queueName) Method to test whether a queue with a specified name exists (tries to open the queue)
MessageQueue	open(String queueName, boolean createOnFail) Open a message queue, get a handle to it, and increment the queue's reference counter.

Method Detail

open

MessageQueue open(String queueName,
                  boolean createOnFail)

Open a message queue, get a handle to it, and increment the queue's reference counter. The handle is used by the functions that write to and read from the message queue.

Parameters:

queueName - name of the queue that is to be opened

createOnFail - true to create the queue if it doesn't exist

Returns:

the message queue

Throws:

DominoException - if the queue doesn't exist and createOnFail is false

hasQueue

boolean hasQueue(String queueName)

Method to test whether a queue with a specified name exists (tries to open the queue)

Parameters:

queueName - queue name

Returns:

true if queue exists

createAndOpen

MessageQueue createAndOpen(String queueName,
                           int quota)

Create a message queue with the specified name.

Parameters:

queueName - name to be assigned to the message queue

quota - Maximum number of messages that the queue may contain. Set this to zero for the default maximum. The default maximum number of messages that the queue may contain is MAXWORD.

Returns:

the message queue