Package org.apache.pekko.http.scaladsl.server.directives

Interface CacheConditionDirectives

All Known Subinterfaces:
Directives
All Known Implementing Classes:
CacheConditionDirectives$, Directives$, HttpApp
public interface CacheConditionDirectives

  • Method Summary

    Modifier and Type
    Method
    Description
    Directive<scala.runtime.BoxedUnit>
    conditional(DateTime lastModified)
    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232
    Directive<scala.runtime.BoxedUnit>
    conditional(EntityTag eTag)
    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232
    Directive<scala.runtime.BoxedUnit>
    conditional(EntityTag eTag, DateTime lastModified)
    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232
    Directive<scala.runtime.BoxedUnit>
    conditional(scala.Option<EntityTag> eTag, scala.Option<DateTime> lastModified)
    Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

  • Method Details

    • conditional

      Directive<scala.runtime.BoxedUnit> conditional(EntityTag eTag)
      Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

      In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

      Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

      Parameters:
      eTag - (undocumented)
      Returns:
      (undocumented)

    • conditional

      Directive<scala.runtime.BoxedUnit> conditional(DateTime lastModified)
      Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

      In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

      Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

      Parameters:
      lastModified - (undocumented)
      Returns:
      (undocumented)

    • conditional

      Directive<scala.runtime.BoxedUnit> conditional(EntityTag eTag, DateTime lastModified)
      Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

      In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

      Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

      Parameters:
      eTag - (undocumented)
      lastModified - (undocumented)
      Returns:
      (undocumented)

    • conditional

      Directive<scala.runtime.BoxedUnit> conditional(scala.Option<EntityTag> eTag, scala.Option<DateTime> lastModified)
      Wraps its inner route with support for Conditional Requests as defined by http://tools.ietf.org/html/rfc7232

      In particular the algorithm defined by http://tools.ietf.org/html/rfc7232#section-6 is implemented by this directive.

      Note: if you want to combine this directive with withRangeSupport(...) you need to put it on the *outside* of the withRangeSupport(...) directive, i.e. withRangeSupport(...) must be on a deeper level in your route structure in order to function correctly.

      Parameters:
      eTag - (undocumented)
      lastModified - (undocumented)
      Returns:
      (undocumented)