Package io.ebean.docker.container
Interface ContainerConfig
-
- All Known Implementing Classes:
BaseConfig,ClickHouseConfig,CockroachConfig,DbConfig,ElasticConfig,HanaConfig,MariaDBConfig,MySqlConfig,NuoDBConfig,OracleConfig,PostgresConfig,RedisConfig,SqlServerConfig
public interface ContainerConfig
Configuration details associated with a container.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringcontainerName()Return the container name.ConnectioncreateAdminConnection()Return a DB connection using the admin user.ConnectioncreateConnection()Return a DB connection.ConnectioncreateConnectionNoSchema()Return a DB connection without schema (as it maybe is not created yet).StringjdbcAdminUrl()Return a DB connection url for the admin database user.StringjdbcUrl()Return a DB connection url or null if not a database container.Stringplatform()Return the type of container.voidsetShutdownMode(StopMode shutdownHookMode)Set the shutdown hook mode to automatically stop/remove the container on JVM shutdown.voidsetStartMode(StartMode startMode)Set the start mode.voidsetStopMode(StopMode stopMode)Set the stop mode used when stop() is called.StringstartDescription()Return a good description for starting the container typically for logging.StringstopDescription()Return a good description for stopping the container typically for logging.Stringversion()Return the image version.
-
-
-
Method Detail
-
containerName
String containerName()
Return the container name.
-
jdbcAdminUrl
String jdbcAdminUrl()
Return a DB connection url for the admin database user.
-
createConnection
Connection createConnection() throws SQLException
Return a DB connection.- Throws:
SQLException
-
createConnectionNoSchema
Connection createConnectionNoSchema() throws SQLException
Return a DB connection without schema (as it maybe is not created yet).- Throws:
SQLException
-
createAdminConnection
Connection createAdminConnection() throws SQLException
Return a DB connection using the admin user.- Throws:
SQLException
-
setStartMode
void setStartMode(StartMode startMode)
Set the start mode. One of create, dropCreate, or container [only].
-
setStopMode
void setStopMode(StopMode stopMode)
Set the stop mode used when stop() is called.
-
setShutdownMode
void setShutdownMode(StopMode shutdownHookMode)
Set the shutdown hook mode to automatically stop/remove the container on JVM shutdown.
-
startDescription
String startDescription()
Return a good description for starting the container typically for logging.
-
stopDescription
String stopDescription()
Return a good description for stopping the container typically for logging.
-
-