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

Class ProcessingUnitProxy

java.lang.Object

com.github.toolarium.processing.unit.runtime.runnable.ProcessingUnitProxy

All Implemented Interfaces:

IProcessingUnitProxy

public final class ProcessingUnitProxy
extends java.lang.Object
implements IProcessingUnitProxy

Implements the IProcessingUnitProxy.

Method Summary

Modifier and Type	Method	Description
long	getDuration()	Get the duration in milliseconds
IEmptyProcessingUnitHandler	getEmptyProcessingUnitHandler()	Get the empty processing unit handler
java.lang.String	getId()	Get the runnable id
java.lang.Long	getMaxNumberOfProcessingUnitCallsPerSecond()	Get the max number of processing unit calls per seconds
java.lang.String	getName()	Get the runnable name or null
java.util.List<ParameterDefinition>	getParameterDefinition()	Gets the parameter definition list of the processing.
java.util.List<Parameter>	getParameterList()	Get the processing parameter list.
ProcessingRuntimeStatus	getProcessingRuntimeStatus()	Get the processing runtime status
IProcessingUnit	getProcessingUnit()	Get the processing unit.
java.lang.Class<? extends IProcessingUnit>	getProcessingUnitClass()	Get the processing unit class.
IProcessingUnitContext	getProcessingUnitContext()	Get the processing unit context
IProcessingUnitProgress	getProcessingUnitProgress()	Gets the processing unit progress
java.time.Instant	getStartTimestamp()	Get the start time stamp
java.util.List<java.lang.String>	getStatusMessageList()	Get the status message list
static ProcessingUnitProxy	init(java.lang.String id, java.lang.String name, java.lang.Class<? extends IProcessingUnit> processingUnitClass, java.util.List<Parameter> parameterList, IProcessingUnitContext processingUnitContext)	Initialize a IProcessingUnit: Initialize the processing unit class Validate the input parameters against the parameter definition Calls on the IProcessingUnit instance initialize method
void	onAborting()	This method is called in case of an abort (status aborting) before the resources are released.
void	onEnding()	This method is called on ending after a successful end (status ending) before the resources are released.
boolean	processUnit()	Process unit: This method will be called until the IProcessingUnitStatus.hasNext() returns false or an exception occurs: RuntimeException will abort; ValidationException or ProcessingException depends on the value returned by the method abortProcessing.
void	releaseResource()	Release resources will be called to release all internal referenced resources after a processing success, error or by a suspendProcessing (see method below).
static ProcessingUnitProxy	resume(byte[] persisted)	Resume a IProcessingUnit: Initialize the processing unit class Validate the input parameters against the parameter definition Calls on the IProcessingUnit instance resumeProcessing method
void	setEmptyProcessingUnitHandler(IEmptyProcessingUnitHandler emptyProcessingUnitHandler)	Set the empty processing unit handler
boolean	setMaxNumberOfProcessingUnitCallsPerSecond(java.lang.Long maxNumberOfProcessingUnitCallsPerSecond)	Set the max number of processing unit calls per seconds
byte[]	suspendProcessing()	Suspends the processing: The processing is able to persist its state with the help of the IProcessingUnitPersistence object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

init

public static ProcessingUnitProxy init(java.lang.String id,
                                       java.lang.String name,
                                       java.lang.Class<? extends IProcessingUnit> processingUnitClass,
                                       java.util.List<Parameter> parameterList,
                                       IProcessingUnitContext processingUnitContext)
                                throws ValidationException,
                                       ProcessingException

Initialize a IProcessingUnit:

Initialize the processing unit class Validate the input parameters against the parameter definition Calls on the IProcessingUnit instance initialize method

Parameters:

id - the unique id of the processing

name - the name of the processing

processingUnitClass - the processing unit class

parameterList - the parameter list

processingUnitContext - the processing unit context

Returns:

the IProcessingUnitProxy

Throws:

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

ProcessingException - Throws this exception in case of initialization failures.

resume

public static ProcessingUnitProxy resume(byte[] persisted)
                                  throws ValidationException,
                                         ProcessingException

Resume a IProcessingUnit:

Initialize the processing unit class Validate the input parameters against the parameter definition Calls on the IProcessingUnit instance resumeProcessing method

Parameters:

persisted - the persisted processing unit to resume

Returns:

the IProcessingUnitProxy

Throws:

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

ProcessingException - Throws this exception in case of initialization failures.

getId

public java.lang.String getId()

Description copied from interface: IProcessingUnitProxy

Get the runnable id

Specified by:

getId in interface IProcessingUnitProxy

Returns:

the runnable id

See Also:

IProcessingUnitProxy.getId()

getName

public java.lang.String getName()

Description copied from interface: IProcessingUnitProxy

Get the runnable name or null

Specified by:

getName in interface IProcessingUnitProxy

Returns:

the name or null

See Also:

IProcessingUnitProxy.getName()

