Package land.oras.auth

Class HttpClient

java.lang.Object

land.oras.auth.HttpClient

@NullMarked
public final class HttpClient
extends Object

HTTP client for ORAS

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpClient.Builder	Builder for the HTTP client
static final record	HttpClient.ResponseWrapper<T>	Response wrapper
static final record	HttpClient.TokenResponse	The token response

Method Summary

Modifier and Type	Method	Description
HttpClient	build()	Create a new HTTP client
HttpClient.ResponseWrapper<String>	delete(URI uri, Map<String,String> headers, Scopes scopes, AuthProvider authProvider)	Perform a DELETE request
HttpClient.ResponseWrapper<Path>	download(URI uri, Map<String,String> headers, Path file, Scopes scopes, AuthProvider authProvider)	Download to a file
HttpClient.ResponseWrapper<InputStream>	download(URI uri, Map<String,String> headers, Scopes scopes, AuthProvider authProvider)	Download to to input stream
HttpClient.ResponseWrapper<String>	get(URI uri, Map<String,String> headers, Scopes scopes, AuthProvider authProvider)	Perform a GET request
HttpClient.ResponseWrapper<String>	head(URI uri, Map<String,String> headers, Scopes scopes, AuthProvider authProvider)	Perform a HEAD request
HttpClient.ResponseWrapper<String>	patch(URI uri, byte[] body, Map<String,String> headers, Scopes scopes, AuthProvider authProvider)	Perform a Patch request
HttpClient.ResponseWrapper<String>	post(URI uri, byte[] body, Map<String,String> headers, Scopes scopes, AuthProvider authProvider)	Perform a POST request.
HttpClient.ResponseWrapper<String>	put(URI uri, byte[] body, Map<String,String> headers, Scopes scopes, AuthProvider authProvider)	Perform a PUT request
<T> HttpClient.TokenResponse	refreshToken(HttpClient.ResponseWrapper<T> response, Scopes scopes, AuthProvider authProvider)	Retrieve a token from the registry
HttpClient.ResponseWrapper<String>	upload(String method, URI uri, Map<String,String> headers, Path file, Scopes scopes, AuthProvider authProvider)	Upload a file

Methods inherited from class java.lang.Object

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

Method Details

build

public HttpClient build()

Create a new HTTP client

Returns:

The client

get

public HttpClient.ResponseWrapper<String> get(URI uri,
 Map<String,String> headers,
 Scopes scopes,
 AuthProvider authProvider)

Perform a GET request

Parameters:

uri - The URI

headers - The headers

scopes - The scopes

authProvider - The authentication provider

Returns:

The response

download

public HttpClient.ResponseWrapper<Path> download(URI uri,
 Map<String,String> headers,
 Path file,
 Scopes scopes,
 AuthProvider authProvider)

Download to a file

Parameters:

uri - The URI

headers - The headers

file - The file

scopes - The scopes

authProvider - The authentication provider

Returns:

The response

download

public HttpClient.ResponseWrapper<InputStream> download(URI uri,
 Map<String,String> headers,
 Scopes scopes,
 AuthProvider authProvider)

Download to to input stream

Parameters:

uri - The URI

headers - The headers

scopes - The scopes

authProvider - The authentication provider

Returns:

The response

upload

public HttpClient.ResponseWrapper<String> upload(String method,
 URI uri,
 Map<String,String> headers,
 Path file,
 Scopes scopes,
 AuthProvider authProvider)

Upload a file

Parameters:

method - The method (POST or PUT)

uri - The URI

headers - The headers

file - The file

scopes - The scopes

authProvider - The authentication provider

Returns:

The response

head

public HttpClient.ResponseWrapper<String> head(URI uri,
 Map<String,String> headers,
 Scopes scopes,
 AuthProvider authProvider)

Perform a HEAD request

Parameters:

uri - The URI

headers - The headers

scopes - The scopes

authProvider - The authentication provider

Returns:

The response

delete

public HttpClient.ResponseWrapper<String> delete(URI uri,
 Map<String,String> headers,
 Scopes scopes,
 AuthProvider authProvider)

Perform a DELETE request

Parameters:

uri - The URI

headers - The headers

scopes - The scopes

authProvider - The authentication provider

Returns:

The response

post

public HttpClient.ResponseWrapper<String> post(URI uri,
 byte[] body,
 Map<String,String> headers,
 Scopes scopes,
 AuthProvider authProvider)

Perform a POST request. Might not be suitable for large files. Use upload for large files.

Parameters:

uri - The URI.

body - The body

headers - The headers

scopes - The scopes

authProvider - The authentication provider

Returns:

The response

patch

public HttpClient.ResponseWrapper<String> patch(URI uri,
 byte[] body,
 Map<String,String> headers,
 Scopes scopes,
 AuthProvider authProvider)

Perform a Patch request

Parameters:

uri - The URI

body - The body

headers - The headers

scopes - The scopes

authProvider - The authentication provider

Returns:

The response

put

public HttpClient.ResponseWrapper<String> put(URI uri,
 byte[] body,
 Map<String,String> headers,
 Scopes scopes,
 AuthProvider authProvider)

Perform a PUT request

Parameters:

uri - The URI

body - The body

headers - The headers

scopes - The scopes

authProvider - The authentication provider

Returns:

The response

refreshToken

public <T> HttpClient.TokenResponse refreshToken(HttpClient.ResponseWrapper<T> response,
 Scopes scopes,
 AuthProvider authProvider)

Retrieve a token from the registry

Type Parameters:

T - The response type

Parameters:

response - The response that may contain a the WWW-Authenticate header

scopes - The scopes

authProvider - The authentication provider

Returns:

The token