Package org.opencms.setup.db
Class A_CmsUpdateDBPart
- java.lang.Object
-
- org.opencms.setup.db.A_CmsUpdateDBPart
-
- All Implemented Interfaces:
I_CmsUpdateDBPart
- Direct Known Subclasses:
CmsUpdateDBAlterTables
,CmsUpdateDBCmsUsers
,CmsUpdateDBContentTables
,CmsUpdateDBCreateIndexes7
,CmsUpdateDBDropBackupTables
,CmsUpdateDBDropOldIndexes
,CmsUpdateDBDropUnusedTables
,CmsUpdateDBHistoryPrincipals
,CmsUpdateDBHistoryTables
,CmsUpdateDBNewTables
,CmsUpdateDBNewTables
,CmsUpdateDBProjectId
,CmsUpdateDBUpdateOU
,CmsUpdatePasswordColumn
public abstract class A_CmsUpdateDBPart extends java.lang.Object implements I_CmsUpdateDBPart
Represent a part of the database update process.- Since:
- 6.9.2
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Map<java.lang.String,java.lang.String>
m_poolData
The connection data to use.protected java.util.Map<java.lang.String,java.lang.String>
m_queries
A map holding all SQL queries.
-
Constructor Summary
Constructors Constructor Description A_CmsUpdateDBPart()
Default constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
execute(java.util.Map<java.lang.String,java.lang.String> dbPoolData)
Executes the update part.java.util.Map<java.lang.String,java.lang.String>
getPoolData()
Returns the database pool Data.protected java.lang.String
getPropertyFileLocation()
Returns the default property file location.protected abstract void
internalExecute(CmsSetupDb setupDb)
Does the hard work.protected boolean
isKeepHistory()
Returns the keep History parameter value.protected void
loadQueryProperties(java.lang.String propertyFilename)
Loads a Java properties hash containing SQL queries.java.lang.String
readQuery(java.lang.String queryKey)
Searches for the SQL query with the specified key.
-
-
-
Field Detail
-
m_poolData
protected java.util.Map<java.lang.String,java.lang.String> m_poolData
The connection data to use.
-
m_queries
protected java.util.Map<java.lang.String,java.lang.String> m_queries
A map holding all SQL queries.
-
-
Constructor Detail
-
A_CmsUpdateDBPart
public A_CmsUpdateDBPart()
Default constructor.
-
-
Method Detail
-
execute
public void execute(java.util.Map<java.lang.String,java.lang.String> dbPoolData)
Description copied from interface:I_CmsUpdateDBPart
Executes the update part.- Specified by:
execute
in interfaceI_CmsUpdateDBPart
- Parameters:
dbPoolData
- the database pool data- See Also:
I_CmsUpdateDBPart.execute(Map)
-
getPoolData
public java.util.Map<java.lang.String,java.lang.String> getPoolData()
Returns the database pool Data.- Returns:
- the database pool Data
-
readQuery
public java.lang.String readQuery(java.lang.String queryKey)
Searches for the SQL query with the specified key.- Parameters:
queryKey
- the SQL query key- Returns:
- the the SQL query in this property list with the specified key
-
getPropertyFileLocation
protected java.lang.String getPropertyFileLocation()
Returns the default property file location.- Returns:
- the default property file location
-
internalExecute
protected abstract void internalExecute(CmsSetupDb setupDb) throws java.sql.SQLException
Does the hard work.- Parameters:
setupDb
- the db connection interface- Throws:
java.sql.SQLException
- if something goes wrong
-
isKeepHistory
protected boolean isKeepHistory()
Returns the keep History parameter value.- Returns:
- the keep History parameter value
-
loadQueryProperties
protected void loadQueryProperties(java.lang.String propertyFilename) throws java.io.IOException
Loads a Java properties hash containing SQL queries.- Parameters:
propertyFilename
- the package/filename of the properties hash- Throws:
java.io.IOException
- if the sql queries property file could not be read
-
-