com.cmobilecom.af.util.db

Class DbConfig

java.lang.Object

com.cmobilecom.af.util.db.DbConfig

All Implemented Interfaces:

java.lang.Cloneable

public class DbConfig
extends java.lang.Object
implements java.lang.Cloneable

DbConfig: database configuration

Since:

4.1.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbConfig.JdbcConfig PersistenceConfig contains values for JDBC configuration.

Constructor Summary

Constructors

Constructor and Description
DbConfig(DbDescriptor dbDescriptor, java.lang.String dbmsHome, java.lang.String host, java.lang.String port, java.lang.String sysAdminUsername, java.lang.String sysAdminPassword, java.lang.String database, java.lang.String username, java.lang.String password) Constructor

Method Summary

Modifier and Type	Method and Description
DbConfig	clone() Copy: shallow clone that refers to the same instance of DbDescriptor
static java.lang.String	getConnectionUrl(DbConfig dbConfig, boolean connectAsSystemAdmin, boolean encodeForXML) {@literal Get connection string the parameter separator is using & instead of its entity &.
static java.lang.String	getConnectionUrl(DbDescriptor dbDescriptor, java.lang.String host, java.lang.String port, java.lang.String database, boolean encodeForXML) Get connection string.
java.lang.String	getDatabase() Get database or service name for creating connection url.
DbDescriptor	getDbDescriptor() Get the DbDescriptor of this DbConfig
DbExec	getDbExec(boolean connectAsSystemAdmin, org.slf4j.Logger logger) Get DbExec
java.lang.String	getDbmsClientHome() Get database client home that usually has bin directory to put commands for database related administration.
java.lang.String	getHost() Get database server host
DbConfig.JdbcConfig	getJdbcConfig(java.lang.String schema, boolean encodeForXML) Get JdbcConfig
java.lang.String	getPassword() Get the password for connecting to the schema
java.lang.String	getPort() Get database server port
java.lang.String	getSchema() Get schema name for connection
java.lang.String	getSysAdminPassword() Get database system admin password
java.lang.String	getSysAdminUsername() Get database system admin username
java.lang.String	getUserHost() Get the name of the host from which the user access the database
java.lang.String	getUsername() Get the username for connecting to the schema
void	setDatabase(java.lang.String database) Set database or service name for creating connection url.
void	setDbDescriptor(DbDescriptor dbDescriptor) Set the DbDescriptor of this DbConfig
void	setDbmsClientHome(java.lang.String dbmsClientHome) Set database client home that usually has bin directory to put commands for database related administration.
void	setHost(java.lang.String host) Set database server host
void	setPassword(java.lang.String password) Set the password for connecting to the schema
void	setPort(java.lang.String port) Set database server port
void	setSchema(java.lang.String newSchema) Set new schema.
void	setSysAdminPassword(java.lang.String sysAdminPassword) Set database system admin password
void	setSysAdminUsername(java.lang.String sysAdminUsername) Set database system admin username
void	setUsername(java.lang.String username) Set the username for connecting to the schema

Methods inherited from class java.lang.Object

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

Constructor Detail

DbConfig

public DbConfig(DbDescriptor dbDescriptor,
                java.lang.String dbmsHome,
                java.lang.String host,
                java.lang.String port,
                java.lang.String sysAdminUsername,
                java.lang.String sysAdminPassword,
                java.lang.String database,
                java.lang.String username,
                java.lang.String password)

Constructor

Parameters:

dbDescriptor - database descriptor

dbmsHome - dbms client home

host - database server host

port - database server port

sysAdminUsername - system username

sysAdminPassword - system password

database - database or service name for connection

username - username for connection

password - password for connection

Method Detail

getDbDescriptor

public DbDescriptor getDbDescriptor()

Get the DbDescriptor of this DbConfig

Returns:

DbDescriptor instance

setDbDescriptor

public void setDbDescriptor(DbDescriptor dbDescriptor)

Set the DbDescriptor of this DbConfig

Parameters:

dbDescriptor - the DbDescriptor to set

getDbmsClientHome

public java.lang.String getDbmsClientHome()

Get database client home that usually has bin directory to put commands for database related administration.

Returns:

client installation home directory

setDbmsClientHome

public void setDbmsClientHome(java.lang.String dbmsClientHome)

Set database client home that usually has bin directory to put commands for database related administration.

Parameters:

dbmsClientHome - client installation home directory

getHost

public java.lang.String getHost()

Get database server host

Returns:

host name or ip address

setHost

public void setHost(java.lang.String host)

Set database server host

Parameters:

host - host name or ip address

getPort

public java.lang.String getPort()

Get database server port

Returns:

port number

setPort

public void setPort(java.lang.String port)

Set database server port

Parameters:

port - server port number

getSysAdminUsername

public java.lang.String getSysAdminUsername()

Get database system admin username

Returns:

admin username

setSysAdminUsername

public void setSysAdminUsername(java.lang.String sysAdminUsername)

Set database system admin username

Parameters:

sysAdminUsername - admin username

getSysAdminPassword

public java.lang.String getSysAdminPassword()

Get database system admin password

Returns:

admin password

setSysAdminPassword

public void setSysAdminPassword(java.lang.String sysAdminPassword)

Set database system admin password

Parameters:

sysAdminPassword - admin password

getDatabase

public java.lang.String getDatabase()

Get database or service name for creating connection url.

Returns:

database/service name

setDatabase

public void setDatabase(java.lang.String database)

Set database or service name for creating connection url.

Parameters:

database - database or service name

getSchema

public java.lang.String getSchema()

Get schema name for connection

Returns:

schema name

setSchema

public void setSchema(java.lang.String newSchema)

Set new schema. change database or username to the schema name if applicable to the database.

Parameters:

newSchema - new schema

getUsername

public java.lang.String getUsername()

Get the username for connecting to the schema

Returns:

non-system-admin username

setUsername

public void setUsername(java.lang.String username)

Set the username for connecting to the schema

Parameters:

username - schema username

getPassword

public java.lang.String getPassword()

Get the password for connecting to the schema

Returns:

password password for connecting to the schema

setPassword

public void setPassword(java.lang.String password)

Set the password for connecting to the schema

Parameters:

password - password for the username getUsername()}

