org.apache.ignite.cache.store.hibernate

Class CacheHibernateStoreSessionListener

java.lang.Object

org.apache.ignite.cache.store.hibernate.CacheHibernateStoreSessionListener

All Implemented Interfaces:

CacheStoreSessionListener, LifecycleAware

public class CacheHibernateStoreSessionListener
extends Object
implements CacheStoreSessionListener, LifecycleAware

Hibernate-based cache store session listener.

This listener creates a new Hibernate session for each store session. If there is an ongoing cache transaction, a corresponding Hibernate transaction is created as well.

The Hibernate session is saved as a store session attachment. The listener guarantees that the session will be available for any store operation. If there is an ongoing cache transaction, all operations within this transaction will share a DB transaction.

As an example, here is how the CacheWriter.write(javax.cache.Cache.Entry) method can be implemented if CacheHibernateStoreSessionListener is configured:

 private static class Store extends CacheStoreAdapter<Integer, Integer> {
     @CacheStoreSessionResource
     private CacheStoreSession ses;

     @Override public void write(Cache.Entry<? extends Integer, ? extends Integer> entry) throws CacheWriterException {
         // Get Hibernate session from the current store session.
         Session hibSes = ses.attachment();

         // Persist the value.
         hibSes.persist(entry.getValue());
     }
 }
 

Hibernate session will be automatically created by the listener at the start of the session and closed when it ends.

CacheHibernateStoreSessionListener requires that either setSessionFactory(SessionFactory) session factory} or Hibernate configuration file is provided. If non of them is set, exception is thrown. Is both are provided, session factory will be used.

Constructor Summary

Constructors

Constructor and Description
CacheHibernateStoreSessionListener()

Method Summary

Modifier and Type	Method and Description
String	getHibernateConfigurationPath() Gets hibernate configuration path.
org.hibernate.SessionFactory	getSessionFactory() Gets Hibernate session factory.
void	onSessionEnd(CacheStoreSession ses, boolean commit) On session end callback.
void	onSessionStart(CacheStoreSession ses) On session start callback.
void	setHibernateConfigurationPath(String hibernateCfgPath) Sets hibernate configuration path.
void	setSessionFactory(org.hibernate.SessionFactory sesFactory) Sets Hibernate session factory.
void	start() Starts grid component, called on grid start.
void	stop() Stops grid component, called on grid shutdown.

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheHibernateStoreSessionListener

public CacheHibernateStoreSessionListener()

Method Detail

setSessionFactory

public void setSessionFactory(org.hibernate.SessionFactory sesFactory)

Sets Hibernate session factory.

Either session factory or configuration file is required. If none is provided, exception will be thrown on startup.

Parameters:

sesFactory - Session factory.

getSessionFactory

public org.hibernate.SessionFactory getSessionFactory()

Gets Hibernate session factory.

Returns:

Session factory.

setHibernateConfigurationPath

public void setHibernateConfigurationPath(String hibernateCfgPath)

Sets hibernate configuration path.

Either session factory or configuration file is required. If none is provided, exception will be thrown on startup.

Parameters:

hibernateCfgPath - Hibernate configuration path.

getHibernateConfigurationPath

public String getHibernateConfigurationPath()

Gets hibernate configuration path.

Returns:

Hibernate configuration path.

start

public void start()
           throws IgniteException

Starts grid component, called on grid start.

Specified by:

start in interface LifecycleAware

Throws:

IgniteException - If failed.

stop

public void stop()
          throws IgniteException

Stops grid component, called on grid shutdown.

Specified by:

stop in interface LifecycleAware

Throws:

IgniteException - If failed.

onSessionStart

public void onSessionStart(CacheStoreSession ses)

On session start callback.

Called before any store operation within a session is invoked.

Specified by:

onSessionStart in interface CacheStoreSessionListener

Parameters:

ses - Current session.

onSessionEnd

public void onSessionEnd(CacheStoreSession ses,
                         boolean commit)

On session end callback.

Called after all operations within a session are invoked.

Specified by:

onSessionEnd in interface CacheStoreSessionListener

Parameters:

ses - Current session.

commit - True if persistence store transaction should commit, false for rollback.