org.dspace.core

Class HibernateDBConnection

java.lang.Object

org.dspace.core.HibernateDBConnection

All Implemented Interfaces:

DBConnection<org.hibernate.Session>

public class HibernateDBConnection
extends Object
implements DBConnection<org.hibernate.Session>

Hibernate implementation of the DBConnection.

Author:

kevinvandevelde at atmire.com

Constructor Summary

Constructors

Constructor and Description
HibernateDBConnection()

Method Summary

Modifier and Type	Method and Description
void	closeDBConnection() Close this session: close DBMS connection(s) and clean up resources.
void	commit() Commit the open transaction.
long	getCacheSize() How many entities are cached in this session?
DatabaseConfigVO	getDatabaseConfig() Identify certain characteristics of the DBMS being used to support persistence.
DataSource	getDataSource() The JDBC DataSource used by this session.
org.hibernate.Session	getSession() Access to the underlying persistence provider's session object.
protected org.hibernate.Transaction	getTransaction()
String	getType() Some description of the DBMS used to persist entities.
boolean	isOptimizedForBatchProcessing() Has this session been configured for large batches? Typically this means that automatic flushing of updates to the database is suppressed, and thus one must take care to flush manually (or commit) at appropriate times.
boolean	isSessionAlive()
boolean	isTransActionAlive()
<E extends ReloadableEntity> E	reloadEntity(E entity) Reload a DSpace object from the database.
void	rollback() Roll back the open transaction.
void	setConnectionMode(boolean batchOptimized, boolean readOnlyOptimized) Configure the connection for special uses.
void	shutdown() Close all sessions.
<E extends ReloadableEntity> void	uncacheEntity(E entity) Evict an entity from the hibernate cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

HibernateDBConnection

public HibernateDBConnection()

Method Detail

getSession

public org.hibernate.Session getSession()
                                 throws SQLException

Description copied from interface: DBConnection

Access to the underlying persistence provider's session object.

Specified by:

getSession in interface DBConnection<org.hibernate.Session>

Returns:

the provider's session object for this connection.

Throws:

SQLException - passed through.

isTransActionAlive

public boolean isTransActionAlive()

Specified by:

isTransActionAlive in interface DBConnection<org.hibernate.Session>

Returns:

true if this session has an uncommitted transaction.

getTransaction

protected org.hibernate.Transaction getTransaction()

isSessionAlive

public boolean isSessionAlive()

Specified by:

isSessionAlive in interface DBConnection<org.hibernate.Session>

Returns:

true if the session is open, false if it has been closed.

rollback

public void rollback()
              throws SQLException

Description copied from interface: DBConnection

Roll back the open transaction.

Specified by:

rollback in interface DBConnection<org.hibernate.Session>

Throws:

SQLException - passed through.

closeDBConnection

public void closeDBConnection()
                       throws SQLException

Description copied from interface: DBConnection

Close this session: close DBMS connection(s) and clean up resources.

Specified by:

closeDBConnection in interface DBConnection<org.hibernate.Session>

Throws:

SQLException - passed through.

commit

public void commit()
            throws SQLException

Description copied from interface: DBConnection

Commit the open transaction.

Specified by:

commit in interface DBConnection<org.hibernate.Session>

Throws:

SQLException - passed through.

shutdown

public void shutdown()

Description copied from interface: DBConnection

Close all sessions. Release all associated resources (cache, DBMS connections, etc.) To be used only when exiting the application.

Specified by:

shutdown in interface DBConnection<org.hibernate.Session>

getType

public String getType()

Description copied from interface: DBConnection

Some description of the DBMS used to persist entities.

Specified by:

getType in interface DBConnection<org.hibernate.Session>

Returns:

Brand, version, dialect, etc. Implementation specific.

getDataSource

public DataSource getDataSource()

Description copied from interface: DBConnection

The JDBC DataSource used by this session. Think carefully before using.

Specified by:

getDataSource in interface DBConnection<org.hibernate.Session>

Returns:

the source of DBMS connections.

getDatabaseConfig

public DatabaseConfigVO getDatabaseConfig()
                                   throws SQLException

Description copied from interface: DBConnection

Identify certain characteristics of the DBMS being used to support persistence.

Specified by:

getDatabaseConfig in interface DBConnection<org.hibernate.Session>

Returns:

a collection of DBMS, database and connection information.

Throws:

SQLException - passed through.

getCacheSize

public long getCacheSize()
                  throws SQLException

Description copied from interface: DBConnection

How many entities are cached in this session?

Specified by:

getCacheSize in interface DBConnection<org.hibernate.Session>

Returns:

number of cached entities.

Throws:

SQLException - passed through.

reloadEntity

public <E extends ReloadableEntity> E reloadEntity(E entity)
                                            throws SQLException

Description copied from interface: DBConnection

Reload a DSpace object from the database. This will make sure the object is valid and stored in the cache. The returned object should be used henceforth instead of the passed object.

Specified by:

reloadEntity in interface DBConnection<org.hibernate.Session>

Type Parameters:

E - type of entity

Parameters:

entity - The DSpace object to reload

Returns:

the reloaded entity.

Throws:

SQLException - passed through.

setConnectionMode

public void setConnectionMode(boolean batchOptimized,
                              boolean readOnlyOptimized)
                       throws SQLException

Description copied from interface: DBConnection

Configure the connection for special uses.

Specified by:

setConnectionMode in interface DBConnection<org.hibernate.Session>

Parameters:

batchOptimized - if true, optimize for batch use. Typically this means suppressing automatic flushing of updates, thus requiring manual flushing at appropriate points in the process.

readOnlyOptimized - if true, optimize for read-only use. Typically this suppresses all updating.

Throws:

SQLException

isOptimizedForBatchProcessing

public boolean isOptimizedForBatchProcessing()

Description copied from interface: DBConnection

Has this session been configured for large batches? Typically this means that automatic flushing of updates to the database is suppressed, and thus one must take care to flush manually (or commit) at appropriate times.

Specified by:

isOptimizedForBatchProcessing in interface DBConnection<org.hibernate.Session>

Returns:

true if configured for batch.

uncacheEntity

public <E extends ReloadableEntity> void uncacheEntity(E entity)
                                                throws SQLException

Evict an entity from the hibernate cache. This is necessary when batch processing a large number of items.

Specified by:

uncacheEntity in interface DBConnection<org.hibernate.Session>

Type Parameters:

E - The class of the enity. The entity must implement the ReloadableEntity interface.

Parameters:

entity - The entity to reload

Throws:

SQLException - When reloading the entity from the database fails.