How to use an hibernate interceptor with spring

[rboere]

I want to use my own hibernate interceptor to achieve history functions in my database tables.

My question is how to make spring to use the interceptor.

The messege i get is :'Bean with name 'personDAOTarget' concluding interceptor chain is not an advisor class: treating it as a target or TargetSourc', and the methods of the interceptor are not called.

The interceptor i created extends org.springframework.orm.hibernate.HibernateInterce ptor

I added the following to the applicationContext.

<bean id="myHibernateInterceptor" class="org.appfuse.MyInterceptor">
<property name="sessionFactory"><ref local="sessionFactory"/></property>
</bean>

<bean id="personDAOTarget" class="org.appfuse.dao.hibernate.PersonDAOHibernat e">
<property name="sessionFactory"><ref local="sessionFactory"/></property>
</bean>

<bean id="personDAO" class="org.springframework.aop.framework.ProxyFact oryBean">
<property name="proxyInterfaces">
<value>org.appfuse.dao.PersonDAO</value>
</property>
<property name="interceptorNames">
<list>
<value>myHibernateInterceptor</value>
<value>personDAOTarget</value>
</list>
</property>
</bean>

Regards,
Rene Boere

[Rod Johnson]

If you want to use your own HibernateInterceptor, use the entityInterceptor property of Spring's LocalSessionFactoryBean.

Hibernate interceptors are quite separate from Spring's AOP framework.

[scesbron]

But is there a way with spring to tell hibernate to use an interceptor each time it opens a session ?

[sds]

Since version 1.1, you can use an entityInterceptorBeanName, and the hibernateInterceptor will request a new Hibernate Interceptor for each request. If you set your entity interceptor to singleton="false", a new entity interceptor will be created for each request.

<beans>
    ...

    <bean id="myHibernateInterceptor" 
        class="org.springframework.orm.hibernate.HibernateInterceptor">
        <property name="sessionFactory">
            <ref bean="mySessionFactory"/>
        </property>
	<property name="entityInterceptorBeanName">
            <value>myEntityInterceptor</value>
	</property>
    </bean>

    <bean id="myEntityInterceptor" class="mypackage.MyEntitiyInterceptor" singleton="false"/>

    ...
</beans>

If you want to access request specific information, I recommend not to follow this approach but instead call a class where that request-specific information, such as the current user, is currently stored in a threadlocal object.

Cheers, Stefaan

[scesbron]

There is a naming problem here. I don't want to use spring's HibernateInterceptor but I want to use hibernate's Interceptor which is call on some hibernate events (save/update/delete).

The hibernate docs says that I have to pass this interceptor to the session when I create it but with spring I have no access to the session creation : this is my problem

[sds]

Yeah, it is really confusing. My reply did indeed speak about hibernate's interceptor, I call it the entity interceptor. You normally configure this entity interceptor (hibernate class) which you define the HibernateInterceptor, which is a Spring AOP interceptor for Hibernate. In that HibernateInterceptor, you set the entityInterceptorBeanName.

Hope this clearifies

[spring04]

Hi,

I've the same requirement that i would like to record some history information when the a record in the table is inserted/updated/deleted (CRUD). I'm trying to implement as discussed here....the spring way.

I've the AuditLogInterceptor class that implements Interceptor as follows:

public class AuditLogRecordInterceptor implements Interceptor {
.....
......

	public void postFlush(Iterator arg0) throws CallbackException {
		try {
			for(Iterator itr = inserts.iterator(); itr.hasNext(); ) {
				Auditable entity = (Auditable)itr.next();
				AuditLog.logEvent("create", entity, "testuser");
			}
			for(Iterator itr = updates.iterator(); itr.hasNext(); ) {
				Auditable entity = (Auditable)itr.next();
				AuditLog.logEvent("update", entity, "testuser");
			}
		} catch(HibernateException e) {
			
		} finally {
			inserts.clear();
			updates.clear();
		}
		
	}
}

In this class i'm implementing the required methods such as OnSave, OnPostFlush etc as per the hibernate requirement.

I also have a class called AuditLog an utility class as follows:

public class AuditLog {
	private SessionFactory sessionFactory;
	
	public void setSessionFactory(SessionFactory sessionFactory) {
		this.sessionFactory = sessionFactory;
	}
	
	public SessionFactory getSessionFactory() {
		return sessionFactory;
	}
	
	public void logEvent(String message, Auditable entity,
							Long userId) 
								throws CallbackException {
		Session session = null;
		
		try {
			AuditLogRecord record = new AuditLogRecord(message, entity.getId(),
								entity.getClass(), userId);
		    session = sessionFactory.openSession();
			session.save(record);
			session.flush();
		} catch(Exception ex) {
			throw new CallbackException(ex);
		} finally {
			try {
				session.close();
			} catch(HibernateException ex) {
				throw new CallbackException(ex);				
			}
		}
		
	}
}

Here is my applicationContext.xml file (partial)

	    <!-- Hibernate SessionFactory 2 used for audit log-->
    <bean id="sessionFactory2" class="org.springframework.orm.hibernate.LocalSessionFactoryBean">
        <property name="dataSource"><ref local="dataSource"/></property>
 		<property name="mappingResources">
			<list>
				<value>com/apple/ermt/model/Project.hbm.xml</value>
				<value>com/apple/ermt/model/ProjectResource.hbm.xml</value>
				<value>com/apple/ermt/model/Resource.hbm.xml</value>
				<value>com/apple/ermt/model/Requirement.hbm.xml</value>	
				<value>com/apple/ermt/model/TestCase.hbm.xml</value>	
				<value>com/apple/ermt/model/UseCase.hbm.xml</value>						
			</list>
		</property>
    </bean>
 
	<bean id="auditLogInterceptor" class="com.apple.ermt.persistence.audit.AuditLogInterceptor" singleton="false"/>
	
	<bean id="auditLog" class="com.apple.ermt.persistence.audit.AuditLog">
		<property name="sessionFactory"><ref local="sessionFactory2"/></property>
	</bean>
	
    <!-- Hibernate SessionFactory -->
    <bean id="sessionFactory" class="org.springframework.orm.hibernate.LocalSessionFactoryBean">
        <property name="dataSource"><ref local="dataSource"/></property>
 		<property name="mappingResources">
			<list>
				<value>com/apple/ermt/model/Project.hbm.xml</value>
				<value>com/apple/ermt/model/ProjectResource.hbm.xml</value>
				<value>com/apple/ermt/model/Resource.hbm.xml</value>
				<value>com/apple/ermt/model/Requirement.hbm.xml</value>	
				<value>com/apple/ermt/model/TestCase.hbm.xml</value>	
				<value>com/apple/ermt/model/UseCase.hbm.xml</value>						
			</list>
		</property>
        <property name="hibernateProperties">
        <props>
            <prop key="hibernate.dialect">net.sf.hibernate.dialect.MySQLDialect</prop>
            <prop key="hibernate.hbm2ddl.auto">update</prop>
        </props>
        </property>  
        <property name="entityInterceptor"><ref local="auditLogInterceptor"/></property>
    </bean>
........
......

My problem is that per the Hibernate in Action book, the AuditLog can have a static method called logEvent which can be used from the AuditLogRecord class to actually record the entry in the table. If i make this method STATIC, it can't access the instance variable sessionFactory being injected by Spring. The solution is to make this variable also STATIC. But i feel that this is WRONG. So do i need to have the logEvent method to be STATIC? If not, how else should i implement this?

Could someone please share your experience?


Thanks very much in advance.

[spring04]

Just one correction.

I've added the property "entityInterceptor" under the "transactionManager" bean.


Thanks!

[sds]

Why do you access AuditLog with static methods ? You've configured it using spring as a singleton, then there is no need to define static methods any more. Just add AuditLog as a property of your AuditLogInterceptor.

Actually, you don't need to configure the AuditLogInterceptor as a non-singleton. It's much simpler without singleton="false". If you say you configered it using the entityInterceptor property, there will be only one instance anyway. Only if you define it using the entityInterceptorBeanName, a new entityInterceptor on each new session.

If you need to get to the user information, I suggest using a "UserResolver" (interface returing a String getUser()) that looks up in a ThreadLocal the object. You only need to set it into the ThreadLocal by using a Servlet Filter for example. This is the suggested approach in the acegi security framework. This works in my project like a charm.

Good luck,
Stefaan.

[spring04]

Thanks Stefaan.

This is what i've done. As you said, i've added AuditLog as a property in the AuditLogRecordInterceptor as follows:

public class AuditLogRecordInterceptor implements Interceptor {
	private Log log = LogFactory.getLog(HibernateProjectDAO.class);
	
	private SessionFactory sessionFactory;
	private AuditLog  auditLog;
	
	private Set inserts = new HashSet();
	private Set updates = new HashSet();
	

	public void setSessionFactory(SessionFactory sessionFactory) {
		this.sessionFactory = sessionFactory;
	}
	
	public SessionFactory getSessionFactory() {
		return this.sessionFactory;
	}

	public void setAuditLog(AuditLog auditLog) {
		this.auditLog = auditLog;
	}

	public AuditLog getAuditLog() {
		return this.auditLog;
	}

	
	/* (non-Javadoc)
	 * @see net.sf.hibernate.Interceptor#onLoad(java.lang.Object, java.io.Serializable, java.lang.Object[], java.lang.String[], net.sf.hibernate.type.Type[])
	 */
	public boolean onLoad(Object arg0, Serializable arg1, Object[] arg2, String[] arg3, Type[] arg4) throws CallbackException {
		// TODO Auto-generated method stub
		return false;
	}

	/* (non-Javadoc)
	 * @see net.sf.hibernate.Interceptor#onFlushDirty(java.lang.Object, java.io.Serializable, java.lang.Object[], java.lang.Object[], java.lang.String[], net.sf.hibernate.type.Type[])
	 */
	public boolean onFlushDirty(Object arg0, Serializable arg1, Object[] arg2, Object[] arg3, String[] arg4, Type[] arg5) throws CallbackException {
		if(arg0 instanceof Auditable)
			updates.add(arg0);
		return false;
	}

	/* (non-Javadoc)
	 * @see net.sf.hibernate.Interceptor#onSave(java.lang.Object, java.io.Serializable, java.lang.Object[], java.lang.String[], net.sf.hibernate.type.Type[])
	 */
	public boolean onSave(Object arg0, Serializable arg1, Object[] arg2, String[] arg3, Type[] arg4) throws CallbackException {
		if(arg0 instanceof Auditable)
			inserts.add(arg0);
		return false;
	}

	/* (non-Javadoc)
	 * @see net.sf.hibernate.Interceptor#onDelete(java.lang.Object, java.io.Serializable, java.lang.Object[], java.lang.String[], net.sf.hibernate.type.Type[])
	 */
	public void onDelete(Object arg0, Serializable arg1, Object[] arg2, String[] arg3, Type[] arg4) throws CallbackException {
		// TODO Auto-generated method stub
		
	}

	/* (non-Javadoc)
	 * @see net.sf.hibernate.Interceptor#preFlush(java.util.Iterator)
	 */
	public void preFlush(Iterator arg0) throws CallbackException {
		// TODO Auto-generated method stub
		
	}

	/* (non-Javadoc)
	 * @see net.sf.hibernate.Interceptor#postFlush(java.util.Iterator)
	 */
	public void postFlush(Iterator arg0) throws CallbackException {
		log.debug("In postFlush#########..");
		
		try {
			for(Iterator itr = inserts.iterator(); itr.hasNext(); ) {
				Auditable entity = (Auditable)itr.next();
				auditLog.logEvent("create", entity, new Long(1), sessionFactory);
			}
			for(Iterator itr = updates.iterator(); itr.hasNext(); ) {
				Auditable entity = (Auditable)itr.next();
				auditLog.logEvent("update", entity, new Long(1), sessionFactory);
			}
		} catch(HibernateException e) {
			
		} finally {
			inserts.clear();
			updates.clear();
		}
		
	}

	/* (non-Javadoc)
	 * @see net.sf.hibernate.Interceptor#isUnsaved(java.lang.Object)
	 */
	public Boolean isUnsaved(Object arg0) {
		// TODO Auto-generated method stub
		return null;
	}

	/* (non-Javadoc)
	 * @see net.sf.hibernate.Interceptor#findDirty(java.lang.Object, java.io.Serializable, java.lang.Object[], java.lang.Object[], java.lang.String[], net.sf.hibernate.type.Type[])
	 */
	public int[] findDirty(Object arg0, Serializable arg1, Object[] arg2, Object[] arg3, String[] arg4, Type[] arg5) {
		// TODO Auto-generated method stub
		return null;
	}

	/* (non-Javadoc)
	 * @see net.sf.hibernate.Interceptor#instantiate(java.lang.Class, java.io.Serializable)
	 */
	public Object instantiate(Class arg0, Serializable arg1) throws CallbackException {
		// TODO Auto-generated method stub
		return null;
	}
	
	public void logEvent(String message, Auditable entity, Long userId) 
				throws CallbackException {
		Session session = null;
		
		try {
			AuditLogRecord record = new AuditLogRecord(message, entity.getId(),
							entity.getClass(), userId);
			session = sessionFactory.openSession();
			session.save(record);
			session.flush();
		} catch(Exception ex) {
			throw new CallbackException(ex);
		} finally {
			try {
				session.close();
			} catch(HibernateException ex) {
				throw new CallbackException(ex);				
			}
		}
	}


	
}

The AuditLog is the util class which has the logEvent method that logs the event in the DB.

My Project.java extends Auditable interface.

Here's my latest applicationContext.xml.

<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
		<property name="driverClassName"><value>$&#123;hibernate.connection.driver_class&#125;</value></property>
		<property name="url"><value>$&#123;hibernate.connection.url&#125;</value></property>
		<property name="username"><value>$&#123;hibernate.connection.username&#125;</value></property>
		<property name="password"><value>$&#123;hibernate.connection.password&#125;</value></property> 
	</bean>
	
	    <!-- Hibernate SessionFactory 2 used for audit log-->
    <bean id="sessionFactory2" class="org.springframework.orm.hibernate.LocalSessionFactoryBean">
        <property name="dataSource"><ref local="dataSource"/></property>
 		<property name="mappingResources">
			<list>
				<value>com/apple/ermt/model/Project.hbm.xml</value>
				<value>com/apple/ermt/model/ProjectResource.hbm.xml</value>
				<value>com/apple/ermt/model/Resource.hbm.xml</value>
				<value>com/apple/ermt/model/Requirement.hbm.xml</value>	
				<value>com/apple/ermt/model/TestCase.hbm.xml</value>	
				<value>com/apple/ermt/persistence/audit/AuditLogRecord.hbm.xml</value>	
				<value>com/apple/ermt/model/UseCase.hbm.xml</value>						
			</list>
		</property>
    </bean>
 
 
	<bean id="auditLog" class="com.apple.ermt.persistence.audit.interceptor.AuditLog"/>

	<bean id="auditLogRecord" class="com.apple.ermt.persistence.audit.AuditLogRecord"/>

    <!-- Hibernate SessionFactory -->
    <bean id="sessionFactory" class="org.springframework.orm.hibernate.LocalSessionFactoryBean">
        <property name="dataSource"><ref local="dataSource"/></property>
 		<property name="mappingResources">
			<list>
				<value>com/apple/ermt/model/Project.hbm.xml</value>
				<value>com/apple/ermt/model/ProjectResource.hbm.xml</value>
				<value>com/apple/ermt/model/Resource.hbm.xml</value>
				<value>com/apple/ermt/model/Requirement.hbm.xml</value>	
				<value>com/apple/ermt/model/TestCase.hbm.xml</value>	
				<value>com/apple/ermt/persistence/audit/AuditLogRecord.hbm.xml</value>	
				<value>com/apple/ermt/model/UseCase.hbm.xml</value>								</list>
		</property>
        <property name="hibernateProperties">
		<props>
		    <prop key="hibernate.dialect">net.sf.hibernate.dialect.MySQLDialect</prop>
		    <prop key="hibernate.hbm2ddl.auto">create</prop>
		</props>
        </property>  
    </bean>

<!--
	<bean id="myHibernateInterceptor" class="org.springframework.orm.hibernate.HibernateInterceptor">
	      <property name="sessionFactory"><ref local="sessionFactory2"/></property>
	      <property name="entityInterceptorBeanName"><value>auditLogInterceptor</value></property>
	</bean>
 -->
 
	<bean id="auditLogInterceptor" class="com.apple.ermt.persistence.audit.interceptor.AuditLogRecordInterceptor" singleton="false">
		<property name="auditLog"><ref local="auditLog"/></property>
	</bean>

    <!-- Transaction manager for a single Hibernate SessionFactory &#40;alternative to JTA&#41; -->
    <bean id="transactionManager" class="org.springframework.orm.hibernate.HibernateTransactionManager">
        <property name="sessionFactory"><ref local="sessionFactory"/></property>
   		<property name="entityInterceptor"><ref local="auditLogInterceptor"/></property>    
    </bean>

Please note that i'm wiring the interceptor through the transaction manager.

My problem is that, when i save the project, the interceptor never gets called.


Could someone please let me know what is that i'm missing?

Thanks in advance!