Skip navigation links

com.sigmadynamics.sdo.support
Class BatchJobBase<T extends com.sigmadynamics.batch.InputRow>

java.lang.Object
com.sigmadynamics.sdo.support.BatchJobBase<T>

All Implemented Interfaces:

com.sigmadynamics.batch.BatchJob<T>

public abstract class BatchJobBase<T extends com.sigmadynamics.batch.InputRow>

extends java.lang.Object

implements com.sigmadynamics.batch.BatchJob<T>

Field Summary

protected com.sigmadynamics.batch.BatchAgent	agent
protected java.lang.String	batchID
protected java.lang.String	batchName
protected int	errorCountsFatalThreshold
protected static InlineServiceLogger	logger
static java.lang.String	PARAM_ERROR_COUNTS_FATAL_THESHOLD
static java.lang.String	PARAM_ROWS_BETWEEN_FLUSH_OUTPUTS
static java.lang.String	PARAM_ROWS_BETWEEN_STATUS_UPDATES
static java.util.Properties	paramDefaults
static java.util.Properties	paramDescriptions
protected int	restartCount
protected int	rowsBetweenFlushOutputs
protected int	rowsBetweenStatusUpdates
protected BatchRequest	startParameters

Constructor Summary

BatchJobBase()

Method Summary

com.sigmadynamics.batch.BatchAgent	getAgent()
java.lang.String	getBatchID()
java.lang.String	getBatchName()
java.util.Properties	getDefaultPropertyValues() This is used by BatchJobBase at runtime to access the Properties object containing default values for its properties.
int	getErrorsCountFatalThreshold() Return how many non-fatal errors can be tolerated before the batch job should be terminated.
protected InlineServiceLogger	getLogger()
int	getRestartCount()
int	getRowsBetweenFlushOutputs() Return how many InputRows to process between calling the BatchJob's flushOutputs method.
int	getRowsBetweenStatusUpdates() Return how many rows to process between reporting status updates to the batch manager.
void	init(com.sigmadynamics.batch.BatchAgent agent, java.lang.String batchName, java.lang.String batchID, int restartCount, BatchRequest startParameters) Subclasses should call super.init().
void	logDebug(java.lang.String msg)
void	logDebug(java.lang.String msg, java.lang.Object[] args)
void	logDebug(java.lang.String msg, java.lang.Object[] args, java.lang.Throwable t)
void	logDebug(java.lang.String msg, java.lang.Throwable t)
void	logError(java.lang.String msg)
void	logError(java.lang.String msg, java.lang.Object[] args)
void	logError(java.lang.String msg, java.lang.Object[] args, java.lang.Throwable t)
void	logError(java.lang.String key, java.lang.String msg)
void	logError(java.lang.String key, java.lang.String msg, java.lang.Object[] args)
void	logError(java.lang.String key, java.lang.String msg, java.lang.Object[] args, java.lang.Throwable t)
void	logError(java.lang.String key, java.lang.String msg, java.lang.Throwable t)
void	logError(java.lang.String msg, java.lang.Throwable t)
void	logError(java.lang.Throwable t)
void	logInfo(java.lang.String msg)
void	logInfo(java.lang.String msg, java.lang.Object[] args)
void	logInfo(java.lang.String msg, java.lang.Object[] args, java.lang.Throwable t)
void	logInfo(java.lang.String key, java.lang.String msg)
void	logInfo(java.lang.String key, java.lang.String msg, java.lang.Object[] args)
void	logInfo(java.lang.String key, java.lang.String msg, java.lang.Object[] args, java.lang.Throwable t)
void	logInfo(java.lang.String key, java.lang.String msg, java.lang.Throwable t)
void	logInfo(java.lang.String msg, java.lang.Throwable t)
void	logTrace(java.lang.String msg)
void	logTrace(java.lang.String msg, SDOInterface sdo)
void	logTrace(java.lang.String key, java.lang.String msg, java.lang.Object[] args)
void	logTrace(java.lang.String key, java.lang.String msg, java.lang.Object[] args, SDOInterface sdo)
void	logWarning(java.lang.String msg)
void	logWarning(java.lang.String msg, java.lang.Object[] args)
void	logWarning(java.lang.String msg, java.lang.Object[] args, java.lang.Throwable t)
void	logWarning(java.lang.String key, java.lang.String msg)
void	logWarning(java.lang.String key, java.lang.String msg, java.lang.Object[] args)
void	logWarning(java.lang.String key, java.lang.String msg, java.lang.Object[] args, java.lang.Throwable t)
void	logWarning(java.lang.String key, java.lang.String msg, java.lang.Throwable t)
void	logWarning(java.lang.String msg, java.lang.Throwable t)
protected void	setLogger(InlineServiceLogger logger)
boolean	shouldCountSessionCloseErrors()
boolean	traceEnabled()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static InlineServiceLogger logger

