org.javalite.activejdbc.connection_config

Class DbConfiguration

java.lang.Object

org.javalite.activejdbc.connection_config.DbConfiguration

Direct Known Subclasses:

AbstractDBConfig, DBSpec

public class DbConfiguration
extends Object

Author:

igor on 12/2/16.

Constructor Summary

Constructors

Constructor and Description
DbConfiguration()

Method Summary

Modifier and Type	Method and Description
static void	addConnectionWrapper(ConnectionSpecWrapper connectionWrapper, boolean override)
static void	clearConnectionWrappers()
protected static void	clearConnectionWrappers(String env)
static List<ConnectionSpecWrapper>	getConnectionSpecWrappers() Provides a list of all connection wrappers corresponding to a current environment.
static List<ConnectionSpecWrapper>	getConnectionSpecWrappers(String env) Provides a list of all connection wrappers corresponding to a given environment.
List<ConnectionSpecWrapper>	getTestConnectionWrappers()
void	loadConfiguration(String file) Configures multiple database connections from a single property file.
static void	resetConnectionWrappers()

Methods inherited from class java.lang.Object

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

Constructor Detail

DbConfiguration

public DbConfiguration()

Method Detail

addConnectionWrapper

public static void addConnectionWrapper(ConnectionSpecWrapper connectionWrapper,
                                        boolean override)

getConnectionSpecWrappers

public static List<ConnectionSpecWrapper> getConnectionSpecWrappers()

Provides a list of all connection wrappers corresponding to a current environment.

Returns:

a list of all connection wrappers corresponding to a current environment.

getConnectionSpecWrappers

public static List<ConnectionSpecWrapper> getConnectionSpecWrappers(String env)

Provides a list of all connection wrappers corresponding to a given environment.

Parameters:

env - name of environment, such as "development", "production", etc.

Returns:

a list of all connection wrappers corresponding to a given environment.

clearConnectionWrappers

public static void clearConnectionWrappers()

resetConnectionWrappers

public static void resetConnectionWrappers()

clearConnectionWrappers

protected static void clearConnectionWrappers(String env)

loadConfiguration

public void loadConfiguration(String file)

Configures multiple database connections from a single property file. Example content for such file:

     development.driver=com.mysql.jdbc.Driver
     development.username=john
     development.password=pwd
     development.url=jdbc:mysql://localhost/proj_dev

     test.driver=com.mysql.jdbc.Driver
     test.username=mary
     test.password=pwd1
     test.url=jdbc:mysql://localhost/test

     production.jndi=java:comp/env/jdbc/prod

     # this one is to run migrations in production remotely
     production.remote.driver=com.mysql.jdbc.Driver
     production.remote.username=root
     production.remote.password=xxx
     production.remote.url=jdbc:mysql://127.0.0.1:3307/poj1_production

 

Rules and limitations of using a file-based configuration:

• Only one database connection can be configured per environment (with the exception of development and test connections only in development environment)
• Currently additional database parameters need to be specified as a part of a database URL
• Database connection named "test" in the database configuration file is for "development" environment and is automatically marked for testing (will be used during tests)
• All connections specified in a property file automatically assigned DB name "default"

Parameters:

file - path to a file. Can be located on classpath, or on a file system. First searched on classpath, then on file system.

getTestConnectionWrappers

public List<ConnectionSpecWrapper> getTestConnectionWrappers()