Websphere MQ Everyplace

examples.midp.exampleapp.msgpump
Interface MsgPumpController

All Known Implementing Classes:
MidpClient, NormalClient

public interface MsgPumpController

This is the msgpump controller interface class. All controllers of a message pump must implement this.

The aim of the controller is to act as both the user interface and the control centre for the message pump. This means that if a decision needs to be made, this is the class that does it.

Controllers will be dependant on whether they are being run on J2SE, MIDP or other versions of java - it is not expected that a generic controller client will be used to control all client models as the user interface will differ between java platforms.


Field Summary
static short[] version
           
 
Method Summary
 void deleteQueueManager()
          Purges the queue manager from the system.
 void displayMsg(java.lang.String msg)
          Displays a status report or other type of message.
 MsgPumpModel getModel()
          Returns the pump model, creating a new one first if necessary.
 java.lang.String getQMname()
          Returns the name of hte queue manager.
 void initialize()
          Performs any actions necessary to initialize the controller.
 void processMsg(java.lang.String msg)
          This function is used to process a message before it is displayed.
 void start()
          Called to start the pumping.
 

Field Detail

version

public static final short[] version
Method Detail

processMsg

public void processMsg(java.lang.String msg)
This function is used to process a message before it is displayed.

Parameters:
msg - The message to be displayed

getModel

public MsgPumpModel getModel()
Returns the pump model, creating a new one first if necessary.

Returns:
MsgPumpModel - the pump model

deleteQueueManager

public void deleteQueueManager()
Purges the queue manager from the system.

Returns:
void

displayMsg

public void displayMsg(java.lang.String msg)
Displays a status report or other type of message.

Parameters:
msg - The message to display

getQMname

public java.lang.String getQMname()
Returns the name of hte queue manager.

Returns:
String - the name of the queue manager

start

public void start()
           throws java.lang.Exception
Called to start the pumping.

Returns:
void
java.lang.Exception

initialize

public void initialize()
                throws java.lang.Exception
Performs any actions necessary to initialize the controller. This includes getting the QM name and initializing the model.

Returns:
void
java.lang.Exception

Websphere MQ Everyplace