Class DockerComposeConnectionDetailsFactory<D extends ConnectionDetails>

java.lang.Object

org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionDetailsFactory<D>

Type Parameters:

D - the connection details type

All Implemented Interfaces:

ConnectionDetailsFactory<DockerComposeConnectionSource, D>

public abstract class DockerComposeConnectionDetailsFactory<D extends ConnectionDetails>
extends Object
implements ConnectionDetailsFactory<DockerComposeConnectionSource, D>

Base class for ConnectionDetailsFactory implementations that provide ConnectionDetails from a DockerComposeConnectionSource.

Since:

3.1.0

Author:

Moritz Halbritter, Andy Wilkinson, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DockerComposeConnectionDetailsFactory.DockerComposeConnectionDetails	Convenient base class for ConnectionDetails results that are backed by a RunningService.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DockerComposeConnectionDetailsFactory(String[] connectionNames, String... requiredClassNames)	Create a new DockerComposeConnectionDetailsFactory instance.
protected	DockerComposeConnectionDetailsFactory(String connectionName, String... requiredClassNames)	Create a new DockerComposeConnectionDetailsFactory instance.
protected	DockerComposeConnectionDetailsFactory(Predicate<DockerComposeConnectionSource> predicate, String... requiredClassNames)	Create a new DockerComposeConnectionDetailsFactory instance.

Method Summary

Modifier and Type	Method	Description
final @Nullable D	getConnectionDetails(DockerComposeConnectionSource source)	Get the ConnectionDetails from the given source.
protected abstract @Nullable D	getDockerComposeConnectionDetails(DockerComposeConnectionSource source)	Get the ConnectionDetails from the given RunningService source.

Methods inherited from class Object

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

Constructor Details

DockerComposeConnectionDetailsFactory

protected DockerComposeConnectionDetailsFactory(String connectionName,
 String... requiredClassNames)

Create a new DockerComposeConnectionDetailsFactory instance.

Parameters:

connectionName - the required connection name

requiredClassNames - the names of classes that must be present

DockerComposeConnectionDetailsFactory

protected DockerComposeConnectionDetailsFactory(String[] connectionNames,
 String... requiredClassNames)

Create a new DockerComposeConnectionDetailsFactory instance.

Parameters:

connectionNames - the required connection name

requiredClassNames - the names of classes that must be present

Since:

3.2.0

DockerComposeConnectionDetailsFactory

protected DockerComposeConnectionDetailsFactory(Predicate<DockerComposeConnectionSource> predicate,
 String... requiredClassNames)

Create a new DockerComposeConnectionDetailsFactory instance.

Parameters:

predicate - a predicate used to check when a service is accepted

requiredClassNames - the names of classes that must be present

Method Details

getConnectionDetails

public final @Nullable D getConnectionDetails(DockerComposeConnectionSource source)

Description copied from interface: ConnectionDetailsFactory

Get the ConnectionDetails from the given source. May return null if no details can be created.

Specified by:

getConnectionDetails in interface ConnectionDetailsFactory<DockerComposeConnectionSource, D extends ConnectionDetails>

Parameters:

source - the source

Returns:

the connection details or null

getDockerComposeConnectionDetails

protected abstract @Nullable D getDockerComposeConnectionDetails(DockerComposeConnectionSource source)

Get the ConnectionDetails from the given RunningService source. May return null if no connection can be created. Result types should consider extending DockerComposeConnectionDetailsFactory.DockerComposeConnectionDetails.

Parameters:

source - the source

Returns:

the service connection or null.