Package io.micronaut.http.cachecontrol

Enum Class ResponseDirective

java.lang.Object
java.lang.Enum<ResponseDirective>
io.micronaut.http.cachecontrol.ResponseDirective
All Implemented Interfaces:
Serializable, Comparable<ResponseDirective>, Constable
public enum ResponseDirective extends Enum<ResponseDirective>
Represents the response directives for the HTTP Cache-Control header.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    IMMUTABLE
    The immutable response directive indicates that the response will not be updated while it's fresh.
    MAX_AGE
    The max-age=N response directive indicates that the response remains fresh until N seconds after the response is generated.
    MUST_REVALIDATE
    The must-revalidate response directive indicates that the response can be stored in caches and can be reused while fresh.
    MUST_UNDERSTAND
    The must-understand response directive indicates that a cache should store the response only if it understands the requirements for caching based on status code.
    NO_CACHE
    The no-cache response directive indicates that the response can be stored in caches, but the response must be validated with the origin server before each reuse, even when the cache is disconnected from the origin server.
    NO_STORE
    The no-store response directive indicates that any caches of any kind (private or shared) should not store this response.
    NO_TRANSFORM
    Indicates that any intermediary (regardless of whether it implements a cache) shouldn't transform the response contents.
    PRIVATE
    The private response directive indicates that the response can be stored only in a private cache (e.g.
    PROXY_REVALIDATE
    The proxy-revalidate response directive is the equivalent of must-revalidate, but specifically for shared caches only.
    PUBLIC
    The public response directive indicates that the response can be stored in a shared cache.
    S_MAXAGE
    The s-maxage response directive indicates how long the response remains fresh in a shared cache.
    STALE_IF_ERROR
    The stale-if-error response directive indicates that the cache can reuse a stale response when an upstream server generates an error, or when the error is generated locally.
    STALE_WHILE_REVALIDATE
    The stale-while-revalidate response directive indicates that the cache could reuse a stale response while it revalidates it to a cache.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    toString()
    Returns the lowercase string value of the directive for use in HTTP headers.
    static ResponseDirective
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ResponseDirective[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • MAX_AGE

      public static final ResponseDirective MAX_AGE
      The max-age=N response directive indicates that the response remains fresh until N seconds after the response is generated.

    • S_MAXAGE

      public static final ResponseDirective S_MAXAGE
      The s-maxage response directive indicates how long the response remains fresh in a shared cache.

    • NO_CACHE

      public static final ResponseDirective NO_CACHE
      The no-cache response directive indicates that the response can be stored in caches, but the response must be validated with the origin server before each reuse, even when the cache is disconnected from the origin server.

    • MUST_REVALIDATE

      public static final ResponseDirective MUST_REVALIDATE
      The must-revalidate response directive indicates that the response can be stored in caches and can be reused while fresh. If the response becomes stale, it must be validated with the origin server before reuse.

    • PROXY_REVALIDATE

      public static final ResponseDirective PROXY_REVALIDATE
      The proxy-revalidate response directive is the equivalent of must-revalidate, but specifically for shared caches only.

    • NO_STORE

      public static final ResponseDirective NO_STORE
      The no-store response directive indicates that any caches of any kind (private or shared) should not store this response.

    • PRIVATE

      public static final ResponseDirective PRIVATE
      The private response directive indicates that the response can be stored only in a private cache (e.g. local caches in browsers).

    • PUBLIC

      public static final ResponseDirective PUBLIC
      The public response directive indicates that the response can be stored in a shared cache.

    • MUST_UNDERSTAND

      public static final ResponseDirective MUST_UNDERSTAND
      The must-understand response directive indicates that a cache should store the response only if it understands the requirements for caching based on status code.

    • NO_TRANSFORM

      public static final ResponseDirective NO_TRANSFORM
      Indicates that any intermediary (regardless of whether it implements a cache) shouldn't transform the response contents.

    • IMMUTABLE

      public static final ResponseDirective IMMUTABLE
      The immutable response directive indicates that the response will not be updated while it's fresh.

    • STALE_WHILE_REVALIDATE

      public static final ResponseDirective STALE_WHILE_REVALIDATE
      The stale-while-revalidate response directive indicates that the cache could reuse a stale response while it revalidates it to a cache.

    • STALE_IF_ERROR

      public static final ResponseDirective STALE_IF_ERROR
      The stale-if-error response directive indicates that the cache can reuse a stale response when an upstream server generates an error, or when the error is generated locally.

  • Method Details

    • values

      public static ResponseDirective[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ResponseDirective valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Returns the lowercase string value of the directive for use in HTTP headers.
      Overrides:
      toString in class Enum<ResponseDirective>