|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
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:
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 |
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.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 |
public static final java.lang.String DEFAULT_MQBRIDGE_NAME
Constructor Detail |
public MQeMQBridgeAdminMsg() throws java.lang.Exception
This simple constructor creates and initializes a default MQeBridgeAdminMsg.
java.lang.Exception
try { MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg(); } catch (Exception e) { System.err.println("Failure ! " + e.toString()); }
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.
affectChildren
- A boolean flag indicating whether or not this
administration message affects the children of the listener.
java.lang.Exception
- If any of the parameters contain invalid
characters.MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg("MQBridgeV100", true);
Method Detail |
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
.
setName
in class MQeAdminMsg
bridgeName
- Name of the resource
java.lang.Exception
- If there are any invalid characters in the
name parameters.MQeAdminMsg.Admin_Name
MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg(); msg.setName("MQBridgeV100");
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.
java.lang.Exception
- If there are any invalid characters in the
name parameters.MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg(); msg.putBridgeName("MQBridgeV100");
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.
java.lang.Exception
- If the name has not been set in this
administration message, or if the name that has been set is invalid.MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg("MQBridgeV100", true); String bridgeName = msg.getBridgeName(); return bridgeName;
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
.
characteristics
in class MQeBridgeResourceAdminMsg
MQeFields
object containing the characteristics of
the resource.
java.lang.Exception
- If the MQeFields
object cannot
be created.MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg("MQBridgeV100", true); MQeFields bridgeCharacteristics = msg.characteristics(); return bridgeCharacteristics;
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
.
getName
in class MQeBridgeResourceAdminMsg
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 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |