com.cs.software.engine

Class EngineBase

java.lang.Object

com.cs.software.engine.EngineBase

All Implemented Interfaces:

EngineIntf, FrameworkIntf, Serializable

Direct Known Subclasses:

DataFlowEngine, DataProcess, TimerEngine

public abstract class EngineBase
extends Object
implements EngineIntf

Engine Base - default implmentation for all engines must be overridden

Author:

Steve Crombie

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	active
protected ClassCache	classCache
protected CommandLine	cmdLine
protected Map<String,String>	engineConfigMap
protected ServicesIntf	engineReader
protected MessageIntf	initMessage
protected long	inProcess
protected JVMService	jvmService
protected PoolMgr	poolMgr
protected String	product
protected String[]	programArgs
protected boolean	running
protected SchemaConfigIntf	schemaConfig
protected ThreadMgr	threadMgr
protected long	totalErrors
protected long	totalMessages
protected long	totalProcessed
protected TransportIntf	transportReader
protected TransportIntf	transportWriter
protected String	version
protected String	workerServiceClassName

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

BOOLEAN_FALSE, BOOLEAN_TRUE, MAP_ENGINENAME, MAP_ENGINEREADERSERVICE, MAP_QUEUENAMEREADER, MAP_QUEUENAMEWRITER, MAP_TIMERQUEUENAMEWRITER, MAP_TIMERTRANSPORTWRITER, MAP_TIMERTRANSPORTWRITERTYPE, MAP_TRANSPORTREADER, MAP_TRANSPORTREADERTYPE, MAP_TRANSPORTWRITER, MAP_TRANSPORTWRITERTYPE, MAP_WORKERPOOLNAME, MAP_WORKERSERVICE, MAP_WORKERSERVICE_MAXTHREADS, MAP_WORKERSERVICE_MINTHREADS

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

Modifier	Constructor and Description
protected	EngineBase() Creates a DataFlowEngine.

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)
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)
void	close()
protected void	connectToDB(Map<String,String> aDatabaseParam)
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
abstract void	doJob(MessageIntf aMsg)
void	doMessage(MessageIntf aData) This method is called to send the service status message
int	getDefError()
long	getInProcess() This method will return the Total Number of Messages in process.
String	getJvmId()
FrameworkIntf	getJvmService()
MessageIntf	getMsg()
MessageIntf	getMsgNoWait()
String	getName()
String	getProduct()
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()
int	getUserHashCode()
String	getVersion()
void	init(MessageIntf aMsg)
protected void	initArgs() This method initArgs is used to setup the run-time command line arguments for the Schema Maintenance.
void	initMessage(MessageIntf aData)
boolean	isActive()
boolean	isRunning()
void	logError(MessageIntf aMsg, Map<String,Object> anErrorParams, String anErrorMsg, int anErrorCode)
void	processSetup()
MessageIntf	readMsg()
MessageIntf	readMsg(long aTimeout)
void	register(FrameworkIntf aFramework) This method is called to register the service
void	removeTransport(TransportIntf aTransport)
void	resetTotals()
void	runEngine()
void	sendMessage(MessageIntf aMsg)
void	setActive(boolean aFlag)
void	setInfo(String aProduct, String aVersion)
void	setRunning(boolean aFlag)
int	setRunTimeParams(String[] args)
int	size()
void	startEngine(String[] args)
void	subtractInProcess() This method will add 1 to the total message in process.

Methods inherited from class java.lang.Object

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

Field Detail

engineConfigMap

protected Map<String,String> engineConfigMap

schemaConfig

protected SchemaConfigIntf schemaConfig

initMessage

protected MessageIntf initMessage

jvmService

protected JVMService jvmService

threadMgr

protected ThreadMgr threadMgr

poolMgr

protected PoolMgr poolMgr

engineReader

protected ServicesIntf engineReader

transportReader

protected TransportIntf transportReader

transportWriter

protected TransportIntf transportWriter

cmdLine

protected CommandLine cmdLine

classCache

