com.feedzai.commons.sql.abstraction.batch

Class AbstractBatch

java.lang.Object

com.feedzai.commons.sql.abstraction.batch.AbstractPdbBatch

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

All Implemented Interfaces:

PdbBatch, AutoCloseable, Runnable

Direct Known Subclasses:

DefaultBatch, DefaultBatch

public abstract class AbstractBatch
extends AbstractPdbBatch
implements Runnable, PdbBatch

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:

2.0.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 BatchListener	batchListener The listener for customized behavior when this batch succeeds or fails to persist data.
protected int	batchSize The batchSize.
protected long	batchTimeout The batch timeout.
protected LinkedList<BatchEntry>	buffer EntityEntry buffer.
protected org.slf4j.Logger	confidentialLogger The confidential logger.
protected DatabaseEngine	de The database engine.
static long	DEFAULT_RETRY_INTERVAL Constant representing the default time interval (milliseconds) to wait between batch flush retries.
protected static org.slf4j.Marker	dev The dev Marker.
protected long	flushRetryDelay The time interval (milliseconds) to wait between batch flush retries.
protected long	lastFlush Timestamp of the last flush.
protected static org.slf4j.Logger	logger The logger.
protected long	maxAwaitTimeShutdown The maximum await time to wait for the batch to shutdown.
protected int	maxFlushRetries The number of times to retry a batch flush upon failure.
protected String	name The name of the batch.
static int	NO_RETRY Constant representing that no retries should be attempted on batch flush failures.
protected static int	salt Salt to avoid erroneous flushes.
protected ScheduledExecutorService	scheduler The Timer that runs this task.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBatch(DatabaseEngine de, BatchConfig<?> config) Creates a new instance of AbstractBatch.
protected	AbstractBatch(DatabaseEngine de, int batchSize, long batchTimeout, long maxAwaitTimeShutdown) Deprecated. Use AbstractBatch(DatabaseEngine, BatchConfig) instead.
protected	AbstractBatch(DatabaseEngine de, String name, int batchSize, long batchTimeout, long maxAwaitTimeShutdown) Deprecated. Use AbstractBatch(DatabaseEngine, BatchConfig) instead.
protected	AbstractBatch(DatabaseEngine de, String name, int batchSize, long batchTimeout, long maxAwaitTimeShutdown, BatchListener batchListener) Deprecated. Use AbstractBatch(DatabaseEngine, BatchConfig) instead.
protected	AbstractBatch(DatabaseEngine de, String name, int batchSize, long batchTimeout, long maxAwaitTimeShutdown, BatchListener batchListener, int maxFlushRetries, long flushRetryDelay) Deprecated. Use AbstractBatch(DatabaseEngine, BatchConfig) instead.
protected	AbstractBatch(DatabaseEngine de, String name, int batchSize, long batchTimeout, long maxAwaitTimeShutdown, BatchListener batchListener, int maxFlushRetries, long flushRetryDelay, org.slf4j.Logger confidentialLogger) Deprecated. Use AbstractBatch(DatabaseEngine, BatchConfig) instead.
protected	AbstractBatch(DatabaseEngine de, String name, int batchSize, long batchTimeout, long maxAwaitTimeShutdown, FailureListener failureListener) Deprecated. Use AbstractBatch(DatabaseEngine, BatchConfig) instead.
protected	AbstractBatch(DatabaseEngine de, String name, int batchSize, long batchTimeout, long maxAwaitTimeShutdown, FailureListener failureListener, int maxFlushRetries, long flushRetryDelay) Deprecated. Use AbstractBatch(DatabaseEngine, BatchConfig) instead.

Method Summary

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	close()
static BatchListener	convertToBatchListener(FailureListener failureListener) Deprecated. The FailureListener is deprecated and this method will be removed once it is removed.
void	destroy() Destroys this batch.
void	flush() Flushes the pending batches.
void	flush(boolean sync) Flushes the pending messages.
void	onFlushFailure(BatchEntry[] entries) Notifies about the pending entries on flush failure.
void	onFlushSuccess(BatchEntry[] entries) Notifies about succeeded entries on flush success.
void	run()
protected void	start() Starts the timer task.

Methods inherited from class com.feedzai.commons.sql.abstraction.batch.AbstractPdbBatch

flushAsync, processBatch

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.feedzai.commons.sql.abstraction.batch.PdbBatch

flushAsync

Field Detail

logger

protected static final org.slf4j.Logger logger

The logger.

confidentialLogger

protected final org.slf4j.Logger confidentialLogger

