Websphere MQ Everyplace

com.ibm.mqe.administration
Class MQeQueueManagerAdminMsg

java.lang.Object
  |
  +--com.ibm.mqe.MQe
        |
        +--com.ibm.mqe.MQeFields
              |
              +--com.ibm.mqe.MQeMsgObject
                    |
                    +--com.ibm.mqe.MQeAdminMsg
                          |
                          +--com.ibm.mqe.administration.MQeQueueManagerAdminMsg
All Implemented Interfaces:
MQeExceptionCodes

public class MQeQueueManagerAdminMsg
extends MQeAdminMsg

This class is used to manage WebSphere MQ Everyplace queue managers.

The class extends MQeAdminMsg and provides the implementation for managing queue managers.

The queue manager is the central component of Webpshere MQ Everyplace, it provides the main programming interface for application programs as well as owning queues, communication and MQ bridge sub systems.

The following actions are applicable on queue manager:

Note: Create and Delete actions are not supported on queue managers as a queue manager has to be in place and have an administration queue configured before administration can take place. For examples of how to create and delete queue managers see package examples.install.

For information on basic administration concepts see MQeAdminMsg and for basic information on managing queues see MQeQueueAdminMsg.

Properties of the QueueManager resource (in addition to those inherited - see MQeAdminMsg)
Field name Actions using these fields
QMgr_Description MQeAdminMsg.Action_Inquire, MQeAdminMsg.Action_Create, MQeAdminMsg.Action_Update.
QMgr_Rules MQeAdminMsg.Action_Inquire, MQeAdminMsg.Action_Create, MQeAdminMsg.Action_Update.
QMgr_ChnlTimeout MQeAdminMsg.Action_Inquire, MQeAdminMsg.Action_Create, MQeAdminMsg.Action_Update.
QMgr_ChnlAttrRules MQeAdminMsg.Action_Inquire, MQeAdminMsg.Action_Create, MQeAdminMsg.Action_Update.
QMgr_QueueStore MQeAdminMsg.Action_Inquire, MQeAdminMsg.Action_Create, MQeAdminMsg.Action_Update.
QMgr_MaximumTransmissionThreads MQeAdminMsg.Action_Inquire, MQeAdminMsg.Action_Create, MQeAdminMsg.Action_Update.
QMgr_BridgeCapable MQeAdminMsg.Action_Inquire.
QMgr_Aliases MQeAdminMsg.Action_Inquire, MQeAdminMsg.Action_Create, MQeAdminMsg.Action_Update.
QMgr_Queues MQeAdminMsg.Action_Inquire.
QMgr_QueueName MQeAdminMsg.Action_Inquire.
QMgr_QueueQMgrName MQeAdminMsg.Action_Inquire.
QMgr_QueueType MQeAdminMsg.Action_Inquire.
QMgr_Connections MQeAdminMsg.Action_Inquire.
QMgr_CommsListeners MQeAdminMsg.Action_Inquire.
QMgr_Version MQeAdminMsg.Action_Inquire.


Field Summary
static java.lang.String QMgr_Aliases
          String used to identify the field in the message representing a set of aliases for the queue manager.
static java.lang.String QMgr_BridgeCapable
          String used to identify the field in the message that determines if the queue manager is bridge capable.
static java.lang.String QMgr_ChnlAttrRules
          String used to identify the field in the message representing the channel attribute rule.
static java.lang.String QMgr_ChnlTimeout
          String used to identify the field in the message representing the channel timeout for channels initiated by the queue manager.
static java.lang.String QMgr_CommsListeners
          String used to identify the field in the message that represents the set of communication listeners known by the queue manager.
static java.lang.String QMgr_Connections
          String used to identify the field in the message that represents the set of connections known by the queue manager.
static java.lang.String QMgr_Description
          String used to identify the field in the message representing the description of the queue manager.
static java.lang.String QMgr_MaximumTransmissionThreads
          String used to identify the field in the message representing the maximum number of threads spawned by the transmission threadpool.
static java.lang.String QMgr_QueueName
          Field name that represents the queue name in the list of queues field QMgr_Queues.
static java.lang.String QMgr_QueueQMgrName
          Field name that represents the queue manager name in the list of queues field QMgr_Queues.
static java.lang.String QMgr_Queues
          String used to identify the field in the message that represents the set of queues known by the queue manager.
static java.lang.String QMgr_QueueStore
          String used to identify the field in the message representing the default message store.
static java.lang.String QMgr_QueueType
          Field name that represents the queue type in the list of queues field QMgr_Queues.
static java.lang.String QMgr_Rules
          String used to identify the field in the message representing the queue manager rule.
