cachecontrol
API
Generated with
cachecontrol/com.typesafe.play.cachecontrol/CacheDirectives

CacheDirectives

com.typesafe.play.cachecontrol.CacheDirectives
object CacheDirectives

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

case class CacheDirectiveExtension(name: String, value: Option[String]) extends CacheDirective

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MaxAge(delta: Seconds) extends CacheDirective

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MaxStale(delta: Option[Seconds]) extends CacheDirective

The "max-stale" request directive indicates that the client is willing to accept a response that has exceeded its freshness lifetime. If max-stale is assigned a value, then the client is willing to accept a response that has exceeded its freshness lifetime by no more than the specified number of seconds. If no value is assigned to max-stale, then the client is willing to accept a stale response of any age.

The "max-stale" request directive indicates that the client is willing to accept a response that has exceeded its freshness lifetime. If max-stale is assigned a value, then the client is willing to accept a response that has exceeded its freshness lifetime by no more than the specified number of seconds. If no value is assigned to max-stale, then the client is willing to accept a stale response of any age.

This directive uses the token form of the argument syntax: e.g., 'max-stale=10' not 'max-stale="10"'. A sender SHOULD NOT generate the quoted-string form.

https://tools.ietf.org/html/rfc7234#section-5.2.1.2

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MinFresh(delta: Seconds) extends CacheDirective

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case object MustRevalidate extends CacheDirective

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case class NoCache(headerNames: Option[Seq[String]]) extends CacheDirective

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case object NoStore extends CacheDirective

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
NoStore.type
case object NoTransform extends CacheDirective

The "no-transform" request directive indicates that an intermediary (whether or not it implements a cache) MUST NOT transform the payload, as defined in Section 5.7.2 of [RFC7230].

The "no-transform" request directive indicates that an intermediary (whether or not it implements a cache) MUST NOT transform the payload, as defined in Section 5.7.2 of [RFC7230].

// https://tools.ietf.org/html/rfc7234#section-5.2.1.6

The "no-transform" response directive indicates that an intermediary (regardless of whether it implements a cache) MUST NOT transform the payload, as defined in Section 5.7.2 of [RFC7230].

// https://tools.ietf.org/html/rfc7234#section-5.2.2.4

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case object OnlyIfCached extends CacheDirective

The "only-if-cached" request directive indicates that the client only wishes to obtain a stored response. If it receives this directive, a cache SHOULD either respond using a stored response that is consistent with the other constraints of the request, or respond with a 504 (Gateway Timeout) status code. If a group of caches is being operated as a unified system with good internal connectivity, a member cache MAY forward such a request within that group of caches.

The "only-if-cached" request directive indicates that the client only wishes to obtain a stored response. If it receives this directive, a cache SHOULD either respond using a stored response that is consistent with the other constraints of the request, or respond with a 504 (Gateway Timeout) status code. If a group of caches is being operated as a unified system with good internal connectivity, a member cache MAY forward such a request within that group of caches.

https://tools.ietf.org/html/rfc7234#section-5.2.1.7

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case class Private(headerNames: Option[Seq[String]]) extends CacheDirective

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case object ProxyRevalidate extends CacheDirective

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case object Public extends CacheDirective

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
Public.type
case class SMaxAge(delta: Seconds) extends CacheDirective

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class StaleIfError(delta: Seconds) extends CacheDirective

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class StaleWhileRevalidate(delta: Seconds) extends CacheDirective

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Value members

Concrete methods

def `private`(directives: Seq[CacheDirective]): Option[Private]
def extensions(directives: Seq[CacheDirective]): Seq[CacheDirectiveExtension]
def maxAge(directives: Seq[CacheDirective]): Option[MaxAge]

Finds the instance of MaxAge.

Finds the instance of MaxAge.

Attributes

def maxStale(directives: Seq[CacheDirective]): Option[MaxStale]
def minFresh(directives: Seq[CacheDirective]): Option[MinFresh]
def noCache(directives: Seq[CacheDirective]): Option[NoCache]
def sMaxAge(directives: Seq[CacheDirective]): Option[SMaxAge]
def staleIfError(directives: Seq[CacheDirective]): Option[StaleIfError]
Generated with