Package dev.gmitch215.bytebox.net.http

Class HttpRequest.Builder

java.lang.Object
dev.gmitch215.bytebox.net.http.HttpRequest.Builder
Enclosing class:
HttpRequest
public static final class HttpRequest.Builder extends Object
Assembles a request.

  • Method Details

    • uri

      public HttpRequest.Builder uri(URI uri)
      Where to send the request.
      Parameters:
      uri - an absolute HTTP or HTTPS URI
      Returns:
      this builder

    • setHeader

      public HttpRequest.Builder setHeader(String name, String value)
      Sets a header, replacing any value already set.
      Parameters:
      name - the header name
      value - the value
      Returns:
      this builder

    • header

      public HttpRequest.Builder header(String name, String value)
      Adds a header, keeping any value already set.
      Parameters:
      name - the header name
      value - the value
      Returns:
      this builder

    • headers

      public HttpRequest.Builder headers(String... nameAndValues)
      Adds headers, given as alternating names and values.
      Parameters:
      nameAndValues - an even number of strings
      Returns:
      this builder

    • timeout

      public HttpRequest.Builder timeout(Duration timeout)
      How long the request may take.
      Parameters:
      timeout - the limit
      Returns:
      this builder

    • GET

      public HttpRequest.Builder GET()
      Returns this builder, sending a GET.
      Returns:
      this builder, sending a GET

    • POST

      public HttpRequest.Builder POST(HttpRequest.BodyPublisher body)
      Sends a POST.
      Parameters:
      body - the body
      Returns:
      this builder

    • PUT

      public HttpRequest.Builder PUT(HttpRequest.BodyPublisher body)
      Sends a PUT.
      Parameters:
      body - the body
      Returns:
      this builder

    • DELETE

      public HttpRequest.Builder DELETE()
      Returns this builder, sending a DELETE.
      Returns:
      this builder, sending a DELETE

    • method

      public HttpRequest.Builder method(String method, HttpRequest.BodyPublisher body)
      Sends a method of your own.
      Parameters:
      method - the method
      body - the body, or HttpRequest.BodyPublishers.noBody() for none
      Returns:
      this builder

    • expectContinue

      public HttpRequest.Builder expectContinue(boolean enable)
      Whether to expect a 100-continue, which the platform does not send.
      Parameters:
      enable - ignored
      Returns:
      this builder

    • build

      public HttpRequest build()
      Returns the request.
      Returns:
      the request