com.cs.software.api

Interface ServicesIntf

All Superinterfaces:

Serializable

All Known Implementing Classes:

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

public interface ServicesIntf
extends Serializable

This interface is used as the API for all services running on the CS Software platform

Author:

Steve Crombie

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOG_PARAM_LOGFIELDS
static String	LOG_PARAM_LOGMESSAGE
static String	LOG_PARAM_LOGTYPE
static String	LOG_TYPE_DEBUG
static String	LOG_TYPE_ERROR
static String	LOG_TYPE_INFO
static String	LOG_TYPE_SYSTEM_OUT
static String	LOG_TYPE_WARN

Method Summary

Modifier and Type	Method and Description
ServicesIntf	cloneService()
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()
MessageIntf	runService()
void	runServicePost()
void	runServicePre()
void	setFunctionParams(List<Map<String,Object>> aParamList, String aDatabasePoolName)
void	setServiceDisplayName(String aName)
void	setServiceName(String aName)
void	shutdown()

Field Detail

LOG_PARAM_LOGMESSAGE

static final String LOG_PARAM_LOGMESSAGE

See Also:

Constant Field Values

LOG_PARAM_LOGFIELDS

static final String LOG_PARAM_LOGFIELDS

See Also:

Constant Field Values

LOG_PARAM_LOGTYPE

static final String LOG_PARAM_LOGTYPE

See Also:

Constant Field Values

LOG_TYPE_ERROR

static final String LOG_TYPE_ERROR

See Also:

Constant Field Values

LOG_TYPE_WARN

static final String LOG_TYPE_WARN

See Also:

Constant Field Values

LOG_TYPE_INFO

static final String LOG_TYPE_INFO

See Also:

Constant Field Values

LOG_TYPE_DEBUG

static final String LOG_TYPE_DEBUG

See Also:

Constant Field Values

LOG_TYPE_SYSTEM_OUT

static final String LOG_TYPE_SYSTEM_OUT

See Also:

Constant Field Values

Method Detail

setFunctionParams

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

Throws:

Exception

init

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

Throws:

Exception

getServiceName

String getServiceName()

setServiceName

void setServiceName(String aName)

getServiceDisplayName

String getServiceDisplayName()

setServiceDisplayName

void setServiceDisplayName(String aName)

getMessage

MessageIntf getMessage()

getFieldDataFromMsg

Object getFieldDataFromMsg(MessageIntf aMsg,
                           String aFieldKey)
                    throws Exception

Throws:

Exception

convertTemplateMessage

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

runServicePre

void runServicePre()
            throws Exception

Throws:

Exception

runService

MessageIntf runService()

runServicePost

void runServicePost()
             throws Exception

Throws:

Exception

resetService

void resetService()
           throws Exception

Throws:

Exception

cloneService

ServicesIntf cloneService()
                   throws Exception

Throws:

Exception

shutdown

void shutdown()