com.feedzai.commons.sql.abstraction.batch

Interface BatchConfig<C extends PdbBatch>

Type Parameters:

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

All Known Implementing Classes:

AbstractBatchConfig, DefaultBatchConfig, MultithreadedBatchConfig

public interface BatchConfig<C extends PdbBatch>

Interface specifying a configuration for a PdbBatch.

Author:

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

Method Summary

Modifier and Type	Method and Description
Class<C>	getBatchClass() Gets the concrete class of the PdbBatch implementation that this config belongs to.
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.

Method Detail

getBatchClass

@Nonnull
Class<C> getBatchClass()

Gets the concrete class of the PdbBatch implementation that this config belongs to.

Returns:

The batch class.

getName

@Nonnull
String getName()

Gets the name to use for the batch.

Returns:

The batch name.

getBatchSize

int getBatchSize()

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

Returns:

The batch size.

getBatchTimeout

@Nonnull
Duration getBatchTimeout()

Gets the batch timeout.

Each time there aren't enough pending entries as specified in the 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.

Returns:

The batch timeout.

getMaxAwaitTimeShutdown

@Nullable
Duration getMaxAwaitTimeShutdown()

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

Returns:

The maximum await time for batch shutdown.

Implementation Note:

This can be null, in which case the batch implementation should use the value specified in the PDB property PdbProperties.MAXIMUM_TIME_BATCH_SHUTDOWN.

getMaxFlushRetries

int getMaxFlushRetries()

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

Returns:

The maximum number of batch flush retries.

getFlushRetryDelay

@Nonnull
Duration getFlushRetryDelay()

Gets the time interval to wait between batch flush retries.

Returns:

The time delay between flush retries.

getBatchListener

@Nonnull
BatchListener getBatchListener()

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

Returns:

The BatchListener.

getMetricsListener

@Nonnull
MetricsListener getMetricsListener()

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

Returns:

The MetricsListener.

getConfidentialLogger

@Nonnull
Optional<org.slf4j.Logger> getConfidentialLogger()

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

Returns:

The Optional confidential logger.