com.konakart.mqif

Interface MqMgrIf

All Known Implementing Classes:

MqMgr, RabbitMqMgrEE

public interface MqMgrIf

MqMgrIf - Message Queue Manager Interface Interface which an implementation of this manager must adhere to.

Method Summary

Modifier and Type	Method and Description
void	checkAPIAccessSupported(java.lang.String apiName, MqOptionsIf options) Check that the MQOptions parameters are supported through the specified KKEngIf API
void	commit(MqOptionsIf options) Commit all the messages read by the message reader (typically after successful processing).
void	delayMessage(MqOptionsIf options) Re-post the message with a delay (typically after unsuccessful processing).
MqResponseIf	listMessagesOnQueue(MqOptionsIf options) Creates a string containing a list of the messages on the specified queue
void	postMessageToQueue(MqOptionsIf options) Post a message to a specified queue.
void	purgeQueue(MqOptionsIf options) Purge all messages from a specified queue.
MqResponseIf	readMessageFromQueue(MqOptionsIf options) Read a single message from a specified queue.
void	removeReader(MqOptionsIf options) Remove the message reader if it exists.

Method Detail

postMessageToQueue

void postMessageToQueue(MqOptionsIf options)
                 throws com.konakart.app.KKException

Post a message to a specified queue. Use the options parameter to define the message text, credentials and the destination queue.

Parameters:

options - the MQ options

Throws:

com.konakart.app.KKException - an unexpected KKException exception

readMessageFromQueue

MqResponseIf readMessageFromQueue(MqOptionsIf options)
                           throws com.konakart.app.KKException

Read a single message from a specified queue. Use the options parameter to define credentials, a timeout value and the name of the queue to read.

Parameters:

options - the MQ options

Returns:

an object describing the response from this call. Usually it will contain the text of the message that was read, but if there was a timeout the message will be null and the timedout attribute will be true.

Throws:

com.konakart.app.KKException - an unexpected KKException exception

listMessagesOnQueue

MqResponseIf listMessagesOnQueue(MqOptionsIf options)
                          throws com.konakart.app.KKException

Creates a string containing a list of the messages on the specified queue

Parameters:

options - the MQ options

Returns:

an object describing the response from this call. Usually it will contain a list of the messages on the specified queue, but if there was a timeout the message will be null and the timedout attribute will be true.

Throws:

com.konakart.app.KKException - an unexpected KKException exception

purgeQueue

void purgeQueue(MqOptionsIf options)
         throws com.konakart.app.KKException

Purge all messages from a specified queue. Use the options parameter to define credentials, a timeout value and the name of the queue to read.

Parameters:

options - the MQ options

Throws:

com.konakart.app.KKException - an unexpected KKException exception

delayMessage

void delayMessage(MqOptionsIf options)
           throws com.konakart.app.KKException

Re-post the message with a delay (typically after unsuccessful processing). The original message is removed from the queue with a commit.

Parameters:

options - the MqOptions object - set the brokerURL, the username, the Queue name, the messageId and the mode.

Throws:

com.konakart.app.KKException - an unexpected KKException exception

commit

void commit(MqOptionsIf options)
     throws com.konakart.app.KKException

Commit all the messages read by the message reader (typically after successful processing).

Parameters:

options - the MqOptions object - set the brokerURL, the username, the Queue name, the messageId and the mode.

Throws:

com.konakart.app.KKException - an unexpected KKException exception

removeReader

void removeReader(MqOptionsIf options)
           throws com.konakart.app.KKException

Remove the message reader if it exists.

Parameters:

options - the MqOptions object - set the brokerURL, the username, the Queue, name the messageId and the mode.

Throws:

com.konakart.app.KKException - an unexpected KKException exception

checkAPIAccessSupported

void checkAPIAccessSupported(java.lang.String apiName,
                             MqOptionsIf options)
                      throws com.konakart.app.KKException

Check that the MQOptions parameters are supported through the specified KKEngIf API

Parameters:

apiName - the name of the API called

options - the MQ Options

Throws:

com.konakart.app.KKException - if the specified MQ Options are not supported for this API call