clone

public DbConfig clone()

Copy: shallow clone that refers to the same instance of DbDescriptor

Overrides:

clone in class java.lang.Object

getUserHost

public java.lang.String getUserHost()
                             throws ExecException

Get the name of the host from which the user access the database

Returns:

host name

Throws:

ExecException - throw if host is unknown

getDbExec

public DbExec getDbExec(boolean connectAsSystemAdmin,
                        org.slf4j.Logger logger)
                 throws java.sql.SQLException

Get DbExec

Parameters:

connectAsSystemAdmin - whether to login as system administrator to manage schema.

logger - logger. null to disable logging

Returns:

DbExec instance

Throws:

java.sql.SQLException - throw if a database access error occurs

getConnectionUrl

public static java.lang.String getConnectionUrl(DbConfig dbConfig,
                                                boolean connectAsSystemAdmin,
                                                boolean encodeForXML)

Get connection string the parameter separator is using & instead of its entity &.

Parameters:

dbConfig - DbConfig

connectAsSystemAdmin - whether to connect as a system admin

encodeForXML - whether to encode for XML by escaping special characters

Returns:

connection URL

getConnectionUrl

public static java.lang.String getConnectionUrl(DbDescriptor dbDescriptor,
                                                java.lang.String host,
                                                java.lang.String port,
                                                java.lang.String database,
                                                boolean encodeForXML)

Get connection string.

Parameters:

dbDescriptor - database descriptor

host - host name or ip address

port - port number of dbms server

database - the database or service name to connect

encodeForXML - if true, the connection string will be encoded for xml.

Returns:

database connection string

getJdbcConfig

public DbConfig.JdbcConfig getJdbcConfig(java.lang.String schema,
                                         boolean encodeForXML)

Get JdbcConfig

Parameters:

schema - if not null, get JdbcConfig for the schema instead of default schema.

encodeForXML - if true, the connection string will be encoded for xml.

Returns:

JdbcConfig instance