Package org.apache.pekko.http.scaladsl.model

Class HttpMethod

java.lang.Object
org.apache.pekko.http.javadsl.model.HttpMethod
org.apache.pekko.http.scaladsl.model.HttpMethod
All Implemented Interfaces:
Serializable, Renderable, SingletonValueRenderable, scala.Equals, scala.Product
public final class HttpMethod extends HttpMethod implements SingletonValueRenderable, scala.Product, Serializable
The method of an HTTP request. param: isSafe true if the resource should not be altered on the server param: isIdempotent true if requests can be safely (& automatically) repeated param: requestEntityAcceptance Expected if meaning of request entities is properly defined
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    HttpMethod(String value, boolean isSafe, boolean isIdempotent, RequestEntityAcceptance requestEntityAcceptance)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static HttpMethod
    custom(String name)
    Creates a custom method by name and assumes properties conservatively to be safe = false, idempotent = false and requestEntityAcceptance = Expected.
    static HttpMethod
    custom(String name, boolean safe, boolean idempotent, RequestEntityAcceptance requestEntityAcceptance)
     
    boolean
    isEntityAccepted()
    Returns if requests with this method may contain an entity.
    boolean
    isIdempotent()
    Returns if this method is "idempotent" as defined in http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-26#section-4.2.2
    boolean
    isSafe()
    Returns if this method is "safe" as defined in http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-26#section-4.2.1
    RequestEntityAcceptance
    requestEntityAcceptance()
     
    String
    toString()
     
    String
    value()
    Returns the name of the method.

    Methods inherited from class org.apache.pekko.http.javadsl.model.HttpMethod

    name

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface scala.Equals

    canEqual, equals

    Methods inherited from interface scala.Product

    productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

    Methods inherited from interface org.apache.pekko.http.impl.util.SingletonValueRenderable

    render

  • Constructor Details

  • Method Details

    • custom

      public static HttpMethod custom(String name, boolean safe, boolean idempotent, RequestEntityAcceptance requestEntityAcceptance)

    • custom

      public static HttpMethod custom(String name)
      Creates a custom method by name and assumes properties conservatively to be safe = false, idempotent = false and requestEntityAcceptance = Expected.
      Parameters:
      name - (undocumented)
      Returns:
      (undocumented)

    • value

      public String value()
      Description copied from class: HttpMethod
      Returns the name of the method.
      Specified by:
      value in interface SingletonValueRenderable
      Specified by:
      value in class HttpMethod

    • isSafe

      public boolean isSafe()
      Description copied from class: HttpMethod
      Returns if this method is "safe" as defined in http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-26#section-4.2.1
      Specified by:
      isSafe in class HttpMethod

    • isIdempotent

      public boolean isIdempotent()
      Description copied from class: HttpMethod
      Returns if this method is "idempotent" as defined in http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-26#section-4.2.2
      Specified by:
      isIdempotent in class HttpMethod

    • requestEntityAcceptance

      public RequestEntityAcceptance requestEntityAcceptance()

    • isEntityAccepted

      public boolean isEntityAccepted()
      Description copied from class: HttpMethod
      Returns if requests with this method may contain an entity.
      Specified by:
      isEntityAccepted in class HttpMethod

    • toString

      public String toString()
      Overrides:
      toString in class Object