static java.lang.String QMgr_Version
          String used to identify the field in the message representing the version of the queue manager.
 
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
 
Fields inherited from class com.ibm.mqe.MQe
Admin_Queue_Name, Admin_Reply_Queue_Name, copyright, DeadLetter_Queue_Name, Event_Activate, Event_Attribute, Event_Authenticate, Event_Close, Event_Logoff, Event_Logon, Event_MiniCert_Validate, Event_Queue, Event_QueueManager, Event_UserBase, JMS_Version, MQ_Headers, MQe_Log_Audit_Failure, MQe_Log_Audit_Success, MQe_Log_Error, MQe_Log_Information, MQe_Log_Success, MQe_Log_Warning, Msg_BackoutCount, Msg_CorrelID, Msg_ExpireTime, Msg_LockID, Msg_MsgID, Msg_OriginQMgr, Msg_Priority, Msg_ReplyToQ, Msg_ReplyToQMgr, Msg_Resend, Msg_Style, Msg_Style_Datagram, Msg_Style_Reply, Msg_Style_Request, Msg_Time, Msg_WrapMsg, sccsid, System_Default_Queue_Name, version
 
Fields inherited from interface com.ibm.mqe.MQeExceptionCodes
Except_Active, Except_AdapterException, Except_AdapterMissingRemoteAddress, Except_Admin_ActionNotSupported, Except_Admin_InvalidField, Except_Admin_NotAdminMsg, Except_AdminAction, Except_Authenticate, Except_BadRequest, Except_BridgeListener, Except_Chnl_Attributes, Except_Chnl_ID, Except_Chnl_Limit, Except_Chnl_Overrun, Except_Closed, Except_Con_AdapterRequired, Except_Con_AliasAlreadyExists, Except_Con_AlreadyExists, Except_Con_InvalidName, Except_Connect_Failure, Except_ConnectonType, Except_Cryptor, Except_Data, Except_Duplicate, Except_JmxProperties, Except_Listener, Except_MessageStore, Except_MiniCertReg_ActivateFailed, Except_MiniCertReg_BadPIN, Except_MiniCertReg_NotOpen, Except_NotActive, Except_NotAllowed, Except_NotFound, Except_NotSupported, Except_PrivateReg_ActivateFailed, Except_PrivateReg_BadPIN, Except_PrivateReg_NotOpen, Except_PublicReg_ActivateFailed, Except_PublicReg_InvalidAddress, Except_PublicReg_InvalidRequest, Except_Q_Full, Except_Q_InvalidName, Except_Q_InvalidPriority, Except_Q_MsgTooLarge, Except_Q_NoMatchingMsg, Except_Q_TargetRegistryRequired, Except_QMgr_Activated, Except_QMgr_AlreadyExists, Except_QMgr_InvalidQMgrName, Except_QMgr_InvalidQName, Except_QMgr_NotActive, Except_QMgr_NotBridgeEnabled, Except_QMgr_NotConfigured, Except_QMgr_QDoesNotExist, Except_QMgr_QExists, Except_QMgr_QNotEmpty, Except_QMgr_RegistryDataVersion, Except_QMgr_UnknownQMgr, Except_QMgr_WrongQType, Except_Reg_AddFailed, Except_Reg_AlreadyExists, Except_Reg_AlreadyOpen, Except_Reg_CRTKeyDecFailed, Except_Reg_CRTKeySignFailed, Except_Reg_DeleteFailed, Except_Reg_DeleteRegistryFailed, Except_Reg_DoesNotExist, Except_Reg_InvalidSession, Except_Reg_ListFailed, Except_Reg_NotDefined, Except_Reg_NotSecure, Except_Reg_NullName, Except_Reg_OpenFailed, Except_Reg_ReadFailed, Except_Reg_RenameFailed, Except_Reg_ResetPINFailed, Except_Reg_SearchFailed, Except_Reg_UpdateFailed, Except_RemoteException, Except_Rule, Except_S_BadIntegrity, Except_S_BadSubject, Except_S_CertificateExpired, Except_S_Cipher, Except_S_InvalidAttribute, Except_S_InvalidSignature, Except_S_MiniCertNotAvailable, Except_S_MissingSection, Except_S_NoPresetKeyAvailable, Except_S_RegistryNotAvailable, Except_Stopped, Except_Syntax, Except_TimeOut, Except_Transporter, Except_TriggerTransmission, Except_Trnsport_QMgr, Except_Trnsport_Request, Except_Type, Except_UdpipAdapterStateException, Except_UdpipAdapterTimeOut, Except_UdpipAdapterUnableToConfirmSuccess, Except_UnCoded, Except_Uncontactable_DontTransmit
 
Constructor Summary
MQeQueueManagerAdminMsg()
          Default constructor.
