Package org.springframework.boot.testcontainers.service.connection

Class ContainerConnectionDetailsFactory<C extends org.testcontainers.containers.Container<?>,D extends ConnectionDetails>

java.lang.Object

org.springframework.boot.testcontainers.service.connection.ContainerConnectionDetailsFactory<C,D>

Type Parameters:

D - the connection details type

C - the container type

All Implemented Interfaces:

RuntimeHintsRegistrar, ConnectionDetailsFactory<ContainerConnectionSource<C>,D>

public abstract class ContainerConnectionDetailsFactory<C extends org.testcontainers.containers.Container<?>,D extends ConnectionDetails>
extends Object
implements ConnectionDetailsFactory<ContainerConnectionSource<C>,D>, RuntimeHintsRegistrar

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

Since:

3.1.0

Author:

Moritz Halbritter, Andy Wilkinson, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ContainerConnectionDetailsFactory.ContainerConnectionDetails<C extends org.testcontainers.containers.Container<?>>	Base class for ConnectionDetails results that are backed by a ContainerConnectionSource.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ANY_CONNECTION_NAME	Constant passed to the constructor when any connection name is accepted.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ContainerConnectionDetailsFactory()	Create a new ContainerConnectionDetailsFactory instance that accepts any connection name.
protected	ContainerConnectionDetailsFactory(String connectionName, String... requiredClassNames)	Create a new ContainerConnectionDetailsFactory instance with the given connection name restriction.

Method Summary

Modifier and Type	Method	Description
final D	getConnectionDetails(ContainerConnectionSource<C> source)	Get the ConnectionDetails from the given source.
protected abstract D	getContainerConnectionDetails(ContainerConnectionSource<C> source)	Get the ConnectionDetails from the given ContainerConnectionSource source.
void	registerHints(RuntimeHints hints, ClassLoader classLoader)

Methods inherited from class java.lang.Object

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

Field Details

ANY_CONNECTION_NAME

protected static final String ANY_CONNECTION_NAME

Constant passed to the constructor when any connection name is accepted.

Constructor Details

ContainerConnectionDetailsFactory

protected ContainerConnectionDetailsFactory()

Create a new ContainerConnectionDetailsFactory instance that accepts any connection name.

ContainerConnectionDetailsFactory

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

Create a new ContainerConnectionDetailsFactory instance with the given connection name restriction.

Parameters:

connectionName - the required connection name or ANY_CONNECTION_NAME

requiredClassNames - the names of classes that must be present

Method Details

getConnectionDetails

public final D getConnectionDetails(ContainerConnectionSource<C> 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<C extends org.testcontainers.containers.Container<?>,D extends ConnectionDetails>

Parameters:

source - the source

Returns:

the connection details or null

registerHints

public void registerHints(RuntimeHints hints,
 ClassLoader classLoader)

Specified by:

registerHints in interface RuntimeHintsRegistrar

getContainerConnectionDetails

protected abstract D getContainerConnectionDetails(ContainerConnectionSource<C> source)

Get the ConnectionDetails from the given ContainerConnectionSource source. May return null if no connection can be created. Result types should consider extending ContainerConnectionDetailsFactory.ContainerConnectionDetails.

Parameters:

source - the source

Returns:

the service connection or null.