com.feedzai.commons.sql.abstraction.batch

Class AbstractBatch

java.lang.Object

java.util.TimerTask

com.feedzai.commons.sql.abstraction.batch.AbstractBatch

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

DefaultBatch

public abstract class AbstractBatch
extends TimerTask

A Batch that periodically flushes pending insertions to the database.

Extending classes that want to be notified when a flush could not be performed after the timeout has been reached, must override the onFlushFailure(BatchEntry[]).

Since:

13.1.0

Author:

Rui Vilao (rui.vilao@feedzai.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected int	batch The batch at the present moment.
protected int	batchSize The batchSize.
protected long	batchTimeout The batch timeout.
protected LinkedList<BatchEntry>	buffer EntityEntry buffer.
protected DatabaseEngine	de The database engine.
protected static org.slf4j.Marker	dev The dev Marker.
protected long	lastFlush Timestamp of the last flush.
protected org.slf4j.Logger	logger The logger.
protected static int	salt Salt to avoid erroneous flushes.
protected Timer	timer The Timer that runs this task.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBatch(DatabaseEngine de, int batchSize, long batchTimeout) Creates a new instance of AbstractBatch.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(BatchEntry batchEntry) Adds the fields to the batch.
void	add(String entityName, EntityEntry ee) Adds the fields to the batch.
void	destroy() Destroys this batch.
void	finalize()
void	flush() Flushes the pending batches.
void	onFlushFailure(BatchEntry[] entries) Notifies about the pending entries on flush failure.
void	run()
protected void	start() Starts the timer task.

Methods inherited from class java.util.TimerTask

cancel, scheduledExecutionTime

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

The logger.

dev

protected static final org.slf4j.Marker dev

The dev Marker.

salt

protected static final int salt

Salt to avoid erroneous flushes.

See Also:

Constant Field Values

de

protected final DatabaseEngine de

The database engine.

timer

protected final Timer timer

The Timer that runs this task.

batchSize

protected final int batchSize

The batchSize.

batchTimeout

protected final long batchTimeout

The batch timeout.

batch

protected int batch

The batch at the present moment.

lastFlush

protected long lastFlush

Timestamp of the last flush.

buffer

protected LinkedList<BatchEntry> buffer

EntityEntry buffer.

Constructor Detail

AbstractBatch

protected AbstractBatch(DatabaseEngine de,
             int batchSize,
             long batchTimeout)

Creates a new instance of AbstractBatch.

Parameters:

de - The database engine.

batchSize - The batch size.

batchTimeout - The batch timeout.

Method Detail

start

protected void start()

Starts the timer task.

destroy

public void destroy()

Destroys this batch.

add

public void add(BatchEntry batchEntry)
         throws DatabaseEngineException

Adds the fields to the batch.

Parameters:

batchEntry - The batch entry.

Throws:

DatabaseEngineException - If an error with the database occurs.

add

public void add(String entityName,
       EntityEntry ee)
         throws DatabaseEngineException

Adds the fields to the batch.

Parameters:

entityName - The table name.

ee - The entity entry.

Throws:

DatabaseEngineException - If an error with the database occurs.

flush

public void flush()

Flushes the pending batches.

onFlushFailure

public void onFlushFailure(BatchEntry[] entries)

Notifies about the pending entries on flush failure.

Parameters:

entries - The entries that are pending to be persisted.

run

public void run()

Specified by:

run in interface Runnable

Specified by:

run in class TimerTask

finalize

public void finalize()
              throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable