com.ibm.mqe.mqbridge
Class MQeBridgeResourceAdminMsg
java.lang.Object
|
+--com.ibm.mqe.MQe
|
+--com.ibm.mqe.MQeFields
|
+--com.ibm.mqe.MQeMsgObject
|
+--com.ibm.mqe.MQeAdminMsg
|
+--com.ibm.mqe.mqbridge.MQeBridgeResourceAdminMsg
- All Implemented Interfaces:
- MQeExceptionCodes
- Direct Known Subclasses:
- MQeMQBridgesAdminMsg, MQePersistentBridgeResourceAdminMsg
- public abstract class MQeBridgeResourceAdminMsg
- extends MQeAdminMsg
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 |
Method Summary |
abstract MQeFields |
characteristics()
Creates an MQe fields object containing all the MQe fields required
for an admin message of this type. |
abstract java.lang.String |
getName()
Returns the name of the administered object we want to manipulate. |
void |
start()
Tells the administered object that this is a "start" type message. |
void |
start(boolean affectChildren)
Tells the administered object that this is a "start" type message. |
void |
start(MQeFields fields)
Tells the administered object that this is a "start" message. |
void |
stop()
Tells the administered object that this is a "stop" request. |
void |
stop(MQeFields fields)
Tells the administered object that this is a "stop" request. |
Methods inherited from class com.ibm.mqe.MQeAdminMsg |
create, 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.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 |
MQeBridgeResourceAdminMsg
public MQeBridgeResourceAdminMsg()
start
public void start(boolean affectChildren)
throws java.lang.Exception
- Tells the administered object that this is a "start" type message.
- Parameters:
affectChildren
- A boolean. Says whether the start command
set in this admin message is allowed to affect
the children of the bridges object. true means it is allowed
to affect the children, false otherwise.
- Throws:
java.lang.Exception
- Fails if we cannot set the "start" action or the
affectChildren flag into MQeFields in this admin message.
start
public void start()
throws java.lang.Exception
- Tells the administered object that this is a "start" type message. Will
also note that the start request should be propagated to the
object's children. Equivalent to start(true);
- Throws:
java.lang.Exception
- Fails if we cannot set the "start" action
into MQeFields in this admin message.
start
public void start(MQeFields fields)
throws java.lang.Exception
- Tells the administered object that this is a "start" message.
May also tell all the object's child objects to start or not, depending
on the value of the affect-children field which is passed inside the
given MQeFields object.
This method is inherited by subclasses.
- Throws:
java.lang.Exception
- Fails if we cannot set the "start" action into the
admin message, or if we cannot copy the passed fields into the admin
message.
stop
public void stop()
throws java.lang.Exception
Tells the administered object that this is a "stop" request.
This method is inherited by subclasses.
- Throws:
java.lang.Exception
- Fails if we can't set the action into this
admin message.
stop
public void stop(MQeFields fields)
throws java.lang.Exception
- Tells the administered object that this is a "stop" request.
This version accepts a set of fields, which can already contain the
fields which identify which MQeAdministeredObject we want to stop.
This method is inherited by subclasses.
- Parameters:
fields
- An MQeFields object. These fields are copied into
the admin message fields, over-riding any duplicate field values.
- Throws:
java.lang.Exception
- Fails if we can't set the action into this
admin message.
getName
public abstract java.lang.String getName()
- Returns the name of the administered object we want to manipulate.
When issued against an object of this class it returns a blank string
as the MQeMQBridges object does not have a name.
- Overrides:
getName
in class MQeAdminMsg
- Returns:
- String blank
- See Also:
MQeAdminMsg.Admin_Name
characteristics
public abstract MQeFields characteristics()
throws java.lang.Exception
- Creates an MQe fields object containing all the MQe fields required
for an admin message of this type.
- Overrides:
characteristics
in class MQeAdminMsg
- 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.
- Throws:
java.lang.Exception
- fails if we can't create the MQeFields object
or fill it in with decent information.
java.lang.Exception