|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.setup.CmsSetupDb
public class CmsSetupDb
Helper class to call database setup scripts.
Field Summary | |
---|---|
static java.lang.String |
SETUP_DATA_FOLDER
The folder where to read the setup data from. |
static java.lang.String |
SETUP_FOLDER
The folder where the setup wizard is located. |
Constructor Summary | |
---|---|
CmsSetupDb(java.lang.String basePath)
Creates a new CmsSetupDb object. |
Method Summary | |
---|---|
java.lang.String |
checkVariables(java.lang.String db)
Returns an optional warning message if needed, null if not. |
void |
clearErrors()
Clears the error messages stored internally. |
void |
closeConnection()
Closes the internal connection to the database. |
void |
createDatabase(java.lang.String database,
java.util.Map replacer)
Calls the create database script for the given database. |
void |
createDatabase(java.lang.String database,
java.util.Map replacer,
boolean abortOnError)
Calls the create database script for the given database. |
void |
createTables(java.lang.String database,
java.util.Map replacer)
Calls the create tables script for the given database. |
void |
createTables(java.lang.String database,
java.util.Map replacer,
boolean abortOnError)
Calls the create tables script for the given database. |
void |
dropDatabase(java.lang.String database,
java.util.Map replacer)
Calls the drop script for the given database. |
void |
dropDatabase(java.lang.String database,
java.util.Map replacer,
boolean abortOnError)
Calls the drop script for the given database. |
void |
dropTables(java.lang.String database)
Calls the drop tables script for the given database. |
void |
dropTables(java.lang.String database,
java.util.Map replacer)
Calls the drop tables script for the given database. |
void |
dropTables(java.lang.String database,
java.util.Map replacer,
boolean abortOnError)
Calls the drop tables script for the given database. |
java.sql.ResultSet |
executeSqlStatement(java.lang.String query,
java.util.Map replacer)
Creates and executes a database statment from a String returning the result set. |
java.sql.ResultSet |
executeSqlStatement(java.lang.String query,
java.util.Map replacer,
java.util.List params)
Creates and executes a database statment from a String returning the result set. |
protected void |
finalize()
|
java.sql.Connection |
getConnection()
Returns the connection. |
java.util.Vector |
getErrors()
Returns a Vector of Error messages. |
boolean |
hasTableOrColumn(java.lang.String table,
java.lang.String column)
Checks if the given table, column or combination of both is available in the database. |
boolean |
noErrors()
Checks if internal errors occured. |
void |
setConnection(java.sql.Connection conn)
Sets a new internal connection to teh database. |
void |
setConnection(java.lang.String DbDriver,
java.lang.String DbConStr,
java.lang.String DbConStrParams,
java.lang.String DbUser,
java.lang.String DbPwd)
Creates a new internal connection to the database. |
void |
updateDatabase(java.lang.String updateScript,
java.util.Map replacers)
Calls an update script. |
void |
updateDatabase(java.lang.String updateScript,
java.util.Map replacers,
boolean abortOnError)
Calls an update script. |
int |
updateSqlStatement(java.lang.String query,
java.util.Map replacer,
java.util.List params)
Creates and executes a database statment from a String. |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SETUP_DATA_FOLDER
public static final java.lang.String SETUP_FOLDER
Constructor Detail |
---|
public CmsSetupDb(java.lang.String basePath)
basePath
- the location of the setup scriptsMethod Detail |
---|
public java.lang.String checkVariables(java.lang.String db)
null
if not.
db
- the selected database key
null
if no warningpublic void clearErrors()
public void closeConnection()
public void createDatabase(java.lang.String database, java.util.Map replacer)
database
- the name of the databasereplacer
- the replacements to perform in the drop scriptpublic void createDatabase(java.lang.String database, java.util.Map replacer, boolean abortOnError)
database
- the name of the databasereplacer
- the replacements to perform in the drop scriptabortOnError
- indicates if the script is aborted if an error occurspublic void createTables(java.lang.String database, java.util.Map replacer)
database
- the name of the databasereplacer
- the replacements to perform in the drop scriptpublic void createTables(java.lang.String database, java.util.Map replacer, boolean abortOnError)
database
- the name of the databasereplacer
- the replacements to perform in the drop scriptabortOnError
- indicates if the script is aborted if an error occurspublic void dropDatabase(java.lang.String database, java.util.Map replacer)
database
- the name of the databasereplacer
- the replacements to perform in the drop scriptpublic void dropDatabase(java.lang.String database, java.util.Map replacer, boolean abortOnError)
database
- the name of the databasereplacer
- the replacements to perform in the drop scriptabortOnError
- indicates if the script is aborted if an error occurspublic void dropTables(java.lang.String database)
database
- the name of the databasepublic void dropTables(java.lang.String database, java.util.Map replacer)
database
- the name of the databasereplacer
- the replacements to perform in the drop scriptpublic void dropTables(java.lang.String database, java.util.Map replacer, boolean abortOnError)
database
- the name of the databasereplacer
- the replacements to perform in the drop scriptabortOnError
- indicates if the script is aborted if an error occurspublic java.sql.ResultSet executeSqlStatement(java.lang.String query, java.util.Map replacer) throws java.sql.SQLException
query
- the query to executereplacer
- the replacements to perform in the script
java.sql.SQLException
- if something goes wrongpublic java.sql.ResultSet executeSqlStatement(java.lang.String query, java.util.Map replacer, java.util.List params) throws java.sql.SQLException
query
- the query to executereplacer
- the replacements to perform in the scriptparams
- the list of parameters for the statement
java.sql.SQLException
- if something goes wrongpublic java.sql.Connection getConnection()
public java.util.Vector getErrors()
public boolean hasTableOrColumn(java.lang.String table, java.lang.String column)
table
- the sought tablecolumn
- the sought column
public boolean noErrors()
public void setConnection(java.sql.Connection conn)
conn
- the connection to usepublic void setConnection(java.lang.String DbDriver, java.lang.String DbConStr, java.lang.String DbConStrParams, java.lang.String DbUser, java.lang.String DbPwd)
DbDriver
- JDBC driver class nameDbConStr
- JDBC connect URLDbConStrParams
- JDBC connect URL params, or nullDbUser
- JDBC database userDbPwd
- JDBC database passwordpublic void updateDatabase(java.lang.String updateScript, java.util.Map replacers)
updateScript
- the update script codereplacers
- the replacers to use in the script codepublic void updateDatabase(java.lang.String updateScript, java.util.Map replacers, boolean abortOnError)
updateScript
- the update script codereplacers
- the replacers to use in the script codeabortOnError
- indicates if the script is aborted if an error occurspublic int updateSqlStatement(java.lang.String query, java.util.Map replacer, java.util.List params) throws java.sql.SQLException
query
- the query to executereplacer
- the replacements to perform in the scriptparams
- the list of parameters for the statement
java.sql.SQLException
- if something goes wrongprotected void finalize() throws java.lang.Throwable
finalize
in class java.lang.Object
java.lang.Throwable
Object.finalize()
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |