Package com.inrupt.client

Class Request

java.lang.Object

com.inrupt.client.Request

public final class Request
extends Object

An HTTP Request.

This interface provides a generic API for building and interacting with HTTP requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Request.BodyPublisher	An API for serializing an HTTP Request.
static final class	Request.BodyPublishers	Built-in Request.BodyPublisher implementations.
static final class	Request.Builder	A Request builder.

Method Summary

Modifier and Type	Method	Description
Optional<Request.BodyPublisher>	bodyPublisher()	The Request.BodyPublisher set on this request.
Headers	headers()	The HTTP headers for this request.
String	method()	The HTTP method.
static Request.Builder	newBuilder()	Creates a Request builder.
static Request.Builder	newBuilder(URI uri)	Creates a Request builder with the given URI.
Optional<Duration>	timeout()	The timeout for this request.
URI	uri()	The HTTP URI.

Methods inherited from class java.lang.Object

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

Method Details

method

public String method()

The HTTP method.

Returns:

the HTTP method

uri

public URI uri()

The HTTP URI.

Returns:

the HTTP URI

bodyPublisher

public Optional<Request.BodyPublisher> bodyPublisher()

The Request.BodyPublisher set on this request.

Returns:

the body publisher, if present

headers

public Headers headers()

The HTTP headers for this request.

Returns:

the HTTP headers

timeout

public Optional<Duration> timeout()

The timeout for this request.

Returns:

the timeout for this request, if present

newBuilder

public static Request.Builder newBuilder()

Creates a Request builder.

Returns:

the builder

newBuilder

public static Request.Builder newBuilder(URI uri)

Creates a Request builder with the given URI.

Parameters:

uri - the request URI

Returns:

the builder