Package land.oras.utils

Class OrasHttpClient

java.lang.Object

land.oras.utils.OrasHttpClient

@NullMarked
public final class OrasHttpClient
extends Object

HTTP client for ORAS

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OrasHttpClient.Builder	Builder for the HTTP client
static final record	OrasHttpClient.ResponseWrapper<T>	Response wrapper

Method Summary

Modifier and Type	Method	Description
OrasHttpClient	build()	Create a new HTTP client
OrasHttpClient.ResponseWrapper<String>	delete(URI uri, Map<String,String> headers)	Perform a DELETE request
OrasHttpClient.ResponseWrapper<InputStream>	download(URI uri, Map<String,String> headers)	Download to to input stream
OrasHttpClient.ResponseWrapper<Path>	download(URI uri, Map<String,String> headers, Path file)	Download to a file
OrasHttpClient.ResponseWrapper<String>	get(URI uri, Map<String,String> headers)	Perform a GET request
OrasHttpClient.ResponseWrapper<String>	head(URI uri, Map<String,String> headers)	Perform a HEAD request
OrasHttpClient.ResponseWrapper<String>	patch(URI uri, byte[] body, Map<String,String> headers)	Perform a Patch request
OrasHttpClient.ResponseWrapper<String>	post(URI uri, byte[] body, Map<String,String> headers)	Perform a POST request.
OrasHttpClient.ResponseWrapper<String>	put(URI uri, byte[] body, Map<String,String> headers)	Perform a PUT request
void	updateAuthentication(AuthProvider authProvider)	Update the authentication method for this client Typically used to change from basic to bearer token authentication or no auth to basic auth
OrasHttpClient.ResponseWrapper<String>	upload(String method, URI uri, Map<String,String> headers, Path file)	Upload a file
OrasHttpClient.ResponseWrapper<String>	uploadStream(String method, URI uri, InputStream input, long size, Map<String,String> headers)	Upload a stream

Methods inherited from class java.lang.Object

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

Method Details

updateAuthentication

public void updateAuthentication(AuthProvider authProvider)

Update the authentication method for this client Typically used to change from basic to bearer token authentication or no auth to basic auth

Parameters:

authProvider - The auth provider

build

public OrasHttpClient build()

Create a new HTTP client

Returns:

The client

get

public OrasHttpClient.ResponseWrapper<String> get(URI uri,
 Map<String,String> headers)

Perform a GET request

Parameters:

uri - The URI

headers - The headers

Returns:

The response

download

public OrasHttpClient.ResponseWrapper<Path> download(URI uri,
 Map<String,String> headers,
 Path file)

Download to a file

Parameters:

uri - The URI

headers - The headers

file - The file

Returns:

The response

download

public OrasHttpClient.ResponseWrapper<InputStream> download(URI uri,
 Map<String,String> headers)

Download to to input stream

Parameters:

uri - The URI

headers - The headers

Returns:

The response

upload

public OrasHttpClient.ResponseWrapper<String> upload(String method,
 URI uri,
 Map<String,String> headers,
 Path file)

Upload a file

Parameters:

method - The method (POST or PUT)

uri - The URI

headers - The headers

file - The file

Returns:

The response

head

public OrasHttpClient.ResponseWrapper<String> head(URI uri,
 Map<String,String> headers)

Perform a HEAD request

Parameters:

uri - The URI

headers - The headers

Returns:

The response

delete

public OrasHttpClient.ResponseWrapper<String> delete(URI uri,
 Map<String,String> headers)

Perform a DELETE request

Parameters:

uri - The URI

headers - The headers

Returns:

The response

post

public OrasHttpClient.ResponseWrapper<String> post(URI uri,
 byte[] body,
 Map<String,String> headers)

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

Returns:

The response

patch

public OrasHttpClient.ResponseWrapper<String> patch(URI uri,
 byte[] body,
 Map<String,String> headers)

Perform a Patch request

Parameters:

uri - The URI

body - The body

headers - The headers

Returns:

The response

put

public OrasHttpClient.ResponseWrapper<String> put(URI uri,
 byte[] body,
 Map<String,String> headers)

Perform a PUT request

Parameters:

uri - The URI

body - The body

headers - The headers

Returns:

The response

uploadStream

public OrasHttpClient.ResponseWrapper<String> uploadStream(String method,
 URI uri,
 InputStream input,
 long size,
 Map<String,String> headers)

Upload a stream

Parameters:

method - The method (POST or PUT)

uri - The URI

input - The input stream

size - The size of the stream

headers - The headers

Returns:

The response