org.opencms.setup
Class CmsSetupDb

java.lang.Object
  org.opencms.setup.CmsSetupDb

public class CmsSetupDb
extends Object

Helper class to call database setup scripts.

Since:

6.0.0

Version:

$Revision: 1.24 $

Author:

Thomas Weckert, Carsten Weinholz

Field Summary

static String	SETUP_DATA_FOLDER The folder where to read the setup data from.
static String	SETUP_FOLDER The folder where the setup wizard is located.

Constructor Summary

CmsSetupDb(String basePath)
Creates a new CmsSetupDb object.

Method Summary

void	clearErrors() Clears the error messages stored internally.
void	closeConnection() Closes the internal connection to the database.
void	createDatabase(String database, Map replacer) Calls the create database script for the given database.
void	createDatabase(String database, Map replacer, boolean abortOnError) Calls the create database script for the given database.
void	createTables(String database, Map replacer) Calls the create tables script for the given database.
void	createTables(String database, Map replacer, boolean abortOnError) Calls the create tables script for the given database.
void	dropDatabase(String database, Map replacer) Calls the drop script for the given database.
void	dropDatabase(String database, Map replacer, boolean abortOnError) Calls the drop script for the given database.
void	dropTables(String database) Calls the drop tables script for the given database.
void	dropTables(String database, Map replacer) Calls the drop tables script for the given database.
void	dropTables(String database, Map replacer, boolean abortOnError) Calls the drop tables script for the given database.
protected void	finalize()
Vector	getErrors() Returns a Vector of Error messages.
boolean	noErrors() Checks if internal errors occured.
void	setConnection(Connection conn) Sets a new internal connection to teh database.
void	setConnection(String DbDriver, String DbConStr, String DbConStrParams, String DbUser, String DbPwd) Creates a new internal connection to the database.
void	updateDatabase(String updateScript, Map replacers) Calls an update script.
void	updateDatabase(String updateScript, Map replacers, boolean abortOnError) Calls an update script.

Methods inherited from class java.lang.Object

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

Field Detail

SETUP_DATA_FOLDER

public static final String SETUP_DATA_FOLDER

The folder where to read the setup data from.

See Also:

Constant Field Values

SETUP_FOLDER

public static final String SETUP_FOLDER

The folder where the setup wizard is located.

See Also:

Constant Field Values

Constructor Detail

CmsSetupDb

public CmsSetupDb(String basePath)

Creates a new CmsSetupDb object.

Parameters:

basePath - the location of the setup scripts

Method Detail

clearErrors

public void clearErrors()

Clears the error messages stored internally.

closeConnection

public void closeConnection()

Closes the internal connection to the database.

createDatabase

public void createDatabase(String database,
                           Map replacer)

Calls the create database script for the given database.

Parameters:

database - the name of the database

replacer - the replacements to perform in the drop script

createDatabase

public void createDatabase(String database,
                           Map replacer,
                           boolean abortOnError)

Calls the create database script for the given database.

Parameters:

database - the name of the database

replacer - the replacements to perform in the drop script

abortOnError - indicates if the script is aborted if an error occurs

createTables

public void createTables(String database,
                         Map replacer)

Calls the create tables script for the given database.

Parameters:

database - the name of the database

replacer - the replacements to perform in the drop script

createTables

public void createTables(String database,
                         Map replacer,
                         boolean abortOnError)

Calls the create tables script for the given database.

Parameters:

database - the name of the database

replacer - the replacements to perform in the drop script

abortOnError - indicates if the script is aborted if an error occurs

dropDatabase

public void dropDatabase(String database,
                         Map replacer)

Calls the drop script for the given database.

Parameters:

database - the name of the database

replacer - the replacements to perform in the drop script

dropDatabase

public void dropDatabase(String database,
                         Map replacer,
                         boolean abortOnError)

Calls the drop script for the given database.

Parameters:

database - the name of the database

replacer - the replacements to perform in the drop script

abortOnError - indicates if the script is aborted if an error occurs

dropTables

public void dropTables(String database)

Calls the drop tables script for the given database.

Parameters:

database - the name of the database

dropTables

public void dropTables(String database,
                       Map replacer)

Calls the drop tables script for the given database.

Parameters:

database - the name of the database

replacer - the replacements to perform in the drop script

dropTables

public void dropTables(String database,
                       Map replacer,
                       boolean abortOnError)

Calls the drop tables script for the given database.

Parameters:

database - the name of the database

replacer - the replacements to perform in the drop script

abortOnError - indicates if the script is aborted if an error occurs

getErrors

public Vector getErrors()

Returns a Vector of Error messages.

Returns:

all error messages collected internally

noErrors

public boolean noErrors()

Checks if internal errors occured.

Returns:

true if internal errors occured

setConnection

public void setConnection(Connection conn)

Sets a new internal connection to teh database.

Parameters:

conn - the connection to use

setConnection

public void setConnection(String DbDriver,
                          String DbConStr,
                          String DbConStrParams,
                          String DbUser,
                          String DbPwd)

Creates a new internal connection to the database.

Parameters:

DbDriver - JDBC driver class name

DbConStr - JDBC connect URL

DbConStrParams - JDBC connect URL params, or null

DbUser - JDBC database user

DbPwd - JDBC database password

updateDatabase

public void updateDatabase(String updateScript,
                           Map replacers)

Calls an update script.

Parameters:

updateScript - the update script code

replacers - the replacers to use in the script code

updateDatabase

public void updateDatabase(String updateScript,
                           Map replacers,
                           boolean abortOnError)

Calls an update script.

Parameters:

updateScript - the update script code

replacers - the replacers to use in the script code

abortOnError - indicates if the script is aborted if an error occurs

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

See Also:

Object.finalize()