org.apache.james.rate.limiter.api.RateLimiter.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of james-server-rate-limiter
Rate limiting for Apache James email processing
The newest version!
/****************************************************************
 * Licensed to the Apache Software Foundation (ASF) under one   *
 * or more contributor license agreements.  See the NOTICE file *
 * distributed with this work for additional information        *
 * regarding copyright ownership.  The ASF licenses this file   *
 * to you under the Apache License, Version 2.0 (the            *
 * "License"); you may not use this file except in compliance   *
 * with the License.  You may obtain a copy of the License at   *
 *                                                              *
 * http://www.apache.org/licenses/LICENSE-2.0                   *
 *                                                              *
 * Unless required by applicable law or agreed to in writing,   *
 * software distributed under the License is distributed on an  *
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
 * KIND, either express or implied.  See the License for the    *
 * specific language governing permissions and limitations      *
 * under the License.                                           *
 ****************************************************************/

package org.apache.james.rate.limiter.api

import java.time.Duration

import eu.timepit.refined
import eu.timepit.refined.api.Refined
import eu.timepit.refined.numeric.Positive
import org.apache.james.rate.limiter.api.AllowedQuantity.AllowedQuantity
import org.apache.james.rate.limiter.api.Increment.Increment
import org.reactivestreams.Publisher

trait RateLimitingKey {
    def asString(): String
}

object AllowedQuantity {
  type PositiveLongConstraint = Positive
  type AllowedQuantity = Long Refined PositiveLongConstraint

  def validate(value: Long): Either[NumberFormatException, AllowedQuantity] =
    refined.refineV[PositiveLongConstraint](value)
      .left.map(error => new NumberFormatException(error))
}

object Increment {
  type PositiveLongConstraint = Positive
  type Increment = Int Refined PositiveLongConstraint

  def validate(value: Int): Either[NumberFormatException, Increment] =
    refined.refineV[PositiveLongConstraint](value)
      .left.map(error => new NumberFormatException(error))
}

case class Rule(quantity: AllowedQuantity, duration: Duration)
case class Rules(rules: Seq[Rule])

trait RateLimiter {
    def rateLimit(key: RateLimitingKey, increaseQuantity: Increment): Publisher[RateLimitingResult]
}

trait RateLimiterFactory {
   def withSpecification(rules: Rules, precision: Option[Duration]): RateLimiter
}

sealed trait RateLimitingResult {
  def merge(other: RateLimitingResult): RateLimitingResult
}
case object RateExceeded extends RateLimitingResult {
  override def merge(other: RateLimitingResult): RateLimitingResult = RateExceeded
}
case object AcceptableRate extends RateLimitingResult {
  override def merge(other: RateLimitingResult): RateLimitingResult = other
}