Websphere MQ Everyplace

examples.administration.commandline
Class LocalQueueCreator

java.lang.Object
  |
  +--examples.administration.commandline.MQeAbstractCmdLineAdminTool
        |
        +--examples.administration.commandline.LocalQueueCreator

public class LocalQueueCreator
extends MQeAbstractCmdLineAdminTool

To add a local queue to a queue manager from the command-line.

Syntax

java examples.administration.commandline.LocalQueueCreator <queue_name> <compressor> <cryptor> <authenticator> <maxMsgSize> <maxQDepth> <queue_manager_name> <ini_file> <storageLocation>

Parameters

queue_name
The name of the local queue to create on the target queue manager.
compressor
The name of the class (or alias which resolves into a class) indicating which compressor the queue should use to store messages on the disk. Use "null" if you don't want a compressor.
cryptor
The name of the class (or alias which resolves into a class) indicating which cryptor the queue should use to store messages on the disk. Use "null" if you don't want a cryptor.
authenticator
The name of the class (or alias which resolves into a class) indicating which authenticator the queue should use to store messages on the disk. Use "null" if you don't want an authenticator.
maxMsgSize
The size of the largest message (in bytes) which can be accepted on this queue. This must be an integer number. Specify "nolimit" if you want to allow any size of message to be put to the queue. Specify "default" if you want to set this to the default value chosen by MQe.
maxQDepth
The max number of messages allowed to be stored in the queue, before the queue is considered to be "full". This must be an integer number. Specify "nolimit" if you want to allow any limit to the depth of the queue Specify "default" if you want to set this to the default value chosen by MQe.
queue_manager_name
The name of the queue manager on which the new local queue will be defined. This would normally be the name of the queue manager described by the .ini file
ini_file
The fully-qualified path name of the .ini file to be used to send and receive the admin messages.
storageLocation
A string, following the syntax <adapter>:<path> Where the adapter is a class name without the .class extension, and the path is the name of the directory in which the files containing queue messages are stored. eg: com.ibm.mqe.adapers.MQeDiskFieldsAdapter:C:\ServerQMgr23\RemoteQ48 Specify "default" if you want to set this to the default value chosen by MQe.


Field Summary
static java.lang.String syntax
           
static short[] version
           
 
Fields inherited from class examples.administration.commandline.MQeAbstractCmdLineAdminTool
ADMIN_Q_NAME, REPLY_TO_Q, TIMEOUT_MILLISECS
 
Constructor Summary
LocalQueueCreator()
           
 
Method Summary
 void activate(java.lang.String[] args)
          Gathers command-line parameters into variables, and calls the method which creates the queue.
static void createQueue(java.lang.String q, java.lang.String compressorClass, java.lang.String cryptorClass, java.lang.String authenticatorClass, java.lang.String maxMsgSize, java.lang.String maxQDepth, java.lang.String qmgr, java.lang.String storageLocation, MQeQueueManager myQMgr)
          Creates an admin message which will create a queue, and sends it to the target queue manager.
static void main(java.lang.String[] args)
          Entry point from the command line.
 
Methods inherited from class examples.administration.commandline.MQeAbstractCmdLineAdminTool
checkAdminReply, primeAdminMsg, processAdminMsg, sendWaitMessage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

version

public static short[] version

syntax

public static final java.lang.String syntax
See Also:
Constant Field Values
Constructor Detail

LocalQueueCreator

public LocalQueueCreator()
Method Detail

main

public static void main(java.lang.String[] args)
Entry point from the command line.


activate

public void activate(java.lang.String[] args)
              throws java.lang.Exception
Gathers command-line parameters into variables, and calls the method which creates the queue.

Parameters:
args -
Returns:
void
Throws:
java.lang.Exception

createQueue

public static void createQueue(java.lang.String q,
                               java.lang.String compressorClass,
                               java.lang.String cryptorClass,
                               java.lang.String authenticatorClass,
                               java.lang.String maxMsgSize,
                               java.lang.String maxQDepth,
                               java.lang.String qmgr,
                               java.lang.String storageLocation,
                               MQeQueueManager myQMgr)
                        throws java.lang.Exception
Creates an admin message which will create a queue, and sends it to the target queue manager.

Parameters:
q - The name of the local queue to create
compressorClass - The name of the compression class to use (or alias which resolves to a class name) Should include the .class extension. Specify "null" if you don't want to use a compressor.
cryptorClass - The name of the cryptor class to use (or alias which resolves to a class name) Should include the .class extension. Specify "null" if you don't want to use a cryptor.
authenticatorClass - The name of the authenticator class to use (or alias which resolves to a class name) Should include the .class extension. Specify "null" if you don't want to use an authenticator
maxMsgSize - The size of the largest message (in bytes) which can be accepted on this queue. This must be an integer number. Specify "nolimit" if you want to allow any size of message to be put to the queue. Specify "default" if you want to set this to the default value chosen by MQe.
maxQDepth - The max number of messages allowed to be stored in the queue, before the queue is considered to be "full". This must be an integer number. Specify "nolimit" if you want to allow any limit to the depth of the queue Specify "default" if you want to set this to the default value chosen by MQe.
qmgr - The queue manager on which the local queue is created.
storageLocation - A string, following the syntax <adapter>:<path> Where the adapter is a class name without the .class extension, and the path is the name of the directory in which the files containing queue messages are stored. eg: com.ibm.mqe.adapers.MQeDiskFieldsAdapter:C:\ServerQMgr23\RemoteQ48 Specify "default" if you want to set this to the default value chosen by MQe
myQMgr - A reference to an active MQe queue manager, which will be used to send and receive admin messages.
Returns:
void
Throws:
java.lang.Exception

Websphere MQ Everyplace