PARAM_ERROR_COUNTS_FATAL_THESHOLD

public static final java.lang.String PARAM_ERROR_COUNTS_FATAL_THESHOLD

See Also:

Constant Field Values

PARAM_ROWS_BETWEEN_STATUS_UPDATES

public static final java.lang.String PARAM_ROWS_BETWEEN_STATUS_UPDATES

See Also:

Constant Field Values

PARAM_ROWS_BETWEEN_FLUSH_OUTPUTS

public static final java.lang.String PARAM_ROWS_BETWEEN_FLUSH_OUTPUTS

See Also:

Constant Field Values

agent

protected com.sigmadynamics.batch.BatchAgent agent

batchName

protected java.lang.String batchName

batchID

protected java.lang.String batchID

restartCount

protected int restartCount

startParameters

protected BatchRequest startParameters

errorCountsFatalThreshold

protected int errorCountsFatalThreshold

rowsBetweenStatusUpdates

protected int rowsBetweenStatusUpdates

rowsBetweenFlushOutputs

protected int rowsBetweenFlushOutputs

paramDefaults

public static java.util.Properties paramDefaults

paramDescriptions

public static java.util.Properties paramDescriptions

Constructor Detail

BatchJobBase

public BatchJobBase()

Method Detail

init

public void init(com.sigmadynamics.batch.BatchAgent agent,
                 java.lang.String batchName,
                 java.lang.String batchID,
                 int restartCount,
                 BatchRequest startParameters)

Subclasses should call super.init().

getDefaultPropertyValues

public java.util.Properties getDefaultPropertyValues()

This is used by BatchJobBase at runtime to access the Properties object containing default values for its properties.

If a subclass wants to change the default values of any properties used by the base class, it should clone the base class's paramDefaults member, change the relevant values, and then override this method to return the cloned properties object to the base class. This allows multiple subclasses to have different default values for the same property name.

getAgent

public com.sigmadynamics.batch.BatchAgent getAgent()

getBatchName

public java.lang.String getBatchName()

getBatchID

public java.lang.String getBatchID()

getRestartCount

public int getRestartCount()

getErrorsCountFatalThreshold

public int getErrorsCountFatalThreshold()

Return how many non-fatal errors can be tolerated before the batch job should be terminated.

Returning 0 indicates the job should not be terminated for any number of non-fatal errors.

getRowsBetweenStatusUpdates

public int getRowsBetweenStatusUpdates()

Return how many rows to process between reporting status updates to the batch manager.

Returning 0 indicates the job should not report status updates until it is finished.

getRowsBetweenFlushOutputs

public int getRowsBetweenFlushOutputs()

Return how many InputRows to process between calling the BatchJob's flushOutputs method.

Returning 0 indicates the BatchJob's flushOutputs method will be called only after the batch job finishes -- just before calling BatchJob.cleanup, unless BatchJob.getRowsBetweenStatusUpdates returns a positive number. If BatchJob.getRowsBetweenStatusUpdates returns a positive number, BatchJob.fluserhOutputs will also be called each time the BatchManager's status is updated.

logDebug

public void logDebug(java.lang.String msg,
                     java.lang.Object[] args,
                     java.lang.Throwable t)

