org.gridgain.grid.cache.store.hibernate

Class GridCacheHibernateBlobStore<K,V>

java.lang.Object

org.gridgain.grid.cache.store.GridCacheStoreAdapter<K,V>

org.gridgain.grid.cache.store.hibernate.GridCacheHibernateBlobStore<K,V>

All Implemented Interfaces:

org.gridgain.grid.cache.store.GridCacheStore<K,V>

public class GridCacheHibernateBlobStore<K,V>
extends org.gridgain.grid.cache.store.GridCacheStoreAdapter<K,V>

GridCacheStore implementation backed by Hibernate. This implementation stores objects in underlying database in BLOB format.

Configuration

Either setSessionFactory(SessionFactory) or setHibernateConfigurationPath(String) or setHibernateProperties(Properties) should be set.

If session factory is provided it should contain GridCacheHibernateBlobStoreEntry persistent class (via provided mapping file GridCacheHibernateStoreEntry.hbm.xml or by adding GridCacheHibernateBlobStoreEntry to annotated classes of session factory.

Path to hibernate configuration may be either an URL or a file path or a classpath resource. This configuration file should include provided mapping GridCacheHibernateStoreEntry.hbm.xml or include annotated class GridCacheHibernateBlobStoreEntry.

If hibernate properties are provided, mapping GridCacheHibernateStoreEntry.hbm.xml is included automatically.

Java Example

In this example existing session factory is provided.

     ...
     GridCacheHibernateBlobStore<String, String> store = new GridCacheHibernateBlobStore<String, String>();

     store.setSessionFactory(sesFactory);
     ...
 

Spring Example (using Spring ORM)

   ...
   <bean id="cache.hibernate.store"
       class="org.gridgain.grid.cache.store.hibernate.GridCacheHibernateBlobStore">
       <property name="sessionFactory">
           <bean class="org.springframework.orm.hibernate3.LocalSessionFactoryBean">
               <property name="hibernateProperties">
                   <value>
                       connection.url=jdbc:h2:mem:
                       show_sql=true
                       hbm2ddl.auto=true
                       hibernate.dialect=org.hibernate.dialect.H2Dialect
                   </value>
               </property>
               <property name="mappingResources">
                   <list>
                       <value>
                           org/gridgain/grid/cache/store/hibernate/GridCacheHibernateBlobStoreEntry.hbm.xml
                       </value>
                   </list>
               </property>
           </bean>
       </property>
   </bean>
   ...
 

Spring Example (using Spring ORM and persistent annotations)

     ...
     <bean id="cache.hibernate.store1"
         class="org.gridgain.grid.cache.store.hibernate.GridCacheHibernateBlobStore">
         <property name="sessionFactory">
             <bean class="org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean">
                 <property name="hibernateProperties">
                     <value>
                         connection.url=jdbc:h2:mem:
                         show_sql=true
                         hbm2ddl.auto=true
                         hibernate.dialect=org.hibernate.dialect.H2Dialect
                     </value>
                 </property>
                 <property name="annotatedClasses">
                     <list>
                         <value>
                             org.gridgain.grid.cache.store.hibernate.GridCacheHibernateBlobStoreEntry
                         </value>
                     </list>
                 </property>
             </bean>
         </property>
     </bean>
     ...
 

Spring Example

     ...
     <bean id="cache.hibernate.store2"
         class="org.gridgain.grid.cache.store.hibernate.GridCacheHibernateBlobStore">
         <property name="hibernateProperties">
             <props>
                 <prop key="connection.url">jdbc:h2:mem:</prop>
                 <prop key="hbm2ddl.auto">update</prop>
                 <prop key="show_sql">true</prop>
             </props>
         </property>
     </bean>
     ...
 

For information about Spring framework visit www.springframework.org

Field Summary

Fields

Modifier and Type	Field and Description
static String	DFLT_CONN_URL Default connection URL (value is jdbc:h2:mem:hibernateCacheStore;DB_CLOSE_DELAY=-1;DEFAULT_LOCK_TIMEOUT=5000).
static String	DFLT_HBM2DDL_AUTO Default hibernate.hbm2ddl.auto property value (value is true).
static String	DFLT_SHOW_SQL Default show SQL property value (value is true).

Constructor Summary

Constructors

Constructor and Description
GridCacheHibernateBlobStore()

Method Summary

Methods

Modifier and Type	Method and Description
protected <X> X	fromBytes(byte[] bytes) Deserialize object from byte array using marshaller.
V	load(org.gridgain.grid.cache.GridCacheTx tx, K key)
void	put(org.gridgain.grid.cache.GridCacheTx tx, K key, V val)
void	remove(org.gridgain.grid.cache.GridCacheTx tx, K key)
void	setHibernateConfigurationPath(String hibernateCfgPath) Sets hibernate configuration path.
void	setHibernateProperties(Properties hibernateProps) Sets Hibernate properties.
void	setSessionFactory(org.hibernate.SessionFactory sesFactory) Sets session factory.
protected byte[]	toBytes(Object obj) Serialize object to byte array using marshaller.
String	toString()
void	txEnd(org.gridgain.grid.cache.GridCacheTx tx, boolean commit)

Methods inherited from class org.gridgain.grid.cache.store.GridCacheStoreAdapter

loadAll, loadCache, putAll, removeAll

Methods inherited from class java.lang.Object

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

Field Detail

DFLT_CONN_URL

public static final String DFLT_CONN_URL

Default connection URL (value is jdbc:h2:mem:hibernateCacheStore;DB_CLOSE_DELAY=-1;DEFAULT_LOCK_TIMEOUT=5000).

See Also:

Constant Field Values

DFLT_SHOW_SQL

public static final String DFLT_SHOW_SQL

Default show SQL property value (value is true).

See Also:

Constant Field Values

DFLT_HBM2DDL_AUTO

public static final String DFLT_HBM2DDL_AUTO

Default hibernate.hbm2ddl.auto property value (value is true).

See Also:

Constant Field Values

Constructor Detail

GridCacheHibernateBlobStore

public GridCacheHibernateBlobStore()

Method Detail

load

public V load(@Nullable
     org.gridgain.grid.cache.GridCacheTx tx,
     K key)
       throws org.gridgain.grid.GridException

Throws:

org.gridgain.grid.GridException

put

public void put(@Nullable
       org.gridgain.grid.cache.GridCacheTx tx,
       K key,
       @Nullable
       V val)
         throws org.gridgain.grid.GridException

Throws:

org.gridgain.grid.GridException

remove

public void remove(@Nullable
          org.gridgain.grid.cache.GridCacheTx tx,
          K key)
            throws org.gridgain.grid.GridException

Throws:

org.gridgain.grid.GridException

txEnd

public void txEnd(org.gridgain.grid.cache.GridCacheTx tx,
         boolean commit)
           throws org.gridgain.grid.GridException

Specified by:

txEnd in interface org.gridgain.grid.cache.store.GridCacheStore<K,V>

Overrides:

txEnd in class org.gridgain.grid.cache.store.GridCacheStoreAdapter<K,V>

Throws:

org.gridgain.grid.GridException

setSessionFactory

public void setSessionFactory(org.hibernate.SessionFactory sesFactory)

Sets session factory.

Parameters:

sesFactory - Session factory.

setHibernateConfigurationPath

public void setHibernateConfigurationPath(String hibernateCfgPath)

Sets hibernate configuration path.

This may be either URL or file path or classpath resource.

Parameters:

hibernateCfgPath - URL or file path or classpath resource pointing to hibernate configuration XML file.

setHibernateProperties

public void setHibernateProperties(Properties hibernateProps)

Sets Hibernate properties.

Parameters:

hibernateProps - Hibernate properties.

toString

public String toString()

Overrides:

toString in class Object

toBytes

protected byte[] toBytes(Object obj)
                  throws org.gridgain.grid.GridException

Serialize object to byte array using marshaller.

Parameters:

obj - Object to convert to byte array.

Returns:

Byte array.

Throws:

org.gridgain.grid.GridException - If failed to convert.

fromBytes

protected <X> X fromBytes(byte[] bytes)
               throws org.gridgain.grid.GridException

Deserialize object from byte array using marshaller.

Type Parameters:

X - Result object type.

Parameters:

bytes - Bytes to deserialize.

Returns:

Deserialized object.

Throws:

org.gridgain.grid.GridException - If failed.