Package io.inversion.utils

Class JdbcUtils

java.lang.Object

io.inversion.utils.JdbcUtils

public class JdbcUtils
extends Object

A collection of super helpful JDBC utility methods with SQL injection attack defense built in.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JdbcUtils.SqlListener

Constructor Summary

Constructors

Constructor	Description
JdbcUtils()

Method Summary

Modifier and Type	Method	Description
static void	addSqlListener(JdbcUtils.SqlListener listener)
static String	buildInsertSQL(Connection conn, String tableName, Object[] columnNameArray)
static String	buildUpdateSQL(Connection conn, String tableName, Object[] setColumnNameArray, Object[] whereColumnNames)
static String	check(Object sql)
static void	close(Object... toClose)
static char	colQuote(Connection conn)
static <T> T	convert(Object value, Class<T> type)
static Object	execute(Connection conn, String sql, Object... vals)
static String	getColumnStr(Connection conn, Object[] columnNameArray)
static String	getColumnStr(Connection conn, List columnNameArray)
static String	getDbType(Connection conn)
static List<Field>	getFields(Class clazz)
static String	getQuestionMarkStr(int numQMarks)
static String	getQuestionMarkStr(Object[] columnNameArray)
static String	getWhereColumnStr(Connection conn, Object[] columnNameArray, String sep)
static Object	insertMap(Connection conn, String tableName, Map row)
static List	insertMaps(Connection conn, String tableName, List maps)
static boolean	isInsert(String sql)
static boolean	isSelect(String sql)
static boolean	isUpdate(String sql)
static void	notifyAfter(String method, String sql, Object args, Exception ex, Object result)
static void	notifyBefore(String method, String sql, Object args)
static void	notifyError(String method, String sql, Object args, Exception ex)
static Object	poplulate(Object o, Map<String,Object> row)
static String	quoteCol(Connection conn, Object str)
static List<String>	readSql(InputStream ddlStream)	Breaks the input stream up into a list of sql statements where statements are terminated by ";".
static List<String>	readSql(String string)
static void	removeSqlListener(JdbcUtils.SqlListener listener)
static void	runSql(Connection conn, InputStream ddlStream)
static void	runSql(Connection conn, String sqlString)
static void	runSql(Connection con, String[] sql)
static void	runSql(Connection con, List<String> sql)
static long	selectLong(Connection conn, String sql, Object... vals)
static <T> T	selectObject(Connection conn, String sql, Class<T> clazz, Object... vals)
static <T> T	selectObject(Connection conn, String sql, T o, Object... vals)
static List	selectObjects(Connection conn, String sql, Class type, Object... vals)
static Rows.Row	selectRow(Connection conn, String sql, Object... vals)
static Rows	selectRows(Connection conn, String sql, Object... vals)
static Object	selectValue(Connection conn, String sql, Object... vals)
static List<Integer>	update(Connection conn, String tableName, List<String> primaryKeyCols, List<Map<String,Object>> rows)
static List<Integer>	updateBatch(Connection conn, String tableName, List<String> keyCols, List<Map<String,Object>> rows)
static List<Rows.Row>	upsert(Connection conn, String tableName, List<String> primaryKeyCols, List<Map<String,Object>> rows)	Batches rows into groups containing identical keys and then inserts rows that are missing indexCols key values or attempts an upsert for rows that have the key values...the row could have the key but still not exist in the db in cases where the key is not an autoincrement number.

Methods inherited from class java.lang.Object

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

Constructor Details

JdbcUtils

public JdbcUtils()

Method Details

getDbType

public static String getDbType(Connection conn)

colQuote

public static char colQuote(Connection conn)

quoteCol

public static String quoteCol(Connection conn,
 Object str)

addSqlListener

public static void addSqlListener(JdbcUtils.SqlListener listener)

removeSqlListener

public static void removeSqlListener(JdbcUtils.SqlListener listener)

notifyBefore

public static void notifyBefore(String method,
 String sql,
 Object args)

notifyError

public static void notifyError(String method,
 String sql,
 Object args,
 Exception ex)

notifyAfter

public static void notifyAfter(String method,
 String sql,
 Object args,
 Exception ex,
 Object result)

execute

public static Object execute(Connection conn,
 String sql,
 Object... vals)
                      throws SQLException

Throws:

SQLException

isSelect

public static boolean isSelect(String sql)

selectObject

public static <T> T selectObject(Connection conn,
 String sql,
 Class<T> clazz,
 Object... vals)
                          throws Exception

Throws:

Exception

selectObject

public static <T> T selectObject(Connection conn,
 String sql,
 T o,
 Object... vals)
                          throws Exception

Throws:

Exception

selectObjects

public static List selectObjects(Connection conn,
 String sql,
 Class type,
 Object... vals)
                          throws Exception

Throws:

Exception

poplulate

public static Object poplulate(Object o,
 Map<String,Object> row)

getFields

public static List<Field> getFields(Class clazz)

convert

public static <T> T convert(Object value,
 Class<T> type)

selectRows

public static Rows selectRows(Connection conn,
 String sql,
 Object... vals)
                       throws SQLException

Throws:

SQLException

selectRow

public static Rows.Row selectRow(Connection conn,
 String sql,
 Object... vals)
                          throws SQLException

Throws:

SQLException

selectLong

public static long selectLong(Connection conn,
 String sql,
 Object... vals)
                       throws SQLException

Throws:

SQLException

selectValue

public static Object selectValue(Connection conn,
 String sql,
 Object... vals)
                          throws SQLException

Throws:

SQLException

isInsert

public static boolean isInsert(String sql)

buildInsertSQL

public static String buildInsertSQL(Connection conn,
 String tableName,
 Object[] columnNameArray)

insertMap

public static Object insertMap(Connection conn,
 String tableName,
 Map row)
                        throws SQLException

Throws:

SQLException

insertMaps

public static List insertMaps(Connection conn,
 String tableName,
 List maps)
                       throws SQLException

Throws:

SQLException

isUpdate

public static boolean isUpdate(String sql)

update

public static List<Integer> update(Connection conn,
 String tableName,
 List<String> primaryKeyCols,
 List<Map<String,Object>> rows)
                            throws Exception

Throws:

Exception

updateBatch

public static List<Integer> updateBatch(Connection conn,
 String tableName,
 List<String> keyCols,
 List<Map<String,Object>> rows)
                                 throws SQLException

Throws:

SQLException

buildUpdateSQL

public static String buildUpdateSQL(Connection conn,
 String tableName,
 Object[] setColumnNameArray,
 Object[] whereColumnNames)

upsert

public static List<Rows.Row> upsert(Connection conn,
 String tableName,
 List<String> primaryKeyCols,
 List<Map<String,Object>> rows)
                             throws SQLException

Batches rows into groups containing identical keys and then inserts rows that are missing indexCols key values or attempts an upsert for rows that have the key values...the row could have the key but still not exist in the db in cases where the key is not an autoincrement number.

Parameters:

conn - the jdbc connection

tableName - the table to upsert into

primaryKeyCols - a unique key for the table that will constrain the upsert

rows - the data to upsert

Returns:

the primaryKeyCols values for all rows upserted

Throws:

SQLException - when the upsert fails

runSql

public static void runSql(Connection conn,
 String sqlString)
                   throws SQLException

Throws:

SQLException

runSql

public static void runSql(Connection conn,
 InputStream ddlStream)
                   throws SQLException

Throws:

SQLException

readSql

public static List<String> readSql(String string)
                            throws SQLException

Throws:

SQLException

readSql

public static List<String> readSql(InputStream ddlStream)
                            throws SQLException

Breaks the input stream up into a list of sql statements where statements are terminated by ";". Lines starting with "--" or "#" are considred comments are are ignored.

Parameters:

ddlStream - a stream of ddl text

Returns:

the text broken into individual sql statements

Throws:

SQLException - when io fails

runSql

public static void runSql(Connection con,
 List<String> sql)
                   throws SQLException

Throws:

SQLException

runSql

public static void runSql(Connection con,
 String[] sql)
                   throws SQLException

Throws:

SQLException

getWhereColumnStr

public static String getWhereColumnStr(Connection conn,
 Object[] columnNameArray,
 String sep)

getColumnStr

public static String getColumnStr(Connection conn,
 Object[] columnNameArray)

getColumnStr

public static String getColumnStr(Connection conn,
 List columnNameArray)

getQuestionMarkStr

public static String getQuestionMarkStr(Object[] columnNameArray)

getQuestionMarkStr

public static String getQuestionMarkStr(int numQMarks)

check

public static String check(Object sql)

close

public static void close(Object... toClose)