com.cs.software.engine.queue

Class QueueTransport

java.lang.Object

java.lang.Thread

com.cs.software.engine.queue.QueueTransport

All Implemented Interfaces:

FrameworkIntf, TransportIntf, Serializable, Runnable

Direct Known Subclasses:

QueueReader, QueueWriter

public class QueueTransport
extends Thread
implements TransportIntf

This class QueueReader is used to remove messages from the internal memory queue.

Author:

Steve Crombie

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected Queue	queue
protected boolean	runLoop
protected ServicesIntf	service
protected QueueStats	stats

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

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

Constructor Summary

Constructors

Constructor and Description
QueueTransport()
QueueTransport(Queue aQueue, int aHashCode, ServicesIntf aService) Constructor - Creates a new QueueReader

Method Summary

Modifier and Type	Method and Description
void	addInProcess() This method will add 1 to the total message in process.
void	addMsg(MessageIntf aMsg) Add a new message to the queue
void	addTotalErrorNumber() This method will add 1 to the total error number.
void	addTotalMsgNumber() This method will add 1 to the total message received.
void	addTotalProcessed() This method will add 1 to the total number of message processed.
void	addTransport(TransportIntf aTransport) Synchronized - Will add a new Writer to the Queue
void	close() Will stop this reader from reading the queue
void	deRegister(FrameworkIntf aFramework) This method is called to de-register the service
void	doEventMessage(MessageIntf aData) This method is called to send the service event message
void	doMessage(MessageIntf aData) This method is called to send the service status message
long	getInProcess() This method will return the Total Number of Messages in process.
String	getJvmId()
FrameworkIntf	getJvmService()
MessageIntf	getMsg() Get a new message from the queue (No Wait)
MessageIntf	getMsgNoWait() Get a new message from the queue (No Wait)
MessageIntf	getStats() This method is called to send a snapshot of performance data
long	getTotalErrorNumber() This method will return the Total Number of Errors processed.
long	getTotalMsgNumber() This method will return the Total Number of Messages received.
long	getTotalProcessed() This method will return the Total Number of Messages processed.
String	getTransportName() Returns the Queue Reference Name
int	getUserHashCode() Returns the users object hash code
void	init(MessageIntf Msg)
void	initMessage(MessageIntf aData)
void	initTransport(Map<String,String> aDataMap, ServicesIntf aService) This method will initialize the internal parameters.
boolean	isActive()
boolean	isListener()
boolean	isReader()
boolean	isRunning()
boolean	isWriter()
boolean	processMsg(MessageIntf aMsg)
boolean	processMsgListner(MessageIntf aMsg)
MessageIntf	readMsg() This method will remove the next message from the queue, if one does not exist then wait for next message.
MessageIntf	readMsg(long aTimeout) This method will remove the next message from the queue, if one does not exist then wait for next message or until specified timeout.
void	register(FrameworkIntf aFramework) This method is called to register the service
void	register(TransportIntf aListener)
void	removeTransport() Will remove the this reader from the queue reader list
void	removeTransport(TransportIntf aTransport) Synchronized - Will remove a Reader from the Queue
void	resetTotals()
void	run() This method is called by the thread an will run until the close method is called.
void	setActive(boolean aFlag)
void	setListener(boolean aFlag)
void	setReader(boolean aFlag)
void	setRunning(boolean aFlag)
void	setWriter(boolean aFlag)
void	shutdown() Called to shut down the reader.
int	size() Returns the total number of messages left in the queue
void	subtractInProcess() This method will add 1 to the total message in process.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

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

getName

Field Detail

queue

protected Queue queue

stats

protected QueueStats stats

service

protected ServicesIntf service

runLoop

protected boolean runLoop

Constructor Detail

QueueTransport

public QueueTransport()

QueueTransport

public QueueTransport(Queue aQueue,
                      int aHashCode,
                      ServicesIntf aService)

Constructor - Creates a new QueueReader

Parameters:

