Package io.ebean.docker.commands

Class BaseConfig

java.lang.Object

io.ebean.docker.commands.BaseConfig

All Implemented Interfaces:

ContainerConfig

Direct Known Subclasses:

DbConfig, ElasticConfig, RedisConfig

public abstract class BaseConfig
extends Object
implements ContainerConfig

Configuration for an DBMS like Postgres, MySql, Oracle, SQLServer

Method Summary

Modifier and Type	Method	Description
void	clearStopMode()	Clear the stopMode when detect already running.
String	containerName()	Return the container name.
Connection	createAdminConnection()	Return a DB connection using the admin user.
Connection	createConnection()	Return a Connection to the database (make sure you close it).
Connection	createConnectionNoSchema()	Return a DB connection without schema (as it maybe is not created yet).
int	getAdminInternalPort()
int	getAdminPort()
String	getCharacterSet()
String	getCollation()
String	getDocker()
String	getImage()
int	getInternalPort()
int	getMaxReadyAttempts()
int	getPort()
StartMode	getStartMode()
StopMode	getStopMode()
boolean	isDefaultCollation()
boolean	isExplicitCollation()
boolean	isStopModeNone()
String	jdbcAdminUrl()	Return a DB connection url for the admin database user.
String	jdbcUrl()	Return a DB connection url or null if not a database container.
String	platform()	Return the type of container.
BaseConfig	setAdminInternalPort(int adminInternalPort)	Set the internal admin (to the container) port.
BaseConfig	setAdminPort(int adminPort)	Set the exposed admin port.
BaseConfig	setCharacterSet(String characterSet)	Set the character set to use.
BaseConfig	setCollation(String collation)	Set the collation to use.
BaseConfig	setContainerName(String containerName)	Set the container name.
BaseConfig	setDocker(String docker)	Set the docker command to use (defaults to 'docker').
BaseConfig	setImage(String image)	Set the docker image to use.
BaseConfig	setInternalPort(int internalPort)	Set the internal (to the container) port.
BaseConfig	setMaxReadyAttempts(int maxReadyAttempts)	Set the max attempts to wait for DB ready.
BaseConfig	setPort(int port)	Set the exposed port.
BaseConfig	setProperties(Properties properties)	Load configuration from properties.
void	setShutdownMode(StopMode shutdownMode)	Set the shutdown hook mode to automatically stop/remove the container on JVM shutdown.
void	setStartMode(StartMode startMode)	Set the start mode.
void	setStopMode(StopMode stopMode)	Set the stop mode used when stop() is called.
StopMode	shutdownMode()
String	startDescription()	Return a description of the configuration.
String	stopDescription()	Return a good description for stopping the container typically for logging.
String	version()	Return the image version.

Methods inherited from class java.lang.Object

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

Method Detail

startDescription

public String startDescription()

Return a description of the configuration.

Specified by:

startDescription in interface ContainerConfig

stopDescription

public String stopDescription()

Description copied from interface: ContainerConfig

Return a good description for stopping the container typically for logging.

Specified by:

stopDescription in interface ContainerConfig

platform

public String platform()

Description copied from interface: ContainerConfig

Return the type of container. postgres, mysql, elastic etc.

Specified by:

platform in interface ContainerConfig

containerName

public String containerName()

Description copied from interface: ContainerConfig

Return the container name.

Specified by:

containerName in interface ContainerConfig

version

public String version()

Description copied from interface: ContainerConfig

Return the image version.

Specified by:

version in interface ContainerConfig

setStartMode

public void setStartMode(StartMode startMode)

Description copied from interface: ContainerConfig

Set the start mode. One of create, dropCreate, or container [only].

Specified by:

setStartMode in interface ContainerConfig

setStopMode

public void setStopMode(StopMode stopMode)

Description copied from interface: ContainerConfig

Set the stop mode used when stop() is called.

Specified by:

setStopMode in interface ContainerConfig

setShutdownMode

public void setShutdownMode(StopMode shutdownMode)

Description copied from interface: ContainerConfig

Set the shutdown hook mode to automatically stop/remove the container on JVM shutdown.

Specified by:

setShutdownMode in interface ContainerConfig

createConnection

public Connection createConnection()
                            throws SQLException

Return a Connection to the database (make sure you close it).

Specified by:

createConnection in interface ContainerConfig

Throws:

SQLException

createConnectionNoSchema

public Connection createConnectionNoSchema()
                                    throws SQLException

Description copied from interface: ContainerConfig

Return a DB connection without schema (as it maybe is not created yet).

Specified by:

createConnectionNoSchema in interface ContainerConfig

Throws:

SQLException

createAdminConnection

public Connection createAdminConnection()
                                 throws SQLException

Description copied from interface: ContainerConfig

Return a DB connection using the admin user.

Specified by:

createAdminConnection in interface ContainerConfig

Throws:

SQLException

jdbcUrl

public String jdbcUrl()

Description copied from interface: ContainerConfig

Return a DB connection url or null if not a database container.

Specified by:

jdbcUrl in interface ContainerConfig

jdbcAdminUrl

public String jdbcAdminUrl()

Description copied from interface: ContainerConfig

Return a DB connection url for the admin database user.

Specified by:

jdbcAdminUrl in interface ContainerConfig

setProperties

public BaseConfig setProperties(Properties properties)

Load configuration from properties.

setContainerName

public BaseConfig setContainerName(String containerName)

Set the container name.

setPort

public BaseConfig setPort(int port)

Set the exposed port.

setInternalPort

public BaseConfig setInternalPort(int internalPort)

Set the internal (to the container) port.

setAdminPort

public BaseConfig setAdminPort(int adminPort)

Set the exposed admin port.

setAdminInternalPort

public BaseConfig setAdminInternalPort(int adminInternalPort)

Set the internal admin (to the container) port.

setImage

public BaseConfig setImage(String image)

Set the docker image to use.

setCharacterSet

public BaseConfig setCharacterSet(String characterSet)

Set the character set to use.

setCollation

public BaseConfig setCollation(String collation)

Set the collation to use.

setMaxReadyAttempts

public BaseConfig setMaxReadyAttempts(int maxReadyAttempts)

Set the max attempts to wait for DB ready.

setDocker

public BaseConfig setDocker(String docker)

Set the docker command to use (defaults to 'docker').

getPort

public int getPort()

getInternalPort

public int getInternalPort()

getAdminPort

public int getAdminPort()

getAdminInternalPort

public int getAdminInternalPort()

getImage

public String getImage()

getStartMode

public StartMode getStartMode()

getStopMode

public StopMode getStopMode()

getMaxReadyAttempts

public int getMaxReadyAttempts()

getDocker

public String getDocker()

shutdownMode

public StopMode shutdownMode()

getCharacterSet

public String getCharacterSet()

getCollation

public String getCollation()

isExplicitCollation

public boolean isExplicitCollation()

isDefaultCollation

public boolean isDefaultCollation()

isStopModeNone

public boolean isStopModeNone()

clearStopMode

public void clearStopMode()

Clear the stopMode when detect already running.