Administration reply messages contain information about the success or
failure of the attempt to perform the administration request. There are three
levels of success:
- Total success - the action happened as requested. For enquire requests
the messages contains the data requested.
- Total failure - the action failed. The message contains a reason
why the action failed.
- Partial failure - some portion of a composite request failed. For
example an attempt to update five fields might be successful for three, but
unsuccessful for two. The fields that failed, and the reason for their failure
is contained in the message.
- Total success
- If the administration action is successful then the return message contains
a byte field called MQeAdminMsg.Admin_RC with a value of MQeAdminMsg.RC_Success.
- Total failure
- If the administration action is a complete failure then the return message
contains a byte field called MQeAdminMsg.Admin_RC with a value of MQeAdminMsg.RC_Fail.
It also contains a String field called MQeAdminMsg#Admin_Reason which
contains a description of the failure.
- Partial failure
- If the administration action is a partial failure then the return message
contains a byte field called MQeAdminMsg.Admin_RC with a
value of MQeAdminMsg.RC_Mixed. The String field called MQeAdminMsg.Admin_Reason which
only contains a general explanation 'errors occurred'. For more detail, access
the field called MQeAdminMsg.Admin_Errors. The MQeFields
object contains any errors related to subproblems that occur when a request
fails with a return code of RC_Fail or RC_Mixed. For each
attribute in error, there is a corresponding field in this MQeFields object.
If the field that was processed was an array then the corresponding error
field is of type ASCII array. If the field that was processed was not an array
then the corresponding error field is of type ASCII.
For example if an
update request was made to change 4 attributes of a resource and 2 of the
updates were successful and 2 failed, this field would contain information
detailing the reason for the 2 failures.
Each error is typically a toString() representation
of the exception that caused the failure. If the exception is of type com.ibm.mqe.MQeException the
string includes the MQeException code at the start of the
string as "Code=nnn".