aQueue - a Queue value

aHashCode - an int value

aService - QueueReaderIntf QueueReader Object

Method Detail

initTransport

public void initTransport(Map<String,String> aDataMap,
                          ServicesIntf aService)

Description copied from interface: TransportIntf

This method will initialize the internal parameters.

Specified by:

initTransport in interface TransportIntf

Parameters:

aDataMap - data

aService - service

getUserHashCode

public int getUserHashCode()

Returns the users object hash code

Specified by:

getUserHashCode in interface TransportIntf

Returns:

int Objects hash code

close

public void close()

Will stop this reader from reading the queue

Specified by:

close in interface TransportIntf

addMsg

public void addMsg(MessageIntf aMsg)

Add a new message to the queue

Specified by:

addMsg in interface TransportIntf

Parameters:

aMsg - Object New Queue Message

readMsg

public MessageIntf readMsg()
                    throws Exception

This method will remove the next message from the queue, if one does not exist then wait for next message.

Specified by:

readMsg in interface TransportIntf

Returns:

Message new message

Throws:

Exception

readMsg

public MessageIntf readMsg(long aTimeout)
                    throws Exception

This method will remove the next message from the queue, if one does not exist then wait for next message or until specified timeout.

Specified by:

readMsg in interface TransportIntf

Returns:

Message new message

Throws:

Exception

getMsg

public MessageIntf getMsg()
                   throws Exception

Get a new message from the queue (No Wait)

Specified by:

getMsg in interface TransportIntf

Returns:

Object New Queue Message

Throws:

Exception - ex

getMsgNoWait

public MessageIntf getMsgNoWait()
                         throws Exception

Get a new message from the queue (No Wait)

Specified by:

getMsgNoWait in interface TransportIntf

Returns:

Object New Queue Message

Throws:

Exception - ex

removeTransport

public void removeTransport()

Will remove the this reader from the queue reader list

size

public int size()

Returns the total number of messages left in the queue

Specified by:

size in interface TransportIntf

Returns:

int Number of messages

run

public void run()

This method is called by the thread an will run until the close method is called.

Specified by:

run in interface Runnable

Overrides:

run in class Thread

register

public void register(TransportIntf aListener)
              throws Exception

Throws:

Exception

processMsg

public boolean processMsg(MessageIntf aMsg)

shutdown

public void shutdown()
              throws Exception

Called to shut down the reader.

Throws:

Exception - ex

isReader

public boolean isReader()

Specified by:

isReader in interface TransportIntf

setReader

public void setReader(boolean aFlag)

Specified by:

setReader in interface TransportIntf

isWriter

public boolean isWriter()

Specified by:

isWriter in interface TransportIntf

setWriter

public void setWriter(boolean aFlag)

Specified by:

setWriter in interface TransportIntf

isListener

public boolean isListener()

Specified by:

isListener in interface TransportIntf

setListener

public void setListener(boolean aFlag)

Specified by:

setListener in interface TransportIntf

register

public void register(FrameworkIntf aFramework)

Description copied from interface: FrameworkIntf

This method is called to register the service

Specified by:

register in interface FrameworkIntf

Parameters:

aFramework - ServerBaseIntf Service Object

deRegister

public void deRegister(FrameworkIntf aFramework)

Description copied from interface: FrameworkIntf

This method is called to de-register the service

Specified by:

deRegister in interface FrameworkIntf

Parameters:

aFramework - ServerBaseIntf Service Object

initMessage

public void initMessage(MessageIntf aData)
                 throws Exception

Specified by:

initMessage in interface FrameworkIntf

Throws:

Exception

doMessage

public void doMessage(MessageIntf aData)

Description copied from interface: FrameworkIntf

This method is called to send the service status message

Specified by:

doMessage in interface FrameworkIntf

Parameters:

aData - ServiceDataintf Service Data

doEventMessage

public void doEventMessage(MessageIntf aData)

Description copied from interface: FrameworkIntf

