|
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.administration.MQeQueueAdminMsg | +--com.ibm.mqe.administration.MQeRemoteQueueAdminMsg | +--com.ibm.mqe.administration.MQeStoreAndForwardQueueAdminMsg
This class is used to manage Websphere MQ Everyplace store and forward queues.
The class extends MQeRemoteQueueAdminMsg
which
provides most of the administration capability for remote queues. This class adds
additional actions and features for managing store and forward queues.
Unlike a remote queue that handles messages for one queue on one remote queue manager, this type of queue handles messages for multiple queue managers. A store and forward queue can be configured to run in one of two modes:
The main addition to this subclass is the ability to add and remove
the names of queue managers for which the store-and-forward queue can hold
messages. To add and delete target queue managers, use the actions
Action_AddQueueManager
and Action_RemoveQueueManager
.
Multiple target queue manager names can be manipulated with one
administration message by:
addQueueManager(String)
and removeQueueManager(String)
Queue_QMgrNameList
If the store-and-forward queue is to push messages to the next queue manager, the queue manager name attribute of the store-and-forward queue must be the name of the next queue manager. A connection with the same name as the next queue manager must be configured. The store-and-forward queue uses this connection as the transport mechanism for pushing messages to the next hop.
If the store-and-forward queue is to hold messages awaiting collection (pulled), the queue manager name attribute of the store-and-forward queue should
This type of queue is normally but not necessarily defined on a server or gateway. Multiple store-and-forward queues can exist on a single queue manager, but a target queue manager can only be on one store and forward queue.
For information on basic administration concepts see MQeAdminMsg
and for basic information on managing queues see
MQeQueueAdminMsg
and
MQeRemoteQueueAdminMsg
.
Field Summary | |
static int |
Action_AddQueueManager
Action to use when adding a target queue manager. |
static int |
Action_RemoveQueueManager
Action to use when removing a target queue manager. |
static java.lang.String |
Queue_QMgrNameList
String used to identify the field in the message representing a set of target queue managers. |
Fields inherited from class com.ibm.mqe.administration.MQeRemoteQueueAdminMsg |
Queue_CloseIdle, Queue_DefaultTransporter, Queue_Transporter, Queue_TransporterXOR |
Fields inherited from class com.ibm.mqe.administration.MQeQueueAdminMsg |
Queue_Active, Queue_Asynchronous, Queue_AttrRule, Queue_Authenticator, Queue_Compressor, Queue_CreationDate, Queue_Cryptor, Queue_CurrentSize, Queue_Description, Queue_Expiry, Queue_FileDesc, Queue_MaxMsgSize, Queue_MaxQSize, Queue_Mode, Queue_NoLimit, Queue_Priority, Queue_QAliasNameList, Queue_QMgrName, Queue_RegistryNone, Queue_RegistryQMgr, Queue_RegistryQueue, Queue_Rule, Queue_Synchronous, Queue_TargetRegistry |
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 | |
MQeStoreAndForwardQueueAdminMsg()
Default constructor. |
|
MQeStoreAndForwardQueueAdminMsg(java.lang.String qMgrName,
java.lang.String qName)
This constructor takes the name of the queue that is to be managed and puts it into the admin msg. |
Method Summary | |
void |
addQueueManager(java.lang.String queueManager)
Setup the message to add a target queue manager. |
void |
removeQueueManager(java.lang.String queueManager)
Setup the message to remove a target queue manager. |
Methods inherited from class com.ibm.mqe.administration.MQeQueueAdminMsg |
addAlias, changeAlias, removeAlias, setName |
Methods inherited from class com.ibm.mqe.MQeAdminMsg |
characteristics, create, delete, duplicate, getAction, getErrorFields, getFieldInError, getInputFields, getMaxAttempts, getName, 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 |
Field Detail |
public static final int Action_AddQueueManager
The store and forward queue will store messages on behalf of the target queue manager(s).
MQeAdminMsg.Admin_Action
,
Constant Field Valuespublic static final int Action_RemoveQueueManager
public static final java.lang.String Queue_QMgrNameList
Multiple target queue manager names can be assigned to a queue. This field holds the set of target queue managers.
The field is of type ascii array
Constructor Detail |
public MQeStoreAndForwardQueueAdminMsg() throws java.lang.Exception
Default constructor.
public MQeStoreAndForwardQueueAdminMsg(java.lang.String qMgrName, java.lang.String qName) throws java.lang.Exception
This constructor uses the MQeQueueAdminMsg.setName(String,String)
method to
put the name into the administratoin message parameters field
qMgrName
- name of the destination queue manager.qName
- name of the Queue
java.lang.Exception
MQeQueueAdminMsg.setName(String, String)
Method Detail |
public void addQueueManager(java.lang.String queueManager) throws java.lang.Exception
A method that assists in setting up an administration message to add
one or more target queue managers to a queue. Multiple targets can be
added in one message by calling the method multiple times. The message is
set to perform action Action_AddQueueManager
.
The following basic fields are set:
The following fields are set in the Admin_Parms field.
The name of the queue to add an alias to is specified using
method MQeQueueAdminMsg.setName(String, String)
or using
the constructor that takes the resource name or by setting
the MQeAdminMsg.Admin_Name
and MQeQueueAdminMsg.Queue_QMgrName
fields
queueManager
- name of a target queue manager.
java.lang.Exception
Action_AddQueueManager
,
Queue_QMgrNameList
//Add target queue managers to a S&F queue MQeStoreAndForwardQueueAdminMsg msg = new MQeStoreAndForwardQueueAdminMsg(); msg.setName("ExampleQM", "ExampleQ"); //Set the action required and its parameters into the message msg.addQueueManager("Client129345"); msg.addQueueManager("Client129387");
public void removeQueueManager(java.lang.String queueManager) throws java.lang.Exception
A method that assists in setting up an administration message to remove
one or more target queue managers from a queue. Multiple targets can be
removed in one message by calling the method multiple times. The message is
set to perform action Action_RemoveQueueManager
.
The following basic fields are set:
The following fields are set in the Admin_Parms field.
The name of the queue to remove an alias to is specified using
method MQeQueueAdminMsg.setName(String, String)
or using
the constructor that takes the resource name or by setting
the MQeAdminMsg.Admin_Name
and MQeQueueAdminMsg.Queue_QMgrName
fields
queueManager
- name of a target queue manager.
java.lang.Exception
Action_RemoveQueueManager
,
Queue_QMgrNameList
// Remove target queue managers from S&F queue MQeStoreAndForwardQueueAdminMsg msg = new MQeStoreAndForwardQueueAdminMsg(); msg.setName("ExampleQM", "ExampleQ"); //Set the action required and its parameters into the message msg.removeQueueManager("Client129345"); msg.removeQueueManager("Client129387");
|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |