Websphere MQ Everyplace

com.ibm.mqe.mqbridge
Class MQeMQBridgeAdminMsg

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

public class MQeMQBridgeAdminMsg
extends MQePersistentBridgeResourceAdminMsg

Represents an administration message which manipulates a bridge resource.

This is a special type of WebSphere MQ Everyplace message that is used to encapsulate an administration command. The message is created by the application that is doing the administration.

The message itself can manipulate the following properties:
Properties of the bridge resource
Field name Actions using these fields
MQeCharacteristicLabels.MQE_FIELD_LABEL_RUN_STATE MQeAdminMsg.Action_Inquire
MQeCharacteristicLabels.MQE_FIELD_LABEL_CHILDREN MQeAdminMsg.Action_Inquire
MQeCharacteristicLabels.MQE_FIELD_LABEL_ADMINISTERED_OBJECT_CLASS MQeAdminMsg.Action_Inquire MQeAdminMsg.Action_Create MQeAdminMsg.Action_Update
MQeCharacteristicLabels.MQE_FIELD_LABEL_STARTUP_RULE_CLASS MQeAdminMsg.Action_Inquire MQeAdminMsg.Action_Create MQeAdminMsg.Action_Update
MQeCharacteristicLabels.MQE_FIELD_LABEL_BRIDGE_NAME MQeAdminMsg.Action_Inquire MQeAdminMsg.Action_Create MQeAdminMsg.Action_Update MQeAdminMsg.Action_Delete MQeAdminMsg.Action_Start MQeAdminMsg.Action_Stop
MQeCharacteristicLabels.MQE_FIELD_LABEL_HEARTBEAT_INTERVAL MQeAdminMsg.Action_Inquire MQeAdminMsg.Action_Create MQeAdminMsg.Action_Update
MQeCharacteristicLabels.MQE_FIELD_LABEL_DEFAULT_TRANSFORMER MQeAdminMsg.Action_Inquire MQeAdminMsg.Action_Create MQeAdminMsg.Action_Update
MQeCharacteristicLabels.MQE_FIELD_LABEL_DESCRIPTION MQeAdminMsg.Action_Inquire MQeAdminMsg.Action_Create MQeAdminMsg.Action_Update


Field Summary
static java.lang.String DEFAULT_MQBRIDGE_NAME
           
 
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
MQeMQBridgeAdminMsg()
          This simple constructor creates and initializes a default MQeBridgeAdminMsg.
MQeMQBridgeAdminMsg(java.lang.String bridgeName, boolean affectChildren)
          This constructor includes the name of the WebSphere MQ-bridge and a flag to determine whether children should be affected by the administration commands.
 
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 WebSphere MQ-bridge 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 WebSphere MQ-bridge connection name in a field in the MQeFields administration message object.
 void setName(java.lang.String bridgeName)
          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, 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
 

Field Detail

DEFAULT_MQBRIDGE_NAME

public static final java.lang.String DEFAULT_MQBRIDGE_NAME
See Also:
Constant Field Values
Constructor Detail

MQeMQBridgeAdminMsg

public MQeMQBridgeAdminMsg()
                    throws java.lang.Exception

This simple constructor creates and initializes a default MQeBridgeAdminMsg.

Throws:
java.lang.Exception
Example:
 try {
     MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg();
 } catch (Exception e) {
     System.err.println("Failure ! " + e.toString());
 }
 
 

MQeMQBridgeAdminMsg

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

This constructor includes the name of the WebSphere MQ-bridge and a flag to determine whether children should be affected by the administration commands.

Parameters:
affectChildren - A boolean flag indicating whether or not this administration message affects the children of the listener.
Throws:
java.lang.Exception - If any of the parameters contain invalid characters.
Example:
 MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg("MQBridgeV100", true);
 
 
Method Detail

setName

public void setName(java.lang.String bridgeName)
             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.

Used by the source of the administration message to add the WebSphere MQ-bridge name to the administration message.

Overrides setName() in class MQeAdminMsg.

Overrides:
setName in class MQeAdminMsg
Parameters:
bridgeName - Name of the resource
Returns:
void
Throws:
java.lang.Exception - If there are any invalid characters in the name parameters.
See Also:
MQeAdminMsg.Admin_Name
Example:
 MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg();
 
 msg.setName("MQBridgeV100");
 
 

putBridgeName

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

Puts the WebSphere MQ-bridge connection name in a field in the MQeFields administration message object.

Used by the source of the administration message to add the WebSphere MQ queue manager name to the administration message.

Returns:
void
Throws:
java.lang.Exception - If there are any invalid characters in the name parameters.
Example:
 MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg();
 
 msg.putBridgeName("MQBridgeV100");
 
 

getBridgeName

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

Gets the WebSphere MQ-bridge name from the administered object.

Can be issued against an MQeMQBridgeAdminMsg or one of its descendants.

Returns:
The name of the WebSphere MQ-bridge.
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:
 MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg("MQBridgeV100", true);
 String bridgeName = msg.getBridgeName();
 
 return bridgeName;
 
 

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 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 MQeMQBridgesAdminMsg.characteristics() in class MQeMQBridgesAdminMsg.

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

getName

public java.lang.String getName()

Gets the name of the administered object to be created.

Gets the name of the WebSphere MQ-bridge that is to be administered. When issued against an object of this class it is identical to getBridgeName().

Overrides MQeMQBridgesAdminMsg.getName() in class MQeMQBridgesAdminMsg.

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 bridgeName = null;
 
 try {
     MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg("MQBridgeV100", true);
 
     bridgeName = msg.getName();
 } catch (Exception e) {
     System.err.println("Failure ! " + e.toString());
 }
 return bridgeName;
 
 
 

Websphere MQ Everyplace