|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This acts as a frontend to WMQe, wrapping a queuemanager and performing functions such as queue creation and message sending. This is the core of the examples and allows the apps to be written with minimal calls to the WMQe API. This also means that to see the code required to create a local queue for example, a user can simply look at: createLocalQueue().
Functions can be split up as follows:
Message Service Functions --------------------------------------------- open() close() setMessageConsumer() Queue Manager Functions --------------------------------------------- createQueueManager() updateQueueManager() deleteQueueManager() createConnection() Queue Functions --------------------------------------------- createLocalQueue() createRemoteQueue() createStoreAndForwardQueue() createHomeServerQueue() monitorQueue() emptyQueue() Messaging Functions --------------------------------------------- sendMessage() sendSecureMessage() getMessage() getSecureMessage() processMessages() waitForReply()
Field Summary | |
static short[] |
version
|
Method Summary | |
void |
close()
When an application wishes to stop, this method must be called to allow the model to tidy up. |
void |
createConnection(java.lang.String onQMgr,
java.lang.String name,
java.lang.String adapter,
java.lang.String parms,
java.lang.String options)
Create a new connection to a queue manager. |
void |
createHomeServerQueue(java.lang.String onQMgr,
java.lang.String qm,
java.lang.String q,
long pollTime)
Create a home server queue. |
void |
createLocalQueue(java.lang.String onQMgr,
java.lang.String q,
boolean sync,
java.lang.String compressor,
java.lang.String cryptor)
Create a new local queue. |
void |
createQueueManager()
Creates the queue manager. |
void |
createRemoteQueue(java.lang.String onQMgr,
java.lang.String qm,
java.lang.String q,
boolean sync,
java.lang.String compressor,
java.lang.String cryptor)
Create a new remote queue. |
void |
createStoreAndForwardQueue(java.lang.String onQMgr,
java.lang.String qm,
java.lang.String q)
Create a store and forward queue. |
void |
emptyQueue(java.lang.String queueManagerName,
java.lang.String queueName)
This method is called when a requestor wishes to delete all messages from a queue. |
MQeMsgObject |
getMessage(java.lang.String queueManagerName,
java.lang.String queueName,
MQeFields filter)
Get a message from a given queue manager/queue. |
MQeMsgObject |
getSecureMessage(java.lang.String queueManagerName,
java.lang.String queueName,
MQeFields filter,
MQeAttribute attribute)
Get a secure message from a given queue manager/queue. |
void |
monitorQueue(java.lang.String queueManagerName,
java.lang.String queueName)
Montior the named queue for new messages as a result of which a view components displayMessage method will be called. |
void |
open()
Performs processing needed to activate the system. |
void |
processMessages(java.lang.String queueManagerName,
java.lang.String queueName,
MQeFields match)
This method reads messages from a queue that match a filter. |
void |
sendMessage(java.lang.String queueManagerName,
java.lang.String queueName,
MQeMsgObject message)
Send a message to a queue on a specific queue manager. |
void |
sendSecureMessage(java.lang.String queueManagerName,
java.lang.String queueName,
MQeMsgObject message,
MQeAttribute attribute)
Send a secure message to a queue on a specific queue manager. |
void |
setMessageConsumer(MessageConsumer msgConsumer)
Provide the model with an instance of a message consumer that can process messages. |
void |
updateQueueManager(java.lang.String onQMgr,
MQeFields parms)
Change the characteristics of a queue manager. |
MQeMsgObject |
waitForReply(java.lang.String onQMgr,
java.lang.String onQueue,
MQeFields msgTest)
Wait a while for a message to turn up on a queue. |
Field Detail |
public static final short[] version
Method Detail |
public void close() throws java.lang.Exception
java.lang.Exception
public void createConnection(java.lang.String onQMgr, java.lang.String name, java.lang.String adapter, java.lang.String parms, java.lang.String options) throws java.lang.Exception
onQMgr
- Queue manager to send the admin messagename
- Name of the connectionadapter
- Adapter plus base parms to be usedparms
- Connection parametersoptions
- Connection options
java.lang.Exception
public void createHomeServerQueue(java.lang.String onQMgr, java.lang.String qm, java.lang.String q, long pollTime) throws java.lang.Exception
onQMgr
- Which QMgr to send the admin messageqm
- Queue manager the queue resides onq
- Name of the queuepollTime
- The polltime for checking for messages
0 - do not poll check for messages on
call to triggerTransmission()
java.lang.Exception
public void createLocalQueue(java.lang.String onQMgr, java.lang.String q, boolean sync, java.lang.String compressor, java.lang.String cryptor) throws java.lang.Exception
onQMgr
- Queue manager the queue will be onq
- Queue namesync
- True for synchronous, false for asynccompressor
- The compressor to usecryptor
- The cryptor to use
java.lang.Exception
public void createQueueManager() throws java.lang.Exception
Part of the programatic creation of a queue manager.
java.lang.Exception
public void createRemoteQueue(java.lang.String onQMgr, java.lang.String qm, java.lang.String q, boolean sync, java.lang.String compressor, java.lang.String cryptor) throws java.lang.Exception
onQMgr
- The QMgr to send the admin messageqm
- Queue manager the queue resides onq
- Name of the queuesync
- True for synchronous, false for asynchronouscompressor
- The name of the compressor to use, or null for nonecryptor
- The name of the cryptor to use, or null for none
java.lang.Exception
public void createStoreAndForwardQueue(java.lang.String onQMgr, java.lang.String qm, java.lang.String q) throws java.lang.Exception
onQMgr
- Which QMgr to send the admin messageqm
- Queue manager the queue resides onq
- Name of the queue
java.lang.Exception
public void emptyQueue(java.lang.String queueManagerName, java.lang.String queueName) throws java.lang.Exception
queueManagerName
- Queue manager that queue is located onqueueName
- Name of queue
java.lang.Exception
public MQeMsgObject getMessage(java.lang.String queueManagerName, java.lang.String queueName, MQeFields filter) throws java.lang.Exception
queueManagerName
- Which QMgr to get the message fromqueueName
- Which queue to get the message fromfilter
- Get a message that matches the filter
java.lang.Exception
public MQeMsgObject getSecureMessage(java.lang.String queueManagerName, java.lang.String queueName, MQeFields filter, MQeAttribute attribute) throws java.lang.Exception
queueManagerName
- Which QMgr to get the message fromqueueName
- Which queue to get the message fromfilter
- Get a message that matches the filterattribute
- The attribute used to decode the secure message
java.lang.Exception
public void monitorQueue(java.lang.String queueManagerName, java.lang.String queueName)
If the queue is a local queue then a message listener can be used to automatically monitor for new messages. If it is a remote queue then message listeners cannot be used and an alternative approach needs to be found for instance the remote queue could be polled either automatically or by user request to see if there are any new messages.
queueManagerName
- Queue manager namequeueName
- Queue name
public void open() throws java.lang.Exception
For Example, start/configure the system.
java.lang.Exception
public void processMessages(java.lang.String queueManagerName, java.lang.String queueName, MQeFields match)
queueName
- Which queue to browsematch
- Only return fields matching
public void sendMessage(java.lang.String queueManagerName, java.lang.String queueName, MQeMsgObject message) throws java.lang.Exception
queueManagerName
- The queue manager that queue is onqueueName
- The queue to put message onmessage
- The message to send
java.lang.Exception
public void sendSecureMessage(java.lang.String queueManagerName, java.lang.String queueName, MQeMsgObject message, MQeAttribute attribute) throws java.lang.Exception
queueManagerName
- The queue manager that queue is located onqueueName
- The queue that message is going tomessage
- The message to send
java.lang.Exception
public void setMessageConsumer(MessageConsumer msgConsumer)
msgConsumer
- The message consumer to be set
public void updateQueueManager(java.lang.String onQMgr, MQeFields parms) throws java.lang.Exception
onQMgr
- A String containing the name of the queue manager
where the admin message will be sent.
java.lang.Exception
public MQeMsgObject waitForReply(java.lang.String onQMgr, java.lang.String onQueue, MQeFields msgTest) throws java.lang.Exception
onQMgr
- Wait for message on queue manageronQueue
- Wait for message on queuemsgTest
- Filter for a specific message
java.lang.Exception
|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |