Websphere MQ Everyplace

com.ibm.mqe.mqbridge
Class MQeMQQMgrProxyAdminMsg

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.MQeMQQMgrProxyAdminMsg
All Implemented Interfaces:
MQeExceptionCodes

public class MQeMQQMgrProxyAdminMsg
extends MQePersistentBridgeResourceAdminMsg

This message is created by the application doing the administration and is used to encapsulate an administration command that acts on the MQeMQQMgrProxy object.
Properties of the MQQMgrProxy resource
Field name Actions using these fields Notes
MQeCharacteristicLabels.MQE_FIELD_LABEL_RUN_STATE MQeAdminMsg.Action_Inquire Only passed back from the inquire action in the results.
MQeCharacteristicLabels.MQE_FIELD_LABEL_CHILDREN MQeAdminMsg.Action_Inquire Only passed back from the inquire action in the results.
MQeCharacteristicLabels.MQE_FIELD_LABEL_ADMINISTERED_OBJECT_CLASS MQeAdminMsg.Action_Inquire MQeAdminMsg.Action_Create MQeAdminMsg.Action_Update Optional
MQeCharacteristicLabels.MQE_FIELD_LABEL_STARTUP_RULE_CLASS MQeAdminMsg.Action_Inquire MQeAdminMsg.Action_Create MQeAdminMsg.Action_Update Optional
MQeCharacteristicLabels.MQE_FIELD_LABEL_BRIDGE_NAME MQeAdminMsg.Action_Inquire MQeAdminMsg.Action_Create MQeAdminMsg.Action_Update MQeAdminMsg.Action_Delete MQeAdminMsg.Action_Start MQeAdminMsg.Action_Stop Required for all actions to identify which proxy object to act on.
MQeCharacteristicLabels.MQE_FIELD_LABEL_MQ_Q_MGR_PROXY_NAME MQeAdminMsg.Action_Inquire MQeAdminMsg.Action_Create MQeAdminMsg.Action_Update MQeAdminMsg.Action_Delete MQeAdminMsg.Action_Start MQeAdminMsg.Action_Stop Required for all actions to identify which proxy object to act on.
MQeCharacteristicLabels.MQE_FIELD_LABEL_HOST_NAME MQeAdminMsg.Action_Inquire MQeAdminMsg.Action_Create MQeAdminMsg.Action_Update Optional
MQeCharacteristicLabels.MQE_FIELD_LABEL_DESCRIPTION MQeAdminMsg.Action_Inquire MQeAdminMsg.Action_Create MQeAdminMsg.Action_Update Optional


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
MQeMQQMgrProxyAdminMsg()
          This simple constructor creates and initializes a default MQeMQQMgrProxyAdminMsg.
MQeMQQMgrProxyAdminMsg(java.lang.String bridgeName, java.lang.String nameOfMQQMgrProxy, boolean affectChildren)
           This constructor includes the WebSphere MQ Everyplace queue manager name, the name of the Websphere MQ-bridge, and the name of the proxy.
 
Method Summary
 MQeFields characteristics()
          Creates an WebSphere MQ Everyplace fields 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 getMQQMgrProxyName()
          Gets the Websphere MQ queue manager proxy 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 putMQQMgrProxyName(java.lang.String mqQMgrProxyName)
          Puts the Websphere MQ queue manager proxy name in a field in the MQeFields administration message object.
 void setName(java.lang.String bridgeName, java.lang.String mqQMgrProxyName)
          Puts the name information in a field in the MQeFields administration message object.
 
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

MQeMQQMgrProxyAdminMsg

public MQeMQQMgrProxyAdminMsg()
                       throws java.lang.Exception

This simple constructor creates and initializes a default MQeMQQMgrProxyAdminMsg.

Throws:
java.lang.Exception
Example:
 MQeMQQMgrProxyAdminMsg msg = new MQeMQQMgrProxyAdminMsg();
 
 

MQeMQQMgrProxyAdminMsg

public MQeMQQMgrProxyAdminMsg(java.lang.String bridgeName,
                              java.lang.String nameOfMQQMgrProxy,
                              boolean affectChildren)
                       throws java.lang.Exception

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

Parameters:
affectChildren - A boolean flag indicating whether or not this administration message affects the children of the MQeMQBridges object.

true means it is allowed to affect the children, false indicates that the children should not be affected.

Throws:
java.lang.Exception - If any fields could not be set or if the Websphere MQ queue manager name is invalid.
Example:
 MQeMQQMgrProxyAdminMsg msg;
 
 msg = new MQeMQQMgrProxyAdminMsg("MQBridgeV100", "lizzieQM", true);
 
 
Method Detail

setName

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

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

Returns:
void
Throws:
java.lang.Exception - If any fields could not be set or if the Websphere MQ queue manager name is invalid.
Example:
 MQeMQQMgrProxyAdminMsg msg = new MQeMQQMgrProxyAdminMsg();
 
 msg.setName("MQBridgeV100", "lizzieQM");
 
 

putMQQMgrProxyName

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

Puts the Websphere MQ queue manager proxy name in a field in the MQeFields administration message object.

Returns:
void
Throws:
java.lang.Exception - If any fields could not be set or if the Websphere MQ queue manager name is invalid.
Example:
 MQeMQQMgrProxyAdminMsg msg = new MQeMQQMgrProxyAdminMsg();
 
 msg.putMQQMgrProxyName("lizzieQM");
 
 

getMQQMgrProxyName

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

Gets the Websphere MQ queue manager proxy name from the administered object.

This method also checks the field for validity. It can be issued against an MQeMQQMgrProxyAdminMsg or one of its descendants.

Returns:
A String containing the MQQMgrProxyName.
Throws:
java.lang.Exception - If the get 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 admin 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 fails.
Example:
 MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg("MQBridgeV100", true);
 String bridgeName = msg.getBridgeName();
 
 return bridgeName;
 
 

characteristics

public MQeFields characteristics()
                          throws java.lang.Exception

Creates an WebSphere MQ Everyplace fields object containing all the fields required for an administration message of this type.

Returns a fields 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. Overrides characteristics() in class MQeMQBridgeAdminMsg.

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:
 MQeMQQMgrProxyAdminMsg msg;
 
 msg = new MQeMQQMgrProxyAdminMsg("MQBridgeV100", "lizzieQM", true);
 MQeFields proxyChars = msg.characteristics();
 
 return proxyChars;
 
 

getName

public java.lang.String getName()

Gets the name of the administered object to be created.

Returns the name of the current administration object. When issued against an object of this class it is identical to getMQQMgrProxyName().

Overrides getName() in class MQeMQBridgeAdminMsg.

Specified by:
getName in class MQeBridgeResourceAdminMsg
Returns:
null if the name was not set, a String otherwise.
Throws:
none
Example:
 MQeMQQMgrProxyAdminMsg msg;
 String proxyName = null;
 
 try {
     msg = new MQeMQQMgrProxyAdminMsg("MQBridgeV100", "lizzieQM", true);
     proxyName = msg.getName();
 } catch (Exception e) {
     System.err.println("Failure ! " + e.toString());
 }
 return proxyName;
 
 

Websphere MQ Everyplace