io.debezium.embedded

Interface OffsetCommitPolicy

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
interface OffsetCommitPolicy

The policy that defines when the offsets should be committed to offset storage.

Author:

Randall Hauch

Method Summary

Modifier and Type	Method and Description
static OffsetCommitPolicy	always() Get an OffsetCommitPolicy that will commit offsets as frequently as possible.
default OffsetCommitPolicy	and(OffsetCommitPolicy other) Obtain a new OffsetCommitPolicy that will commit offsets if both this policy AND the other requests it.
default OffsetCommitPolicy	or(OffsetCommitPolicy other) Obtain a new OffsetCommitPolicy that will commit offsets if this policy OR the other requests it.
boolean	performCommit(long numberOfMessagesSinceLastCommit, long timeSinceLastCommit, TimeUnit timeUnit) Determine if a commit of the offsets should be performed.
static OffsetCommitPolicy	periodic(long minimumTime, TimeUnit timeUnit) Get an OffsetCommitPolicy that will commit offsets no more than the specified time period.

Method Detail

always

static OffsetCommitPolicy always()

Get an OffsetCommitPolicy that will commit offsets as frequently as possible. This may result in reduced performance, but it has the least potential for seeing source records more than once upon restart.

Returns:

the offset commit policy; never null

periodic

static OffsetCommitPolicy periodic(long minimumTime,
                                   TimeUnit timeUnit)

Get an OffsetCommitPolicy that will commit offsets no more than the specified time period. If the minimumTime is not positive, then this method returns always().

Parameters:

minimumTime - the minimum amount of time between committing offsets

timeUnit - the time unit for minimumTime; may not be null

Returns:

the offset commit policy; never null

performCommit

boolean performCommit(long numberOfMessagesSinceLastCommit,
                      long timeSinceLastCommit,
                      TimeUnit timeUnit)

Determine if a commit of the offsets should be performed.

Parameters:

numberOfMessagesSinceLastCommit - the number of messages that have been received from the connector since last the offsets were last committed; never negative

timeSinceLastCommit - the time that has elapsed since the offsets were last committed; never negative

timeUnit - the unit of time used for timeSinceLastCommit; never null

Returns:

true if the offsets should be committed, or false otherwise

or

default OffsetCommitPolicy or(OffsetCommitPolicy other)

Obtain a new OffsetCommitPolicy that will commit offsets if this policy OR the other requests it.

Parameters:

other - the other commit policy; if null, then this policy instance is returned as is

Returns:

the resulting policy; never null

and

default OffsetCommitPolicy and(OffsetCommitPolicy other)

Obtain a new OffsetCommitPolicy that will commit offsets if both this policy AND the other requests it.

Parameters:

other - the other commit policy; if null, then this policy instance is returned as is

Returns:

the resulting policy; never null