Parameters:

msg -

args -

t -

See Also:

InlineServiceLogger.logDebug(java.lang.String, java.lang.Object[], java.lang.Throwable)

logDebug

public void logDebug(java.lang.String msg,
                     java.lang.Object[] args)

Parameters:

msg -

args -

See Also:

InlineServiceLogger.logDebug(java.lang.String, java.lang.Object[])

logDebug

public void logDebug(java.lang.String msg,
                     java.lang.Throwable t)

Parameters:

msg -

t -

See Also:

InlineServiceLogger.logDebug(java.lang.String, java.lang.Throwable)

logDebug

public void logDebug(java.lang.String msg)

Parameters:

msg -

See Also:

InlineServiceLogger.logDebug(java.lang.String)

logError

public void logError(java.lang.String msg,
                     java.lang.Object[] args,
                     java.lang.Throwable t)

Parameters:

msg -

args -

t -

See Also:

InlineServiceLogger.logError(java.lang.String, java.lang.Object[], java.lang.Throwable)

logError

public void logError(java.lang.String msg,
                     java.lang.Object[] args)

Parameters:

msg -

args -

See Also:

InlineServiceLogger.logError(java.lang.String, java.lang.Object[])

logError

public void logError(java.lang.String key,
                     java.lang.String msg,
                     java.lang.Object[] args,
                     java.lang.Throwable t)

Parameters:

key -

msg -

args -

t -

See Also:

InlineServiceLogger.logError(java.lang.String, java.lang.String, java.lang.Object[], java.lang.Throwable)

logError

public void logError(java.lang.String key,
                     java.lang.String msg,
                     java.lang.Object[] args)

Parameters:

key -

msg -

args -

See Also:

InlineServiceLogger.logError(java.lang.String, java.lang.String, java.lang.Object[])

logError

public void logError(java.lang.String key,
                     java.lang.String msg,
                     java.lang.Throwable t)

Parameters:

key -

msg -

t -

See Also:

InlineServiceLogger.logError(java.lang.String, java.lang.String, java.lang.Throwable)

logError

public void logError(java.lang.String key,
                     java.lang.String msg)

Parameters:

key -

msg -

See Also:

InlineServiceLogger.logError(java.lang.String, java.lang.String)

logError

public void logError(java.lang.String msg,
                     java.lang.Throwable t)

Parameters:

msg -

t -

See Also:

InlineServiceLogger.logError(java.lang.String, java.lang.Throwable)

logError

public void logError(java.lang.String msg)

Parameters:

msg -

See Also:

InlineServiceLogger.logError(java.lang.String)

logError

public void logError(java.lang.Throwable t)

Parameters:

t -

See Also:

InlineServiceLogger.logError(java.lang.Throwable)

logInfo

public void logInfo(java.lang.String msg,
                    java.lang.Object[] args,
                    java.lang.Throwable t)

Parameters:

msg -

args -

t -

See Also:

InlineServiceLogger.logInfo(java.lang.String, java.lang.Object[], java.lang.Throwable)

logInfo

public void logInfo(java.lang.String msg,
                    java.lang.Object[] args)

Parameters:

msg -

args -

See Also:

InlineServiceLogger.logInfo(java.lang.String, java.lang.Object[])

logInfo

public void logInfo(java.lang.String key,
                    java.lang.String msg,
                    java.lang.Object[] args,
                    java.lang.Throwable t)

Parameters:

key -

msg -

args -

t -

See Also:

InlineServiceLogger.logInfo(java.lang.String, java.lang.String, java.lang.Object[], java.lang.Throwable)

logInfo

public void logInfo(java.lang.String key,
                    java.lang.String msg,
                    java.lang.Object[] args)

Parameters:

key -

msg -

args -

See Also:

InlineServiceLogger.logInfo(java.lang.String, java.lang.String, java.lang.Object[])

logInfo

public void logInfo(java.lang.String key,
                    java.lang.String msg,
                    java.lang.Throwable t)

Parameters:

key -

msg -

t -

See Also:

InlineServiceLogger.logInfo(java.lang.String, java.lang.String, java.lang.Throwable)

logInfo

public void logInfo(java.lang.String key,
                    java.lang.String msg)

Parameters:

key -

msg -

See Also:

InlineServiceLogger.logInfo(java.lang.String, java.lang.String)

logInfo

public void logInfo(java.lang.String msg,
                    java.lang.Throwable t)

Parameters:

msg -

t -

See Also:

InlineServiceLogger.logInfo(java.lang.String, java.lang.Throwable)

logInfo

public void logInfo(java.lang.String msg)

Parameters:

msg -

See Also:

InlineServiceLogger.logInfo(java.lang.String)

logTrace

public void logTrace(java.lang.String msg,
                     SDOInterface sdo)

Parameters:

msg -

sdo -

See Also:

InlineServiceLogger.logTrace(java.lang.String, com.sigmadynamics.sdo.interfaces.client.SDOInterface)

logTrace

public void logTrace(java.lang.String key,
                     java.lang.String msg,
                     java.lang.Object[] args,
                     SDOInterface sdo)

Parameters:

key -

msg -

args -

sdo -

See Also:

InlineServiceLogger.logTrace(java.lang.String, java.lang.String, java.lang.Object[], com.sigmadynamics.sdo.interfaces.client.SDOInterface)

logTrace

public void logTrace(java.lang.String key,
                     java.lang.String msg,
                     java.lang.Object[] args)

Parameters:

key -

msg -

args -

See Also:

InlineServiceLogger.logTrace(java.lang.String, java.lang.String, java.lang.Object[])

logTrace

public void logTrace(java.lang.String msg)

Parameters:

msg -

See Also:

InlineServiceLogger.logTrace(java.lang.String)

logWarning

public void logWarning(java.lang.String msg,
                       java.lang.Object[] args,
                       java.lang.Throwable t)

Parameters:

msg -

args -

t -

See Also:

InlineServiceLogger.logWarning(java.lang.String, java.lang.Object[], java.lang.Throwable)

logWarning

public void logWarning(java.lang.String msg,
                       java.lang.Object[] args)

Parameters:

msg -

args -

See Also:

InlineServiceLogger.logWarning(java.lang.String, java.lang.Object[])

logWarning

public void logWarning(java.lang.String key,
                       java.lang.String msg,
                       java.lang.Object[] args,
                       java.lang.Throwable t)

Parameters:

key -

msg -

args -

t -

See Also:

InlineServiceLogger.logWarning(java.lang.String, java.lang.String, java.lang.Object[], java.lang.Throwable)

logWarning

public void logWarning(java.lang.String key,
                       java.lang.String msg,
                       java.lang.Object[] args)

Parameters:

key -

msg -

args -

See Also:

InlineServiceLogger.logWarning(java.lang.String, java.lang.String, java.lang.Object[])

logWarning

public void logWarning(java.lang.String key,
                       java.lang.String msg,
                       java.lang.Throwable t)

Parameters:

key -

msg -

t -

See Also:

InlineServiceLogger.logWarning(java.lang.String, java.lang.String, java.lang.Throwable)

logWarning

public void logWarning(java.lang.String key,
                       java.lang.String msg)

Parameters:

key -

msg -

See Also:

InlineServiceLogger.logWarning(java.lang.String, java.lang.String)

logWarning

public void logWarning(java.lang.String msg,
                       java.lang.Throwable t)

Parameters:

msg -

t -

See Also:

InlineServiceLogger.logWarning(java.lang.String, java.lang.Throwable)

logWarning

public void logWarning(java.lang.String msg)

Parameters:

msg -

See Also:

InlineServiceLogger.logWarning(java.lang.String)

traceEnabled

public boolean traceEnabled()

See Also:

InlineServiceLogger.traceEnabled()

getLogger

protected InlineServiceLogger getLogger()

setLogger

protected void setLogger(InlineServiceLogger logger)

shouldCountSessionCloseErrors

public boolean shouldCountSessionCloseErrors()

Skip navigation links