protected ClassCache classCache

programArgs

protected String[] programArgs

workerServiceClassName

protected String workerServiceClassName

product

protected String product

version

protected String version

totalMessages

protected long totalMessages

totalErrors

protected long totalErrors

inProcess

protected long inProcess

totalProcessed

protected long totalProcessed

running

protected boolean running

active

protected boolean active

Constructor Detail

EngineBase

protected EngineBase()
              throws Exception

Creates a DataFlowEngine. Called for a stand alone engine.

Throws:

Exception - if an error occurs.

Method Detail

setInfo

public void setInfo(String aProduct,
                    String aVersion)

Specified by:

setInfo in interface EngineIntf

initArgs

protected void initArgs()

This method initArgs is used to setup the run-time command line arguments for the Schema Maintenance.

setRunTimeParams

public int setRunTimeParams(String[] args)
                     throws Exception

Specified by:

setRunTimeParams in interface EngineIntf

Throws:

Exception

getJvmService

public FrameworkIntf getJvmService()

Specified by:

getJvmService in interface FrameworkIntf

getJvmId

public String getJvmId()

Specified by:

getJvmId in interface FrameworkIntf

getProduct

public String getProduct()

Specified by:

getProduct in interface EngineIntf

getVersion

public String getVersion()

Specified by:

getVersion in interface EngineIntf

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

logError

public void logError(MessageIntf aMsg,
                     Map<String,Object> anErrorParams,
                     String anErrorMsg,
                     int anErrorCode)
              throws Exception

Specified by:

logError in interface EngineIntf

Throws:

Exception

processSetup

public void processSetup()
                  throws Exception

Specified by:

processSetup in interface EngineIntf

Throws:

Exception

runEngine

public void runEngine()

Specified by:

runEngine in interface EngineIntf

doJob

public abstract void doJob(MessageIntf aMsg)
                    throws Exception

Specified by:

doJob in interface EngineIntf

Throws:

Exception

sendMessage

public void sendMessage(MessageIntf aMsg)
                 throws Exception

Specified by:

sendMessage in interface EngineIntf

Throws:

Exception

getTotalErrorNumber

public long getTotalErrorNumber()

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()

This method will add 1 to the total error number.

Specified by:

addTotalErrorNumber in interface FrameworkIntf

getTotalProcessed

public long getTotalProcessed()

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()

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

Specified by:

addTotalProcessed in interface FrameworkIntf

getInProcess

public long getInProcess()

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()

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

Specified by:

addInProcess in interface FrameworkIntf

subtractInProcess

public void subtractInProcess()

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

Specified by:

subtractInProcess in interface FrameworkIntf

getTotalMsgNumber

public long getTotalMsgNumber()

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()

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 aMsg)

getUserHashCode

public int getUserHashCode()

getTransportName

public String getTransportName()

addMsg

public void addMsg(MessageIntf aMsg)
            throws Exception

Throws:

Exception

getMsg

public MessageIntf getMsg()
                   throws Exception

Throws:

Exception

getMsgNoWait

public MessageIntf getMsgNoWait()
                         throws Exception

Throws:

Exception

readMsg

public MessageIntf readMsg()
                    throws Exception

Throws:

Exception

readMsg

public MessageIntf readMsg(long aTimeout)
                    throws Exception

Throws:

Exception

size

public int size()

close

public void close()

addTransport

public void addTransport(TransportIntf aTransport)

removeTransport

public void removeTransport(TransportIntf aTransport)

getName

public String getName()

Specified by:

getName in interface FrameworkIntf

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

initMessage

public void initMessage(MessageIntf aData)
                 throws Exception

Specified by:

initMessage in interface FrameworkIntf

Throws:

Exception

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

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

connectToDB

protected void connectToDB(Map<String,String> aDatabaseParam)
                    throws Exception

Throws:

Exception

startEngine

public void startEngine(String[] args)
                 throws Exception

Specified by:

startEngine in interface EngineIntf

Throws:

Exception

getDefError

public int getDefError()