The confidential logger.

NO_RETRY

public static final int NO_RETRY

Constant representing that no retries should be attempted on batch flush failures.

See Also:

Constant Field Values

DEFAULT_RETRY_INTERVAL

public static final long DEFAULT_RETRY_INTERVAL

Constant representing the default time interval (milliseconds) to wait between batch flush retries.

See Also:

Constant Field Values

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.

maxAwaitTimeShutdown

protected final long maxAwaitTimeShutdown

The maximum await time to wait for the batch to shutdown.

scheduler

protected ScheduledExecutorService scheduler

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 volatile long lastFlush

Timestamp of the last flush.

buffer

protected LinkedList<BatchEntry> buffer

EntityEntry buffer.

name

protected String name

The name of the batch.

batchListener

protected BatchListener batchListener

The listener for customized behavior when this batch succeeds or fails to persist data.

Since:

2.8.1

maxFlushRetries

protected final int maxFlushRetries

The number of times to retry a batch flush upon failure.

Defaults to 0.

flushRetryDelay

protected final long flushRetryDelay

The time interval (milliseconds) to wait between batch flush retries.

Defaults to 300L.

Constructor Detail

AbstractBatch

protected AbstractBatch(DatabaseEngine de,
                        BatchConfig<?> config)

Creates a new instance of AbstractBatch.

Parameters:

de - The database engine.

config - The batch configuration.

AbstractBatch

@Deprecated
protected AbstractBatch(DatabaseEngine de,
                                    String name,
                                    int batchSize,
                                    long batchTimeout,
                                    long maxAwaitTimeShutdown,
                                    @Nullable
                                    BatchListener batchListener,
                                    int maxFlushRetries,
                                    long flushRetryDelay,
                                    @Nullable
                                    org.slf4j.Logger confidentialLogger)

Deprecated. Use AbstractBatch(DatabaseEngine, BatchConfig) instead.

Creates a new instance of AbstractBatch with a BatchListener.

Parameters:

de - The database engine.

name - The batch name (null or empty names are allowed, falling back to "Anonymous Batch").

batchSize - The batch size.

batchTimeout - The batch timeout.

maxAwaitTimeShutdown - The maximum await time for the batch to shutdown.

batchListener - The listener that will be invoked whenever some batch operation fail or succeeds to persist.

maxFlushRetries - The number of times to retry a batch flush upon failure. When set to 0, no retries will be attempted.

flushRetryDelay - The time interval (milliseconds) to wait between batch flush retries.

confidentialLogger - The confidential logger.

Since:

2.8.8

AbstractBatch

@Deprecated
protected AbstractBatch(DatabaseEngine de,
                                    String name,
                                    int batchSize,
                                    long batchTimeout,
                                    long maxAwaitTimeShutdown,
                                    @Nullable
                                    BatchListener batchListener,
                                    int maxFlushRetries,
                                    long flushRetryDelay)

Deprecated. Use AbstractBatch(DatabaseEngine, BatchConfig) instead.

Creates a new instance of AbstractBatch with a BatchListener.

Parameters:

de - The database engine.

name - The batch name (null or empty names are allowed, falling back to "Anonymous Batch").

batchSize - The batch size.

batchTimeout - The batch timeout.

maxAwaitTimeShutdown - The maximum await time for the batch to shutdown.

batchListener - The listener that will be invoked whenever some batch operation fail or succeeds to persist.

maxFlushRetries - The number of times to retry a batch flush upon failure. When set to 0, no retries will be attempted.

flushRetryDelay - The time interval (milliseconds) to wait between batch flush retries.

Since:

2.8.1

AbstractBatch

@Deprecated
protected AbstractBatch(DatabaseEngine de,
                                    String name,
                                    int batchSize,
                                    long batchTimeout,
                                    long maxAwaitTimeShutdown,
                                    @Nullable
                                    BatchListener batchListener)

Deprecated. Use AbstractBatch(DatabaseEngine, BatchConfig) instead.

Creates a new instance of AbstractBatch with a BatchListener.

Parameters:

de - The database engine.

name - The batch name (null or empty names are allowed, falling back to "Anonymous Batch").

batchSize - The batch size.

batchTimeout - The batch timeout.

maxAwaitTimeShutdown - The maximum await time for the batch to shutdown.

batchListener - The listener that will be invoked whenever some batch operation fail or succeeds to persist.

Since:

2.8.1

AbstractBatch

@Deprecated
protected AbstractBatch(DatabaseEngine de,
                                    String name,
                                    int batchSize,
                                    long batchTimeout,
                                    long maxAwaitTimeShutdown,
                                    FailureListener failureListener,
                                    int maxFlushRetries,
                                    long flushRetryDelay)

Deprecated. Use AbstractBatch(DatabaseEngine, BatchConfig) instead.

Creates a new instance of AbstractBatch with a FailureListener.

Parameters:

de - The database engine.

name - The batch name (null or empty names are allowed, falling back to "Anonymous Batch").

batchSize - The batch size.

batchTimeout - The batch timeout.

maxAwaitTimeShutdown - The maximum await time for the batch to shutdown.

failureListener - The listener that will be invoked whenever some batch operation fail to persist.

maxFlushRetries - The number of times to retry a batch flush upon failure. When set to 0, no retries will be attempted.

flushRetryDelay - The time interval (milliseconds) to wait between batch flush retries.

Since:

2.1.12

AbstractBatch

@Deprecated
protected AbstractBatch(DatabaseEngine de,
                                    String name,
                                    int batchSize,
                                    long batchTimeout,
                                    long maxAwaitTimeShutdown,
                                    FailureListener failureListener)

Deprecated. Use AbstractBatch(DatabaseEngine, BatchConfig) instead.

Creates a new instance of AbstractBatch with a FailureListener.

Parameters:

de - The database engine.

name - The batch name (null or empty names are allowed, falling back to "Anonymous Batch").

batchSize - The batch size.

batchTimeout - The batch timeout.

maxAwaitTimeShutdown - The maximum await time for the batch to shutdown.

failureListener - The listener that will be invoked whenever some batch operation fail to persist.

Since:

2.1.11

AbstractBatch

@Deprecated
protected AbstractBatch(DatabaseEngine de,
                                    String name,
                                    int batchSize,
                                    long batchTimeout,
                                    long maxAwaitTimeShutdown)

Deprecated. Use AbstractBatch(DatabaseEngine, BatchConfig) instead.

Creates a new instance of AbstractBatch.

Parameters:

de - The database engine.

name - The batch name (null or empty names are allowed, falling back to "Anonymous Batch").

batchSize - The batch size.

batchTimeout - The batch timeout.

maxAwaitTimeShutdown - The maximum await time for the batch to shutdown.

AbstractBatch

@Deprecated
protected AbstractBatch(DatabaseEngine de,
                                    int batchSize,
                                    long batchTimeout,
                                    long maxAwaitTimeShutdown)

Deprecated. Use AbstractBatch(DatabaseEngine, BatchConfig) instead.

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.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

destroy

public void destroy()

Destroys this batch.

add

public void add(BatchEntry batchEntry)
         throws DatabaseEngineException

Adds the fields to the batch.

Specified by:

add in interface PdbBatch

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.

Specified by:

add in interface PdbBatch

Overrides:

add in class AbstractPdbBatch

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.

Specified by:

flush in interface PdbBatch

Implementation Requirements:

Same as flush(boolean) with false.

flush

public void flush(boolean sync)

Flushes the pending messages.

If sync is true it waits for other pending flush operations. If it is false it can return directly if the buffer in the batch is empty.

Parameters:

sync - true if it should wait for other flush operations (from here, or those started by calling flush()).

Since:

2.1.6

Implementation Note:

It is possible that two threads might execute in competing order and sync execution acquires the flushTransactionLock before a non synchronous one, leading to a non serial execution.

Since the flushes on the DB connection are also guarded by the same flushTransactionLock, the result is that if the batch is not empty, the thread calling this method will wait for an ongoing flush either before or after draining the batch buffer to a local temporary buffer (respectively, when sync is true or false). If the batch is empty, then the thread calling this method will either wait for an ongoing flush or it will return from the method, depending on whether sync is true or false, respectively.

onFlushFailure

public void onFlushFailure(BatchEntry[] entries)

Notifies about the pending entries on flush failure.

Parameters:

entries - The entries that are pending to be persisted.

onFlushSuccess

public void onFlushSuccess(BatchEntry[] entries)

Notifies about succeeded entries on flush success.

Parameters:

entries - The entries that were persisted.

Since:

2.8.1

run

public void run()

Specified by:

run in interface Runnable

convertToBatchListener

public static BatchListener convertToBatchListener(FailureListener failureListener)

Deprecated. The FailureListener is deprecated and this method will be removed once it is removed.

Converts a FailureListener to BatchListener.

Parameters:

failureListener - The FailureListener to be converted.

Returns:

A BatchListener that calls a FailureListener on failure.

Since:

2.8.1