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 and Description
static interface	HttpTransport.Response An HTTP operation response.

Method Summary

Modifier and Type	Method and Description
static HttpTransport	create() Create the most suitable HttpTransport based on the system environment.
static HttpTransport	create(DockerHost dockerHost) Create the most suitable HttpTransport based on the system environment.
static HttpTransport	create(Environment environment) Create the most suitable HttpTransport based on the given Environment.
static HttpTransport	create(Environment environment, DockerHost dockerHost) Create the most suitable HttpTransport based on the given Environment and DockerConfiguration.
HttpTransport.Response	delete(URI uri) Perform a HTTP DELETE operation.
HttpTransport.Response	get(URI uri) Perform a HTTP GET operation.
HttpTransport.Response	post(URI uri) Perform a HTTP POST operation.
HttpTransport.Response	post(URI uri, String registryAuth) Perform a HTTP POST operation.
HttpTransport.Response	post(URI uri, String contentType, IOConsumer<OutputStream> writer) Perform a HTTP POST operation.
HttpTransport.Response	put(URI uri, String contentType, IOConsumer<OutputStream> writer) Perform a HTTP PUT operation.

Method Detail

get

HttpTransport.Response get(URI uri)
                    throws IOException

Perform a 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 a 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 a 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 a 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 a 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 a HTTP DELETE operation.

Parameters:

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

Returns:

the operation response

Throws:

IOException - on IO error

create

static HttpTransport create()

Create the most suitable HttpTransport based on the system environment.

Returns:

a HttpTransport instance

create

static HttpTransport create(DockerHost dockerHost)

Create the most suitable HttpTransport based on the system environment.

Parameters:

dockerHost - the Docker engine host configuration

Returns:

a HttpTransport instance

create

static HttpTransport create(Environment environment)

Create the most suitable HttpTransport based on the given Environment.

Parameters:

environment - the source environment

Returns:

a HttpTransport instance

create

static HttpTransport create(Environment environment,
                            DockerHost dockerHost)

Create the most suitable HttpTransport based on the given Environment and DockerConfiguration.

Parameters:

environment - the source environment

dockerHost - the Docker engine host configuration

Returns:

a HttpTransport instance