Package io.aiven.kafka.connect.common.source

Interface OffsetManager.OffsetManagerEntry<T extends OffsetManager.OffsetManagerEntry<T>>

All Superinterfaces:
Comparable<T>
Enclosing class:
OffsetManager<E extends OffsetManager.OffsetManagerEntry<E>>
public static interface OffsetManager.OffsetManagerEntry<T extends OffsetManager.OffsetManagerEntry<T>> extends Comparable<T>
The definition of an entry in the OffsetManager.

  • Method Details

    • fromProperties

      T fromProperties(Map<String,Object> properties)
      Creates a new OffsetManagerEntry by wrapping the properties with the current implementation. This method may throw a RuntimeException if requried properties are not defined in the map.
      Parameters:
      properties - the properties to wrap. May be null.
      Returns:
      an OffsetManagerProperty

    • getProperties

      Map<String,Object> getProperties()
      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.

      Returns:
      the properties in a format to return to Kafka.

    • getProperty

      Object getProperty(String key)
      Gets the value of the named property. The value returned from a null key is implementation dependant.
      Parameters:
      key - the property to retrieve.
      Returns:
      the value associated with the property or @{code null} if not set.
      Throws:
      NullPointerException - if a null key is not supported.

    • setProperty

      void setProperty(String key, Object value)
      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.
      Parameters:
      key - the key to set.
      value - the value to set.
      Throws:
      IllegalArgumentException - if the key is restricted.

    • getInt

      default int getInt(String key)
      Gets the value of the named property as an int.
      Parameters:
      key - the property to retrieve.
      Returns:
      the value associated with the property or @{code null} if not set.
      Throws:
      NullPointerException - if a null key is not supported.

    • getLong

      default long getLong(String key)
      Gets the value of the named property as a long
      Parameters:
      key - the property to retrieve.
      Returns:
      the value associated with the property or @{code null} if not set.
      Throws:
      NullPointerException - if a null key is not supported.

    • getString

      default String getString(String key)
      Gets the value of the named property as a String.
      Parameters:
      key - the property to retrieve.
      Returns:
      the value associated with the property or @{code null} if not set.
      Throws:
      NullPointerException - if a null key is not supported.

    • getManagerKey

      OffsetManager.OffsetManagerKey getManagerKey()
      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.

      Returns:
      The offset manager key for this entry.

    • incrementRecordCount

      void incrementRecordCount()
      Increments the record count.