com.cs.software.engine.queue

Class QueueMgr

java.lang.Object

com.cs.software.engine.FrameworkBase

com.cs.software.engine.queue.QueueMgr

All Implemented Interfaces:

FrameworkIntf, Serializable

public class QueueMgr
extends FrameworkBase

This class QueueMgr is used to Manage all in memory queues. NOTE: CONVERT TO JMS SPEC SO QUEUE CAN BE REPLACED WITH ANY JMS COMPLIANT QUEUE.

Author:

Steve Crombie

See Also:

Serialized Form

Field Summary

Fields inherited from class com.cs.software.engine.FrameworkBase

active, initMessage, inProcess, jvmService, running, serviceData, totalErrors, totalMessages, totalProcessed

Fields inherited from interface com.cs.software.api.FrameworkIntf

CATEGROY_ADAPTER, CATEGROY_APP, CATEGROY_DB_CON, CATEGROY_DB_POOL, CATEGROY_ENGINE, CATEGROY_MODULE, CATEGROY_POOL_MGR, CATEGROY_QUEUE, CATEGROY_THREAD_MGR, CATEGROY_WORKER, COMMAND_DEREGISTER_KEY, COMMAND_PAUSE, COMMAND_REGISTER_KEY, COMMAND_RESTART, COMMAND_SHUTDOWN, COMMAND_START, COMMAND_STOP, FLAG_FALSE, FLAG_TRUE, PARAM_JVM_STR, PARAM_JVMID_STR, PARAM_SERVERNAME_STR, PARAM_SERVICEACTIVE_STR, PARAM_SERVICECATAGORY_STR, PARAM_SERVICENAME_STR, PARAM_SERVICERUNNING_STR, TYPE_CLUSTER, TYPE_DISPLAY_STR, TYPE_EVENT, TYPE_JVM, TYPE_JVM_STR, TYPE_MAX, TYPE_SERVER, TYPE_SERVICE

Method Summary

Modifier and Type	Method and Description
void	addQueue(Queue aQueue) Create a new queue with the specified refernece name
void	commit()
void	createQueue(String aName) Create a new queue with the specified refernece name
static QueueMgr	getInstance() Create a new QueueMgr if one does not exist otherwise return a refernece to the one already created - Limit one QueueMgr per Java VM
Queue	getQueue(String aQueueName)
QueueReader	getQueueReader(String aName, int aUserProcessHashCode) Attaches a QueueReader to the specified queue reference name This reader can only read Messages in a No Wait State
QueueReader	getQueueReader(String aName, int aUserProcessHashCode, ServicesIntf aService) Attaches a QueueReader to the specified queue reference name and starts the reader on its own thread.
QueueWriter	getQueueWriter(String aName, int aUserProcessHashCode) Attaches a QueueWriter to the specified queue reference name.
void	register() This method will register a new queue object
void	register(Queue aQueue, String aName) This method will register a new queue object
void	removeQueue(String aName) This method removeQueue will remove the queue from the Queue Manager.
void	rollback()
void	shutdown()
void	startConnection()

Methods inherited from class com.cs.software.engine.FrameworkBase

addInProcess, addTotalErrorNumber, addTotalMsgNumber, addTotalProcessed, deRegister, deRegister, doEventMessage, doMessage, getDefError, getInProcess, getJvmId, getJvmService, getName, getService, getServiceData, getServiceName, getStats, getTotalErrorNumber, getTotalMsgNumber, getTotalProcessed, initMessage, isActive, isRunning, register, resetTotals, setActive, setRunning, setServiceData, subtractInProcess

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static QueueMgr getInstance()

Create a new QueueMgr if one does not exist otherwise return a refernece to the one already created - Limit one QueueMgr per Java VM

Returns:

QueueMgr Reference to QueueMgr Object

addQueue

public void addQueue(Queue aQueue)

Create a new queue with the specified refernece name

Parameters:

aQueue - String Queue Reference Name

createQueue

public void createQueue(String aName)

Create a new queue with the specified refernece name

Parameters:

aName - String Queue Reference Name

getQueueWriter

public QueueWriter getQueueWriter(String aName,
                                  int aUserProcessHashCode)

Attaches a QueueWriter to the specified queue reference name. Note: if a queue by the specified name does not exist a new queue will be created.

Parameters:

aName - String Queue Reference Name

aUserProcessHashCode - int Hash code of the associated QueueWriter Class

Returns:

QueueWriter New Queue Writer

getQueueReader

public QueueReader getQueueReader(String aName,
                                  int aUserProcessHashCode,
                                  ServicesIntf aService)

Attaches a QueueReader to the specified queue reference name and starts the reader on its own thread.

Parameters:

aName - String Queue Reference Name

aUserProcessHashCode - int Hash code of the associated QueueReader Class

aService - QueueReaderIntf QueueReader Object

Returns:

QueueReader New Queue Reader

getQueueReader

public QueueReader getQueueReader(String aName,
                                  int aUserProcessHashCode)

Attaches a QueueReader to the specified queue reference name This reader can only read Messages in a No Wait State

Parameters:

aName - String Queue Reference Name

aUserProcessHashCode - int Hash code of the associated QueueReader Class

Returns:

QueueReader New Queue Reader

register

public void register()

This method will register a new queue object

Overrides:

register in class FrameworkBase

register

public void register(Queue aQueue,
                     String aName)

This method will register a new queue object

Parameters:

aQueue - Queue Queue Object

aName - String Queue Service Name

removeQueue

public void removeQueue(String aName)

This method removeQueue will remove the queue from the Queue Manager.

Parameters:

aName - a String value

getQueue

public Queue getQueue(String aQueueName)

startConnection

public void startConnection()

commit

public void commit()

rollback

public void rollback()

shutdown

public void shutdown()