Package io.aiven.commons.kafka.connector.source.impl

Class ExampleOffsetManagerEntry

java.lang.Object

io.aiven.commons.kafka.connector.source.impl.ExampleOffsetManagerEntry

All Implemented Interfaces:

OffsetManager.OffsetManagerEntry, Comparable<ExampleOffsetManagerEntry>

public class ExampleOffsetManagerEntry
extends Object
implements OffsetManager.OffsetManagerEntry, Comparable<ExampleOffsetManagerEntry>

An implementation of OffsetManagerEntry. This entry has 3 values stored in the map.

The OffsetManagerEntry must contain a representation of the NativeKey (the K in type in NativeSourceData<K,N,O,T>) The record count must be included but may be set to 1 for all cases where the native source may only return a single Kafka record. All other items are optional.

Constructor Summary

Constructors

Constructor	Description
ExampleOffsetManagerEntry(String nativeKey, String grouping)	Constructor.
ExampleOffsetManagerEntry(Map<String,Object> properties)	A constructor.

Method Summary

Modifier and Type	Method	Description
int	compareTo(ExampleOffsetManagerEntry other)
boolean	equals(Object other)
ExampleOffsetManagerEntry	fromProperties(Map<String,Object> properties)	Creates a new OffsetManagerEntry by wrapping the properties with the current implementation.
OffsetManager.OffsetManagerKey	getManagerKey()	Gets the OffsetManagerKey for this entry.
Map<String,Object>	getProperties()	Extracts the data from the entry in the correct format to return to Kafka.
Object	getProperty(String key)	Gets the value of the named property.
long	getRecordCount()	Gets the current record count.
int	hashCode()
void	incrementRecordCount()	Increments the record count.
void	setProperty(String key, Object value)	Sets a key/value pair.
void	setRecordCount(int value)	Not part of the standard OffsetManagerEntry.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.aiven.commons.kafka.connector.source.OffsetManager.OffsetManagerEntry

getInt, getLong, getString

Constructor Details

ExampleOffsetManagerEntry

public ExampleOffsetManagerEntry(String nativeKey,
 String grouping)

Constructor.

Parameters:

nativeKey - The native Key.

grouping - An grouping division

ExampleOffsetManagerEntry

public ExampleOffsetManagerEntry(Map<String,Object> properties)

A constructor.

Parameters:

properties - THe data map to use.

Method Details

fromProperties

public ExampleOffsetManagerEntry fromProperties(Map<String,Object> properties)

Description copied from interface: OffsetManager.OffsetManagerEntry

Creates a new OffsetManagerEntry by wrapping the properties with the current implementation. This method may throw a RuntimeException if required properties are not defined in the map.

Specified by:

fromProperties in interface OffsetManager.OffsetManagerEntry

Parameters:

properties - the properties to wrap. May be null.

Returns:

an OffsetManagerProperty

getProperties

public Map<String,Object> getProperties()

Description copied from interface: OffsetManager.OffsetManagerEntry

Extracts the data from the entry in the correct format to return to Kafka.

This method should make a copy of the internal data and return that to prevent any accidental updates to the internal data.

Specified by:

getProperties in interface OffsetManager.OffsetManagerEntry

Returns:

the properties in a format to return to Kafka.

getProperty

public Object getProperty(String key)

Description copied from interface: OffsetManager.OffsetManagerEntry

Gets the value of the named property. The value returned from a null key is implementation dependant.

Specified by:

getProperty in interface OffsetManager.OffsetManagerEntry

Parameters:

key - the property to retrieve.

Returns:

the value associated with the property or @{code null} if not set.

setProperty

public void setProperty(String key,
 Object value)

Description copied from interface: OffsetManager.OffsetManagerEntry

Sets a key/value pair. Will overwrite any existing value. Implementations of OffsetManagerEntry may declare specific keys as restricted. These are generally keys that are managed internally by the OffsetManagerEntry and may not be set except through provided setter methods or the constructor.

Specified by:

setProperty in interface OffsetManager.OffsetManagerEntry

Parameters:

key - the key to set.

value - the value to set.

getManagerKey

public OffsetManager.OffsetManagerKey getManagerKey()

Description copied from interface: OffsetManager.OffsetManagerEntry

Gets the OffsetManagerKey for this entry.

The return value should be a copy of the internal structure or constructed in such a way that modification to the key values is not reflected in the OffsetManagerEntry.

Specified by:

getManagerKey in interface OffsetManager.OffsetManagerEntry

Returns:

The offset manager key for this entry.

incrementRecordCount

public void incrementRecordCount()

Description copied from interface: OffsetManager.OffsetManagerEntry

Increments the record count.

Specified by:

incrementRecordCount in interface OffsetManager.OffsetManagerEntry

getRecordCount

public long getRecordCount()

Description copied from interface: OffsetManager.OffsetManagerEntry

Gets the current record count.

Specified by:

getRecordCount in interface OffsetManager.OffsetManagerEntry

Returns:

The current record count.

setRecordCount

public void setRecordCount(int value)

Not part of the standard OffsetManagerEntry. Used in testing to force the system to skip records.

Parameters:

value - the record to start on.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(ExampleOffsetManagerEntry other)

Specified by:

compareTo in interface Comparable<ExampleOffsetManagerEntry>