getParameterDefinition

public java.util.List<ParameterDefinition> getParameterDefinition()

Description copied from interface: IProcessingUnitProxy

Gets the parameter definition list of the processing.

Specified by:

getParameterDefinition in interface IProcessingUnitProxy

Returns:

the parameter definition list or null in case of no parameters

See Also:

IProcessingUnitProxy.getParameterDefinition()

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

processUnit

public boolean processUnit()

Description copied from interface: IProcessingUnitProxy

Process unit: This method will be called until the IProcessingUnitStatus.hasNext() returns false or an exception occurs: RuntimeException will abort; ValidationException or ProcessingException depends on the value returned by the method abortProcessing. Important: this method have to process the sequential or in a small block size.

Specified by:

processUnit in interface IProcessingUnitProxy

Returns:

true to continue the processing; otherwise false

See Also:

IProcessingUnitProxy.processUnit()

onEnding

public void onEnding()

Description copied from interface: IProcessingUnitProxy

This method is called on ending after a successful end (status ending) before the resources are released.

Specified by:

onEnding in interface IProcessingUnitProxy

See Also:

IProcessingUnitProxy.onEnding()

onAborting

public void onAborting()

Description copied from interface: IProcessingUnitProxy

This method is called in case of an abort (status aborting) before the resources are released.

Specified by:

onAborting in interface IProcessingUnitProxy

See Also:

IProcessingUnitProxy.onAborting()

suspendProcessing

public byte[] suspendProcessing()
                         throws ProcessingException

Description copied from interface: IProcessingUnitProxy

Suspends the processing: The processing is able to persist its state with the help of the IProcessingUnitPersistence object. On a resume this instance of the IProcessingUnitPersistence will be returned (see method below).

Specified by:

suspendProcessing in interface IProcessingUnitProxy

Returns:

the processing persistence which contains all information to resume processing later (see resumeProcessing).

Throws:

ProcessingException - Throws this exception in case of while suspend the processing any failures occurs.

See Also:

IProcessingUnitProxy.suspendProcessing()

releaseResource

public void releaseResource()
                     throws ProcessingException

Description copied from interface: IProcessingUnitProxy

Release resources will be called to release all internal referenced resources after a processing success, error or by a suspendProcessing (see method below). It will be called after IProcessingUnitProxy.onEnding() or IProcessingUnitProxy.onAborting().

Specified by:

releaseResource in interface IProcessingUnitProxy

Throws:

ProcessingException - Throws this exception in case of releasing failure.

See Also:

IProcessingUnitProxy.releaseResource()

getProcessingUnitProgress

public IProcessingUnitProgress getProcessingUnitProgress()

Description copied from interface: IProcessingUnitProxy

Gets the processing unit progress

Specified by:

getProcessingUnitProgress in interface IProcessingUnitProxy

Returns:

the processing unit progress

See Also:

IProcessingUnitProxy.getProcessingUnitProgress()

getProcessingRuntimeStatus

public ProcessingRuntimeStatus getProcessingRuntimeStatus()

Get the processing runtime status

Returns:

the processing runtime status

getStatusMessageList

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

Get the status message list

Returns:

the status message list

getStartTimestamp

public java.time.Instant getStartTimestamp()

Get the start time stamp

Returns:

the start time stamp

getDuration

public long getDuration()

Get the duration in milliseconds

Returns:

the duration in milliseconds

getMaxNumberOfProcessingUnitCallsPerSecond

public java.lang.Long getMaxNumberOfProcessingUnitCallsPerSecond()

Description copied from interface: IProcessingUnitProxy

Get the max number of processing unit calls per seconds

Specified by:

getMaxNumberOfProcessingUnitCallsPerSecond in interface IProcessingUnitProxy

Returns:

The max number of processing unit calls per seconds

See Also:

IProcessingUnitProxy.getMaxNumberOfProcessingUnitCallsPerSecond()

setMaxNumberOfProcessingUnitCallsPerSecond

public boolean setMaxNumberOfProcessingUnitCallsPerSecond(java.lang.Long maxNumberOfProcessingUnitCallsPerSecond)

Set the max number of processing unit calls per seconds

Parameters:

maxNumberOfProcessingUnitCallsPerSecond - The max number of processing unit calls per seconds

Returns:

true if the underlining IProcessingUnit implements it own throttling mechanism; otherwise false

getProcessingUnitClass

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

Get the processing unit class.

Returns:

the processing unit class

Throws:

ProcessingException - Throws this exception in case of initialization failures.

getProcessingUnit

public IProcessingUnit getProcessingUnit()

Get the processing unit.

Returns:

the processing unit

Throws:

ProcessingException - Throws this exception in case of initialization failures.

getParameterList

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

Get the processing parameter list.

Returns:

the processing parameter list

getProcessingUnitContext

public IProcessingUnitContext getProcessingUnitContext()

Get the processing unit context

Returns:

the processing unit context

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()