Package dev.gmitch215.bytebox.net.http

Class HttpRequest

java.lang.Object

dev.gmitch215.bytebox.net.http.HttpRequest

public final class HttpRequest
extends Object

A request, standing in for java.net.http.HttpRequest.

Built the same way as anywhere else, and sent by HttpClient.

 HttpRequest request = HttpRequest.newBuilder()
 	.uri(URI.create("https://example.com/things"))
 	.header("Content-Type", "application/json")
 	.POST(HttpRequest.BodyPublishers.ofString("{}"))
 	.build();

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HttpRequest.BodyPublisher	A request body.
static final class	HttpRequest.BodyPublishers	The request bodies there are.
static final class	HttpRequest.Builder	Assembles a request.

Method Summary

Modifier and Type	Method	Description
Optional<HttpRequest.BodyPublisher>	bodyPublisher()	Returns the body, empty for a request that carries none.
HttpHeaders	headers()	Returns the headers.
String	method()	Returns the method.
static HttpRequest.Builder	newBuilder()	Returns a builder.
static HttpRequest.Builder	newBuilder(URI uri)	A builder aimed at a URI.
Optional<Duration>	timeout()	Returns how long the request may take, empty for no limit.
String	toString()
URI	uri()	Returns where the request goes.

Methods inherited from class java.lang.Object

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

Method Details

newBuilder

public static HttpRequest.Builder newBuilder()

Returns a builder.

Returns:

a builder

newBuilder

public static HttpRequest.Builder newBuilder(URI uri)

A builder aimed at a URI.

Parameters:

uri - where to send it

Returns:

the builder

uri

public URI uri()

Returns where the request goes.

Returns:

where the request goes

method

public String method()

Returns the method.

Returns:

the method

headers

public HttpHeaders headers()

Returns the headers.

Returns:

the headers

bodyPublisher

public Optional<HttpRequest.BodyPublisher> bodyPublisher()

Returns the body, empty for a request that carries none.

Returns:

the body, empty for a request that carries none

timeout

public Optional<Duration> timeout()

Returns how long the request may take, empty for no limit.

Returns:

how long the request may take, empty for no limit

toString

public String toString()

Overrides:

toString in class Object