Package com.github.toolarium.processing.unit.runtime.runnable.impl

Class AbstractProcessingUnitRunnable

java.lang.Object

com.github.toolarium.processing.unit.runtime.runnable.impl.AbstractProcessingUnitRunnable

All Implemented Interfaces:

IProcessingUnitRunnable

Direct Known Subclasses:

ProcessingUnitRunnable

public abstract class AbstractProcessingUnitRunnable
extends java.lang.Object
implements IProcessingUnitRunnable

Abstract IProcessingUnitRunnable implementation.

Constructor Summary

Constructors

Constructor	Description
AbstractProcessingUnitRunnable(byte[] suspendedState, IProcessingUnitRunnableListener processingUnitRunnableListener)	Constructor
AbstractProcessingUnitRunnable(java.lang.String id, java.lang.String name, java.lang.Class<? extends IProcessingUnit> processingUnitClass, java.util.List<Parameter> parameterList, IProcessingUnitContext processingUnitContext)	Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	afterProcessUnit(boolean continueProcessing)	Before process unit method call
protected ProcessingUnitProxy	createProcessingUnitProxy()	Create processing unit proxy
IEmptyProcessingUnitHandler	getEmptyProcessingUnitHandler()	Get the empty processing unit handler
java.lang.String	getId()	Get the runnable id
java.lang.Long	getMaxNumberOfProcessingUnitCallsPerSecond()	Get the max calls per second to throttle the processing unit
java.lang.String	getName()	Get the runnable name or null
java.util.List<Parameter>	getParameterList()	Get the processing parameter list.
ProcessingActionStatus	getProcessingActionStatus()	Get the processing action status
ProcessingRuntimeStatus	getProcessingRuntimeStatus()	Get the processing runtime status
protected java.lang.Class<? extends IProcessingUnit>	getProcessingUnitClass()	Get the processing class
protected IProcessingUnitContext	getProcessingUnitContext()	Get the processing unit context
IProcessingUnitProgress	getProcessingUnitProgress()	Get the processing unit progress
protected ProcessingUnitProxy	getProcessingUnitProxy()	Get the processing unit proxy
java.util.List<java.lang.String>	getStatusMessageList()	Get the status message list
protected com.github.toolarium.common.formatter.TimeDifferenceFormatter	getTimeDifferenceFormatter()	Get the time difference formatter
IProcessingUnitRuntimeTimeMeasurement	getTimeMeasurement()	Get the time measurement
protected void	notifyProcessingUnitProgress(com.github.toolarium.common.bandwidth.IBandwidthThrottling bandwidthThrottling)	Notify processing unit action status
protected void	notifyProcessingUnitState(ProcessingActionStatus previousProcessingActionStatus, ProcessingActionStatus processingActionStatus)	Notify processing unit action status
void	releaseResource()	Release resources will be called to release all internal referenced resources after a processing success, warn or error.
void	setEmptyProcessingUnitHandler(IEmptyProcessingUnitHandler emptyProcessingUnitHandler)	Set the empty processing unit handler
void	setMaxNumberOfProcessingUnitCallsPerSecond(java.lang.Long maxNumberOfProcessingUnitCallsPerSecond)	Defines the max calls per second to throttle the processing unit
protected void	setProcessingActionStatus(ProcessingActionStatus processingActionStatus)	Sets the processing action status
protected void	setProcessingUnitProxy(ProcessingUnitProxy processingUnitProxy)	Set the processing unit proxy
protected void	setProcessingUnitRunnableListener(IProcessingUnitRunnableListener processingUnitRunnableListener)	Set the processing unit runnable listener

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProcessingUnitRunnable

public AbstractProcessingUnitRunnable(java.lang.String id,
                                      java.lang.String name,
                                      java.lang.Class<? extends IProcessingUnit> processingUnitClass,
                                      java.util.List<Parameter> parameterList,
                                      IProcessingUnitContext processingUnitContext)

Constructor

Parameters:

id - the unique id of this processing

name - the name of this processing unit runnable

processingUnitClass - the processing unit class

parameterList - the parameter list

processingUnitContext - the processing context.

Throws:

ValidationException - This will be throw in case the consistency check failures.

ProcessingException - Throws this exception in case of initialization failures.

AbstractProcessingUnitRunnable

public AbstractProcessingUnitRunnable(byte[] suspendedState,
                                      IProcessingUnitRunnableListener processingUnitRunnableListener)

Constructor

Parameters:

suspendedState - the suspended state

processingUnitRunnableListener - the processing unit runnable listener

Throws:

ValidationException - This will be throw in case the consistency check failures.

ProcessingException - Throws this exception in case of initialization failures.

Method Detail

getId

public java.lang.String getId()

Description copied from interface: IProcessingUnitRunnable

Get the runnable id

Specified by:

getId in interface IProcessingUnitRunnable

Returns:

the runnable id

See Also:

IProcessingUnitRunnable.getId()

getName

public java.lang.String getName()

Description copied from interface: IProcessingUnitRunnable

Get the runnable name or null

Specified by:

getName in interface IProcessingUnitRunnable

Returns:

the name or null

See Also:

IProcessingUnitRunnable.getName()

getProcessingActionStatus

public ProcessingActionStatus getProcessingActionStatus()

Description copied from interface: IProcessingUnitRunnable

Get the processing action status

Specified by:

getProcessingActionStatus in interface IProcessingUnitRunnable

Returns:

the processing action status

See Also:

