org.opennms.netmgt.dao.db
Class InstallerDb

java.lang.Object
  org.opennms.netmgt.dao.db.InstallerDb

public class InstallerDb
extends Object

InstallerDb class.

Version:

$Id: $

Author:

ranger

Nested Class Summary

class

InstallerDb.Insert

Field Summary

static float	POSTGRES_MAX_VERSION_PLUS_ONE
static float	POSTGRES_MIN_VERSION

Constructor Summary

InstallerDb()
Constructor for InstallerDb.

Method Summary

void	addColumnReplacement(String tableColumn, ColumnChangeReplacement replacement) addColumnReplacement
void	addColumnReplacements() addColumnReplacements
void	addIndexesForTable(String table) addIndexesForTable
void	addStoredProcedures() addStoredProcedures
void	addTriggersForTable(String table) addTriggersForTable
void	changeTable(String table, Table oldTable, Table newTable) changeTable
void	checkConstraint(Constraint constraint) checkConstraint
void	checkConstraints() checkConstraints
void	checkIndexUniqueness() checkIndexUniqueness
void	checkOldTables() checkOldTables
void	checkUnicode() checkUnicode
static String	cleanText(List<String> list) cleanText
void	closeAdminConnection() closeAdminConnection
void	closeColumnReplacements() closeColumnReplacements
void	closeConnection() closeConnection
void	createSequences() createSequences
void	createTables() createTables
void	databaseAddDB() Deprecated.
void	databaseAddUser() Deprecated.
boolean	databaseDBExists() databaseDBExists
void	databaseRemoveDB() databaseRemoveDB
void	databaseSetUser() databaseSetUser
boolean	databaseUserExists() databaseUserExists
void	disconnect() Close all connections to the database.
Column	findColumn(List<Column> columns, String column) findColumn
String	fixConstraint(Constraint constraint, boolean removeRows) fixConstraint
void	fixConstraint(String constraintName, boolean removeRows) fixConstraint
void	fixData() fixData
boolean	functionExists(String function, int[] columnTypes, int retType) functionExists
boolean	functionExists(String function, String columns, String returnType) functionExists
DataSource	getAdminDataSource() getAdminDataSource
List<Column>	getColumnsFromDB(String tableName) getColumnsFromDB
List<Constraint>	getConstraintsFromDB(String tableName) getConstraintsFromDB
String	getCreateSqlLocation() getCreateSqlLocation
String	getDatabaseName() getDatabaseName
DataSource	getDataSource() getDataSource
boolean	getDebug() getDebug
boolean	getForce() getForce
String	getForeignConstraintWhere(String table, List<String> columns, String ftable, List<String> fcolumns) getForeignConstraintWhere
List<Constraint>	getForeignKeyConstraints() getForeignKeyConstraints
String	getFunctionFromSQL(String function) getFunctionFromSQL
IndexDao	getIndexDao() getIndexDao
String	getIndexFromSQL(String index) getIndexFromSQL
Map<String,List<InstallerDb.Insert>>	getInserts() getInserts
String	getLanguageFromSQL(String language) getLanguageFromSQL
String	getPgIpLikeLocation() getPgIpLikeLocation
String	getPgPlPgsqlLocation() getPgPlPgsqlLocation
String	getPostgresOpennmsPassword() getPostgresOpennmsPassword
String	getPostgresOpennmsUser() getPostgresOpennmsUser
String[]	getSequenceMapping(String sequence) getSequenceMapping
List<String>	getSequenceNames() getSequenceNames
String	getSql() getSql
String	getStoredProcedureDirectory() getStoredProcedureDirectory
List<Column>	getTableColumnsFromDB(String tableName) getTableColumnsFromDB
List<Column>	getTableColumnsFromSQL(String tableName) getTableColumnsFromSQL
String	getTableCreateFromSQL(String table) getTableCreateFromSQL
Table	getTableFromDB(String tableName) getTableFromDB
Table	getTableFromSQL(String tableName) getTableFromSQL
List<String>	getTableNames() getTableNames
TriggerDao	getTriggerDao() getTriggerDao
Map<String,Integer>	getTypesFromDB() getTypesFromDB
String	getXFromSQL(String item, String regex, int itemGroup, int returnGroup, String description) getXFromSQL
void	grantAccessToObject(String object, int indent) grantAccessToObject
boolean	hasTableChanged(String table) hasTableChanged
void	insertData() insertData
boolean	isIpLikeUsable() isIpLikeUsable
boolean	isPgPlPgsqlLibPresent() isPgPlPgsqlLibPresent
String	notNullWhereClause(String table, List<String> columns) notNullWhereClause
void	readTables() readTables
void	readTables(Reader reader) readTables
void	setAdminDataSource(DataSource dataSource) setAdminDataSource
void	setCreateSqlLocation(String createSqlLocation) setCreateSqlLocation
void	setDatabaseName(String name) setDatabaseName
void	setDataSource(DataSource dataSource) setDataSource
void	setDebug(boolean debug) setDebug
void	setForce(boolean force) setForce
void	setIgnoreNotNull(boolean ignoreNotNull) setIgnoreNotNull
void	setNoRevert(boolean noRevert) setNoRevert
void	setOutputStream(PrintStream out) setOutputStream
void	setPostgresIpLikeLocation(String location) setPostgresIpLikeLocation
void	setPostgresOpennmsPassword(String password) setPostgresOpennmsPassword
void	setPostgresOpennmsUser(String user) setPostgresOpennmsUser
void	setPostgresPlPgsqlLocation(String location) setPostgresPlPgsqlLocation
void	setStoredProcedureDirectory(String directory) setStoredProcedureDirectory
void	setupPlPgsqlIplike() setupPlPgsqlIplike
void	tableChanged(String table) tableChanged
boolean	tableColumnExists(String table, String column) tableColumnExists
List<String>	tableColumnList(String table, List<String> columns) tableColumnList
boolean	tableExists(String table) tableExists
void	transformData(String table, String oldTable, TreeMap<String,ColumnChange> columnChanges, String[] oldColumnNames) transformData
void	updateIplike() updateIplike
void	updatePlPgsql() updatePlPgsql
void	vacuumDatabase(boolean full) vacuumDatabase

Methods inherited from class java.lang.Object

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

Field Detail

POSTGRES_MIN_VERSION

public static final float POSTGRES_MIN_VERSION

See Also:

Constant Field Values

POSTGRES_MAX_VERSION_PLUS_ONE

public static final float POSTGRES_MAX_VERSION_PLUS_ONE

See Also:

Constant Field Values

Constructor Detail

InstallerDb

public InstallerDb()

Constructor for InstallerDb.

Method Detail

readTables

public void readTables()
                throws Exception

readTables

Throws:

Exception - if any.

readTables

public void readTables(Reader reader)
                throws Exception

readTables

Parameters:

reader - a Reader object.

Throws:

Exception - if any.

cleanText

public static String cleanText(List<String> list)

cleanText

Parameters:

list - a List object.

Returns:

a String object.

createSequences

public void createSequences()
                     throws Exception

createSequences

Throws:

Exception - if any.

updatePlPgsql

public void updatePlPgsql()
                   throws Exception

updatePlPgsql

Throws:

Exception - if any.

isIpLikeUsable

public boolean isIpLikeUsable()

isIpLikeUsable

Returns:

a boolean.

updateIplike

public void updateIplike()
                  throws Exception

updateIplike

Throws:

Exception - if any.

setupPlPgsqlIplike

public void setupPlPgsqlIplike()
                        throws Exception

setupPlPgsqlIplike

Throws:

Exception - if any.

addStoredProcedures

public void addStoredProcedures()
                         throws Exception

addStoredProcedures

Throws:

Exception - if any.

functionExists

public boolean functionExists(String function,
                              String columns,
                              String returnType)
                       throws Exception

functionExists

Parameters:

function - a String object.

columns - a String object.

returnType - a String object.

Returns:

a boolean.

Throws:

Exception - if any.

functionExists

public boolean functionExists(String function,
                              int[] columnTypes,
                              int retType)
                       throws Exception

functionExists

Parameters:

function - a String object.

columnTypes - an array of int.

retType - a int.

Returns:

a boolean.

Throws:

Exception - if any.

getTypesFromDB

public Map<String,Integer> getTypesFromDB()
                                   throws SQLException

getTypesFromDB

Returns:

a Map object.

Throws:

SQLException - if any.

addTriggersForTable

public void addTriggersForTable(String table)
                         throws SQLException

addTriggersForTable

Parameters:

table - a String object.

Throws:

SQLException - if any.

createTables

public void createTables()
                  throws Exception

createTables

Throws:

Exception - if any.

getTableFromSQL

public Table getTableFromSQL(String tableName)
                      throws Exception

getTableFromSQL

Parameters:

tableName - a String object.

Returns:

a Table object.

Throws:

Exception - if any.

getXFromSQL

public String getXFromSQL(String item,
                          String regex,
                          int itemGroup,
                          int returnGroup,
                          String description)
                   throws Exception

getXFromSQL

Parameters:

item - a String object.

regex - a String object.

itemGroup - a int.

returnGroup - a int.

description - a String object.

Returns:

a String object.

Throws:

Exception - if any.

findColumn

public Column findColumn(List<Column> columns,
                         String column)

findColumn

Parameters:

columns - a List object.

column - a String object.

Returns:

a Column object.

tableColumnExists

public boolean tableColumnExists(String table,
                                 String column)
                          throws Exception

tableColumnExists

Parameters:

table - a String object.

column - a String object.

Returns:

a boolean.

Throws:

Exception - if any.

getTableColumnsFromDB

public List<Column> getTableColumnsFromDB(String tableName)
                                   throws Exception

getTableColumnsFromDB

Parameters:

tableName - a String object.

Returns:

a List object.

Throws:

Exception - if any.

getTableFromDB

public Table getTableFromDB(String tableName)
                     throws Exception

getTableFromDB

Parameters:

tableName - a String object.

Returns:

a Table object.

Throws:

Exception - if any.

tableExists

public boolean tableExists(String table)
                    throws SQLException

tableExists

Parameters:

table - a String object.

Returns:

a boolean.

Throws:

SQLException - if any.

getColumnsFromDB

public List<Column> getColumnsFromDB(String tableName)
                              throws Exception

getColumnsFromDB

Parameters:

tableName - a String object.

Returns:

a List object.

Throws:

Exception - if any.

getConstraintsFromDB

public List<Constraint> getConstraintsFromDB(String tableName)
                                      throws SQLException,
                                             Exception

getConstraintsFromDB

Parameters:

tableName - a String object.

Returns:

a List object.

Throws:

SQLException - if any.

Exception - if any.

changeTable

public void changeTable(String table,
                        Table oldTable,
                        Table newTable)
                 throws Exception

changeTable

Parameters:

table - a String object.

oldTable - a Table object.

newTable - a Table object.

Throws:

Exception - if any.

transformData

public void transformData(String table,
                          String oldTable,
                          TreeMap<String,ColumnChange> columnChanges,
                          String[] oldColumnNames)
                   throws SQLException,
                          ParseException,
                          Exception

transformData

Parameters:

table - a String object.

oldTable - a String object.

columnChanges - a TreeMap object.

oldColumnNames - an array of String objects.

Throws:

SQLException - if any.

ParseException - if any.

Exception - if any.

checkOldTables

public void checkOldTables()
                    throws SQLException,
                           BackupTablesFoundException

checkOldTables

Throws:

SQLException - if any.

BackupTablesFoundException - if any.

getForeignKeyConstraints

public List<Constraint> getForeignKeyConstraints()
                                          throws Exception

getForeignKeyConstraints

Returns:

a List object.

Throws:

Exception - if any.

checkConstraints

public void checkConstraints()
                      throws Exception

checkConstraints

Throws:

Exception - if any.

checkConstraint

public void checkConstraint(Constraint constraint)
                     throws Exception

checkConstraint

Parameters:

constraint - a Constraint object.

Throws:

Exception - if any.

getForeignConstraintWhere

public String getForeignConstraintWhere(String table,
                                        List<String> columns,
                                        String ftable,
                                        List<String> fcolumns)
                                 throws Exception

getForeignConstraintWhere

Parameters:

table - a String object.

columns - a List object.

ftable - a String object.

fcolumns - a List object.

Returns:

a String object.

Throws:

Exception - if any.

notNullWhereClause

public String notNullWhereClause(String table,
                                 List<String> columns)

notNullWhereClause

Parameters:

table - a String object.

columns - a List object.

Returns:

a String object.

tableColumnList

public List<String> tableColumnList(String table,
                                    List<String> columns)

tableColumnList

Parameters:

table - a String object.

columns - a List object.

Returns:

a List object.

fixConstraint

public void fixConstraint(String constraintName,
                          boolean removeRows)
                   throws Exception

fixConstraint

Parameters:

constraintName - a String object.

removeRows - a boolean.

Throws:

Exception - if any.

fixConstraint

public String fixConstraint(Constraint constraint,
                            boolean removeRows)
                     throws Exception

fixConstraint

Parameters:

constraint - a Constraint object.

removeRows - a boolean.

Returns:

a String object.

Throws:

Exception - if any.

databaseUserExists

public boolean databaseUserExists()
                           throws SQLException

databaseUserExists

Returns:

a boolean.

Throws:

SQLException - if any.

databaseSetUser

public void databaseSetUser()
                     throws SQLException

databaseSetUser

Throws:

SQLException - if any.

databaseAddUser

@Deprecated
public void databaseAddUser()
                     throws SQLException

Deprecated.

databaseAddUser

Throws:

SQLException - if any.

databaseDBExists

public boolean databaseDBExists()
                         throws SQLException

databaseDBExists

Returns:

a boolean.

Throws:

SQLException - if any.

databaseAddDB

@Deprecated
public void databaseAddDB()
                   throws Exception

Deprecated.

databaseAddDB

Throws:

Exception - if any.

databaseRemoveDB

public void databaseRemoveDB()
                      throws SQLException

databaseRemoveDB

Throws:

SQLException - if any.

addIndexesForTable

public void addIndexesForTable(String table)
                        throws SQLException

addIndexesForTable

Parameters:

table - a String object.

Throws:

SQLException - if any.

grantAccessToObject

public void grantAccessToObject(String object,
                                int indent)
                         throws SQLException

grantAccessToObject

Parameters:

object - a String object.

indent - a int.

Throws:

SQLException - if any.

fixData

public void fixData()
             throws Exception

fixData

Throws:

Exception - if any.

insertData

public void insertData()
                throws Exception

insertData

Throws:

Exception - if any.

checkUnicode

public void checkUnicode()
                  throws Exception

checkUnicode

Throws:

Exception - if any.

checkIndexUniqueness

public void checkIndexUniqueness()
                          throws Exception

checkIndexUniqueness

Throws:

Exception - if any.

getTableColumnsFromSQL

public List<Column> getTableColumnsFromSQL(String tableName)
                                    throws Exception

getTableColumnsFromSQL

Parameters:

tableName - a String object.

Returns:

a List object.

Throws:

Exception - if any.

getTableCreateFromSQL

public String getTableCreateFromSQL(String table)
                             throws Exception

getTableCreateFromSQL

Parameters:

table - a String object.

Returns:

a String object.

Throws:

Exception - if any.

getIndexFromSQL

public String getIndexFromSQL(String index)
                       throws Exception

getIndexFromSQL

Parameters:

index - a String object.

Returns:

a String object.

Throws:

Exception - if any.

getFunctionFromSQL

public String getFunctionFromSQL(String function)
                          throws Exception

getFunctionFromSQL

Parameters:

function - a String object.

Returns:

a String object.

Throws:

Exception - if any.

getLanguageFromSQL

public String getLanguageFromSQL(String language)
                          throws Exception

getLanguageFromSQL

Parameters:

language - a String object.

Returns:

a String object.

Throws:

Exception - if any.

closeConnection

public void closeConnection()
                     throws SQLException

closeConnection

Throws:

SQLException - if any.

closeAdminConnection

public void closeAdminConnection()
                          throws SQLException

closeAdminConnection

Throws:

SQLException - if any.

disconnect

public void disconnect()
                throws SQLException

Close all connections to the database.

Throws:

SQLException - if any.

setCreateSqlLocation

public void setCreateSqlLocation(String createSqlLocation)

setCreateSqlLocation

Parameters:

createSqlLocation - a String object.

getCreateSqlLocation

public String getCreateSqlLocation()

getCreateSqlLocation

Returns:

a String object.

getTableNames

public List<String> getTableNames()

getTableNames

Returns:

a List object.

getSequenceNames

public List<String> getSequenceNames()

getSequenceNames

Returns:

a List object.

getSequenceMapping

public String[] getSequenceMapping(String sequence)

getSequenceMapping

Parameters:

sequence - a String object.

Returns:

an array of String objects.

getIndexDao

public IndexDao getIndexDao()

