com.cs.software.engine

Class DataFlowServiceBase

java.lang.Object

com.cs.software.engine.DataFlowServiceBase

All Implemented Interfaces:

ServicesIntf, Serializable

Direct Known Subclasses:

Command, CommandFtp, DataFlowService, DataFlowWorker, DataProcessService, DataStoreReader, DataStoreWriter, EmailApproval, EmailNotify, EngineReader, JavaScript, KafkaProducerService, KafkaService, LogMessage, TimerReader, WaitService, WebServiceClient

public abstract class DataFlowServiceBase
extends Object
implements ServicesIntf

Title This interface is used to define the services that can be performed with the Data Process Engine

Author:

Steve Crombie

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static Boolean	BOOLEAN_FALSE
protected static Boolean	BOOLEAN_TRUE
protected String	databasePoolName
protected EngineIntf	engine
protected MessageIntf	message
protected List<Map<String,Object>>	paramList
protected ServicesIntf	workerService

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

LOG_PARAM_LOGFIELDS, LOG_PARAM_LOGMESSAGE, LOG_PARAM_LOGTYPE, LOG_TYPE_DEBUG, LOG_TYPE_ERROR, LOG_TYPE_INFO, LOG_TYPE_SYSTEM_OUT, LOG_TYPE_WARN

Constructor Summary

Constructors

Constructor and Description
DataFlowServiceBase()

Method Summary

Modifier and Type	Method and Description
abstract ServicesIntf	cloneService()
String	convertTemplate(MessageIntf aMsg, String aTemplateParam, String aTemplateFieldParm)
String	convertTemplateMessage(MessageIntf aMsg, String aTemplate, List<String> aFields)
Object	getFieldDataFromMsg(MessageIntf aMsg, String aFieldKey)
MessageIntf	getMessage()
String	getServiceDisplayName()
String	getServiceName()
void	init(EngineIntf anEngine, ServicesIntf aWorkerService, MessageIntf aMessage)
void	resetService()
abstract MessageIntf	runService()
void	runServicePost()
void	runServicePre()
void	setFunctionParams(List<Map<String,Object>> aParamList, String aDatabasePoolName)
void	setMessage(MessageIntf aMsg)
void	setServiceDisplayName(String aName)
void	setServiceName(String aName)
void	shutdown()

Methods inherited from class java.lang.Object

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

Field Detail

BOOLEAN_FALSE

protected static final Boolean BOOLEAN_FALSE

BOOLEAN_TRUE

protected static final Boolean BOOLEAN_TRUE

engine

protected EngineIntf engine

workerService

protected ServicesIntf workerService

paramList

protected List<Map<String,Object>> paramList

message

protected MessageIntf message

databasePoolName

protected String databasePoolName

Constructor Detail

DataFlowServiceBase

public DataFlowServiceBase()

Method Detail

getServiceName

public String getServiceName()

Specified by:

getServiceName in interface ServicesIntf

setServiceName

public void setServiceName(String aName)

Specified by:

setServiceName in interface ServicesIntf

getServiceDisplayName

public String getServiceDisplayName()

Specified by:

getServiceDisplayName in interface ServicesIntf

setServiceDisplayName

public void setServiceDisplayName(String aName)

Specified by:

setServiceDisplayName in interface ServicesIntf

setFunctionParams

public void setFunctionParams(List<Map<String,Object>> aParamList,
                              String aDatabasePoolName)
                       throws Exception

Specified by:

setFunctionParams in interface ServicesIntf

Throws:

Exception

init

public void init(EngineIntf anEngine,
                 ServicesIntf aWorkerService,
                 MessageIntf aMessage)
          throws Exception

Specified by:

init in interface ServicesIntf

Throws:

Exception

getMessage

public MessageIntf getMessage()

Specified by:

getMessage in interface ServicesIntf

setMessage

public void setMessage(MessageIntf aMsg)

runServicePre

public void runServicePre()
                   throws Exception

Specified by:

runServicePre in interface ServicesIntf

Throws:

Exception

runService

public abstract MessageIntf runService()

Specified by:

runService in interface ServicesIntf

runServicePost

public void runServicePost()
                    throws Exception

Specified by:

runServicePost in interface ServicesIntf

Throws:

Exception

cloneService

public abstract ServicesIntf cloneService()
                                   throws Exception

Specified by:

cloneService in interface ServicesIntf

Throws:

Exception

getFieldDataFromMsg

public Object getFieldDataFromMsg(MessageIntf aMsg,
                                  String aFieldKey)
                           throws Exception

Specified by:

getFieldDataFromMsg in interface ServicesIntf

Throws:

Exception

convertTemplateMessage

public String convertTemplateMessage(MessageIntf aMsg,
                                     String aTemplate,
                                     List<String> aFields)

Specified by:

convertTemplateMessage in interface ServicesIntf

resetService

public void resetService()
                  throws Exception

Specified by:

resetService in interface ServicesIntf

Throws:

Exception

convertTemplate

public String convertTemplate(MessageIntf aMsg,
                              String aTemplateParam,
                              String aTemplateFieldParm)

shutdown

public void shutdown()

Specified by:

shutdown in interface ServicesIntf