Package org.projectnessie.client.http

Class HttpRequest

java.lang.Object

org.projectnessie.client.http.HttpRequest

All Implemented Interfaces:

ExecutableHttpRequest<HttpClientException,RuntimeException>

Direct Known Subclasses:

BaseHttpRequest

public abstract class HttpRequest
extends Object
implements ExecutableHttpRequest<HttpClientException,RuntimeException>

Class to hold an ongoing HTTP request and its parameters/filters.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	accept
protected HttpAuthentication	auth
protected boolean	bypassFilters
protected final HttpRuntimeConfig	config
protected String	contentsType
protected final HttpHeaders	headers
protected final UriBuilder	uriBuilder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpRequest(HttpRuntimeConfig config, URI baseUri)

Method Summary

Modifier and Type	Method	Description
HttpRequest	accept(String accept)
HttpRequest	authentication(HttpAuthentication auth)	Sets the authentication to use for this request.
HttpRequest	contentsType(String contentType)
HttpResponse	delete()
abstract HttpResponse	executeRequest(HttpClient.Method method, Object body)
HttpResponse	get()
HttpRequest	header(String name, String value)
HttpRequest	path(String path)
HttpResponse	post(Object obj)
HttpResponse	postForm(Object obj)	Sets the content-type to application/x-www-form-urlencoded.
HttpResponse	put(Object obj)
HttpRequest	queryParam(String name, Integer value)
HttpRequest	queryParam(String name, String value)
HttpRequest	resolveTemplate(String name, String value)
<E extends Exception> ExecutableHttpRequest<E,RuntimeException>	unwrap(Class<E> ex)
<E1 extends Exception, E2 extends Exception> ExecutableHttpRequest<E1,E2>	unwrap(Class<E1> ex1, Class<E2> ex2)

Methods inherited from class java.lang.Object

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

Field Details

config

protected final HttpRuntimeConfig config

uriBuilder

protected final UriBuilder uriBuilder

headers

protected final HttpHeaders headers

contentsType

protected String contentsType

accept

protected String accept

auth

protected HttpAuthentication auth

bypassFilters

protected boolean bypassFilters

Constructor Details

HttpRequest

protected HttpRequest(HttpRuntimeConfig config,
 URI baseUri)

Method Details

authentication

public HttpRequest authentication(HttpAuthentication auth)

Sets the authentication to use for this request. A non-null value will override the authentication object set on the HttpClient level, if any.

The passed authentication object will be started when this request is prepared, and will be closed immediately after this request is executed.

Parameters:

auth - the authentication to use

Returns:

this request

contentsType

public HttpRequest contentsType(String contentType)

accept

public HttpRequest accept(String accept)

path

public HttpRequest path(String path)

queryParam

public HttpRequest queryParam(String name,
 String value)

queryParam

public HttpRequest queryParam(String name,
 Integer value)

header

public HttpRequest header(String name,
 String value)

executeRequest

public abstract HttpResponse executeRequest(HttpClient.Method method,
 Object body)
                                     throws HttpClientException

Throws:

HttpClientException

get

public HttpResponse get()
                 throws HttpClientException

Specified by:

get in interface ExecutableHttpRequest<HttpClientException,RuntimeException>

Throws:

HttpClientException

delete

public HttpResponse delete()
                    throws HttpClientException

Specified by:

delete in interface ExecutableHttpRequest<HttpClientException,RuntimeException>

Throws:

HttpClientException

post

public HttpResponse post(Object obj)
                  throws HttpClientException

Specified by:

post in interface ExecutableHttpRequest<HttpClientException,RuntimeException>

Throws:

HttpClientException

put

public HttpResponse put(Object obj)
                 throws HttpClientException

Specified by:

put in interface ExecutableHttpRequest<HttpClientException,RuntimeException>

Throws:

HttpClientException

postForm

public HttpResponse postForm(Object obj)

Sets the content-type to application/x-www-form-urlencoded. The provided body will be automatically encoded as form data. This is a convenience method for contentsType("application/x-www-form-urlencoded").post(obj). The request should be sent with post(Object).

resolveTemplate

public HttpRequest resolveTemplate(String name,
 String value)

unwrap

public <E extends Exception>
ExecutableHttpRequest<E,RuntimeException> unwrap(Class<E> ex)

unwrap

public <E1 extends Exception,
E2 extends Exception>
ExecutableHttpRequest<E1,E2> unwrap(Class<E1> ex1,
 Class<E2> ex2)