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

Interface MethodDirectives

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Directive<scala.runtime.BoxedUnit>
    delete()
    Rejects all non-DELETE requests.
    Directive<scala.Tuple1<HttpMethod>>
    extractMethod()
    Extracts the request method.
    Directive<scala.runtime.BoxedUnit>
    get()
    Rejects all non-GET requests.
    Directive<scala.runtime.BoxedUnit>
    head()
    Rejects all non-HEAD requests.
    Directive<scala.runtime.BoxedUnit>
    method(HttpMethod httpMethod)
    Rejects all requests whose HTTP method does not match the given one.
    Directive<scala.runtime.BoxedUnit>
    options()
    Rejects all non-OPTIONS requests.
    Directive<scala.runtime.BoxedUnit>
    overrideMethodWithParameter(String paramName)
    Changes the HTTP method of the request to the value of the specified query string parameter.
    Directive<scala.runtime.BoxedUnit>
    patch()
    Rejects all non-PATCH requests.
    Directive<scala.runtime.BoxedUnit>
    post()
    Rejects all non-POST requests.
    Directive<scala.runtime.BoxedUnit>
    put()
    Rejects all non-PUT requests.

  • Method Details

    • delete

      Directive<scala.runtime.BoxedUnit> delete()
      Rejects all non-DELETE requests.

      Returns:
      (undocumented)

    • get

      Directive<scala.runtime.BoxedUnit> get()
      Rejects all non-GET requests.

      Returns:
      (undocumented)

    • head

      Directive<scala.runtime.BoxedUnit> head()
      Rejects all non-HEAD requests.

      Returns:
      (undocumented)

    • options

      Directive<scala.runtime.BoxedUnit> options()
      Rejects all non-OPTIONS requests.

      Returns:
      (undocumented)

    • patch

      Directive<scala.runtime.BoxedUnit> patch()
      Rejects all non-PATCH requests.

      Returns:
      (undocumented)

    • post

      Directive<scala.runtime.BoxedUnit> post()
      Rejects all non-POST requests.

      Returns:
      (undocumented)

    • put

      Directive<scala.runtime.BoxedUnit> put()
      Rejects all non-PUT requests.

      Returns:
      (undocumented)

    • extractMethod

      Directive<scala.Tuple1<HttpMethod>> extractMethod()
      Extracts the request method.

      Returns:
      (undocumented)

    • method

      Directive<scala.runtime.BoxedUnit> method(HttpMethod httpMethod)
      Rejects all requests whose HTTP method does not match the given one.

      Parameters:
      httpMethod - (undocumented)
      Returns:
      (undocumented)

    • overrideMethodWithParameter

      Directive<scala.runtime.BoxedUnit> overrideMethodWithParameter(String paramName)
      Changes the HTTP method of the request to the value of the specified query string parameter. If the query string parameter is not specified this directive has no effect. If the query string is specified as something that is not a HTTP method, then this directive completes the request with a 501 Not Implemented response.

      This directive is useful for: - Use in combination with JSONP (JSONP only supports GET) - Supporting older browsers that lack support for certain HTTP methods. E.g. IE8 does not support PATCH

      Parameters:
      paramName - (undocumented)
      Returns:
      (undocumented)