Websphere MQ Everyplace

com.ibm.mqe.mqbridge
Class MQeListenerAdminMsg

java.lang.Object
  |
  +--com.ibm.mqe.MQe
        |
        +--com.ibm.mqe.MQeFields
              |
              +--com.ibm.mqe.MQeMsgObject
                    |
                    +--com.ibm.mqe.MQeAdminMsg
                          |
                          +--com.ibm.mqe.mqbridge.MQeBridgeResourceAdminMsg
                                |
                                +--com.ibm.mqe.mqbridge.MQePersistentBridgeResourceAdminMsg
                                      |
                                      +--com.ibm.mqe.mqbridge.MQeListenerAdminMsg
All Implemented Interfaces:
MQeExceptionCodes

public class MQeListenerAdminMsg
extends MQePersistentBridgeResourceAdminMsg

Used to administer transmission queue listener resources.
Properties of the client connection resource
Field name Actions using these fields
MQeCharacteristicLabels.MQE_FIELD_LABEL_RUN_STATE Reply from Inquire
MQeCharacteristicLabels.MQE_FIELD_LABEL_CHILDREN Reply from Inquire
MQeCharacteristicLabels.MQE_FIELD_LABEL_ADMINISTERED_OBJECT_CLASS Inquire, create, update. reply from inquire, optional unicode field.
MQeCharacteristicLabels.MQE_FIELD_LABEL_STARTUP_RULE_CLASS Inquire, create, update. reply from inquire, optional unicode field.
MQeCharacteristicLabels.MQE_FIELD_LABEL_BRIDGE_NAME Required for all actions to identify which proxy object to act on.
MQeCharacteristicLabels.MQE_FIELD_LABEL_MQ_Q_MGR_PROXY_NAME Required for all actions to identify which proxy object to act on.
MQeCharacteristicLabels.MQE_FIELD_LABEL_CLIENT_CONNECTION_NAME Required for all actions to identify which proxy object to act on.
MQeCharacteristicLabels.MQE_FIELD_LABEL_LISTENER_NAME Required for all actions to identify which proxy object to act on.
MQeCharacteristicLabels.MQE_FIELD_LABEL_DESCRIPTION Inquire, create, update. reply from inquire, optional unicode field.
MQeCharacteristicLabels.MQE_FIELD_LABEL_DEAD_LETTER_Q_NAME Inquire, create, update. reply from inquire, optional unicode field.


Field Summary
 
Fields inherited from class com.ibm.mqe.MQeAdminMsg
Action_AddAlias, Action_Create, Action_Delete, Action_Inquire, Action_InquireAll, Action_RemoveAlias, Action_Start, Action_Stop, Action_Unknown, Action_Update, Admin_Action, Admin_Class, Admin_Errors, Admin_MaxAttempts, Admin_Name, Admin_Parms, Admin_RC, Admin_Reason, Admin_TargetQMgr, RC_Fail, RC_Mixed, RC_Success
 
Fields inherited from class com.ibm.mqe.MQeFields
ArraySeparator, TypeArrayElements, TypeAscii, TypeBoolean, TypeByte, TypeDouble, TypeFields, TypeFloat, TypeInt, TypeLong, TypeShort, TypeUnicode, TypeUnTyped
 
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, version
 
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
MQeListenerAdminMsg()
          This simple constructor creates and initializes a default MQeListenerAdminMsg.
MQeListenerAdminMsg(java.lang.String bridgeName, java.lang.String nameOfMQQMgrProxy, java.lang.String clientConnectionName, java.lang.String listenerName, boolean affectChildren)
          This constructor includes the WebSphere MQ Everyplace queue manager name, the name of the Websphere MQ-bridge, the name of the proxy, the name of the client connection, and the name of the listener.
 
Method Summary
 MQeFields characteristics()
          Creates an MQeFields object containing all the fields required for an administration message of this type.
 java.lang.String getBridgeName()
          Gets the bridge name from the administered object.
 java.lang.String getClientConnectionName()
          Gets the client connection name from the administered object.
 java.lang.String getListenerName()
          Gets the listener name from the administered object.
 java.lang.String getMQQMgrProxyName()
          Returns the MQQMgrProxy name from the administered object.
 java.lang.String getName()
          Gets the name of the administered object to be created.
 void putBridgeName(java.lang.String bridgeName)
          Puts the bridgeName field in an MQeField in the MQeFields administration message object.
 void putClientConnectionName(java.lang.String clientConnectionName)
          Puts the client connection name in an MQeField in the MQeFields administration message object.
 void putListenerName(java.lang.String listenerName)
          Puts the listener name in a field in the MQeFields administration message object.
 void putMQQMgrProxyName(java.lang.String mqQMgrProxyName)
          Puts the name of the MQQMgrProxy name to the administration message.
 void setName(java.lang.String bridgeName, java.lang.String mqQMgrProxyName, java.lang.String clientConnectionName, java.lang.String listenerName)
          Puts the name information in a field in the MQeFields administration message object and also sets the name of the WebSphere MQ Everyplace queue manager that is associated with this Websphere MQ-bridge.
 
Methods inherited from class com.ibm.mqe.mqbridge.MQePersistentBridgeResourceAdminMsg
create, delete
 
Methods inherited from class com.ibm.mqe.mqbridge.MQeBridgeResourceAdminMsg
start, start, start, stop, stop
 
Methods inherited from class com.ibm.mqe.MQeAdminMsg
delete, duplicate, getAction, getErrorFields, getFieldInError, getInputFields, getMaxAttempts, getOutputFields, getRC, getReason, getTargetQMgr, inquire, inquireAll, setAction, setMaxAttempts, setName, setTargetQMgr, update
 
Methods inherited from class com.ibm.mqe.MQeMsgObject
getMsgUIDFields, getOriginQMgr, getTimeStamp, putOriginQMgr, resetMsgUIDFields, unwrapMsgObject
 
Methods inherited from class com.ibm.mqe.MQeFields
contains, copy, copy, dataType, deepCopy, delete, dump, dumpedType, dumpToString, equals, fields, getArrayLength, getArrayOfByte, getArrayOfDoubleAsLong, getArrayOfFloatAsInt, getArrayOfInt, getArrayOfLong, getArrayOfShort, getAscii, getAsciiArray, getAttribute, getBoolean, getByte, getDoubleAsLong, getFields, getFieldsArray, getFloatAsInt, getInt, getIntArray, getLong, getLongArray, getObject, getShort, getShortArray, getUnicode, getUnicodeArray, includes, isEqualTo, putArrayLength, putArrayOfByte, putArrayOfDoubleAsLong, putArrayOfFloatAsInt, putArrayOfInt, putArrayOfLong, putArrayOfShort, putAscii, putAsciiArray, putBoolean, putByte, putByteArray, putDoubleAsLong, putFields, putFieldsArray, putFloatAsInt, putInt, putIntArray, putLong, putLongArray, putObject, putShort, putShortArray, putUnicode, putUnicodeArray, rename, restore, restoreFromString, restoreFromString, restoreFromString, setAttribute, updateValue
 
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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MQeListenerAdminMsg

public MQeListenerAdminMsg()
                    throws java.lang.Exception

This simple constructor creates and initializes a default MQeListenerAdminMsg.

Throws:
java.lang.Exception

MQeListenerAdminMsg

public MQeListenerAdminMsg(java.lang.String bridgeName,
                           java.lang.String nameOfMQQMgrProxy,
                           java.lang.String clientConnectionName,
                           java.lang.String listenerName,
                           boolean affectChildren)
                    throws java.lang.Exception

This constructor includes the WebSphere MQ Everyplace queue manager name, the name of the Websphere MQ-bridge, the name of the proxy, the name of the client connection, and the name of the listener.

Parameters:
bridgeName - A String containing the name of the Websphere MQ-bridge to which the administration message is directed. If set to null , or " ", it is not set.
nameOfMQQMgrProxy - A String containing the name of the Websphere MQ queue manager that owns the transmission queue that the listener is set up to read from. If set to null , or " ", it is not set.
clientConnectionName - A String containing the name of the client connection used to talk to the Websphere MQ queue manager. If set to null , or " ", it is not set.
listenerName - A string containing the name of the listener. This matches the name of the transmission queue on Websphere MQ to which the listener "listens", for messages to be ready to move to the WebSphere MQ Everyplace network.
affectChildren - A boolean flag indicating whether or not this administration message affects the children of the listener.
Throws:
java.lang.Exception - Fails if any of the parameters contain invalid characters.
Example:
 MQeListenerAdminMsg msg = new MQeListenerAdminMsg("MQBridgeV100",
         "lizzieQM",
         "svrconn",
         "MQE.XMITQ",
         true);
 
 
Method Detail

setName

public void setName(java.lang.String bridgeName,
                    java.lang.String mqQMgrProxyName,
                    java.lang.String clientConnectionName,
                    java.lang.String listenerName)
             throws java.lang.Exception

Puts the name information in a field in the MQeFields administration message object and also sets the name of the WebSphere MQ Everyplace queue manager that is associated with this Websphere MQ-bridge.

This method is used by the source of the administration message.

Returns:
void
Throws:
java.lang.Exception - If there are any invalid characters in the name parameters.
Example:
 MQeListenerAdminMsg msg = new MQeListenerAdminMsg();
 
 msg.setName("MQBridgeV100", "lizzieQM", "svrconn", "MQE.XMITQ");
 
 

putListenerName

public void putListenerName(java.lang.String listenerName)
                     throws java.lang.Exception

Puts the listener name in a field in the MQeFields administration message object.

Used to add the Websphere MQ queue manager name to the administration message. Puts the listener name in an field in the MQeFields administration message object.

This method is used by the source of the administration message.

Returns:
void
Throws:
java.lang.Exception - If there are any invalid characters in the name parameters.
Example:
 MQeListenerAdminMsg msg = new MQeListenerAdminMsg();
 
 msg.putListenerName("MQE.XMITQ");
 
 

getListenerName

public java.lang.String getListenerName()
                                 throws java.lang.Exception

Gets the listener name from the administered object. Can be issued only against an MQeListenerAdminMsg object.

Returns:
The name of the listener.
Throws:
java.lang.Exception - If the name has not been set in this administration message, or if the name that has been set is invalid.
Example:
 MQeListenerAdminMsg msg = new MQeListenerAdminMsg("MQBridgeV100",
         "lizzieQM",
         "svrconn",
         "MQE.XMITQ",
         true);
 String listenerName = msg.getListenerName();
 
 return listenerName;
 
 

characteristics

public MQeFields characteristics()
                          throws java.lang.Exception

Creates an MQeFields object containing all the fields required for an administration message of this type.

Returns an MQeFields object containing the characteristics of the resource. The complete set of field names and types for the resource can be determined from the resulting fields object.

Specified by:
characteristics in class MQeBridgeResourceAdminMsg
Returns:
An MQeFields object containing the characteristics of the resource.
Throws:
java.lang.Exception - If the MQeFields object cannot be created.
Example:
 MQeListenerAdminMsg msg = new MQeListenerAdminMsg("MQBridgeV100",
         "lizzieQM",
         "svrconn",
         "MQE.XMITQ",
         true);
 MQeFields characteristics = msg.characteristics();
 
 return characteristics;
 
 

putClientConnectionName

public void putClientConnectionName(java.lang.String clientConnectionName)
                             throws java.lang.Exception

Puts the client connection name in an MQeField in the MQeFields administration message object.

Parameters:
clientConnectionName - A String containing name of the client connection administered object to which this admin message will be directed. This string is validated using the validateName() method to make sure it contains only legal characters.
Returns:
void
Throws:
java.lang.Exception - Fails if there are illegal characters in the client connection name parameter.
Example:
 MQeClientConnectionAdminMsg msg = new MQeClientConnectionAdminMsg();
 
 msg.putClientConnectionName("MQ.to.ExampleQM");
 
 

