Package org.opencms.setup.db
Class CmsUpdateDBManager
java.lang.Object
org.opencms.setup.db.CmsUpdateDBManager
This manager controls the update of the database from OpenCms 6 to OpenCms 7.
- Since:
- 7.0.0
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetDbDriver
(String pool) Returns the configured jdbc driver for the given pool.Returns the database name.getDbParams
(String pool) Returns the configured jdbc url parameters for the given pool.Returns the configured jdbc connection url for the given pool.Returns the configured database user for the given pool.double
Returns the detected mayor version, based on DB structure.protected I_CmsUpdateDBPart
getInstanceForDb
(I_CmsUpdateDBPart dbUpdater, String dbName) Creates a new instance for the given database and setting the db pool data.protected void
getMySqlEngine
(Map<String, String> dbPoolData) Retrieves the mysql engine name.protected void
getOracleTablespaces
(Map<String, String> dbPoolData) Retrieves the oracle tablespace names.getPools()
Returns all configured database pools.protected void
getPostgreSqlTablespaces
(Map<String, String> dbPoolData) Retrieves the postgresql tablespace names.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
Checks if an update is needed.void
run()
Updates all database pools.void
updateDatabase
(String pool) Updates the database.
-
Constructor Details
-
CmsUpdateDBManager
public CmsUpdateDBManager()Default constructor.
-
-
Method Details
-
getDbDriver
Returns the configured jdbc driver for the given pool.- Parameters:
pool
- the db pool to get the driver for- Returns:
- the driver class name
-
getDbName
Returns the database name.- Returns:
- the database name
-
getDbParams
Returns the configured jdbc url parameters for the given pool.- Parameters:
pool
- the db pool to get the params for- Returns:
- the jdbc url parameters
-
getDbUrl
Returns the configured jdbc connection url for the given pool.- Parameters:
pool
- the db pool to get the url for- Returns:
- the jdbc connection url
-
getDbUser
Returns the configured database user for the given pool.- Parameters:
pool
- the db pool to get the user for- Returns:
- the database user
-
getDetectedVersion
Returns the detected mayor version, based on DB structure.- Returns:
- the detected mayor version
-
getPools
Returns all configured database pools.- Returns:
- a list of
String
objects
-
htmlPool
Generates html code for the given db pool.- Parameters:
pool
- the db pool to generate html for- Returns:
- html code
- Throws:
Exception
- if something goes wrong
-
htmlPool
-
initialize
Initializes the Update Manager object with the updateBean to get the database connection.- Parameters:
updateBean
- the update bean with the database connection- Throws:
Exception
- if the setup bean is not initialized
-
needUpdate
Checks if an update is needed.- Returns:
- if an update is needed
-
run
Updates all database pools. -
updateDatabase
Updates the database.- Parameters:
pool
- the database pool to update
-
getInstanceForDb
Creates a new instance for the given database and setting the db pool data.- Parameters:
dbUpdater
- the generic updater partdbName
- the database to get a new instance for- Returns:
- right instance instance for the given database
-
getMySqlEngine
Retrieves the mysql engine name.- Parameters:
dbPoolData
- the database pool data
-
getOracleTablespaces
Retrieves the oracle tablespace names.- Parameters:
dbPoolData
- the database pool data
-
getPostgreSqlTablespaces
Retrieves the postgresql tablespace names.- Parameters:
dbPoolData
- the database pool data
-