org.apache.pekko.kafka.OffsetResetProtectionSettings.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pekko-connectors-kafka_2.13 Show documentation
Apache Pekko Kafka Connector is a Reactive Enterprise Integration library for Java and Scala, based on Reactive Streams and Apache Pekko.
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * license agreements; and to You under the Apache License, version 2.0:
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * This file is part of the Apache Pekko project, which was derived from Akka.
 */

/*
 * Copyright (C) 2014 - 2016 Softwaremill 
 * Copyright (C) 2016 - 2020 Lightbend Inc. 
 */

package org.apache.pekko.kafka
import java.time.{ Duration => JDuration }

import org.apache.pekko
import pekko.annotation.InternalApi
import pekko.util.JavaDurationConverters._
import com.typesafe.config.Config

import scala.concurrent.duration._

class OffsetResetProtectionSettings @InternalApi private[kafka] (val enable: Boolean,
    val offsetThreshold: Long,
    val timeThreshold: FiniteDuration) {
  require(offsetThreshold > 0, "An offset threshold must be greater than 0")
  require(timeThreshold.toMillis > 0, "A time threshold must be greater than 0")

  private def copy(enable: Boolean = enable,
      offsetThreshold: Long = offsetThreshold,
      timeThreshold: FiniteDuration = timeThreshold): OffsetResetProtectionSettings = {
    new OffsetResetProtectionSettings(enable, offsetThreshold, timeThreshold)
  }

  /**
   * Whether offset-reset protection should be enabled.
   */
  def withEnable(enable: Boolean): OffsetResetProtectionSettings = copy(enable = enable)

  /**
   * If consumer gets a record with an offset that is more than this number of offsets back from the previously
   * requested offset, it is considered a reset.
   */
  def withOffsetThreshold(offsetThreshold: Long): OffsetResetProtectionSettings =
    copy(offsetThreshold = offsetThreshold)

  /**
   * Scala API.
   *
   * If the record is more than this duration earlier the last received record, it is considered a reset
   */
  def withTimeThreshold(timeThreshold: FiniteDuration): OffsetResetProtectionSettings =
    copy(timeThreshold = timeThreshold)

  /**
   * Java API
   *
   * If the record is more than this duration earlier the last received record, it is considered a reset
   */
  def withTimeThreshold(timeThreshold: JDuration): OffsetResetProtectionSettings =
    copy(timeThreshold = timeThreshold.asScala)

  override def toString: String =
    s"org.apache.pekko.kafka.OffsetResetProtectionSettings(" +
    s"enable=$enable," +
    s"offsetThreshold=$offsetThreshold," +
    s"timeThreshold=${timeThreshold.toCoarsest}" +
    ")"
}

/**
 * The thresholds after which reset protection is enabled. Offsets, time, or both can be provided.
 */
object OffsetResetProtectionSettings {

  val configPath: String = "offset-reset-protection"

  /**
   * Enable offset-reset protection with the given offset and time threshold, where offsets received outside the
   * threshold are considered indicative of an offset reset.
   */
  def apply(offsetThreshold: Long, timeThreshold: FiniteDuration): OffsetResetProtectionSettings =
    new OffsetResetProtectionSettings(true, offsetThreshold, timeThreshold)

  /**
   * Enable offset-reset protection with the given offset and time threshold, where offsets received outside the
   * threshold are considered indicative of an offset reset.
   */
  def apply(offsetThreshold: Long, timeThreshold: java.time.Duration): OffsetResetProtectionSettings =
    new OffsetResetProtectionSettings(true, offsetThreshold, timeThreshold.asScala)

  /**
   * Create settings from a configuration with layout `connection-checker`.
   */
  def apply(config: Config): OffsetResetProtectionSettings = {
    val enable = config.getBoolean("enable")
    if (enable) {
      val offsetThreshold = config.getLong("offset-threshold")
      val timeThreshold = config.getDuration("time-threshold").asScala
      apply(offsetThreshold, timeThreshold)
    } else Disabled
  }

  /**
   * Java API: Create settings from a configuration with layout `offset-reset-protection`.
   */
  def create(config: Config): OffsetResetProtectionSettings = apply(config)

  // max duration is ~292 years, so we are a touch below that to be safe
  val Disabled: OffsetResetProtectionSettings = new OffsetResetProtectionSettings(false, Long.MaxValue, 100000.days)
}