Websphere MQ Everyplace

examples.queuemanager
Class MQeClient

java.lang.Object
  |
  +--com.ibm.mqe.MQe
        |
        +--examples.queuemanager.MQeClient
All Implemented Interfaces:
MQeExceptionCodes

public class MQeClient
extends MQe

To provide a simple example MQe client.

Components configured on a client at startup are :

      ... Aliases
      ... Registry
      ... QueueManager
 

Note:Only one client per JVM can be started at a time.

This extends the MQe class.

------------------------------------------------------------------------------

 Example configuration data fields :


   [QueueManager]
      (ascii)Name=ClientQMgr

   [Registry]
      (ascii)LocalRegType=FileRegistry
      (ascii)DirName=.\ClientQMgr\Registry\
      (ascii)Adapter=com.ibm.mqe.adapters.MQeDiskFieldsAdapter
 


Field Summary
static MQeQueueManager queueManager
           
static MQeFields sections
           
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
MQeClient()
           
MQeClient(MQeFields thisConfig)
          Constructor with configuration parameter.
MQeClient(java.lang.String iniFileName)
          Starts an MQeClient.
MQeClient(java.lang.String iniFileName, boolean supressStdout)
          Start the client, but allow the caller to indicate whether output the .ini file contents to the stdout is required or not.
 
Method Summary
 void close()
          Stops an MQeClient.
 void init(MQeFields parms)
          First stage setup.
 void init(MQeFields parms, boolean supressStdout)
          First stage setup.
 
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

queueManager

public static MQeQueueManager queueManager

sections

public static MQeFields sections
Constructor Detail

MQeClient

public MQeClient()

MQeClient

public MQeClient(MQeFields thisConfig)
          throws java.lang.Exception
Constructor with configuration parameter.

Parameters:
thisConfig - Configuration options.
Throws:
java.lang.Exception

MQeClient

public MQeClient(java.lang.String iniFileName)
          throws java.lang.Exception
Starts an MQeClient.

Parameters:
iniFileName - A String containing the ini file name containing startup parms.
Throws:
java.lang.Exception

MQeClient

public MQeClient(java.lang.String iniFileName,
                 boolean supressStdout)
          throws java.lang.Exception

Start the client, but allow the caller to indicate whether output the .ini file contents to the stdout is required or not.

Parameters:
iniFileName - A String containing the ini file name containing startup parms.
supressStdout - A Boolean. if True, the ini file contents are not displayed on the Std Output. Displayed, if a value of False is passed in this parameter.
Throws:
java.lang.Exception
Method Detail

close

public void close()
           throws java.lang.Exception
Stops an MQeClient.

Returns:
void
Throws:
java.lang.Exception

init

public void init(MQeFields parms)
          throws java.lang.Exception
First stage setup.

Parameters:
parms - MQeFields object.
Returns:
void
Throws:
java.lang.Exception

init

public void init(MQeFields parms,
                 boolean supressStdout)
          throws java.lang.Exception
First stage setup.

Parameters:
parms - MQeFields object.
supressStdout - A Boolean. if True, the ini file contents are not displayed on the Std Output. Displayed, if a value of False is passed in this parameter.
Throws:
java.lang.Exception

Websphere MQ Everyplace