getClientConnectionName

public java.lang.String getClientConnectionName()
                                         throws java.lang.Exception

Gets the client connection name from the administered object.

Can be issued against an MQeClientConnectionAdminMsg or one of its descendants (ie. MQeListenerAdminMsg).

param none

Returns:
The name of the client connection to which this admin message is going to be sent to. Set using the putClientConnectionName or setName methods.
Throws:
java.lang.Exception - Fails if the name has not been set in this admin message yet, or if the name that has been set is invalid.
Example:
 MQeClientConnectionAdminMsg msg;
 
 msg = new MQeClientConnectionAdminMsg("ExampleQM.MQBridgeV100", "MQA", "MQ.to.ExampleQM", false
         );
 String cconName = msg.getClientConnectionName();
 
 return cconName;
 
 

putMQQMgrProxyName

public void putMQQMgrProxyName(java.lang.String mqQMgrProxyName)
                        throws java.lang.Exception

Puts the name of the MQQMgrProxy name to the administration message.

A helper function to add the MQ QMgr name to the administration message.

Usage Example:

Parameters:
mqQMgrProxyName - A String containing the name of the Websphere MQ queue manager that owns the transmission queue the listener is set up to read from.
Returns:
void
Throws:
java.lang.Exception - If any fields could not be set or if the MQ Queue Manager name was invalid.
Example:
 MQeMQQMgrProxyAdminMsg msg = new MQeMQQMgrProxyAdminMsg();
 
 msg.putMQQMgrProxyName("lizzieQM");
 
 

getMQQMgrProxyName

public java.lang.String getMQQMgrProxyName()
                                    throws java.lang.Exception

Returns the MQQMgrProxy name from the administered object.

This method also checks the field for validity.

Can be issued against an MQeMQQMgrProxyAdminMsg or one of its descendants (ie. MQeClientConnectionAdminMsg and MQeListenerAdminMsg).

Returns:
String containing the name of the MQQMgrProxy.
Throws:
java.lang.Exception - If the get operation fails.
Example:
 MQeMQQMgrProxyAdminMsg msg;
 
 msg = new MQeMQQMgrProxyAdminMsg("MQBridgeV100", "lizzieQM", true);
 String proxyName = msg.getMQQMgrProxyName();
 
 return proxyName;
 
 

putBridgeName

public void putBridgeName(java.lang.String bridgeName)
                   throws java.lang.Exception

Puts the bridgeName field in an MQeField in the MQeFields administration message object.

A helper function to add the bridge name to the administration message.

Parameters:
bridgeName - A String containing the bridgeName.
Returns:
void
Throws:
java.lang.Exception - If the set operation fails.
Example:
 MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg();
 
 msg.putBridgeName("MQBridgeV100");
 
 

getBridgeName

public java.lang.String getBridgeName()
                               throws java.lang.Exception

Gets the bridge name from the administered object.

Returns:
String containing the bridgeName.
Throws:
java.lang.Exception - if the get operation fails.
Example:
 MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg("MQBridgeV100", true);
 String bridgeName = msg.getBridgeName();
 
 return bridgeName;
 
 

getName

public java.lang.String getName()

Gets the name of the administered object to be created.

When issued against an object of this class it is identical to getListenerName().

Specified by:
getName in class MQeBridgeResourceAdminMsg
Returns:
A String containing the name of the administered object to be created, or null if the name is not set.
Example:
 String listenerName = null;
 
 try {
     MQeListenerAdminMsg msg = new MQeListenerAdminMsg("MQBridgeV100",
             "lizzieQM",
             "svrconn",
             "MQE.XMITQ",
             true);
 
     listenerName = msg.getName();
 } catch (Exception e) {
     System.err.println("Failure ! " + e.toString());
 }
 return listenerName;
 
 

Websphere MQ Everyplace