Package com.github.toolarium.processing.engine

Interface IProcessEngine

All Known Implementing Classes:

ProcessingEngineImpl

public interface IProcessEngine

Defines the process engine

Method Summary

Modifier and Type	Method	Description
void	addListener(IProcessingListener listener)	Add a IProcessingListener.
com.github.toolarium.processing.unit.runtime.runnable.IProcessingUnitRunnable	execute(java.lang.String id, java.lang.String name, java.lang.String processingUnitClass, java.util.List<com.github.toolarium.processing.unit.dto.Parameter> parameterList)	Execute the process unit
java.lang.String	getInstanceName()	Get the process engine instance name
IProcessingUnitRegistry	getProcessingUnitRegistry()	Get the processing unit registry
IProcessingEngineStatus	getStatus()	Get the status back
byte[]	shutdown()	Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.

Method Detail

getInstanceName

java.lang.String getInstanceName()

Get the process engine instance name

Returns:

the process engine instance name

getProcessingUnitRegistry

IProcessingUnitRegistry getProcessingUnitRegistry()

Get the processing unit registry

Returns:

the processing unit registry

execute

com.github.toolarium.processing.unit.runtime.runnable.IProcessingUnitRunnable execute(java.lang.String id,
                                                                                      java.lang.String name,
                                                                                      java.lang.String processingUnitClass,
                                                                                      java.util.List<com.github.toolarium.processing.unit.dto.Parameter> parameterList)

Execute the process unit

Parameters:

id - the id of the execution or null

name - the name of the execution

processingUnitClass - the process unit class

parameterList - the parameter list

Returns:

the added IProcessingUnitRunnable.

getStatus

IProcessingEngineStatus getStatus()

Get the status back

Returns:

the status

addListener

void addListener(IProcessingListener listener)

Add a IProcessingListener.

Parameters:

listener - the listener to add

shutdown

byte[] shutdown()

Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down.

Returns:

the processing suspended state