org.testcontainers.containers

Class JdbcDatabaseContainer<SELF extends JdbcDatabaseContainer<SELF>>

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<SELF>

org.testcontainers.containers.JdbcDatabaseContainer<SELF>

All Implemented Interfaces:

AutoCloseable, org.junit.rules.TestRule, Container<SELF>, LinkableContainer

public abstract class JdbcDatabaseContainer<SELF extends JdbcDatabaseContainer<SELF>>
extends GenericContainer<SELF>
implements LinkableContainer

Base class for containers that expose a JDBC connection

Author:

richardnorth

Nested Class Summary

Nested classes/interfaces inherited from class org.testcontainers.containers.GenericContainer

GenericContainer.AbstractWaitStrategy

Nested classes/interfaces inherited from interface org.testcontainers.containers.Container

Container.ExecResult

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	parameters

Fields inherited from class org.testcontainers.containers.GenericContainer

CONTAINER_RUNNING_TIMEOUT_SEC, containerId, containerName, dockerClient, dockerDaemonInfo, waitStrategy

Constructor Summary

Constructors

Constructor and Description
JdbcDatabaseContainer(String dockerImageName)

Method Summary

Modifier and Type	Method and Description
void	addParameter(String paramName, String value)
Connection	createConnection(String queryString) Creates a connection to the underlying containerized database instance.
String	getDatabaseName()
protected abstract String	getDriverClassName()
Driver	getJdbcDriverInstance() Obtain an instance of the correct JDBC driver for this particular database container type
abstract String	getJdbcUrl()
abstract String	getPassword()
protected abstract String	getTestQueryString()
abstract String	getUsername()
protected void	optionallyMapResourceParameterAsVolume(String paramName, String pathNameInContainer, String defaultResource)
void	setParameters(Map<String,String> parameters)
protected void	waitUntilContainerStarted()
SELF	withDatabaseName(String dbName)
SELF	withPassword(String password)
SELF	withUsername(String username)

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addLink, canEqual, close, configure, containerIsStarted, containerIsStarting, copyFileFromContainer, copyFileToContainer, createVolumeDirectory, equals, execInContainer, execInContainer, fetchDockerDaemonInfo, finished, followOutput, followOutput, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerIpAddress, getContainerName, getCreateContainerCmdModifiers, getDockerClient, getDockerDaemonInfo, getDockerImageName, getEnv, getEnvMap, getExposedPorts, getExtraHosts, getImage, getIpAddress, getLinkedContainers, getLivenessCheckPort, getLivenessCheckPorts, getLogConsumers, getMappedPort, getNetwork, getNetworkAliases, getNetworkMode, getPortBindings, getStartupAttempts, getStartupCheckStrategy, getTestHostIpAddress, getVolumesFroms, getWaitStrategy, getWorkingDirectory, hashCode, isPrivilegedMode, isRunning, logger, setBinds, setCommand, setCommand, setCommandParts, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setImage, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setStartupAttempts, setStartupCheckStrategy, setVolumesFroms, setWaitStrategy, setWorkingDirectory, start, starting, stop, toString, waitingFor, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCreateContainerCmdModifier, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, withStartupAttempts, withStartupCheckStrategy, withStartupTimeout, withVolumesFrom, withWorkingDirectory

Methods inherited from class org.testcontainers.containers.FailureDetectingExternalResource

apply, failed, succeeded

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.testcontainers.containers.traits.LinkableContainer

getContainerName

Methods inherited from interface org.testcontainers.containers.Container

addFileSystemBind, getFirstMappedPort, self, withEnv, withFileSystemBind

Field Detail

parameters

protected Map<String,String> parameters

Constructor Detail

JdbcDatabaseContainer

public JdbcDatabaseContainer(String dockerImageName)

Method Detail

getDriverClassName

protected abstract String getDriverClassName()

Returns:

the name of the actual JDBC driver to use

getJdbcUrl

public abstract String getJdbcUrl()

Returns:

a JDBC URL that may be used to connect to the dockerized DB

getDatabaseName

public String getDatabaseName()

Returns:

the database name

getUsername

public abstract String getUsername()

Returns:

the standard database username that should be used for connections

getPassword

public abstract String getPassword()

Returns:

the standard password that should be used for connections

getTestQueryString

protected abstract String getTestQueryString()

Returns:

a test query string suitable for testing that this particular database type is alive

withUsername

public SELF withUsername(String username)

withPassword

public SELF withPassword(String password)

withDatabaseName

public SELF withDatabaseName(String dbName)

waitUntilContainerStarted

protected void waitUntilContainerStarted()

Overrides:

waitUntilContainerStarted in class GenericContainer<SELF extends JdbcDatabaseContainer<SELF>>

getJdbcDriverInstance

public Driver getJdbcDriverInstance()

Obtain an instance of the correct JDBC driver for this particular database container type

Returns:

a JDBC Driver

createConnection

public Connection createConnection(String queryString)
                            throws SQLException

Creates a connection to the underlying containerized database instance.

Parameters:

queryString - any special query string parameters that should be appended to the JDBC connection URL. The '?' character must be included

Returns:

a Connection

Throws:

SQLException - if there is a repeated failure to create the connection

optionallyMapResourceParameterAsVolume

protected void optionallyMapResourceParameterAsVolume(@NotNull
                                                      String paramName,
                                                      @NotNull
                                                      String pathNameInContainer,
                                                      @NotNull
                                                      String defaultResource)

setParameters

public void setParameters(Map<String,String> parameters)

addParameter

public void addParameter(String paramName,
                         String value)