IProcessingUnitRunnable.getProcessingActionStatus()

releaseResource

public void releaseResource()
                     throws ProcessingException

Description copied from interface: IProcessingUnitRunnable

Release resources will be called to release all internal referenced resources after a processing success, warn or error.

Specified by:

releaseResource in interface IProcessingUnitRunnable

Throws:

ProcessingException - Throws this exception in case of releasing failure.

See Also:

IProcessingUnitRunnable.releaseResource()

setProcessingActionStatus

protected void setProcessingActionStatus(ProcessingActionStatus processingActionStatus)

Sets the processing action status

Parameters:

processingActionStatus - the processing action status

getProcessingUnitProgress

public IProcessingUnitProgress getProcessingUnitProgress()

Description copied from interface: IProcessingUnitRunnable

Get the processing unit progress

Specified by:

getProcessingUnitProgress in interface IProcessingUnitRunnable

Returns:

the process unit progress

See Also:

IProcessingUnitRunnable.getProcessingUnitProgress()

getProcessingRuntimeStatus

public ProcessingRuntimeStatus getProcessingRuntimeStatus()

Description copied from interface: IProcessingUnitRunnable

Get the processing runtime status

Specified by:

getProcessingRuntimeStatus in interface IProcessingUnitRunnable

Returns:

the processing runtime status

See Also:

IProcessingUnitRunnable.getProcessingRuntimeStatus()

getStatusMessageList

public java.util.List<java.lang.String> getStatusMessageList()

Description copied from interface: IProcessingUnitRunnable

Get the status message list

Specified by:

getStatusMessageList in interface IProcessingUnitRunnable

Returns:

the status message list

See Also:

IProcessingUnitRunnable.getStatusMessageList()

getTimeMeasurement

public IProcessingUnitRuntimeTimeMeasurement getTimeMeasurement()

Description copied from interface: IProcessingUnitRunnable

Get the time measurement

Specified by:

getTimeMeasurement in interface IProcessingUnitRunnable

Returns:

the time measurement

See Also:

IProcessingUnitRunnable.getTimeMeasurement()

getParameterList

public java.util.List<Parameter> getParameterList()

Description copied from interface: IProcessingUnitRunnable

Get the processing parameter list.

Specified by:

getParameterList in interface IProcessingUnitRunnable

Returns:

the processing parameter list

See Also:

IProcessingUnitRunnable.getParameterList()

getEmptyProcessingUnitHandler

public IEmptyProcessingUnitHandler getEmptyProcessingUnitHandler()

Get the empty processing unit handler

Returns:

the empty processing unit handler

setEmptyProcessingUnitHandler

public void setEmptyProcessingUnitHandler(IEmptyProcessingUnitHandler emptyProcessingUnitHandler)

Set the empty processing unit handler

Parameters:

emptyProcessingUnitHandler - the empty processing unit handler

setMaxNumberOfProcessingUnitCallsPerSecond

public void setMaxNumberOfProcessingUnitCallsPerSecond(java.lang.Long maxNumberOfProcessingUnitCallsPerSecond)

Defines the max calls per second to throttle the processing unit

Parameters:

maxNumberOfProcessingUnitCallsPerSecond - the max number of processing units per second

getMaxNumberOfProcessingUnitCallsPerSecond

public java.lang.Long getMaxNumberOfProcessingUnitCallsPerSecond()

Get the max calls per second to throttle the processing unit

Returns:

the max number of processing units per second

getProcessingUnitContext

protected IProcessingUnitContext getProcessingUnitContext()

Get the processing unit context

Returns:

the processing unit context

createProcessingUnitProxy

protected ProcessingUnitProxy createProcessingUnitProxy()

Create processing unit proxy

Returns:

the processing unit proxy

getProcessingUnitProxy

protected ProcessingUnitProxy getProcessingUnitProxy()

Get the processing unit proxy

Returns:

the processing unit proxy

setProcessingUnitProxy

protected void setProcessingUnitProxy(ProcessingUnitProxy processingUnitProxy)

Set the processing unit proxy

Parameters:

processingUnitProxy - the processing unit proxy

afterProcessUnit

protected boolean afterProcessUnit(boolean continueProcessing)

Before process unit method call

Parameters:

continueProcessing - the continue processing

Returns:

the continue processing

setProcessingUnitRunnableListener

protected void setProcessingUnitRunnableListener(IProcessingUnitRunnableListener processingUnitRunnableListener)

Set the processing unit runnable listener

Parameters:

processingUnitRunnableListener - the processing unit runnable listener

notifyProcessingUnitProgress

protected void notifyProcessingUnitProgress(com.github.toolarium.common.bandwidth.IBandwidthThrottling bandwidthThrottling)

Notify processing unit action status

Parameters:

bandwidthThrottling - the bandwidth throttling

notifyProcessingUnitState

protected void notifyProcessingUnitState(ProcessingActionStatus previousProcessingActionStatus,
                                         ProcessingActionStatus processingActionStatus)

Notify processing unit action status

Parameters:

previousProcessingActionStatus - the previous processing action status

processingActionStatus - the processing action status

getTimeDifferenceFormatter

protected com.github.toolarium.common.formatter.TimeDifferenceFormatter getTimeDifferenceFormatter()

Get the time difference formatter

Returns:

the time difference formatter

getProcessingUnitClass

protected java.lang.Class<? extends IProcessingUnit> getProcessingUnitClass()

Get the processing class

Returns:

the processing class