com.cs.software.api

Interface EngineIntf

All Superinterfaces:

FrameworkIntf, Serializable

All Known Implementing Classes:

DataFlowEngine, DataProcess, EngineBase, TimerEngine

public interface EngineIntf
extends FrameworkIntf

Author:

Steve Crombie

Field Summary

Fields

Modifier and Type	Field and Description
static Boolean	BOOLEAN_FALSE
static Boolean	BOOLEAN_TRUE
static String	MAP_ENGINENAME
static String	MAP_ENGINEREADERSERVICE
static String	MAP_QUEUENAMEREADER
static String	MAP_QUEUENAMEWRITER
static String	MAP_TIMERQUEUENAMEWRITER
static String	MAP_TIMERTRANSPORTWRITER
static String	MAP_TIMERTRANSPORTWRITERTYPE
static String	MAP_TRANSPORTREADER
static String	MAP_TRANSPORTREADERTYPE
static String	MAP_TRANSPORTWRITER
static String	MAP_TRANSPORTWRITERTYPE
static String	MAP_WORKERPOOLNAME
static String	MAP_WORKERSERVICE
static String	MAP_WORKERSERVICE_MAXTHREADS
static String	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

Method Summary

Modifier and Type	Method and Description
void	doJob(MessageIntf aMsg)
String	getProduct()
String	getVersion()
void	logError(MessageIntf aMsg, Map<String,Object> anErrorParams, String anErrorMsg, int anErrorCode)
void	processSetup()
void	runEngine()
void	sendMessage(MessageIntf aMsg)
void	setInfo(String aProduct, String aVersion)
int	setRunTimeParams(String[] args)
void	startEngine(String[] args)

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

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

Field Detail

MAP_ENGINENAME

static final String MAP_ENGINENAME

See Also:

Constant Field Values

MAP_ENGINEREADERSERVICE

static final String MAP_ENGINEREADERSERVICE

See Also:

Constant Field Values

MAP_WORKERSERVICE

static final String MAP_WORKERSERVICE

See Also:

Constant Field Values

MAP_WORKERPOOLNAME

static final String MAP_WORKERPOOLNAME

See Also:

Constant Field Values

MAP_WORKERSERVICE_MINTHREADS

static final String MAP_WORKERSERVICE_MINTHREADS

See Also:

Constant Field Values

MAP_WORKERSERVICE_MAXTHREADS

static final String MAP_WORKERSERVICE_MAXTHREADS

See Also:

Constant Field Values

MAP_TRANSPORTREADERTYPE

static final String MAP_TRANSPORTREADERTYPE

See Also:

Constant Field Values

MAP_TRANSPORTREADER

static final String MAP_TRANSPORTREADER

See Also:

Constant Field Values

MAP_TRANSPORTWRITERTYPE

static final String MAP_TRANSPORTWRITERTYPE

See Also:

Constant Field Values

MAP_TRANSPORTWRITER

static final String MAP_TRANSPORTWRITER

See Also:

Constant Field Values

MAP_TIMERTRANSPORTWRITERTYPE

static final String MAP_TIMERTRANSPORTWRITERTYPE

See Also:

Constant Field Values

MAP_TIMERTRANSPORTWRITER

static final String MAP_TIMERTRANSPORTWRITER

See Also:

Constant Field Values

MAP_QUEUENAMEREADER

static final String MAP_QUEUENAMEREADER

See Also:

Constant Field Values

MAP_QUEUENAMEWRITER

static final String MAP_QUEUENAMEWRITER

See Also:

Constant Field Values

MAP_TIMERQUEUENAMEWRITER

static final String MAP_TIMERQUEUENAMEWRITER

See Also:

Constant Field Values

BOOLEAN_TRUE

static final Boolean BOOLEAN_TRUE

BOOLEAN_FALSE

static final Boolean BOOLEAN_FALSE

Method Detail

setInfo

void setInfo(String aProduct,
             String aVersion)

setRunTimeParams

int setRunTimeParams(String[] args)
              throws Exception

Throws:

Exception

getProduct

String getProduct()

getVersion

String getVersion()

runEngine

void runEngine()

logError

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

Throws:

Exception

processSetup

void processSetup()
           throws Exception

Throws:

Exception

doJob

void doJob(MessageIntf aMsg)
    throws Exception

Throws:

Exception

sendMessage

void sendMessage(MessageIntf aMsg)
          throws Exception

Throws:

Exception

startEngine

void startEngine(String[] args)
          throws Exception

Throws:

Exception