com.konakart.mq

Class MqMgr

java.lang.Object

com.konakart.mq.MqMgr

All Implemented Interfaces:

MqMgrIf

public class MqMgr
extends java.lang.Object
implements MqMgrIf

MqMgrIf - Message Queue Manager Implementation

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log the log
protected static java.util.HashMap<java.lang.String,com.konakart.mq.MqMgr.MessageReader>	messageReaders HashMap to store the Message Readers

Constructor Summary

Constructors

Constructor and Description
MqMgr() Constructor

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.
java.lang.String	toString() For Diagnostic purposes.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

the log

messageReaders

protected static java.util.HashMap<java.lang.String,com.konakart.mq.MqMgr.MessageReader> messageReaders

HashMap to store the Message Readers

Constructor Detail

MqMgr

public MqMgr()
      throws java.lang.Exception

Constructor

Throws:

java.lang.Exception - an unexpected exception

Method Detail

postMessageToQueue

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

Description copied from interface: MqMgrIf

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

Specified by:

postMessageToQueue in interface MqMgrIf

Parameters:

options - the MQ options

Throws:

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

readMessageFromQueue

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

Description copied from interface: MqMgrIf

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.

Specified by:

readMessageFromQueue in interface MqMgrIf

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

commit

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

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

Specified by:

commit in interface MqMgrIf

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

delayMessage

public 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.

Specified by:

delayMessage in interface MqMgrIf

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

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

Remove the message reader if it exists.

Specified by:

removeReader in interface MqMgrIf

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

listMessagesOnQueue

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

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

Specified by:

listMessagesOnQueue in interface MqMgrIf

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

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

Description copied from interface: MqMgrIf

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.

Specified by:

purgeQueue in interface MqMgrIf

Parameters:

options - the MQ options

Throws:

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

toString

public java.lang.String toString()

For Diagnostic purposes. This returns a string describing the state of the MqMg

Overrides:

toString in class java.lang.Object

Returns:

a String providing information on the state of the MqMgr.

checkAPIAccessSupported

public 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

Specified by:

checkAPIAccessSupported in interface MqMgrIf

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