com.hof.mi.etl.runner

Interface ETLRunContext

All Known Implementing Classes:

AbstractETLRunContext, ETLBackgroundRunContext, ETLPreviewRunContext

public interface ETLRunContext

Context for an ETL job

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ETLRunContext.RunMode

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Executed for destroying the context.
java.lang.String	getClientReferenceId() Client Reference ID of the logged-in user.
int	getErrorThreshold() The number of rows which may be rejected because of errors, before the process fails.
ETLThreadManager	getETLThreadManager(int headCount) Return a Thread Manager to which tasks may be submitted.
java.lang.Integer	getIpOrg() Org of the logged-in user.
java.lang.Integer	getIpPerson() ID of the logged-in user.
java.lang.Thread	getMainThread() If the context has designated a Thread which will run the job from end to end, use this method to access it.
long	getMaxRowsPerStep() This is the max number of rows a step can emit along an output flow.
java.util.Map<java.lang.String,java.lang.String>	getProcessConfig() Get all configuration for an ETL Process as a map keyed by configKey and configValue.
java.lang.String	getRunFromStep() Get the UUID of the step from which the job should be run.
ETLRunContext.RunMode	getRunMode() Return the ETLRunContext.RunMode
java.lang.String	getRunStep() Get the UUID of the step which should be run.
java.lang.String	getRunTillStep() Get the UUID of the step till which the job should be run.
boolean	hasExceededErrorThreshold() True if the number of errors in this execution has exceeded the error threshold
void	incrementErrorCount() Increment by 1, the number of errors in the current execution.
void	setMainThread(java.lang.Thread mainThread) Designate a "main" thread.
void	setProcessConfig(java.util.Map<java.lang.String,java.lang.String> configMap) Set a map containing configuration for an ETL Process.

Method Detail

getRunTillStep

java.lang.String getRunTillStep()

Get the UUID of the step till which the job should be run. Use this to run everything up to and including this step, along this step's chain.

getRunFromStep

java.lang.String getRunFromStep()

Get the UUID of the step from which the job should be run. Use this to run everything including this step and beyond, along this step's chain.

getRunStep

java.lang.String getRunStep()

Get the UUID of the step which should be run. Use this to run the step using previously fetched data.

getRunMode

ETLRunContext.RunMode getRunMode()

Return the ETLRunContext.RunMode

getETLThreadManager

ETLThreadManager getETLThreadManager(int headCount)

Return a Thread Manager to which tasks may be submitted. If an implementation wants to restrict the number of threads based on the number of "head" steps, it may do so using the headCount param. Pass -1 to ignore.

destroy

void destroy()

Executed for destroying the context. Perform cleanup tasks here.

getMainThread

java.lang.Thread getMainThread()

If the context has designated a Thread which will run the job from end to end, use this method to access it. This thread will block till the job finishes.

setMainThread

void setMainThread(java.lang.Thread mainThread)

Designate a "main" thread.

See Also:

getMainThread()

getMaxRowsPerStep

long getMaxRowsPerStep()

This is the max number of rows a step can emit along an output flow. A value of -1 indicates that there's no limit.

getErrorThreshold

int getErrorThreshold()

The number of rows which may be rejected because of errors, before the process fails.

hasExceededErrorThreshold

boolean hasExceededErrorThreshold()

True if the number of errors in this execution has exceeded the error threshold

incrementErrorCount

void incrementErrorCount()

Increment by 1, the number of errors in the current execution.

getIpOrg

java.lang.Integer getIpOrg()

Org of the logged-in user.

getIpPerson

java.lang.Integer getIpPerson()

ID of the logged-in user.

getClientReferenceId

java.lang.String getClientReferenceId()

Client Reference ID of the logged-in user.

getProcessConfig

java.util.Map<java.lang.String,java.lang.String> getProcessConfig()

Get all configuration for an ETL Process as a map keyed by configKey and configValue.

setProcessConfig

void setProcessConfig(java.util.Map<java.lang.String,java.lang.String> configMap)

Set a map containing configuration for an ETL Process. Key: configKey; value: configValue