Websphere MQ Everyplace

examples.application
Class ExampleBase

java.lang.Object
  |
  +--com.ibm.mqe.MQe
        |
        +--examples.application.ExampleBase
All Implemented Interfaces:
MQeExceptionCodes
Direct Known Subclasses:
Example1, Example2, Example3, Example4, Example5, Example6, Example7, ExampleAdminBase

public abstract class ExampleBase
extends MQe

Extends MQe, MQe base class.

To provide the base class/object for example applications.

Provides a set variables which are initialised with defaults values. The setParms method allows the values to be over-ridden. The accessLocalQMgr method starts the local queue manager. If the queue manager does not exist, a default queue manager is created and started. The meat of the example is placed in the doIt method.

The examples can run against queues on the local queue manager by using the default constructor or can run against a remote queue manager by using the constructor which takes a string parameter. To run against a remote queue manager, a remote queue manager defintion must be created on the local queue manager.


Field Summary
protected  MQeClient client
           
protected  java.lang.String example
           
protected  java.lang.String localQMgrName
           
protected  java.lang.String msgData
           
protected  java.lang.String msgField
           
protected  MQeQueueManager myQM
           
protected  java.lang.String qMgrName
           
protected  java.lang.String queueName
           
protected  java.lang.String startupIni
           
static short[] version
           
 
Fields inherited from class com.ibm.mqe.MQe
Admin_Queue_Name, Admin_Reply_Queue_Name, copyright, DeadLetter_Queue_Name, Event_Activate, Event_Attribute, Event_Authenticate, Event_Close, Event_Logoff, Event_Logon, Event_MiniCert_Validate, Event_Queue, Event_QueueManager, Event_UserBase, JMS_Version, MQ_Headers, MQe_Log_Audit_Failure, MQe_Log_Audit_Success, MQe_Log_Error, MQe_Log_Information, MQe_Log_Success, MQe_Log_Warning, Msg_BackoutCount, Msg_CorrelID, Msg_ExpireTime, Msg_LockID, Msg_MsgID, Msg_OriginQMgr, Msg_Priority, Msg_ReplyToQ, Msg_ReplyToQMgr, Msg_Resend, Msg_Style, Msg_Style_Datagram, Msg_Style_Reply, Msg_Style_Request, Msg_Time, Msg_WrapMsg, sccsid, System_Default_Queue_Name
 
Fields inherited from interface com.ibm.mqe.MQeExceptionCodes
Except_Active, Except_AdapterException, Except_AdapterMissingRemoteAddress, Except_Admin_ActionNotSupported, Except_Admin_InvalidField, Except_Admin_NotAdminMsg, Except_AdminAction, Except_Authenticate, Except_BadRequest, Except_BridgeListener, Except_Chnl_Attributes, Except_Chnl_ID, Except_Chnl_Limit, Except_Chnl_Overrun, Except_Closed, Except_Con_AdapterRequired, Except_Con_AliasAlreadyExists, Except_Con_AlreadyExists, Except_Con_InvalidName, Except_Connect_Failure, Except_ConnectonType, Except_Cryptor, Except_Data, Except_Duplicate, Except_JmxProperties, Except_Listener, Except_MessageStore, Except_MiniCertReg_ActivateFailed, Except_MiniCertReg_BadPIN, Except_MiniCertReg_NotOpen, Except_NotActive, Except_NotAllowed, Except_NotFound, Except_NotSupported, Except_PrivateReg_ActivateFailed, Except_PrivateReg_BadPIN, Except_PrivateReg_NotOpen, Except_PublicReg_ActivateFailed, Except_PublicReg_InvalidAddress, Except_PublicReg_InvalidRequest, Except_Q_Full, Except_Q_InvalidName, Except_Q_InvalidPriority, Except_Q_MsgTooLarge, Except_Q_NoMatchingMsg, Except_Q_TargetRegistryRequired, Except_QMgr_Activated, Except_QMgr_AlreadyExists, Except_QMgr_InvalidQMgrName, Except_QMgr_InvalidQName, Except_QMgr_NotActive, Except_QMgr_NotBridgeEnabled, Except_QMgr_NotConfigured, Except_QMgr_QDoesNotExist, Except_QMgr_QExists, Except_QMgr_QNotEmpty, Except_QMgr_RegistryDataVersion, Except_QMgr_UnknownQMgr, Except_QMgr_WrongQType, Except_Reg_AddFailed, Except_Reg_AlreadyExists, Except_Reg_AlreadyOpen, Except_Reg_CRTKeyDecFailed, Except_Reg_CRTKeySignFailed, Except_Reg_DeleteFailed, Except_Reg_DeleteRegistryFailed, Except_Reg_DoesNotExist, Except_Reg_InvalidSession, Except_Reg_ListFailed, Except_Reg_NotDefined, Except_Reg_NotSecure, Except_Reg_NullName, Except_Reg_OpenFailed, Except_Reg_ReadFailed, Except_Reg_RenameFailed, Except_Reg_ResetPINFailed, Except_Reg_SearchFailed, Except_Reg_UpdateFailed, Except_RemoteException, Except_Rule, Except_S_BadIntegrity, Except_S_BadSubject, Except_S_CertificateExpired, Except_S_Cipher, Except_S_InvalidAttribute, Except_S_InvalidSignature, Except_S_MiniCertNotAvailable, Except_S_MissingSection, Except_S_NoPresetKeyAvailable, Except_S_RegistryNotAvailable, Except_Stopped, Except_Syntax, Except_TimeOut, Except_Transporter, Except_TriggerTransmission, Except_Trnsport_QMgr, Except_Trnsport_Request, Except_Type, Except_UdpipAdapterStateException, Except_UdpipAdapterTimeOut, Except_UdpipAdapterUnableToConfirmSuccess, Except_UnCoded, Except_Uncontactable_DontTransmit
 
Constructor Summary
ExampleBase()
          Constructor that uses the default queue manager.
ExampleBase(java.lang.String queueManagerName)
          Constructor that runs the example against a remote queue manager.
ExampleBase(java.lang.String remoteQMgrName, java.lang.String localQMgrIniFile)
          Constructor that starts a queue manager with paramters from an ini file.
 
Method Summary
 void accessLocalQMgr()
          Start the local queue manager.
 void close()
          Closes the client.
abstract  void doIt()
          All work is performed in this method.
 void emptyQueue()
          Remove any message from the queue used by the example.
abstract  void setParms()
          Override any default variable settings here
 
Methods inherited from class com.ibm.mqe.MQe
abbreviate, alias, asciiToByte, byteToAscii, byteToHex, byteToHex, byteToInt, byteToLong, byteToShort, byteToUnicode, fileSeparator, getEventLogHandler, hexToAscii, hexToByte, intToByte, isCLDC, loadClass, loadObject, log, setEventLogHandler, setLoader, sliceByteArray, type, unicodeToByte, uniqueValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

version

public static short[] version

localQMgrName

protected java.lang.String localQMgrName

startupIni

protected java.lang.String startupIni

myQM

protected MQeQueueManager myQM

client

protected MQeClient client

qMgrName

protected java.lang.String qMgrName

example

protected java.lang.String example

queueName

protected java.lang.String queueName

msgField

protected java.lang.String msgField

msgData

protected java.lang.String msgData
Constructor Detail

ExampleBase

public ExampleBase()
            throws java.lang.Exception
Constructor that uses the default queue manager.

Throws:
java.lang.Exception

ExampleBase

public ExampleBase(java.lang.String queueManagerName)
            throws java.lang.Exception
Constructor that runs the example against a remote queue manager. The queue manager can also be the local queue manager.

Parameters:
queueManagerName - java.lang.String, remote queue manager name.
Throws:
java.lang.Exception

ExampleBase

public ExampleBase(java.lang.String remoteQMgrName,
                   java.lang.String localQMgrIniFile)
            throws java.lang.Exception
Constructor that starts a queue manager with paramters from an ini file. This queue manager is then used as the access point for interacting with the same or different queue managers.

Parameters:
remoteQMgrName - java.lang.String , queue manager name The name of the queue manager to interact with. The queue manager can be either a local or a remote queue manager.
localQMgrIniFile - java.lang.String, ini file which contains startup parameters for the local queue manager.
Throws:
java.lang.Exception
Method Detail

accessLocalQMgr

public void accessLocalQMgr()
                     throws java.lang.Exception
Start the local queue manager.

Returns:
void
Throws:
java.lang.Exception

close

public void close()
           throws java.lang.Exception
Closes the client.

Returns:
void
Throws:
java.lang.Exception

doIt

public abstract void doIt()
                   throws java.lang.Exception
All work is performed in this method.

java.lang.Exception

emptyQueue

public void emptyQueue()
                throws java.lang.Exception
Remove any message from the queue used by the example.

Returns:
void
Throws:
java.lang.Exception

setParms

public abstract void setParms()
Override any default variable settings here


Websphere MQ Everyplace