Interface ResumeStrategy

All Superinterfaces:

AutoCloseable, Service

public interface ResumeStrategy
extends Service

Defines a strategy for handling resume operations. Implementations can define different ways to handle how to resume processing records.

Since:

3.17

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ResumeStrategy.UpdateCallBack	A callback that can be executed after the last offset is updated

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_NAME

Method Summary

Modifier and Type	Method	Description
ResumeAdapter	getAdapter()	Gets an adapter for resuming operations
default <T extends ResumeAdapter> T	getAdapter(Class<T> clazz)	Gets and adapter for resuming operations
ResumeStrategyConfiguration	getResumeStrategyConfiguration()	Gets the configuration for this resume strategy.
default void	loadCache()	Loads the cache with the data currently available in this strategy
void	setAdapter(ResumeAdapter adapter)	Sets an adapter for resuming operations with this strategy
void	setResumeStrategyConfiguration(ResumeStrategyConfiguration resumeStrategyConfiguration)	Sets the configuration for this resume strategy.
void	updateLastOffset(OffsetKey<?> offsetKey, Offset<?> offsetValue)	Updates the last processed offset
void	updateLastOffset(OffsetKey<?> offsetKey, Offset<?> offset, @Nullable ResumeStrategy.UpdateCallBack updateCallBack)	Updates the last processed offset
<T extends Resumable> void	updateLastOffset(T offset)	Updates the last processed offset
<T extends Resumable> void	updateLastOffset(T offset, @Nullable ResumeStrategy.UpdateCallBack updateCallBack)	Updates the last processed offset

Methods inherited from interface Service

build, close, init, start, stop

Field Details

DEFAULT_NAME

static final String DEFAULT_NAME

See Also:

• Constant Field Values

Method Details

setAdapter

void setAdapter(ResumeAdapter adapter)

Sets an adapter for resuming operations with this strategy

Parameters:

adapter - the component-specific resume adapter

getAdapter

ResumeAdapter getAdapter()

Gets an adapter for resuming operations

getAdapter

default <T extends ResumeAdapter> T getAdapter(Class<T> clazz)

Gets and adapter for resuming operations

Type Parameters:

T - the type of the adapter

Parameters:

clazz - the class of the adapter

Returns:

the adapter or null if it can't be cast to the requested class

loadCache

default void loadCache()
                throws Exception

Loads the cache with the data currently available in this strategy

Throws:

Exception

updateLastOffset

<T extends Resumable> void updateLastOffset(T offset)
                                     throws Exception

Updates the last processed offset

Parameters:

offset - the offset to update

Throws:

Exception - if unable to update the offset

updateLastOffset

<T extends Resumable> void updateLastOffset(T offset,
 @Nullable ResumeStrategy.UpdateCallBack updateCallBack)
                                     throws Exception

Updates the last processed offset

Parameters:

offset - the offset to update

updateCallBack - a callback to be executed after the updated has occurred (null if not available)

Throws:

Exception - if unable to update the offset

updateLastOffset

void updateLastOffset(OffsetKey<?> offsetKey,
 Offset<?> offsetValue)
               throws Exception

Updates the last processed offset

Parameters:

offsetKey - the offset key to update

offsetValue - the offset value to update

Throws:

Exception - if unable to update the offset

updateLastOffset

void updateLastOffset(OffsetKey<?> offsetKey,
 Offset<?> offset,
 @Nullable ResumeStrategy.UpdateCallBack updateCallBack)
               throws Exception

Updates the last processed offset

Parameters:

offsetKey - the offset key to update

offset - the offset value to update

updateCallBack - a callback to be executed after the updated has occurred (null if not available)

Throws:

Exception - if unable to update the offset

setResumeStrategyConfiguration

void setResumeStrategyConfiguration(ResumeStrategyConfiguration resumeStrategyConfiguration)

Sets the configuration for this resume strategy.

Parameters:

resumeStrategyConfiguration - the resume strategy configuration

getResumeStrategyConfiguration

ResumeStrategyConfiguration getResumeStrategyConfiguration()

Gets the configuration for this resume strategy.

Returns:

the resume strategy configuration