|
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.MQeClientConnectionAdminMsg
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.
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_DESCRIPTION
| Inquire, create, update. reply from inquire, optional unicode field. |
MQeCharacteristicLabels.MQE_FIELD_LABEL_PORT
| Inquire, create, update. reply from inquire, optional unicode field. |
MQeCharacteristicLabels.MQE_FIELD_LABEL_USER_ID
| Inquire, create, update. reply from inquire, optional unicode field. |
MQeCharacteristicLabels.MQE_FIELD_LABEL_PASSWORD
| Inquire, create, update. reply from inquire, optional unicode field. |
MQeCharacteristicLabels.MQE_FIELD_LABEL_MQ_BRIDGE_ADAPTER_CLASS
| Inquire, create, update. reply from inquire, optional unicode field. |
MQeCharacteristicLabels.MQE_FIELD_LABEL_SEND_EXIT
| Inquire, create, update. reply from inquire, optional unicode field. |
MQeCharacteristicLabels.MQE_FIELD_LABEL_RECEIVE_EXIT
| Inquire, create, update. reply from inquire, optional unicode field. |
MQeCharacteristicLabels.MQE_FIELD_LABEL_SECURITY_EXIT
| Inquire, create, update. reply from inquire, optional unicode field. |
MQeCharacteristicLabels.MQE_FIELD_LABEL_CCSID
| Inquire, create, update. reply from inquire, optional unicode field. |
MQeCharacteristicLabels.MQE_FIELD_LABEL_SYNC_Q_NAME
| Inquire, create, update. reply from inquire, optional unicode field. |
MQeCharacteristicLabels.MQE_FIELD_LABEL_SYNC_Q_PURGER_RULES_CLASS
| Inquire, create, update. reply from inquire, optional unicode field. |
MQeCharacteristicLabels.MQE_FIELD_LABEL_MAX_CONNECTION_IDLE_TIME
| Inquire, create, update. reply from inquire, optional unicode field. |
MQeCharacteristicLabels.MQE_FIELD_LABEL_SYNC_Q_PURGE_INTERVAL
| 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 |
Constructor Summary | |
MQeClientConnectionAdminMsg()
This simple constructor creates and initializes a default MQeClientConnectionAdminMsg. |
|
MQeClientConnectionAdminMsg(java.lang.String bridgeName,
java.lang.String nameOfMQQMgrProxy,
java.lang.String clientConnectionName,
boolean affectChildren)
This constructor includes fields that are needed to initialize the administration message. |
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 |
getName()
Gets the name of the object to be administered. |
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 a field in the MQeFields administration message object. |
void |
setName(java.lang.String bridgeName,
java.lang.String mqQMgrProxyName,
java.lang.String clientConnectionName)
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.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 |
public MQeClientConnectionAdminMsg() throws java.lang.Exception
This simple constructor creates and initializes a default MQeClientConnectionAdminMsg.
java.lang.Exception
public MQeClientConnectionAdminMsg(java.lang.String bridgeName, java.lang.String nameOfMQQMgrProxy, java.lang.String clientConnectionName, boolean affectChildren) throws java.lang.Exception
This constructor includes fields that are needed to initialize the administration message. It does not include the action that the administration message will hold.
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 proxy to which
the administration message is directed. If set to null ,or " ", it is not set.clientConnectionName
- A String containing the name of the client connection
to which the administration message is directed. If set to null ,or " ", it is
not set.affectChildren
- A boolean flag indicating whether or not this administration
message affects all the children. This is only applicable if the action is start or
delete.
java.lang.Exception
- Fails if any of the parameters contain invalid characters.MQeClientConnectionAdminMsg msg; msg = new MQeClientConnectionAdminMsg("ExampleQM.MQBridgeV100", "MQA", "MQ.to.ExampleQM", false );
Method Detail |
public void setName(java.lang.String bridgeName, java.lang.String mqQMgrProxyName, java.lang.String clientConnectionName) 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.
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.mqQMgrProxyName
- A String containing the name of the proxy to which the
administration message is directed. If set to null ,or " ",it is not set.clientConnectionName
- A String containing the name of the client connection to
which the administration message is directed. If set to null ,or " ", it is not set.
java.lang.Exception
- If there are any invalid characters in the name
parameters.MQeClientConnectionAdminMsg msg = new MQeClientConnectionAdminMsg(); msg.setName("ExampleQM.MQBridgeV100", "MQA", "MQ.to.ExampleQM");
public void putClientConnectionName(java.lang.String clientConnectionName) throws java.lang.Exception
Puts the client connection name in a field in the MQeFields administration message object.
This is used to add the Websphere MQ queue manager name to the administration message. It puts the client connection name in an WebSphere MQ Everyplace field in the WebSphere MQ Everyplace fields administration message object.
clientConnectionName
- A String containing the name of the client connection
to which the administration message is directed. This string is validated using the
validateName() method to make sure it contains only legal characters.
java.lang.Exception
- If there are any invalid characters in the name
parameters.MQeClientConnectionAdminMsg msg = new MQeClientConnectionAdminMsg(); msg.putClientConnectionName("MQ.to.ExampleQM");
public java.lang.String getClientConnectionName() throws java.lang.Exception
Gets the client connection name from the administered object.
This method can be issued against an MQeClientConnectionAdminMsg 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.MQeClientConnectionAdminMsg msg; msg = new MQeClientConnectionAdminMsg("ExampleQM.MQBridgeV100", "MQA", "MQ.to.ExampleQM", false); String cconName = msg.getClientConnectionName(); return cconName;
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.
bridgeName
- A String containing the bridgeName
java.lang.Exception
- If the set operation fails.MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg(); msg.putBridgeName("MQBridgeV100");
public java.lang.String getBridgeName() throws java.lang.Exception
Gets the bridge name from the administered object.
java.lang.Exception
- If the get operation fails.String bridgeName = null; try { MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg("MQBridgeV100", true); bridgeName = msg.getBridgeName(); } catch (Exception e) { System.err.println("Failure ! " + e.toString()); } 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.
characteristics
in class MQeBridgeResourceAdminMsg
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.
java.lang.Exception
- If the MQeFields
object cannot
be created.MQeClientConnectionAdminMsg msg; msg = new MQeClientConnectionAdminMsg("ExampleQM.MQBridgeV100", "MQA", "MQ.to.ExampleQM", false); MQeFields cconAdminCharacteristics = msg.characteristics(); return cconAdminCharacteristics;
public java.lang.String getName()
Gets the name of the object to be administered.
In this case it's the name of the client connection that has been set by the setName() or putClientConnectionName() methods. When issued against an object of this class it is identical to getClientConnectionName().
getName
in class MQeBridgeResourceAdminMsg
String cconName = null; try { MQeClientConnectionAdminMsg msg; msg = new MQeClientConnectionAdminMsg("ExampleQM.MQBridgeV100", "MQA", "MQ.to.ExampleQM", false); cconName = msg.getName(); } catch (Exception e) { System.err.println("Failure ! " + e.toString()); } return cconName;
|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |