org.opencms.setup.db

类 CmsUpdateDBManager

java.lang.Object

org.opencms.setup.db.CmsUpdateDBManager

public class CmsUpdateDBManager
extends java.lang.Object

This manager controls the update of the database from OpenCms 6 to OpenCms 7.

从以下版本开始:

7.0.0

构造器概要

构造器

构造器和说明
CmsUpdateDBManager() Default constructor.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getDbDriver(java.lang.String pool) Returns the configured jdbc driver for the given pool.
java.lang.String	getDbName() Returns the database name.
java.lang.String	getDbParams(java.lang.String pool) Returns the configured jdbc url parameters for the given pool.
java.lang.String	getDbUrl(java.lang.String pool) Returns the configured jdbc connection url for the given pool.
java.lang.String	getDbUser(java.lang.String pool) Returns the configured database user for the given pool.
double	getDetectedVersion() Returns the detected mayor version, based on DB structure.
protected I_CmsUpdateDBPart	getInstanceForDb(I_CmsUpdateDBPart dbUpdater, java.lang.String dbName) Creates a new instance for the given database and setting the db pool data.
protected void	getMySqlEngine(java.util.Map<java.lang.String,java.lang.String> dbPoolData) Retrieves the mysql engine name.
protected void	getOracleTablespaces(java.util.Map<java.lang.String,java.lang.String> dbPoolData) Retrieves the oracle tablespace names.
java.util.List<java.lang.String>	getPools() Returns all configured database pools.
protected void	getPostgreSqlTablespaces(java.util.Map<java.lang.String,java.lang.String> dbPoolData) Retrieves the postgresql tablespace names.
java.lang.String	htmlPool(java.lang.String pool) Generates html code for the given db pool.
void	initialize(CmsUpdateBean updateBean) Initializes the Update Manager object with the updateBean to get the database connection.
boolean	needUpdate() Checks if an update is needed.
void	run() Updates all database pools.
void	updateDatabase(java.lang.String pool) Updates the database.

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsUpdateDBManager

public CmsUpdateDBManager()

Default constructor.

方法详细资料

getDbDriver

public java.lang.String getDbDriver(java.lang.String pool)

Returns the configured jdbc driver for the given pool.

参数:

pool - the db pool to get the driver for

返回:

the driver class name

getDbName

public java.lang.String getDbName()

Returns the database name.

返回:

the database name

getDbParams

public java.lang.String getDbParams(java.lang.String pool)

Returns the configured jdbc url parameters for the given pool.

参数:

pool - the db pool to get the params for

返回:

the jdbc url parameters

getDbUrl

public java.lang.String getDbUrl(java.lang.String pool)

Returns the configured jdbc connection url for the given pool.

参数:

pool - the db pool to get the url for

返回:

the jdbc connection url

getDbUser

public java.lang.String getDbUser(java.lang.String pool)

Returns the configured database user for the given pool.

参数:

pool - the db pool to get the user for

返回:

the database user

getDetectedVersion

public double getDetectedVersion()

Returns the detected mayor version, based on DB structure.

返回:

the detected mayor version

getPools

public java.util.List<java.lang.String> getPools()

Returns all configured database pools.

返回:

a list of String objects

htmlPool

public java.lang.String htmlPool(java.lang.String pool)
                          throws java.lang.Exception

Generates html code for the given db pool.

参数:

pool - the db pool to generate html for

返回:

html code

抛出:

java.lang.Exception - if something goes wrong

initialize

public void initialize(CmsUpdateBean updateBean)
                throws java.lang.Exception

Initializes the Update Manager object with the updateBean to get the database connection.

参数:

updateBean - the update bean with the database connection

抛出:

java.lang.Exception - if the setup bean is not initialized

needUpdate

public boolean needUpdate()

Checks if an update is needed.

返回:

if an update is needed

run

public void run()

Updates all database pools.

updateDatabase

public void updateDatabase(java.lang.String pool)

Updates the database.

参数:

pool - the database pool to update

getInstanceForDb

protected I_CmsUpdateDBPart getInstanceForDb(I_CmsUpdateDBPart dbUpdater,
                                 java.lang.String dbName)

Creates a new instance for the given database and setting the db pool data.

参数:

dbUpdater - the generic updater part

dbName - the database to get a new instance for

返回:

right instance instance for the given database

getMySqlEngine

protected void getMySqlEngine(java.util.Map<java.lang.String,java.lang.String> dbPoolData)

Retrieves the mysql engine name.

参数:

dbPoolData - the database pool data

getOracleTablespaces

protected void getOracleTablespaces(java.util.Map<java.lang.String,java.lang.String> dbPoolData)

Retrieves the oracle tablespace names.

参数:

dbPoolData - the database pool data

getPostgreSqlTablespaces

protected void getPostgreSqlTablespaces(java.util.Map<java.lang.String,java.lang.String> dbPoolData)

Retrieves the postgresql tablespace names.

参数:

dbPoolData - the database pool data