This method is called to send the service event message

Specified by:

doEventMessage in interface FrameworkIntf

Parameters:

aData - ServiceDataintf Service Data

getStats

public MessageIntf getStats()

Description copied from interface: FrameworkIntf

This method is called to send a snapshot of performance data

Specified by:

getStats in interface FrameworkIntf

Returns:

message

getJvmService

public FrameworkIntf getJvmService()

Specified by:

getJvmService in interface FrameworkIntf

getJvmId

public String getJvmId()

Specified by:

getJvmId in interface FrameworkIntf

isRunning

public boolean isRunning()

Specified by:

isRunning in interface FrameworkIntf

setRunning

public void setRunning(boolean aFlag)

Specified by:

setRunning in interface FrameworkIntf

isActive

public boolean isActive()

Specified by:

isActive in interface FrameworkIntf

setActive

public void setActive(boolean aFlag)

Specified by:

setActive in interface FrameworkIntf

getTotalErrorNumber

public long getTotalErrorNumber()

Description copied from interface: FrameworkIntf

This method will return the Total Number of Errors processed.

Specified by:

getTotalErrorNumber in interface FrameworkIntf

Returns:

long Total Number of Messages

addTotalErrorNumber

public void addTotalErrorNumber()

Description copied from interface: FrameworkIntf

This method will add 1 to the total error number.

Specified by:

addTotalErrorNumber in interface FrameworkIntf

getTotalProcessed

public long getTotalProcessed()

Description copied from interface: FrameworkIntf

This method will return the Total Number of Messages processed.

Specified by:

getTotalProcessed in interface FrameworkIntf

Returns:

long Total Number of Messages

addTotalProcessed

public void addTotalProcessed()

Description copied from interface: FrameworkIntf

This method will add 1 to the total number of message processed.

Specified by:

addTotalProcessed in interface FrameworkIntf

getInProcess

public long getInProcess()

Description copied from interface: FrameworkIntf

This method will return the Total Number of Messages in process.

Specified by:

getInProcess in interface FrameworkIntf

Returns:

long Total Number of Messages in process

addInProcess

public void addInProcess()

Description copied from interface: FrameworkIntf

This method will add 1 to the total message in process.

Specified by:

addInProcess in interface FrameworkIntf

subtractInProcess

public void subtractInProcess()

Description copied from interface: FrameworkIntf

This method will add 1 to the total message in process.

Specified by:

subtractInProcess in interface FrameworkIntf

getTotalMsgNumber

public long getTotalMsgNumber()

Description copied from interface: FrameworkIntf

This method will return the Total Number of Messages received.

Specified by:

getTotalMsgNumber in interface FrameworkIntf

Returns:

long Total Number of Messages received

addTotalMsgNumber

public void addTotalMsgNumber()

Description copied from interface: FrameworkIntf

This method will add 1 to the total message received.

Specified by:

addTotalMsgNumber in interface FrameworkIntf

resetTotals

public void resetTotals()

Specified by:

resetTotals in interface FrameworkIntf

init

public void init(MessageIntf Msg)

Specified by:

init in interface TransportIntf

getTransportName

public String getTransportName()

Description copied from interface: TransportIntf

Returns the Queue Reference Name

Specified by:

getTransportName in interface TransportIntf

Returns:

String Queue Reference Name

addTransport

public void addTransport(TransportIntf aTransport)

Description copied from interface: TransportIntf

Synchronized - Will add a new Writer to the Queue

Specified by:

addTransport in interface TransportIntf

Parameters:

aTransport - QueueWriter New queue writer object

removeTransport

public void removeTransport(TransportIntf aTransport)

Description copied from interface: TransportIntf

Synchronized - Will remove a Reader from the Queue

Specified by:

removeTransport in interface TransportIntf

Parameters:

aTransport - QueueReader Queue reader object

processMsgListner

public boolean processMsgListner(MessageIntf aMsg)

Specified by:

processMsgListner in interface TransportIntf