Websphere MQ Everyplace

examples.administration.simple
Class ExampleAdminBase

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

public abstract class ExampleAdminBase
extends ExampleBase

To provide the base class/object for example administration applications.


Field Summary
static short[] version
           
 
Fields inherited from class examples.application.ExampleBase
client, example, localQMgrName, msgData, msgField, myQM, qMgrName, queueName, startupIni
 
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
ExampleAdminBase()
          Constructor that uses the default queue manager.
ExampleAdminBase(java.lang.String queueManagerName)
          Constructor that runs the example against a remote queue manager.
ExampleAdminBase(java.lang.String qMgrName, java.lang.String localQMgrIniFile)
          Constructor that starts a queue manager with paramters from an ini file.
 
Method Summary
 boolean checkReply(MQeAdminMsg replyMsg)
          Check to see if a good reply was required.
 MQeFields primeAdminMsg(MQeAdminMsg msg)
          Prime the admin message.
 void setParms()
          Override any default variable settings here.
 MQeAdminMsg waitForReply(MQeFields msgTest)
          Wait a while for the response message.
 
Methods inherited from class examples.application.ExampleBase
accessLocalQMgr, close, doIt, emptyQueue
 
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
Constructor Detail

ExampleAdminBase

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

Throws:
java.lang.Exception

ExampleAdminBase

public ExampleAdminBase(java.lang.String queueManagerName)
                 throws java.lang.Exception
Constructor that runs the example against a remote queue manager.

Throws:
java.lang.Exception

ExampleAdminBase

public ExampleAdminBase(java.lang.String qMgrName,
                        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:
qMgrName - java.lang.String, queue manager name The name of the queue manager to interact with. The queue manager can be a local or a remote queue manager.
Throws:
java.lang.Exception
Method Detail

checkReply

public boolean checkReply(MQeAdminMsg replyMsg)
                   throws java.lang.Exception
Check to see if a good reply was required. If not, detail the error(s) that occured.

Parameters:
replyMsg - reply message to check
Returns:
boolean true if good
Throws:
java.lang.Exception

primeAdminMsg

public MQeFields primeAdminMsg(MQeAdminMsg msg)
                        throws java.lang.Exception
Prime the admin message. Set the admin message with who to reply to along with a unique identifier.

Parameters:
msg - The admin message to prime
Returns:
MQeFields, a unique identifier for this request
Throws:
java.lang.Exception

setParms

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

Specified by:
setParms in class ExampleBase
Returns:
void

waitForReply

public MQeAdminMsg waitForReply(MQeFields msgTest)
                         throws java.lang.Exception
Wait a while for the response message.

Parameters:
msgTest - A filter for the reply message to wait for.
Returns:
MQeAdminMsg object
Throws:
java.lang.Exception

Websphere MQ Everyplace