org.http4s.CacheDirective.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of http4s-core_2.10 Show documentation
Core http4s library for servers and clients
There is a newer version: 0.16.6a
/*
 * Derived from https://github.com/spray/spray/blob/v1.1-M7/spray-http/src/main/scala/spray/http/CacheDirective.scala
 *
 * Copyright (C) 2011-2012 spray.io
 * Based on code copyright (C) 2010-2011 by the BlueEyes Web Framework Team (http://github.com/jdegoes/blueeyes)
 *
 * Licensed 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.http4s

import scala.Product
import org.http4s.util.{CaseInsensitiveString, Writer, Renderable}
import scala.concurrent.duration.Duration
import util.string._

sealed trait CacheDirective extends Product with Renderable {
  val name = productPrefix.replace("$minus", "-").ci
  def value: String = name.toString
  override def toString = value
  def render(writer: Writer): writer.type = writer.append(value)
}

/**
 * A registry of cache-directives, as listed in
 * http://www.iana.org/assignments/http-cache-directives/http-cache-directives.xhtml
 */
object CacheDirective {
  case class `max-age`(deltaSeconds: Duration) extends CacheDirective {
    override def value = name + "=" + deltaSeconds.toSeconds
  }

  case class `max-stale`(deltaSeconds: Option[Duration] = None) extends CacheDirective {
    override def value = name + deltaSeconds.fold("")("=" + _.toSeconds)
  }

  case class `min-fresh`(deltaSeconds: Duration) extends CacheDirective {
    override def value = name + "=" + deltaSeconds.toSeconds
  }

  case object `must-revalidate` extends CacheDirective

  case class `no-cache`(fieldNames: Seq[CaseInsensitiveString] = Seq.empty) extends CacheDirective {
    override def value = name + (if (fieldNames.isEmpty) "" else fieldNames.mkString("=\"", ",", "\""))
  }

  case object `no-store` extends CacheDirective

  case object `no-transform` extends CacheDirective

  case object `only-if-cached` extends CacheDirective

  case class `private`(fieldNames: Seq[CaseInsensitiveString] = Nil) extends CacheDirective {
    override def value = name + (if (fieldNames.isEmpty) "" else fieldNames.mkString("=\"", ",", "\""))
  }

  case object `proxy-revalidate` extends CacheDirective

  case object public extends CacheDirective

  case class `s-maxage`(deltaSeconds: Duration) extends CacheDirective {
    override def value = name + "=" + deltaSeconds.toSeconds
  }

  case class `stale-if-error`(deltaSeconds: Duration) extends CacheDirective {
    override def value = name + "=" + deltaSeconds.toSeconds
  }

  case class `stale-while-revalidate`(deltaSeconds: Duration) extends CacheDirective {
    override def value = name + "=" + deltaSeconds.toSeconds
  }

  def apply(name: CaseInsensitiveString, argument: Option[String] = None): CacheDirective =
    new CustomCacheDirective(name, argument)

  def apply(name: String, argument: Option[String]): CacheDirective =
    apply(name.ci, argument)

  def apply(name: String): CacheDirective = apply(name, None)

  private case class CustomCacheDirective(override val name: CaseInsensitiveString, argument: Option[String] = None)
    extends CacheDirective
  {
    override def value = name + argument.fold("")("=\"" + _ + '"')
  }
}