MQeQueueManagerAdminMsg(java.lang.String qMgrName)
          This constructor takes the name of the queue manager to administer and puts it into the admin msg.
 
Method Summary
 void addAlias(java.lang.String alias)
          Setup the admin message to add an alias to the connection.
 void changeAlias(java.lang.String alias)
          Adds an alias name to the aliases array.
 void removeAlias(java.lang.String alias)
          Setup the admin message to remove an alias from the connection.
 
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.MQeFields
contains, copy, copy, dataType, deepCopy, delete, dump, dumpedType, dumpToString, equals, fields, getArrayLength, getArrayOfByte, getArrayOfDoubleAsLong, getArrayOfFloatAsInt, getArrayOfInt, getArrayOfLong, getArrayOfShort, getAscii, getAsciiArray, getAttribute, getBoolean, getByte, getDoubleAsLong, getFields, getFieldsArray, getFloatAsInt, getInt, getIntArray, getLong, getLongArray, getObject, getShort, getShortArray, getUnicode, getUnicodeArray, includes, isEqualTo, putArrayLength, putArrayOfByte, putArrayOfDoubleAsLong, putArrayOfFloatAsInt, putArrayOfInt, putArrayOfLong, putArrayOfShort, putAscii, putAsciiArray, putBoolean, putByte, putByteArray, putDoubleAsLong, putFields, putFieldsArray, putFloatAsInt, putInt, putIntArray, putLong, putLongArray, putObject, putShort, putShortArray, putUnicode, putUnicodeArray, rename, restore, restoreFromString, restoreFromString, restoreFromString, setAttribute, updateValue
 
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

QMgr_Description

public static final java.lang.String QMgr_Description
String used to identify the field in the message representing the description of the queue manager.

The field is of type unicode

See Also:
Constant Field Values

QMgr_Rules

public static final java.lang.String QMgr_Rules
String used to identify the field in the message representing the queue manager rule.

This field holds the class name or alias of a queue manager rule. The behaviour of the queue manager can be customised by a set rules. These rules take the form of a user replaceable Java class. The base set of queue manager rules are defined in class, MQeQueueManagerRule. During the operation of the queue manager, the rules are called when certain events occur, for example, when a message is put.

The field is of type ascii.

See Also:
MQeQueueManagerRule, Constant Field Values

QMgr_ChnlTimeout

public static final java.lang.String QMgr_ChnlTimeout
String used to identify the field in the message representing the channel timeout for channels initiated by the queue manager.

The field contains the time in milliseconds that channels initiated by the queue manager remain idle before being timed out. Field MQeCommunicationsListenerAdminMsg.LISTENER_CHANNEL_TIMEOUT controls the idle timeout for incomming channels that were initiated on a remote queue manager.

The field is of type long.

See Also:
Constant Field Values

QMgr_ChnlAttrRules

public static final java.lang.String QMgr_ChnlAttrRules
String used to identify the field in the message representing the channel attribute rule.

This field holds the class name or alias of an attribute rule. The rule is used when setting up channels to ensure that the security characteristics of the channel are good enough. For example see class MQeAttributeRule.

The field is of type ascii.

See Also:
Constant Field Values

QMgr_QueueStore

public static final java.lang.String QMgr_QueueStore
String used to identify the field in the message representing the default message store.

This field contains the default storage type and location that queues will use to store their messages. The message store is a file descriptor that takes the form:

A number of storage adapters are provided and include:

For example, if alias MsgLog is set to com.ibm.mqe.adapters.MQeDiskFieldsAdapater then to store messages in directory d:\ServerQM123\Queues, the file descriptor would be: MsgLog:d:\ServerQM123\Queues

The parameters for the adapter are platform dependant. When setting the file descriptor:

The field is of type ascii.

See Also:
Constant Field Values

QMgr_MaximumTransmissionThreads

public static final java.lang.String QMgr_MaximumTransmissionThreads

String used to identify the field in the message representing the maximum number of threads spawned by the transmission threadpool.

Set the maximum number of threads that will be spawned to service the transmission needs of the queue manager. Each thread will be used to service transmission to one destination at any one time. If the value is zero, then the queue manager background thread will be used for all transmsissions. If the value is less than zero, or is greater than the number of destination queue managers at the time of transmission, then the number of threads created will be equal to the number of destination queue managers.

The field is of type int.

See Also:
Constant Field Values

QMgr_BridgeCapable

public static final java.lang.String QMgr_BridgeCapable

String used to identify the field in the message that determines if the queue manager is bridge capable.

True indicates that the queue manager is able to use bridge functionality.

False indicates that the bridge classes required are not present on the classpath.

