com.feedzai.commons.sql.abstraction.batch

Class DefaultBatch

java.lang.Object

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

com.feedzai.commons.sql.abstraction.batch.DefaultBatch

All Implemented Interfaces:

Runnable

public class DefaultBatch
extends AbstractBatch

The default batch implementation.

Behind the scenes, it will periodically flush pending statements. It has auto recovery and will never thrown any exception.

Since:

2.0.0

Author:

Rui Vilao (rui.vilao@feedzai.com)

See Also:

AbstractBatch

Field Summary

Fields inherited from class com.feedzai.commons.sql.abstraction.batch.AbstractBatch

batch, batchListener, batchSize, batchTimeout, buffer, de, DEFAULT_RETRY_INTERVAL, dev, flushRetryDelay, lastFlush, logger, maxAwaitTimeShutdown, maxFlushRetries, name, NO_RETRY, salt, scheduler

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultBatch(DatabaseEngine de, String name, int batchSize, long batchTimeout, long maxAwaitTimeShutdown) Creates a new instance of DefaultBatch.
protected	DefaultBatch(DatabaseEngine de, String name, int batchSize, long batchTimeout, long maxAwaitTimeShutdown, BatchListener listener) Creates a new instance of DefaultBatch.
protected	DefaultBatch(DatabaseEngine de, String name, int batchSize, long batchTimeout, long maxAwaitTimeShutdown, BatchListener listener, int maxFlushRetries, long flushRetryDelay) Creates a new instance of DefaultBatch.

Method Summary

Modifier and Type	Method and Description
static DefaultBatch	create(DatabaseEngine de, String name, int batchSize, long batchTimeout, long maxAwaitTimeShutdown) Creates a new instance of DefaultBatch.
static DefaultBatch	create(DatabaseEngine de, String name, int batchSize, long batchTimeout, long maxAwaitTimeShutdown, BatchListener listener) Creates a new instance of DefaultBatch with a BatchListener.
static DefaultBatch	create(DatabaseEngine de, String name, int batchSize, long batchTimeout, long maxAwaitTimeShutdown, BatchListener listener, int maxFlushRetries, long flushRetryDelay) Creates a new instance of DefaultBatch with a BatchListener.
static DefaultBatch	create(DatabaseEngine de, String name, int batchSize, long batchTimeout, long maxAwaitTimeShutdown, FailureListener listener) Deprecated. Use create(DatabaseEngine, String, int, long, long, BatchListener) instead.
static DefaultBatch	create(DatabaseEngine de, String name, int batchSize, long batchTimeout, long maxAwaitTimeShutdown, FailureListener listener, int maxFlushRetries, long flushRetryDelay) Deprecated. Use create(DatabaseEngine, String, int, long, long, BatchListener, int, long) intead.

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

add, add, convertToBatchListener, destroy, flush, flush, onFlushFailure, onFlushSuccess, run, start

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBatch

protected DefaultBatch(DatabaseEngine de,
                       String name,
                       int batchSize,
                       long batchTimeout,
                       long maxAwaitTimeShutdown)

Creates a new instance of DefaultBatch.

Parameters:

de - The database engine reference.

name - The batch name.

batchSize - The batch size.

batchTimeout - The timeout.

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

DefaultBatch

protected DefaultBatch(DatabaseEngine de,
                       String name,
                       int batchSize,
                       long batchTimeout,
                       long maxAwaitTimeShutdown,
                       BatchListener listener)

Creates a new instance of DefaultBatch.

Parameters:

de - The database engine reference.

name - The batch name.

batchSize - The batch size.

batchTimeout - The timeout.

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

listener - The listener that will be invoked when batch fails or succeeds to persist at least one data row.

DefaultBatch

protected DefaultBatch(DatabaseEngine de,
                       String name,
                       int batchSize,
                       long batchTimeout,
                       long maxAwaitTimeShutdown,
                       BatchListener listener,
                       int maxFlushRetries,
                       long flushRetryDelay)

Creates a new instance of DefaultBatch.

Parameters:

de - The database engine reference.

name - The batch name.

batchSize - The batch size.

batchTimeout - The timeout.

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

listener - The listener that will be invoked when batch fails or succeeds to persist at least one data row.

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

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

Since:

2.1.12

Method Detail

create

public static DefaultBatch create(DatabaseEngine de,
                                  String name,
                                  int batchSize,
                                  long batchTimeout,
                                  long maxAwaitTimeShutdown)

Creates a new instance of DefaultBatch.

Starts the timertask.

Parameters:

de - The database engine.

name - The batch name.

batchSize - The batch size.

batchTimeout - The batch timeout.

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

Returns:

The Batch.

create

@Deprecated
public static DefaultBatch create(DatabaseEngine de,
                                              String name,
                                              int batchSize,
                                              long batchTimeout,
                                              long maxAwaitTimeShutdown,
                                              FailureListener listener)

Deprecated. Use create(DatabaseEngine, String, int, long, long, BatchListener) instead.

Creates a new instance of DefaultBatch with a FailureListener.

Starts the timertask.

Parameters:

de - The database engine.

name - The batch name.

batchSize - The batch size.

batchTimeout - The batch timeout.

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

listener - The listener that will be invoked when batch fails to persist at least one data row.

Returns:

The Batch.

Since:

2.1.11

create

@Deprecated
public static DefaultBatch create(DatabaseEngine de,
                                              String name,
                                              int batchSize,
                                              long batchTimeout,
                                              long maxAwaitTimeShutdown,
                                              FailureListener listener,
                                              int maxFlushRetries,
                                              long flushRetryDelay)

Deprecated. Use create(DatabaseEngine, String, int, long, long, BatchListener, int, long) intead.

Creates a new instance of DefaultBatch with a FailureListener.

Starts the timertask.

Parameters:

de - The database engine.

name - The batch name.

batchSize - The batch size.

batchTimeout - The batch timeout.

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

listener - The listener that will be invoked when batch fails to persist at least one data row.

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

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

Returns:

The Batch.

Since:

2.1.12

create

public static DefaultBatch create(DatabaseEngine de,
                                  String name,
                                  int batchSize,
                                  long batchTimeout,
                                  long maxAwaitTimeShutdown,
                                  BatchListener listener)

Creates a new instance of DefaultBatch with a BatchListener.

Starts the timertask.

Parameters:

de - The database engine.

name - The batch name.

batchSize - The batch size.

batchTimeout - The batch timeout.

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

listener - The listener that will be invoked when batch fails to persist at least one data row.

Returns:

The Batch.

Since:

2.8.1

create

public static DefaultBatch create(DatabaseEngine de,
                                  String name,
                                  int batchSize,
                                  long batchTimeout,
                                  long maxAwaitTimeShutdown,
                                  BatchListener listener,
                                  int maxFlushRetries,
                                  long flushRetryDelay)

Creates a new instance of DefaultBatch with a BatchListener.

Starts the timertask.

Parameters:

de - The database engine.

name - The batch name.

batchSize - The batch size.

batchTimeout - The batch timeout.

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

listener - The listener that will be invoked when batch fails to persist at least one data row.

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

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

Returns:

The Batch.

Since:

2.8.1