edu.internet2.middleware.grouper.hibernate
Class HibUtils

java.lang.Object
  edu.internet2.middleware.grouper.hibernate.HibUtils

public class HibUtils
extends java.lang.Object

Author:

mchyzer

Constructor Summary

HibUtils()

Method Summary

static void	assignProperty(java.lang.Object[] state, java.lang.String[] propertyNames, java.lang.String propertyName, java.lang.Object propertyValue) assign a property in hibernates arrays of states
static void	attachParams(java.sql.PreparedStatement statement, java.lang.Object params) Attach params for a prepared statement.
static void	closeQuietly(java.sql.Connection connection) close a connection null safe and dont throw exception
static void	closeQuietly(java.sql.PreparedStatement preparedStatement) close a prepared statement
static void	closeQuietly(java.sql.ResultSet resultSet) close a resultSet null safe and dont throw exception
static void	closeQuietly(org.hibernate.ScrollableResults scrollableResults)
static void	closeQuietly(org.hibernate.Session session) close a session null safe and dont throw exception
static void	closeQuietly(java.sql.Statement statement) close a statement null safe and dont throw exception
static void	convertFieldsToSqlInString(java.util.Collection<Field> fields, HqlQuery hqlQuery, java.lang.StringBuilder sql, java.lang.String fieldColumnName)
static java.lang.String	convertHqlToCountHql(java.lang.String hql) convert an hql to a count hql
static java.lang.String	convertSourcesToSqlInString(java.util.Set<edu.internet2.middleware.subject.Source> sources) e.g.
static void	convertSourcesToSqlInString(java.util.Set<edu.internet2.middleware.subject.Source> sources, HqlQuery hqlQuery, java.lang.StringBuilder sql, java.lang.String sourceColumnName)
static java.lang.String	convertToInClause(java.util.Collection<java.lang.String> collection, HqlQuery scalarable) convert a collection of strings (no parens) to an in clause
static java.lang.String	convertToInClauseForSqlStatic(java.util.Collection<java.lang.String> collection) convert a collection of strings (no parens) to an in clause
static void	convertToMultiKeyInClause(java.util.Collection<org.apache.commons.collections.keyvalue.MultiKey> collection, HqlQuery scalarable, java.util.Collection<java.lang.String> columnNames, java.lang.StringBuilder whereClause) convert a collection of multikeys to an in clause with multiple args.
static java.lang.String	convertToSubjectInClause(java.util.Collection<edu.internet2.middleware.subject.Subject> subjects, HqlQuery hqlQuery, java.lang.String memberAlias)
static java.lang.String	equalsOrIs(java.lang.Object value, java.lang.String bindVar) if in an hql or sql query, depending on the value, pass is or = back
static java.lang.String	escapeSqlString(java.lang.String input) escape the quotes from sql string
static void	evict(HibernateSession hibernateSession, java.util.Collection<java.lang.Object> list, boolean onlyEvictIfNotNew) evict a list of objects from hibernate.
static void	evict(HibernateSession hibernateSession, java.lang.Object object, boolean onlyEvictIfNotNew) evict a list of objects from hibernate.
static void	evict(HibernateSession hibernateSession, java.lang.Object object, boolean onlyEvictIfNotNew, boolean evictBeforeFlush) evict a list of objects from hibernate.
static org.hibernate.type.Type	hibernateType(java.lang.Object o) Returns a Hibernate Type for the given java type.
static java.util.List<org.hibernate.type.Type>	hibernateTypes(java.util.List<java.lang.Object> params) Returns a list of Hibernate types corresponding to the given params.
static org.hibernate.criterion.Criterion	listCrit(org.hibernate.criterion.Criterion... criterions) make a list of criterions.
static org.hibernate.criterion.Criterion	listCrit(java.util.List<org.hibernate.criterion.Criterion> criterions) make a list of criterions.
static org.hibernate.criterion.Criterion	listCritOr(org.hibernate.criterion.Criterion... criterions) make a list of criterions.
static org.hibernate.criterion.Criterion	listCritOr(java.util.List<org.hibernate.criterion.Criterion> criterions) make a list of criterions.
static java.util.List<java.lang.Object>	listObject(java.lang.Object object) convert an object to a list of objects
static java.lang.String	paramsToString(java.lang.Object params, java.lang.Object types) Convert the params to friendly strings
static java.lang.String	parseAlias(java.lang.String text, boolean exceptionIfNotFound) Parses an alias out of a sql query.
static int	propertyIndex(java.lang.String[] propertyNames, java.lang.String propertyName) find the property index based on property name
static java.lang.Object	propertyValue(java.lang.Object[] state, java.lang.String[] propertyNames, java.lang.String propertyName) find a property value in hibernates arrays of states
static void	rollbackQuietly(java.sql.Connection connection) rollback a connection quietly
static void	rollbackQuietly(org.hibernate.Transaction transaction) rollback a transaction quietly
static java.lang.String	secondLevelCacheRegion(java.lang.String cacheRegion, QueryOptions queryOptions)
static boolean	secondLevelCaching(java.lang.Boolean cacheable, QueryOptions queryOptions)

Methods inherited from class java.lang.Object

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

Constructor Detail

HibUtils

public HibUtils()

Method Detail

paramsToString

public static java.lang.String paramsToString(java.lang.Object params,
                                              java.lang.Object types)

Convert the params to friendly strings

Parameters:

params -

types -

Returns:

the string of the params (for logging)

parseAlias

public static java.lang.String parseAlias(java.lang.String text,
                                          boolean exceptionIfNotFound)

Parses an alias out of a sql query.

Parameters:

text - is the text to find the alias in.

exceptionIfNotFound - if true, when an alias is not found, and exception will be thrown.

Returns:

the alias.

equalsOrIs

public static java.lang.String equalsOrIs(java.lang.Object value,
                                          java.lang.String bindVar)

if in an hql or sql query, depending on the value, pass is or = back

Parameters:

value -

bindVar -

Returns:

the query comparator

secondLevelCaching

public static boolean secondLevelCaching(java.lang.Boolean cacheable,
                                         QueryOptions queryOptions)

Parameters:

cacheable -

queryOptions -

Returns:

if caching

secondLevelCacheRegion

public static java.lang.String secondLevelCacheRegion(java.lang.String cacheRegion,
                                                      QueryOptions queryOptions)

Parameters:

cacheRegion -

queryOptions -

Returns:

if caching

convertHqlToCountHql

public static java.lang.String convertHqlToCountHql(java.lang.String hql)

convert an hql to a count hql

Parameters:

hql -

Returns:

the hql of the count query

closeQuietly

public static void closeQuietly(org.hibernate.ScrollableResults scrollableResults)

Parameters:

scrollableResults -

propertyIndex

public static int propertyIndex(java.lang.String[] propertyNames,
                                java.lang.String propertyName)

find the property index based on property name

Parameters:

propertyNames -

propertyName - e.g. userId

Returns:

the index (0 based) in the data arrays where the object is

assignProperty

public static void assignProperty(java.lang.Object[] state,
                                  java.lang.String[] propertyNames,
                                  java.lang.String propertyName,
                                  java.lang.Object propertyValue)

assign a property in hibernates arrays of states

Parameters:

state -

propertyNames -

propertyName -

propertyValue -

propertyValue

public static java.lang.Object propertyValue(java.lang.Object[] state,
                                             java.lang.String[] propertyNames,
                                             java.lang.String propertyName)

find a property value in hibernates arrays of states

Parameters:

state -

propertyNames -

propertyName -

Returns:

the object

closeQuietly

public static void closeQuietly(java.sql.PreparedStatement preparedStatement)

close a prepared statement

Parameters:

preparedStatement -

evict

public static void evict(HibernateSession hibernateSession,
                         java.lang.Object object,
                         boolean onlyEvictIfNotNew)

 evict a list of objects from hibernate.  do this always for two reasons:
 1. If you edit an object that is in the hibernate session, and commit, it will
 commit those changes magically.  Only objects called session.save(obj) or 
 update etc should be committed
 2. If you select an object, then try to store it back (but have a different
 reference, e.g. if the DTO went through it, then you will get an exception:
 "a different object with the same identifier value was already associated with the session"
 

Parameters:

hibernateSession - grouper hibernateSession, can be null if not known

object - to evict that was just retrieved, can be list or array

onlyEvictIfNotNew - true to only evict if this is a nested tx

evict

public static void evict(HibernateSession hibernateSession,
                         java.lang.Object object,
                         boolean onlyEvictIfNotNew,
                         boolean evictBeforeFlush)

 evict a list of objects from hibernate.  do this always for two reasons:
 1. If you edit an object that is in the hibernate session, and commit, it will
 commit those changes magically.  Only objects called session.save(obj) or 
 update etc should be committed
 2. If you select an object, then try to store it back (but have a different
 reference, e.g. if the DTO went through it, then you will get an exception:
 "a different object with the same identifier value was already associated with the session"
 

Parameters:

hibernateSession - grouper hibernateSession, can be null if not known

object - to evict that was just retrieved, can be list or array

onlyEvictIfNotNew - true to only evict if this is a nested tx

evictBeforeFlush - if evict before flush (dont do this if iterating through list)

evict

public static void evict(HibernateSession hibernateSession,
                         java.util.Collection<java.lang.Object> list,
                         boolean onlyEvictIfNotNew)

 evict a list of objects from hibernate.  do this always for two reasons:
 1. If you edit an object that is in the hibernate session, and commit, it will
 commit those changes magically.  Only objects called session.save(obj) or 
 update etc should be committed
 2. If you select an object, then try to store it back (but have a different
 reference, e.g. if the DTO went through it, then you will get an exception:
 "a different object with the same identifier value was already associated with the session"
 

Parameters:

hibernateSession - grouper hibernateSession

list - of objects from hibernate to evict

onlyEvictIfNotNew - true to only evict if this is a nested tx

listCrit

public static org.hibernate.criterion.Criterion listCrit(org.hibernate.criterion.Criterion... criterions)

make a list of criterions. e.g. listCrit(crit1, crit2, etc). will AND them together this is null and empty safe

Parameters:

criterions -

Returns:

the criterion containing the list or null if none passed in

listCrit

public static org.hibernate.criterion.Criterion listCrit(java.util.List<org.hibernate.criterion.Criterion> criterions)

make a list of criterions. e.g. listCrit(critList). will AND them together this is null and empty safe

Parameters:

criterions -

Returns:

the criterion containing the list or null if none passed in

listCritOr

public static org.hibernate.criterion.Criterion listCritOr(org.hibernate.criterion.Criterion... criterions)

make a list of criterions. e.g. listCrit(crit1, crit2, etc). will OR them together this is null and empty safe

Parameters:

criterions -

Returns:

the criterion containing the list or null if none passed in

listCritOr

public static org.hibernate.criterion.Criterion listCritOr(java.util.List<org.hibernate.criterion.Criterion> criterions)

make a list of criterions. e.g. listCrit(crits). will OR them together this is null and empty safe

Parameters:

criterions -

Returns:

the criterion containing the list or null if none passed in

closeQuietly

public static void closeQuietly(java.sql.Connection connection)

close a connection null safe and dont throw exception

Parameters:

connection -

closeQuietly

public static void closeQuietly(java.sql.ResultSet resultSet)

close a resultSet null safe and dont throw exception

Parameters:

resultSet -

closeQuietly

public static void closeQuietly(org.hibernate.Session session)

close a session null safe and dont throw exception

Parameters:

session -

closeQuietly

public static void closeQuietly(java.sql.Statement statement)

close a statement null safe and dont throw exception

Parameters:

statement -

rollbackQuietly

public static void rollbackQuietly(java.sql.Connection connection)

rollback a connection quietly

Parameters:

connection -

rollbackQuietly

public static void rollbackQuietly(org.hibernate.Transaction transaction)

rollback a transaction quietly

Parameters:

transaction -

attachParams

public static void attachParams(java.sql.PreparedStatement statement,
                                java.lang.Object params)
                         throws org.hibernate.HibernateException,
                                java.sql.SQLException

Attach params for a prepared statement. The type of the params and types must be the same (e.g. either both array or list, but not one is Array, and the other list

Parameters:

statement -

params - either null, Object, Object[], or List of Objects

Throws:

org.hibernate.HibernateException

java.sql.SQLException

listObject

public static java.util.List<java.lang.Object> listObject(java.lang.Object object)

convert an object to a list of objects

Parameters:

object -

Returns:

the list of objects

hibernateType

public static org.hibernate.type.Type hibernateType(java.lang.Object o)

Returns a Hibernate Type for the given java type. Handles both primitives and Objects. Will throw an exception if the given object is null or if a type cannot be found for it.

Parameters:

o - is the object to find the Type for.

Returns:

the Type.

hibernateTypes

public static java.util.List<org.hibernate.type.Type> hibernateTypes(java.util.List<java.lang.Object> params)

Returns a list of Hibernate types corresponding to the given params.

Parameters:

params - are the objects to get the types for. Can be list, Object, or array.

Returns:

the corresponding types.

convertToInClause

public static java.lang.String convertToInClause(java.util.Collection<java.lang.String> collection,
                                                 HqlQuery scalarable)

convert a collection of strings (no parens) to an in clause

Parameters:

collection -

scalarable - to set the string

Returns:

the string of in clause (without parens)

convertToSubjectInClause

public static java.lang.String convertToSubjectInClause(java.util.Collection<edu.internet2.middleware.subject.Subject> subjects,
                                                        HqlQuery hqlQuery,
                                                        java.lang.String memberAlias)

Parameters:

memberAlias - is the alias of the table for members, e.g. gm

subjects - collection of subjects

hqlQuery - so far

Returns:

the query, e.g. ((gm.subject_id = '123' and gm.subject_source = 'jdbc') or (gm.subject_id = '234' and gm.subject_source = 'jdbc' ))

escapeSqlString

public static java.lang.String escapeSqlString(java.lang.String input)

escape the quotes from sql string

Parameters:

input -

Returns:

the escaped string

convertToInClauseForSqlStatic

public static java.lang.String convertToInClauseForSqlStatic(java.util.Collection<java.lang.String> collection)

convert a collection of strings (no parens) to an in clause

Parameters:

collection -

Returns:

the string of in clause (without parens)

convertToMultiKeyInClause

public static void convertToMultiKeyInClause(java.util.Collection<org.apache.commons.collections.keyvalue.MultiKey> collection,
                                             HqlQuery scalarable,
                                             java.util.Collection<java.lang.String> columnNames,
                                             java.lang.StringBuilder whereClause)

convert a collection of multikeys to an in clause with multiple args. currently this only works with strings, though we could add support for more types in future

Parameters:

collection -

scalarable - to set the string

columnNames - names of columns in multikey

whereClause -

convertFieldsToSqlInString

public static void convertFieldsToSqlInString(java.util.Collection<Field> fields,
                                              HqlQuery hqlQuery,
                                              java.lang.StringBuilder sql,
                                              java.lang.String fieldColumnName)

Parameters:

fields -

hqlQuery -

sql - before the and statement

fieldColumnName -

convertSourcesToSqlInString

public static void convertSourcesToSqlInString(java.util.Set<edu.internet2.middleware.subject.Source> sources,
                                               HqlQuery hqlQuery,
                                               java.lang.StringBuilder sql,
                                               java.lang.String sourceColumnName)

Parameters:

sources -

hqlQuery -

sql - before the and statement

sourceColumnName -

convertSourcesToSqlInString

public static java.lang.String convertSourcesToSqlInString(java.util.Set<edu.internet2.middleware.subject.Source> sources)

e.g. ('g:gsa', 'jdbc')

Parameters:

sources -

Returns:

the in string, of sources sorted alphabetically