This attribute is read-only and is only valid on inquire actions.

The field is of type boolean.

See Also:
Constant Field Values

QMgr_Aliases

public static final java.lang.String QMgr_Aliases
String used to identify the field in the message representing a set of aliases for the queue manager.

Multiple names or aliases can be assigned to a queue manager. This field holds the set of aliases.

The field is of type ascii array

See Also:
Constant Field Values

QMgr_Queues

public static final java.lang.String QMgr_Queues

String used to identify the field in the message that represents the set of queues known by the queue manager.

The list of queues are returned by an inquire action in a fields array. Each element of the array is an MQeFields object containing 3 fields:

This attribute is read-only and is only valid on inquire actions.

The field is of type fields array.

See Also:
Constant Field Values

QMgr_QueueName

public static final java.lang.String QMgr_QueueName

Field name that represents the queue name in the list of queues field QMgr_Queues.

The field is of type ascii.

See Also:
Constant Field Values

QMgr_QueueQMgrName

public static final java.lang.String QMgr_QueueQMgrName

Field name that represents the queue manager name in the list of queues field QMgr_Queues.

The field is of type ascii.

See Also:
Constant Field Values

QMgr_QueueType

public static final java.lang.String QMgr_QueueType

Field name that represents the queue type in the list of queues field QMgr_Queues.

The field is of type ascii.

See Also:
Constant Field Values

QMgr_Connections

public static final java.lang.String QMgr_Connections

String used to identify the field in the message that represents the set of connections known by the queue manager.

The list of connections are returned by an inquire action in a ascii array. Each element of the array is the name of a connection.

This attribute is read-only and is only valid on inquire actions.

The field is of type fields array.

See Also:
Constant Field Values

QMgr_CommsListeners

public static final java.lang.String QMgr_CommsListeners

String used to identify the field in the message that represents the set of communication listeners known by the queue manager.

The list of listeners are returned by an inquire action in a ascii array. Each element of the array is the name of a communication listener.

This attribute is read-only and is only valid on inquire actions.

The field is of type fields array.

See Also:
Constant Field Values

QMgr_Version

public static final java.lang.String QMgr_Version
String used to identify the field in the message representing the version of the queue manager.

The field is of type short array

See Also:
Constant Field Values
Constructor Detail

MQeQueueManagerAdminMsg

public MQeQueueManagerAdminMsg()
                        throws java.lang.Exception

Default constructor.

Throws:
java.lang.Exception

MQeQueueManagerAdminMsg

public MQeQueueManagerAdminMsg(java.lang.String qMgrName)
                        throws java.lang.Exception
This constructor takes the name of the queue manager to administer and puts it into the admin msg.

This constructor uses the MQeAdminMsg.setName(String) method to put the name into the administratoin message parameters field

Throws:
java.lang.Exception
See Also:
MQeAdminMsg.setName(String)
Method Detail

addAlias

public void addAlias(java.lang.String alias)
              throws java.lang.Exception
Setup the admin message to add an alias to the connection.

A method that assists in setting up an administratoin message to add one or more aliases to a connection definition. Multiple aliases can be added in one message by calling the method multiple times. The message is set to perform action MQeAdminMsg.Action_AddAlias.

The following basic fields are set:

The following fields are set in the Admin_Parms field.

The name of the connection to add an alias to is specified using method MQeAdminMsg.setName(java.lang.String) or using the constructor that takes the resource name or by setting the MQeAdminMsg.Admin_Name field.

Parameters:
alias - the alias to add to the connection.
Throws:
java.lang.Exception
See Also:
MQeAdminMsg.Action_AddAlias, QMgr_Aliases

changeAlias

public void changeAlias(java.lang.String alias)
                 throws java.lang.Exception
Adds an alias name to the aliases array. Used internally by addAlias and removeAlias.

Parameters:
alias - java.lang.String
Throws:
java.lang.Exception

removeAlias

public void removeAlias(java.lang.String alias)
                 throws java.lang.Exception
Setup the admin message to remove an alias from the connection.

A method that assists in setting up an administratoin message to remove one or more aliases from a connection. Multiple aliases can be removed in one message by calling the method multiple times. The message is set to perform action MQeAdminMsg.Action_RemoveAlias.

The following basic fields are set:

The following fields are set in the Admin_Parms field.

The name of the connection to remove an alias from is specified using method MQeAdminMsg.setName(java.lang.String) or using the constructor that takes the resource name or by setting the MQeAdminMsg.Admin_Name field.

Parameters:
alias - the alias to remove from a connection.
Throws:
java.lang.Exception
See Also:
MQeAdminMsg.Action_RemoveAlias, QMgr_Aliases

Websphere MQ Everyplace