org.springframework.integration.x.kafka

Class WindowingOffsetManager

java.lang.Object

org.springframework.integration.x.kafka.WindowingOffsetManager

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.integration.kafka.listener.OffsetManager

public class WindowingOffsetManager
extends java.lang.Object
implements org.springframework.integration.kafka.listener.OffsetManager, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

An OffsetManager that aggregates writes over a time or count window, using an underlying delegate to do the actual operations. Its purpose is to reduce the performance impact of writing operations wherever this is desirable. Either a time window or a number of writes can be specified, but not both.

Author:

Marius Bogoevici

Constructor Summary

Constructors

Constructor and Description
WindowingOffsetManager(org.springframework.integration.kafka.listener.OffsetManager offsetManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	close()
void	deleteOffset(org.springframework.integration.kafka.core.Partition partition)
void	destroy()
void	flush()
long	getOffset(org.springframework.integration.kafka.core.Partition partition)
void	resetOffsets(java.util.Collection<org.springframework.integration.kafka.core.Partition> partition)
void	setCount(int count) How many writes should be aggregated, before invoking the underlying OffsetManager.
void	setShutdownTimeout(int shutdownTimeout) The timeout that close() and destroy() operations will wait for receving a confirmation that the underlying writes have been processed.
void	setTimespan(long timespan) The timespan for aggregating write operations, before invoking the underlying OffsetManager.
void	updateOffset(org.springframework.integration.kafka.core.Partition partition, long offset)

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowingOffsetManager

public WindowingOffsetManager(org.springframework.integration.kafka.listener.OffsetManager offsetManager)

Method Detail

setTimespan

public void setTimespan(long timespan)

The timespan for aggregating write operations, before invoking the underlying OffsetManager.

Parameters:

timespan - duration in milliseconds

setCount

public void setCount(int count)

How many writes should be aggregated, before invoking the underlying OffsetManager. Setting this value to 1 effectively disables windowing.

Parameters:

count - number of writes

setShutdownTimeout

public void setShutdownTimeout(int shutdownTimeout)

The timeout that close() and destroy() operations will wait for receving a confirmation that the underlying writes have been processed.

Parameters:

shutdownTimeout - duration in milliseconds

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

destroy

public void destroy()
             throws java.lang.Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

java.lang.Exception

updateOffset

public void updateOffset(org.springframework.integration.kafka.core.Partition partition,
                long offset)

Specified by:

updateOffset in interface org.springframework.integration.kafka.listener.OffsetManager

getOffset

public long getOffset(org.springframework.integration.kafka.core.Partition partition)

Specified by:

getOffset in interface org.springframework.integration.kafka.listener.OffsetManager

deleteOffset

public void deleteOffset(org.springframework.integration.kafka.core.Partition partition)

Specified by:

deleteOffset in interface org.springframework.integration.kafka.listener.OffsetManager

resetOffsets

public void resetOffsets(java.util.Collection<org.springframework.integration.kafka.core.Partition> partition)

Specified by:

resetOffsets in interface org.springframework.integration.kafka.listener.OffsetManager

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Throws:

java.io.IOException