com.oracle.bmc.http.client

Interface HttpRequest

public interface HttpRequest

Setup builder for a HTTP request, to be executed with execute().

A HttpRequest must be either executed or discarded to clean up all resources associated with it.

Method Summary

Modifier and Type	Method and Description
HttpRequest	appendPathPart(String encodedPathPart)
Object	attribute(String name)
HttpRequest	attribute(String name, Object value)
Object	body()
HttpRequest	body(InputStream body, long contentLength)
HttpRequest	body(Object body)
HttpRequest	copy() Create a new copy of this HttpRequest with independent request properties.
void	discard() Discard this request, signalling that it won’t be executed.
CompletionStage<HttpResponse>	execute()
HttpRequest	header(String name, String value)
Map<String,List<String>>	headers()
Method	method()
HttpRequest	offloadExecutor(Executor executor) Executor to offload some work onto (mostly for better stack traces)
HttpRequest	query(String name, String value) Add a query parameter.
HttpRequest	removeAttribute(String name)
URI	uri()

Method Detail

method

Method method()

body

HttpRequest body(Object body)

body

HttpRequest body(InputStream body,
                 long contentLength)

body

Object body()

appendPathPart

HttpRequest appendPathPart(String encodedPathPart)

query

HttpRequest query(String name,
                  String value)

Add a query parameter. May be called multiple times for the same name.

Note: name and value must already be percent-encoded.

uri

URI uri()

header

HttpRequest header(String name,
                   String value)

headers

Map<String,List<String>> headers()

attribute

Object attribute(String name)

removeAttribute

HttpRequest removeAttribute(String name)

attribute

HttpRequest attribute(String name,
                      Object value)

offloadExecutor

HttpRequest offloadExecutor(Executor executor)

Executor to offload some work onto (mostly for better stack traces)

copy

HttpRequest copy()

Create a new copy of this HttpRequest with independent request properties. For example, you can add a new header to the copied request without affecting this one, and execute them independently. Note that the copied request must be either executed or discarded (just like this one).

discard

void discard()

Discard this request, signalling that it won’t be executed. Any resources associated with this request may be released.

execute

CompletionStage<HttpResponse> execute()