getIndexDao

Returns:

a IndexDao object.

getInserts

public Map<String,List<InstallerDb.Insert>> getInserts()

getInserts

Returns:

a Map object.

getSql

public String getSql()

getSql

Returns:

a String object.

hasTableChanged

public boolean hasTableChanged(String table)

hasTableChanged

Parameters:

table - a String object.

Returns:

a boolean.

tableChanged

public void tableChanged(String table)

tableChanged

Parameters:

table - a String object.

setOutputStream

public void setOutputStream(PrintStream out)

setOutputStream

Parameters:

out - a PrintStream object.

getTriggerDao

public TriggerDao getTriggerDao()

getTriggerDao

Returns:

a TriggerDao object.

setStoredProcedureDirectory

public void setStoredProcedureDirectory(String directory)

setStoredProcedureDirectory

Parameters:

directory - a String object.

getStoredProcedureDirectory

public String getStoredProcedureDirectory()

getStoredProcedureDirectory

Returns:

a String object.

setDataSource

public void setDataSource(DataSource dataSource)

setDataSource

Parameters:

dataSource - a DataSource object.

getDataSource

public DataSource getDataSource()

getDataSource

Returns:

a DataSource object.

setAdminDataSource

public void setAdminDataSource(DataSource dataSource)

setAdminDataSource

Parameters:

dataSource - a DataSource object.

getAdminDataSource

public DataSource getAdminDataSource()

getAdminDataSource

Returns:

a DataSource object.

setForce

public void setForce(boolean force)

setForce

Parameters:

force - a boolean.

getForce

public boolean getForce()

getForce

Returns:

a boolean.

setDebug

public void setDebug(boolean debug)

setDebug

Parameters:

debug - a boolean.

getDebug

public boolean getDebug()

getDebug

Returns:

a boolean.

addColumnReplacement

public void addColumnReplacement(String tableColumn,
                                 ColumnChangeReplacement replacement)

addColumnReplacement

Parameters:

tableColumn - a String object.

replacement - a ColumnChangeReplacement object.

setIgnoreNotNull

public void setIgnoreNotNull(boolean ignoreNotNull)

setIgnoreNotNull

Parameters:

ignoreNotNull - a boolean.

getDatabaseName

public String getDatabaseName()

getDatabaseName

Returns:

a String object.

setDatabaseName

public void setDatabaseName(String name)

setDatabaseName

Parameters:

name - a String object.

setNoRevert

public void setNoRevert(boolean noRevert)

setNoRevert

Parameters:

noRevert - a boolean.

setPostgresOpennmsUser

public void setPostgresOpennmsUser(String user)

setPostgresOpennmsUser

Parameters:

user - a String object.

getPostgresOpennmsUser

public String getPostgresOpennmsUser()

getPostgresOpennmsUser

Returns:

a String object.

setPostgresOpennmsPassword

public void setPostgresOpennmsPassword(String password)

setPostgresOpennmsPassword

Parameters:

password - a String object.

getPostgresOpennmsPassword

public String getPostgresOpennmsPassword()

getPostgresOpennmsPassword

Returns:

a String object.

setPostgresIpLikeLocation

public void setPostgresIpLikeLocation(String location)

setPostgresIpLikeLocation

Parameters:

location - a String object.

getPgIpLikeLocation

public String getPgIpLikeLocation()

getPgIpLikeLocation

Returns:

a String object.

setPostgresPlPgsqlLocation

public void setPostgresPlPgsqlLocation(String location)

setPostgresPlPgsqlLocation

Parameters:

location - a String object.

getPgPlPgsqlLocation

public String getPgPlPgsqlLocation()

getPgPlPgsqlLocation

Returns:

a String object.

isPgPlPgsqlLibPresent

public boolean isPgPlPgsqlLibPresent()

isPgPlPgsqlLibPresent

Returns:

a boolean.

addColumnReplacements

public void addColumnReplacements()
                           throws SQLException

addColumnReplacements

Throws:

SQLException - if any.

closeColumnReplacements

public void closeColumnReplacements()
                             throws SQLException

closeColumnReplacements

Throws:

SQLException - if any.

vacuumDatabase

public void vacuumDatabase(boolean full)
                    throws SQLException

vacuumDatabase

Parameters:

full - a boolean.

Throws:

SQLException - if any.