Package org.apache.iceberg.rest

Class BaseHTTPClient

java.lang.Object

org.apache.iceberg.rest.BaseHTTPClient

All Implemented Interfaces:

Closeable, AutoCloseable, RESTClient

Direct Known Subclasses:

HTTPClient

public abstract class BaseHTTPClient
extends Object
implements RESTClient

A base class for RESTClient implementations.

All methods in RESTClient are implemented in the same way: first, an HTTPRequest is built from the method arguments, then executed.

This allows subclasses to provide a consistent way to execute all requests, regardless of the method or arguments.

Constructor Summary

Constructors

Constructor	Description
BaseHTTPClient()

Method Summary

Modifier and Type	Method	Description
protected abstract HTTPRequest	buildRequest(HTTPRequest.HTTPMethod method, String path, Map<String,String> queryParams, Map<String,String> headers, Object body)
<T extends RESTResponse> T	delete(String path, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler)
<T extends RESTResponse> T	delete(String path, Map<String,String> queryParams, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler)
protected abstract <T extends RESTResponse> T	execute(HTTPRequest request, Class<T> responseType, Consumer<ErrorResponse> errorHandler, Consumer<Map<String,String>> responseHeaders)
protected <T extends RESTResponse> T	execute(HTTPRequest request, Class<T> responseType, Consumer<ErrorResponse> errorHandler, Consumer<Map<String,String>> responseHeaders, ParserContext parserContext)
<T extends RESTResponse> T	get(String path, Map<String,String> queryParams, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler)
<T extends RESTResponse> T	get(String path, Map<String,String> queryParams, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler, ParserContext parserContext)
void	head(String path, Map<String,String> headers, Consumer<ErrorResponse> errorHandler)
<T extends RESTResponse> T	post(String path, RESTRequest body, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler)
<T extends RESTResponse> T	post(String path, RESTRequest body, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler, Consumer<Map<String,String>> responseHeaders)
<T extends RESTResponse> T	post(String path, RESTRequest body, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler, Consumer<Map<String,String>> responseHeaders, ParserContext parserContext)
<T extends RESTResponse> T	postForm(String path, Map<String,String> formData, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler)
abstract RESTClient	withAuthSession(AuthSession session)	Returns a REST client that authenticates requests using the given session.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.apache.iceberg.rest.RESTClient

delete, delete, get, get, get, head, post, post, postForm

Constructor Details

BaseHTTPClient

public BaseHTTPClient()

Method Details

withAuthSession

public abstract RESTClient withAuthSession(AuthSession session)

Description copied from interface: RESTClient

Returns a REST client that authenticates requests using the given session.

Implementation requirements:

• Closing the returned client SHOULD NOT affect this client: if they share common resources, the resources SHOULD NOT be closed until the parent client is closed.
• Closing the returned client SHOULD NOT close the given AuthSession: this is the responsibility of this method's caller.

Specified by:

withAuthSession in interface RESTClient

head

public void head(String path,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler)

Specified by:

head in interface RESTClient

delete

public <T extends RESTResponse> T delete(String path,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler)

Specified by:

delete in interface RESTClient

delete

public <T extends RESTResponse> T delete(String path,
 Map<String,String> queryParams,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler)

Specified by:

delete in interface RESTClient

get

public <T extends RESTResponse> T get(String path,
 Map<String,String> queryParams,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler)

Specified by:

get in interface RESTClient

get

public <T extends RESTResponse> T get(String path,
 Map<String,String> queryParams,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler,
 ParserContext parserContext)

Specified by:

get in interface RESTClient

post

public <T extends RESTResponse> T post(String path,
 RESTRequest body,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler)

Specified by:

post in interface RESTClient

post

public <T extends RESTResponse> T post(String path,
 RESTRequest body,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler,
 Consumer<Map<String,String>> responseHeaders)

Specified by:

post in interface RESTClient

post

public <T extends RESTResponse> T post(String path,
 RESTRequest body,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler,
 Consumer<Map<String,String>> responseHeaders,
 ParserContext parserContext)

Specified by:

post in interface RESTClient

postForm

public <T extends RESTResponse> T postForm(String path,
 Map<String,String> formData,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler)

Specified by:

postForm in interface RESTClient

buildRequest

protected abstract HTTPRequest buildRequest(HTTPRequest.HTTPMethod method,
 String path,
 Map<String,String> queryParams,
 Map<String,String> headers,
 Object body)

execute

protected abstract <T extends RESTResponse> T execute(HTTPRequest request,
 Class<T> responseType,
 Consumer<ErrorResponse> errorHandler,
 Consumer<Map<String,String>> responseHeaders)

execute

protected <T extends RESTResponse> T execute(HTTPRequest request,
 Class<T> responseType,
 Consumer<ErrorResponse> errorHandler,
 Consumer<Map<String,String>> responseHeaders,
 ParserContext parserContext)