|
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.MQeQueueManagerAdminMsg
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:
MQeAdminMsg.Action_Inquire
MQeAdminMsg.Action_InquireAll
MQeAdminMsg.Action_Update
MQeAdminMsg.Action_AddAlias
MQeAdminMsg.Action_RemoveAlias
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
.
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 |
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.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 java.lang.String QMgr_Description
The field is of type unicode
public static final java.lang.String QMgr_Rules
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.
MQeQueueManagerRule
,
Constant Field Valuespublic static final java.lang.String QMgr_ChnlTimeout
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.
public static final java.lang.String QMgr_ChnlAttrRules
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.
public static final java.lang.String QMgr_QueueStore
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:
MQeDiskFieldsAdapter
to store
messages on a file system
MQeMemoryFieldsAdapter
to store
messages in memory
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.
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.
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.
public static final java.lang.String QMgr_Aliases
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
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.
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.
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.
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.
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.
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.
public static final java.lang.String QMgr_Version
The field is of type short array
Constructor Detail |
public MQeQueueManagerAdminMsg() throws java.lang.Exception
Default constructor.
java.lang.Exception
public MQeQueueManagerAdminMsg(java.lang.String qMgrName) throws java.lang.Exception
This constructor uses the MQeAdminMsg.setName(String)
method to
put the name into the administratoin message parameters field
java.lang.Exception
MQeAdminMsg.setName(String)
Method Detail |
public void addAlias(java.lang.String alias) throws java.lang.Exception
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.
alias
- the alias to add to the connection.
java.lang.Exception
MQeAdminMsg.Action_AddAlias
,
QMgr_Aliases
public void changeAlias(java.lang.String alias) throws java.lang.Exception
alias
- java.lang.String
java.lang.Exception
public void removeAlias(java.lang.String alias) throws java.lang.Exception
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.
alias
- the alias to remove from a connection.
java.lang.Exception
MQeAdminMsg.Action_RemoveAlias
,
QMgr_Aliases
|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |