com.redhat.rhn.common.hibernate

Class HibernateFactory

java.lang.Object

com.redhat.rhn.common.hibernate.HibernateFactory

Direct Known Subclasses:

ActionChainFactory, ActionFactory, ActivationKeyFactory, ChannelFactory, ChannelFamilyFactory, ChecksumFactory, CommonFactory, ConfigurationFactory, CrashFactory, CveFactory, ErrataCacheManager, ErrataFactory, IssFactory, KickstartFactory, LoggingFactory, OrgFactory, PackageFactory, ProfileFactory, ResetPasswordFactory, RhnSetFactory, RoleFactory, SatConfigFactory, ScapFactory, ServerFactory, ServerGroupFactory, ServerNoteFactory, SystemMigrationFactory, TaskFactory, TaskoFactory, TestFactory, TokenFactory, TokenPackageFactory, UserFactory, UserGroupFactory, VirtualInstanceFactory, WebSessionFactory

public abstract class HibernateFactory
extends java.lang.Object

HibernateFactory - Helper superclass that contains methods for fetching and storing Objects from the DB using Hibernate.

Abstract methods define what the subclass must implement to determine what is specific to that Factory's instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HibernateFactory()

Method Summary

Modifier and Type	Method and Description
static void	addConfigurator(Configurator c) Register a class with HibernateFactory, to give the registered class a chance to modify the Hibernate configuration before creating the SessionFactory.
static byte[]	blobToByteArray(java.sql.Blob fromBlob) utility to convert blob to byte array
static java.sql.Blob	byteArrayToBlob(byte[] data) Convert a byte[] array to a Blob object.
static void	closeSession() Closes the Hibernate Session stored in ThreadLocal storage.
static void	closeSessionFactory() Close the sessionFactory
static void	commitTransaction() Commit the transaction for the current session.
static void	createSessionFactory() Create a SessionFactory, loading the hbm.xml files from the default location (com.redhat.rhn.domain).
static void	createSessionFactory(java.lang.String[] additionalLocation) Create a SessionFactory, loading the hbm.xml files from alternate location
protected static void	executeCallableMode(java.lang.String name, java.lang.String mode, java.util.Map params)
protected static DataResult	executeSelectMode(java.lang.String name, java.lang.String mode, java.util.Map params)
static java.lang.String	getBlobContents(java.lang.Object blob) Get the String version of an object corresponding to a BLOB column Handles both the byte[] and the Blob cases
static java.lang.String	getByteArrayContents(byte[] barr) Get the String version of the byte array contents used to return the string representation of byte arrays constructed from blobs
protected abstract org.apache.log4j.Logger	getLogger() Get the Logger for the derived class so log messages show up on the correct class
java.lang.Object	getObject(java.lang.Class clazz, java.io.Serializable id) Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
static org.hibernate.Session	getSession() Returns the Hibernate session stored in ThreadLocal storage.
static void	initialize() Initialize the underlying db layer
static boolean	inTransaction() Is transaction pending for thread?
static boolean	isClosed() Is the factory closed
static boolean	isInitialized() Returns the current initialization status
protected java.util.List	listObjectsByNamedQuery(java.lang.String qryName, java.util.Map qryParams) Using a named query, find all the objects matching the criteria within.
protected java.util.List	listObjectsByNamedQuery(java.lang.String qryName, java.util.Map qryParams, boolean cacheable) Using a named query, find all the objects matching the criteria within.
protected java.util.List	listObjectsByNamedQuery(java.lang.String qryName, java.util.Map qryParams, java.util.Collection col, java.lang.String colLabel) Using a named query, find all the objects matching the criteria within.
protected java.lang.Object	lockObject(java.lang.Class clazz, java.io.Serializable id) Return a locked persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
protected java.lang.Object	lookupObjectByNamedQuery(java.lang.String qryName, java.util.Map qryParams) Finds a single instance of a persistent object given a named query.
protected java.lang.Object	lookupObjectByNamedQuery(java.lang.String qryName, java.util.Map qryParams, boolean cacheable) Finds a single instance of a persistent object given a named query.
static java.lang.Object	reload(java.lang.Object obj) Util to reload an object using Hibernate
protected int	removeObject(java.lang.Object toRemove) Remove a Session from the DB
static void	rollbackTransaction() Roll the transaction for the current session back.
protected void	saveObject(java.lang.Object toSave) Saves the given object to the database using Hibernate.
protected void	saveObject(java.lang.Object toSave, boolean saveOrUpdate) Saves the given object to the database using Hibernate.
static byte[]	stringToByteArray(java.lang.String data) Convert a String to a byte[] object.

Methods inherited from class java.lang.Object

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

Constructor Detail

HibernateFactory

protected HibernateFactory()

Method Detail

addConfigurator

public static void addConfigurator(Configurator c)

Register a class with HibernateFactory, to give the registered class a chance to modify the Hibernate configuration before creating the SessionFactory.

Parameters:

c - Configurator to override Hibernate configuration.

closeSessionFactory

public static void closeSessionFactory()

Close the sessionFactory

isClosed

public static boolean isClosed()

Is the factory closed

Returns:

boolean

createSessionFactory

public static void createSessionFactory()

Create a SessionFactory, loading the hbm.xml files from the default location (com.redhat.rhn.domain).

createSessionFactory

public static void createSessionFactory(java.lang.String[] additionalLocation)

Create a SessionFactory, loading the hbm.xml files from alternate location

Parameters:

additionalLocation - Alternate location for hbm.xml files

getLogger

protected abstract org.apache.log4j.Logger getLogger()

Get the Logger for the derived class so log messages show up on the correct class

Returns:

Logger for this class.

lookupObjectByNamedQuery

protected java.lang.Object lookupObjectByNamedQuery(java.lang.String qryName,
                                                    java.util.Map qryParams)

Finds a single instance of a persistent object given a named query.

Parameters:

qryName - The name of the query used to find the persistent object. It should be formulated to ensure a single object is returned or an error will occur.

qryParams - Map of named bind parameters whose keys are Strings. The map can also be null.

Returns:

Object found by named query or null if nothing found.

lookupObjectByNamedQuery

protected java.lang.Object lookupObjectByNamedQuery(java.lang.String qryName,
                                                    java.util.Map qryParams,
                                                    boolean cacheable)

Finds a single instance of a persistent object given a named query.

Parameters:

qryName - The name of the query used to find the persistent object. It should be formulated to ensure a single object is returned or an error will occur.

qryParams - Map of named bind parameters whose keys are Strings. The map can also be null.

cacheable - if we should cache the results of this object

Returns:

Object found by named query or null if nothing found.

listObjectsByNamedQuery

protected java.util.List listObjectsByNamedQuery(java.lang.String qryName,
                                                 java.util.Map qryParams)

Using a named query, find all the objects matching the criteria within. Warning: This can be very expensive if the returned list is large. Use only for small tables with static data

Parameters:

qryName - Named query to use to find a list of objects.

qryParams - Map of named bind parameters whose keys are Strings. The map can also be null.

Returns:

List of objects returned by named query, or null if nothing found.

listObjectsByNamedQuery

protected java.util.List listObjectsByNamedQuery(java.lang.String qryName,
                                                 java.util.Map qryParams,
                                                 java.util.Collection col,
                                                 java.lang.String colLabel)

Using a named query, find all the objects matching the criteria within. Warning: This can be very expensive if the returned list is large. Use only for small tables with static data

Parameters:

qryName - Named query to use to find a list of objects.

qryParams - Map of named bind parameters whose keys are Strings. The map can also be null.

col - the collection to use as an inclause

colLabel - the label the collection will have

Returns:

List of objects returned by named query, or null if nothing found.

listObjectsByNamedQuery

protected java.util.List listObjectsByNamedQuery(java.lang.String qryName,
                                                 java.util.Map qryParams,
                                                 boolean cacheable)

Using a named query, find all the objects matching the criteria within. Warning: This can be very expensive if the returned list is large. Use only for small tables with static data

Parameters:

qryName - Named query to use to find a list of objects.

qryParams - Map of named bind parameters whose keys are Strings. The map can also be null.

cacheable - if we should cache the results of this query

Returns:

List of objects returned by named query, or null if nothing found.

saveObject

protected void saveObject(java.lang.Object toSave,
                          boolean saveOrUpdate)

Saves the given object to the database using Hibernate.

Parameters:

toSave - Object to be persisted.

saveOrUpdate - true if saveOrUpdate should be called, false if save() is to be called directly.

saveObject

protected void saveObject(java.lang.Object toSave)

Saves the given object to the database using Hibernate.

Parameters:

toSave - Object to be persisted.

removeObject

protected int removeObject(java.lang.Object toRemove)

Remove a Session from the DB

Parameters:

toRemove - Object to be removed.

Returns:

int number of objects affected.

getSession

public static org.hibernate.Session getSession()

Returns the Hibernate session stored in ThreadLocal storage. If not present, creates a new one and stores it in ThreadLocal; creating the session also begins a transaction implicitly.

Returns:

Session Session asked for

commitTransaction

public static void commitTransaction()
                              throws org.hibernate.HibernateException

Commit the transaction for the current session. This method or rollbackTransaction()can only be called once per session.

Throws:

org.hibernate.HibernateException - if the commit fails

rollbackTransaction

public static void rollbackTransaction()
                                throws org.hibernate.HibernateException

Roll the transaction for the current session back. This method or commitTransaction()can only be called once per session.

Throws:

org.hibernate.HibernateException - if the commit fails

inTransaction

public static boolean inTransaction()

Is transaction pending for thread?

Returns:

boolean

closeSession

public static void closeSession()

Closes the Hibernate Session stored in ThreadLocal storage.

getObject

public java.lang.Object getObject(java.lang.Class clazz,
                                  java.io.Serializable id)

Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. (If the instance, or a proxy for the instance, is already associated with the session, return that instance or proxy.)

Parameters:

clazz - a persistent class

id - an identifier

Returns:

Object persistent instance or null

lockObject

protected java.lang.Object lockObject(java.lang.Class clazz,
                                      java.io.Serializable id)

Return a locked persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. (If the instance, or a proxy for the instance, is already associated with the session, return that instance or proxy.)

Parameters:

clazz - a persistent class

id - an identifier

Returns:

Object persistent instance or null

reload

public static java.lang.Object reload(java.lang.Object obj)
                               throws org.hibernate.HibernateException

Util to reload an object using Hibernate

Parameters:

obj - to be reloaded

Returns:

Object found if not, null

Throws:

org.hibernate.HibernateException - if something bad happens.

blobToByteArray

public static byte[] blobToByteArray(java.sql.Blob fromBlob)

utility to convert blob to byte array

Parameters:

fromBlob - blob to convert

Returns:

byte array converted from blob

getByteArrayContents

public static java.lang.String getByteArrayContents(byte[] barr)

Get the String version of the byte array contents used to return the string representation of byte arrays constructed from blobs

Parameters:

barr - byte array to convert to String

Returns:

String version of the byte array contents

getBlobContents

public static java.lang.String getBlobContents(java.lang.Object blob)

Get the String version of an object corresponding to a BLOB column Handles both the byte[] and the Blob cases

Parameters:

blob - the blob to handle

Returns:

String version of the blob contents, null if the blob was null or if the specified object is not actually a Blob

byteArrayToBlob

public static java.sql.Blob byteArrayToBlob(byte[] data)

Convert a byte[] array to a Blob object. Guards against null arrays and 0 length arrays.

Parameters:

data - array to convert to a Blob

Returns:

Blob if data[] is non-null and length > 0, null otherwise

stringToByteArray

public static byte[] stringToByteArray(java.lang.String data)

Convert a String to a byte[] object. Guards against null arrays and 0 length arrays.

Parameters:

data - string to convert to a Blob

Returns:

Blob if data[] is non-null and length > 0, null otherwise

initialize

public static void initialize()

Initialize the underlying db layer

isInitialized

public static boolean isInitialized()

Returns the current initialization status

Returns:

boolean current status

executeSelectMode

protected static DataResult executeSelectMode(java.lang.String name,
                                              java.lang.String mode,
                                              java.util.Map params)

executeCallableMode

protected static void executeCallableMode(java.lang.String name,
                                          java.lang.String mode,
                                          java.util.Map params)