Module com.darkcollective.relix.lang.ast
Package com.darkcollective.relix.lang.ast.source

Enum Class HttpMethod

java.lang.Object
java.lang.Enum<HttpMethod>
com.darkcollective.relix.lang.ast.source.HttpMethod
All Implemented Interfaces:
Serializable, Comparable<HttpMethod>, Constable
public enum HttpMethod extends Enum<HttpMethod>
HTTP request method for an HttpSourceConfig.

Relix is read-only by design: only methods that fetch data are permitted. GET is the ordinary read. QUERY (RFC 10008) is the read whose query travels in the request body; it is safe and idempotent by definition, and a source declaring it must carry a body. POST is accepted solely as a read mechanism for the many APIs (GraphQL, search endpoints) that take their query in a body and do not accept QUERY. The mutating methods PUT/PATCH/DELETE are deliberately absent, as is HEAD (which returns no body and so cannot produce rows).

  • Enum Constant Details

    • GET

      public static final HttpMethod GET
      An ordinary HTTP read.

    • POST

      public static final HttpMethod POST
      A read whose query travels in the request body (e.g. GraphQL/search).

    • QUERY

      public static final HttpMethod QUERY
      The RFC 10008 read whose query is the request body; safe and idempotent.

  • Method Details

    • values

      public static HttpMethod[] 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 HttpMethod 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