Package org.springframework.boot.buildpack.platform.docker.transport

Interface HttpTransport

public interface HttpTransport

HTTP transport used for docker access.

Since:

2.3.0

Author:

Phillip Webb, Scott Frederick

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	HttpTransport.Response	An HTTP operation response.

Method Summary

Modifier and Type	Method	Description
static HttpTransport	create(DockerConfiguration.DockerHostConfiguration dockerHost)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.5.0 for removal in 4.0.0 in favor of create(DockerConnectionConfiguration)
static HttpTransport	create(DockerConnectionConfiguration connectionConfiguration)	Create the most suitable HttpTransport based on the DockerHost.
HttpTransport.Response	delete(URI uri)	Perform an HTTP DELETE operation.
HttpTransport.Response	get(URI uri)	Perform an HTTP GET operation.
HttpTransport.Response	head(URI uri)	Perform an HTTP HEAD operation.
HttpTransport.Response	post(URI uri)	Perform an HTTP POST operation.
HttpTransport.Response	post(URI uri, String registryAuth)	Perform an HTTP POST operation.
HttpTransport.Response	post(URI uri, String contentType, IOConsumer<OutputStream> writer)	Perform an HTTP POST operation.
HttpTransport.Response	put(URI uri, String contentType, IOConsumer<OutputStream> writer)	Perform an HTTP PUT operation.

Method Details

get

HttpTransport.Response get(URI uri)
                    throws IOException

Perform an HTTP GET operation.

Parameters:

uri - the destination URI (excluding any host/port)

Returns:

the operation response

Throws:

IOException - on IO error

post

HttpTransport.Response post(URI uri)
                     throws IOException

Perform an HTTP POST operation.

Parameters:

uri - the destination URI (excluding any host/port)

Returns:

the operation response

Throws:

IOException - on IO error

post

HttpTransport.Response post(URI uri,
 String registryAuth)
                     throws IOException

Perform an HTTP POST operation.

Parameters:

uri - the destination URI (excluding any host/port)

registryAuth - registry authentication credentials

Returns:

the operation response

Throws:

IOException - on IO error

post

HttpTransport.Response post(URI uri,
 String contentType,
 IOConsumer<OutputStream> writer)
                     throws IOException

Perform an HTTP POST operation.

Parameters:

uri - the destination URI (excluding any host/port)

contentType - the content type to write

writer - a content writer

Returns:

the operation response

Throws:

IOException - on IO error

put

HttpTransport.Response put(URI uri,
 String contentType,
 IOConsumer<OutputStream> writer)
                    throws IOException

Perform an HTTP PUT operation.

Parameters:

uri - the destination URI (excluding any host/port)

contentType - the content type to write

writer - a content writer

Returns:

the operation response

Throws:

IOException - on IO error

delete

HttpTransport.Response delete(URI uri)
                       throws IOException

Perform an HTTP DELETE operation.

Parameters:

uri - the destination URI (excluding any host/port)

Returns:

the operation response

Throws:

IOException - on IO error

head

HttpTransport.Response head(URI uri)
                     throws IOException

Perform an HTTP HEAD operation.

Parameters:

uri - the destination URI (excluding any host/port)

Returns:

the operation response

Throws:

IOException - on IO error

create

@Deprecated(since="3.5.0",
            forRemoval=true)
static HttpTransport create(DockerConfiguration.DockerHostConfiguration dockerHost)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.5.0 for removal in 4.0.0 in favor of create(DockerConnectionConfiguration)

Create the most suitable HttpTransport based on the DockerHost.

Parameters:

dockerHost - the Docker host information

Returns:

a HttpTransport instance

create

static HttpTransport create(DockerConnectionConfiguration connectionConfiguration)

Create the most suitable HttpTransport based on the DockerHost.

Parameters:

connectionConfiguration - the Docker host information

Returns:

a HttpTransport instance