The base administration fields, that are common to all administration messages,
are:
- Admin_Target_QMgr
- This field provides the name of the queue manager on which the requested
action is to take place (target queue manager). The target queue manager can
be either a local or a remote queue manager. As only one queue manager can
be active at a time in a Java™ Virtual Machine, the target queue manager,
and the one to which the message is put, are the same.
- Admin_Action
- This field contains the administration action that is to be performed.
Each managed resource provides a set of administrative actions that it can
perform. A single administration message can only request that one action
be performed. The following common actions are defined:
Table 1. Administration
actionsAdministration action |
Purpose |
Action_Create |
Create a new instance of a managed resource. |
Action_Delete |
Delete an existing managed resource |
Action_Inquire |
Inquire on one or more characteristics of a managed
resource |
Action_InquireAll |
Inquire on all characteristics of a managed resource |
Action_Update |
Update one or more characteristics of a managed resource |
All resources do not necessarily implement these actions. For
instance, it is not possible to create a queue manager using an administration
message. Specific administration messages can extend the base set to provide
additional actions that are specific to a resource.
Each common action
provides a method that sets the
Admin_Action field:
Table 2. Setting the administration action fieldAdministration action |
Setting method |
Action_Create |
create (MQeFields parms) |
Action_Delete |
delete (MQeFields parms) |
Action_Inquire |
inquire (MQeFields parms) |
Action_InquireAll |
inquireAll (MQeFields parms) |
Action_Update |
update( MQeFields parms ) |
- Admin_MaxAttempts
-
This field determines how many times an action can be retried if the
initial action fails. The retry occurs either the next time that the queue
manager restarts or at the next interval set on the administration queue.
- Other fields
- For most failures further information is available in the reply message.
It is the responsibility of the requesting application to read and handle
failure information. See The basic administration reply message for more details
on using the reply data.
A set of methods is available for setting some
of the request fields:
Table 3. Setting administration request fieldsAdministration action |
Field type |
Set and get methods |
Admin_Parms |
MQeFields |
MQeFields getInputFields() |
Admin_Action |
int |
setAction (int action) |
Admin_TargetQMgr |
ASCII |
setTargetQMgr(String qmgr) |
Admin_MaxAttempts |
int |
setMaxAttempts(int attempts) |