|
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.MQeListenerAdminMsg
Used to administer transmission queue listener resources.
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_LISTENER_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_DEAD_LETTER_Q_NAME
| 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 | |
MQeListenerAdminMsg()
This simple constructor creates and initializes a default MQeListenerAdminMsg. |
|
MQeListenerAdminMsg(java.lang.String bridgeName,
java.lang.String nameOfMQQMgrProxy,
java.lang.String clientConnectionName,
java.lang.String listenerName,
boolean affectChildren)
This constructor includes the WebSphere MQ Everyplace queue manager name, the name of the Websphere MQ-bridge, the name of the proxy, the name of the client connection, and the name of the listener. |
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 |
getListenerName()
Gets the listener name from the administered object. |
java.lang.String |
getMQQMgrProxyName()
Returns the MQQMgrProxy 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 |
putClientConnectionName(java.lang.String clientConnectionName)
Puts the client connection name in an MQeField in the MQeFields administration message object. |
void |
putListenerName(java.lang.String listenerName)
Puts the listener name in a field in the MQeFields administration message object. |
void |
putMQQMgrProxyName(java.lang.String mqQMgrProxyName)
Puts the name of the MQQMgrProxy name to the administration message. |
void |
setName(java.lang.String bridgeName,
java.lang.String mqQMgrProxyName,
java.lang.String clientConnectionName,
java.lang.String listenerName)
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 MQeListenerAdminMsg() throws java.lang.Exception
This simple constructor creates and initializes a default MQeListenerAdminMsg.
java.lang.Exception
public MQeListenerAdminMsg(java.lang.String bridgeName, java.lang.String nameOfMQQMgrProxy, java.lang.String clientConnectionName, java.lang.String listenerName, boolean affectChildren) throws java.lang.Exception
This constructor includes the WebSphere MQ Everyplace queue manager name, the name of the Websphere MQ-bridge, the name of the proxy, the name of the client connection, and the name of the listener.
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 Websphere MQ queue
manager that owns the transmission queue that the listener is set up to
read from. If set to null , or " ", it is not set.clientConnectionName
- A String containing the name of the client connection
used to talk to the Websphere MQ queue manager. If set to null , or " ",
it is not set.listenerName
- A string containing the name of the listener. This matches
the name of the transmission queue on Websphere MQ to which the listener
"listens", for messages to be ready to move to the WebSphere MQ Everyplace network.affectChildren
- A boolean flag indicating whether or not this
administration message affects the children of the listener.
java.lang.Exception
- Fails if any of the parameters contain invalid characters.MQeListenerAdminMsg msg = new MQeListenerAdminMsg("MQBridgeV100", "lizzieQM", "svrconn", "MQE.XMITQ", true);
Method Detail |
public void setName(java.lang.String bridgeName, java.lang.String mqQMgrProxyName, java.lang.String clientConnectionName, java.lang.String listenerName) 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.
This method is used by the source of the administration message.
java.lang.Exception
- If there are any invalid characters in the name
parameters.MQeListenerAdminMsg msg = new MQeListenerAdminMsg(); msg.setName("MQBridgeV100", "lizzieQM", "svrconn", "MQE.XMITQ");
public void putListenerName(java.lang.String listenerName) throws java.lang.Exception
Puts the listener name in a field in the MQeFields administration message object.
Used to add the Websphere MQ queue manager name to the administration message. Puts the listener name in an field in the MQeFields administration message object.
This method is used by the source of the administration message.
java.lang.Exception
- If there are any invalid characters in the
name parameters.MQeListenerAdminMsg msg = new MQeListenerAdminMsg(); msg.putListenerName("MQE.XMITQ");
public java.lang.String getListenerName() throws java.lang.Exception
Gets the listener name from the administered object. Can be issued only against an MQeListenerAdminMsg object.
java.lang.Exception
- If the name has not been set in this administration
message, or if the name that has been set is invalid.MQeListenerAdminMsg msg = new MQeListenerAdminMsg("MQBridgeV100", "lizzieQM", "svrconn", "MQE.XMITQ", true); String listenerName = msg.getListenerName(); return listenerName;
public MQeFields characteristics() throws java.lang.Exception
Creates an MQeFields
object containing all the fields
required for an administration message of this type.
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.
characteristics
in class MQeBridgeResourceAdminMsg
MQeFields
object containing the characteristics of
the resource.
java.lang.Exception
- If the MQeFields object cannot be created.MQeListenerAdminMsg msg = new MQeListenerAdminMsg("MQBridgeV100", "lizzieQM", "svrconn", "MQE.XMITQ", true); MQeFields characteristics = msg.characteristics(); return characteristics;
public void putClientConnectionName(java.lang.String clientConnectionName) throws java.lang.Exception
Puts the client connection name in an MQeField in the MQeFields administration message object.
clientConnectionName
- A String containing name of the client connection
administered object to which this admin message will be directed. This string is
validated using the validateName() method to make sure it contains only
legal characters.
java.lang.Exception
- Fails if there are illegal characters in the
client connection name parameter.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.
Can be issued against an MQeClientConnectionAdminMsg or one of its descendants (ie. MQeListenerAdminMsg).
param none
java.lang.Exception
- Fails if the name has not been set in this admin
message yet, 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 putMQQMgrProxyName(java.lang.String mqQMgrProxyName) throws java.lang.Exception
Puts the name of the MQQMgrProxy name to the administration message.
A helper function to add the MQ QMgr name to the administration message.
Usage Example:
mqQMgrProxyName
- A String containing the name of the Websphere MQ queue
manager that owns the transmission queue the listener is set up to read from.
java.lang.Exception
- If any fields could not be set or if the MQ Queue Manager name
was invalid.MQeMQQMgrProxyAdminMsg msg = new MQeMQQMgrProxyAdminMsg(); msg.putMQQMgrProxyName("lizzieQM");
public java.lang.String getMQQMgrProxyName() throws java.lang.Exception
Returns the MQQMgrProxy name from the administered object.
This method also checks the field for validity.
Can be issued against an MQeMQQMgrProxyAdminMsg or one of its descendants (ie. MQeClientConnectionAdminMsg and MQeListenerAdminMsg).
java.lang.Exception
- If the get operation fails.MQeMQQMgrProxyAdminMsg msg; msg = new MQeMQQMgrProxyAdminMsg("MQBridgeV100", "lizzieQM", true); String proxyName = msg.getMQQMgrProxyName(); return proxyName;
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.MQeMQBridgeAdminMsg msg = new MQeMQBridgeAdminMsg("MQBridgeV100", true); String bridgeName = msg.getBridgeName(); return bridgeName;
public java.lang.String getName()
Gets the name of the administered object to be created.
When issued against an object of this class it is identical to getListenerName().
getName
in class MQeBridgeResourceAdminMsg
String listenerName = null; try { MQeListenerAdminMsg msg = new MQeListenerAdminMsg("MQBridgeV100", "lizzieQM", "svrconn", "MQE.XMITQ", true); listenerName = msg.getName(); } catch (Exception e) { System.err.println("Failure ! " + e.toString()); } return listenerName;
|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |