com.feedzai.commons.sql.abstraction.batch

Class AbstractBatchConfig<PB extends PdbBatch,SELF extends AbstractBatchConfig<PB,SELF>>

java.lang.Object

com.feedzai.commons.sql.abstraction.batch.AbstractBatchConfig<PB,SELF>

Type Parameters:

PB - The type of PdbBatch that this config class applies to.

SELF - The concrete type of concrete BatchConfig overriding this abstract class.

All Implemented Interfaces:

BatchConfig<PB>

Direct Known Subclasses:

DefaultBatchConfig, MultithreadedBatchConfig

public abstract class AbstractBatchConfig<PB extends PdbBatch,SELF extends AbstractBatchConfig<PB,SELF>>
extends Object
implements BatchConfig<PB>

Abstract configuration for PdbBatch implementations, containing common properties.

Author:

José Fidalgo (jose.fidalgo@feedzai.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractBatchConfig.Builder<PB extends PdbBatch,BC extends AbstractBatchConfig<PB,?>,SELF extends AbstractBatchConfig.Builder<PB,BC,SELF>> A builder for the AbstractBatchConfig.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BATCH_SIZE Constant representing the default batch size.
static Duration	DEFAULT_BATCH_TIMEOUT Constant representing the default batch timeout.
static Duration	DEFAULT_RETRY_INTERVAL Constant representing the default time interval to wait between batch flush retries.
String	defaultBatchName The default name of the batch, when a name isn't explicitly provided in the config builder.
static int	NO_RETRY Constant representing that no retries should be attempted on batch flush failures.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBatchConfig(AbstractBatchConfig.Builder<PB,SELF,?> builder) Constructor for this AbstractBatchConfig.

Method Summary

Modifier and Type	Method and Description
protected static void	checkArgument(boolean condition, String errorMessageFormat, Object errorMessageArg) Checks that configuration arguments pass the verification specified in the condition expression.
BatchListener	getBatchListener() The listener that will be invoked whenever some batch operation fail or succeeds to persist.
int	getBatchSize() Gets the size of the batch; when the number of pending entries reaches this number, the batch should flush.
Duration	getBatchTimeout() Gets the batch timeout.
Optional<org.slf4j.Logger>	getConfidentialLogger() Gets an optional logger to log messages potentially containing sensitive data.
Duration	getFlushRetryDelay() Gets the time interval to wait between batch flush retries.
Duration	getMaxAwaitTimeShutdown() Gets the maximum time to wait for the batch to shutdown.
int	getMaxFlushRetries() Gets the number of times to retry a batch flush upon failure.
MetricsListener	getMetricsListener() The listener that will be invoked whenever some measurable event occurs, so that it can be captured and reported in monitoring metrics.
String	getName() Gets the name to use for the batch.

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.BatchConfig

getBatchClass

Field Detail

defaultBatchName

public final String defaultBatchName

The default name of the batch, when a name isn't explicitly provided in the config builder.

DEFAULT_BATCH_SIZE

public static final int DEFAULT_BATCH_SIZE

Constant representing the default batch size.

See Also:

getBatchSize(), Constant Field Values

DEFAULT_BATCH_TIMEOUT

public static final Duration DEFAULT_BATCH_TIMEOUT

Constant representing the default batch timeout.

See Also:

getBatchTimeout()

NO_RETRY

public static final int NO_RETRY

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

See Also:

getMaxFlushRetries(), Constant Field Values

DEFAULT_RETRY_INTERVAL

public static final Duration DEFAULT_RETRY_INTERVAL

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

See Also:

getFlushRetryDelay()

Constructor Detail

AbstractBatchConfig

protected AbstractBatchConfig(AbstractBatchConfig.Builder<PB,SELF,?> builder)

Constructor for this AbstractBatchConfig.

Parameters:

builder - The AbstractBatchConfig.Builder for this config.

Method Detail

checkArgument

protected static void checkArgument(boolean condition,
                                    String errorMessageFormat,
                                    Object errorMessageArg)

Checks that configuration arguments pass the verification specified in the condition expression.

Parameters:

condition - A boolean expression for verification of the configuration arguments.

errorMessageFormat - An error message to include in the exception when the verification fails (supports String.format(java.lang.String, java.lang.Object...) parameters).

errorMessageArg - Arguments for the error message template specified in errorMessageFormat.

Throws:

IllegalArgumentException - if expression is false

getName

public String getName()

Description copied from interface: BatchConfig

Gets the name to use for the batch.

Specified by:

getName in interface BatchConfig<PB extends PdbBatch>

Returns:

The batch name.

getBatchSize

public int getBatchSize()

Description copied from interface: BatchConfig

Gets the size of the batch; when the number of pending entries reaches this number, the batch should flush.

Specified by:

getBatchSize in interface BatchConfig<PB extends PdbBatch>

Returns:

The batch size.

getBatchTimeout

public Duration getBatchTimeout()

Description copied from interface: BatchConfig

Gets the batch timeout.

Each time there aren't enough pending entries as specified in the BatchConfig.getBatchSize() to trigger a flush, then a flush should be triggered by timeout, when the time specified by this setting has elapsed since the last flush.

Specified by:

getBatchTimeout in interface BatchConfig<PB extends PdbBatch>

Returns:

The batch timeout.

getMaxAwaitTimeShutdown

public Duration getMaxAwaitTimeShutdown()

Description copied from interface: BatchConfig

Gets the maximum time to wait for the batch to shutdown.

Specified by:

getMaxAwaitTimeShutdown in interface BatchConfig<PB extends PdbBatch>

Returns:

The maximum await time for batch shutdown.

getMaxFlushRetries

public int getMaxFlushRetries()

Description copied from interface: BatchConfig

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

Specified by:

getMaxFlushRetries in interface BatchConfig<PB extends PdbBatch>

Returns:

The maximum number of batch flush retries.

getFlushRetryDelay

public Duration getFlushRetryDelay()

Description copied from interface: BatchConfig

Gets the time interval to wait between batch flush retries.

Specified by:

getFlushRetryDelay in interface BatchConfig<PB extends PdbBatch>

Returns:

The time delay between flush retries.

getBatchListener

public BatchListener getBatchListener()

Description copied from interface: BatchConfig

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

Specified by:

getBatchListener in interface BatchConfig<PB extends PdbBatch>

Returns:

The BatchListener.

getMetricsListener

public MetricsListener getMetricsListener()

Description copied from interface: BatchConfig

The listener that will be invoked whenever some measurable event occurs, so that it can be captured and reported in monitoring metrics.

Specified by:

getMetricsListener in interface BatchConfig<PB extends PdbBatch>

Returns:

The MetricsListener.

getConfidentialLogger

public Optional<org.slf4j.Logger> getConfidentialLogger()

Description copied from interface: BatchConfig

Gets an optional logger to log messages potentially containing sensitive data.

Specified by:

getConfidentialLogger in interface BatchConfig<PB extends PdbBatch>

Returns:

The Optional confidential logger.