How do I assign an Interceptor after a SessionFactory has been created?

[Al Koch]

Hello,

We have a code base that uses the Hibernate implementation of JPA but that has to date only utilized the basic facilities of JPA. In particular that means we have used EntityManager instead of SessionBuilder. This approach was taken because (until now) we only needed the base JPA facilities and saw no benefit to using Hibernate constructs. However, we now need the facilities that a Hibernate Interceptor can provide and are looking for some way to implement this.

We see how to obtain the Session and SessionFactory from an existing EntityManager but cannot see how to "add" an Interceptor to an existing Session(Builder). We can find numerous examples showing how to configure a SessionFactory so that upon construction of the SessionFactory it will start up with an Interceptor but how can an Interceptor be added if (through the creation of an EntiryManager) the SessionFactor already exists?

Thank you.

[H Paul]

Is this what you're looking for?

http://docs.jboss.org/hibernate/orm/4.3/manual/en-US/html_single/#events

Chapter 14. Interceptors and events
…
There are two kinds of inteceptors: Session-scoped and SessionFactory-scoped.

[Al Koch]

Hi H Paul,

Thanks but (I think) we understand the basic creation and use of an Interceptor. My problem is that we have a large code base that has used the JPA API (EntityManager) not the Hibernate API (SessionFactory) so we can't just "hook in"/register the Interceptor at the time the Hibernate Session is created. We can obtain the Hibernate Session from the EntityManager on the em is created so my question is how to we "hook in"/register the Interceptor with Hibernate AFTER the Hibernate Session has been created.

Any ideas?

Thanks.

[H Paul]

Instead of getting session from entityManager

		org.hibernate.Session session = entityManager.unwrap(org.hibernate.Session.class);

You can get session and set interceptor as below:

		EntityManagerFactory entityManagerFactory= Persistence.createEntityManagerFactory( "YOUR PU" );

		SessionFactory sessionFactory= entityManagerFactory.unwrap(SessionFactory.class);

		org.hibernate.Session session = sessionFactory.withOptions().interceptor(new MyInterceptor()).openSession();

[Al Koch]

It looks like we may be getting close. The immediate problem with using your suggested code "as is" is that our code uses injection to get the EM instantiated. We have a class (JPAFacade) that handles all of the interface issues with JPA - here are the (I think relevant) bits of code:


@Stateless
@TransactionAttribute(TransactionAttributeType.REQUIRES_NEW)
public class JPAFacade {
..
@PersistenceContext(unitName=UtilitiesModel.JPA_PERSISTENCE_UNIT)
private EntityManager em;
...
}

then we use em within this class to handle all the CRUD.

I don't know how to make the leap from what you propose to the injection approach currently used (I inherited this code and am scrambling to get up to speed on Hibernate!). Can you adapt your approach to work with injection?

Thanks again for your help!

[H Paul]

http://docs.oracle.com/javaee/6/api/javax/persistence/PersistenceUnit.html
Expresses a dependency on an EntityManagerFactory and its associated persistence unit.


Try this:

@ javax.persistence.PersistenceUnit(unitName=UtilitiesModel.JPA_PERSISTENCE_UNIT) 
private EntityManagerFactory emf; 

Read Detail explanation between Container-Managed Entity Managers and Application-Managed Entity Managers
http://docs.oracle.com/javaee/6/tutorial/doc/bnbqw.html

Container-Managed Entity Managers
@PersistenceContext
EntityManager em;

Application-Managed Entity Managers
@PersistenceUnit
EntityManagerFactory emf;

[Al Koch]

Hi H Paul,

Thanks for the help with the EntityManagerFactory annotation. After adding the annotation I tried your code :

// Don't use the following since the entityManagerFactory is injected!
//EntityManagerFactory entityManagerFactory= Persistence.createEntityManagerFactory( "YOUR PU" );
SessionFactory sessionFactory= entityManagerFactory.unwrap(SessionFactory.class);
org.hibernate.Session session = sessionFactory.withOptions().interceptor(new MyInterceptor()).openSession();

This generated an error on unwrap (it's not defined for EntityManagerFactory ). I changed this to be called off of EntityManager as follows:
SessionFactory sessionFactory= entityManager.unwrap(SessionFactory.class);
but upon execution this yields:

Hibernate cannot unwrap interface org.hibernate.SessionFactory.

In case it is helpful, here is the persistence.xml:

<?xml version="1.0" encoding="UTF-8"?>
<persistence version="2.0"
   xmlns="http://java.sun.com/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="
        http://java.sun.com/xml/ns/persistence
        http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd">
	<persistence-unit name="PU" transaction-type="JTA">
		<provider>org.hibernate.ejb.HibernatePersistence</provider>
		<jta-data-source>java:jboss/datasources/SybaseDS</jta-data-source>
		<properties>
			<property name="hibernate.show_sql" value="false"/>
			<property name="use_sql_comments" value="false"/>
			<property name="hibernate.dialect" value="org.hibernate.dialect.SQLAnywhere16Dialect"/>
			<property name="hibernate.temp.use_jdbc_metadata_defaults" value="false"/>
			<!-- The following are from the SQLAnywhereDialect_Readme.txt -->			
			<property name="hibernate.connection.JCONNECT_VERSION" value="7"/>
			<property name="hibernate.connection.DYNAMIC_PREPARE" value="true"/>
			<property name="hibernate.jdbc.batch.builder" value="org.hibernate.dialect.sqlanywhere.JConnBatchBuilderImpl"/>
			<property name="hibernate.jdbc.batch_size" value="15"/>
<!-- 09/09/14 TEMP till get ClassNotFound resolved			
			<property name="hibernate.ejb.interceptor" value="com.MyCom.model.HibernateInterceptor." />
 --> 
		</properties>
	</persistence-unit>
</persistence>

(Note above that the Interceptor Property is triggering a Class Not Found. This is an "upcoming" problem but I don't think that not including that <property> is affecting the current problem.

Can you help me determine what's wrong here?

Again, thanks for your ongoing help.

[H Paul]

1. This is what I have in mind:

@PersistenceUnit(unitName=UtilitiesModel.JPA_PERSISTENCE_UNIT)   
private EntityManagerFactory emf;   

SessionFactory sessionFactory= entityManagerFactory.unwrap(SessionFactory.class);    
org.hibernate.Session session = sessionFactory.withOptions().interceptor(new MyInterceptor()).openSession(); 

2. If I read you correctly, the code in point 1 generate an error. What exception? check log.

3. What hibernate version do you use? I used the latest 4.3.5 Final (hibernate-entitymanager-4.3.5)

[H Paul]

Can you experiment with this?

@PersistenceContext(unitName=UtilitiesModel.JPA_PERSISTENCE_UNIT) 
private EntityManager em; 


SessionFactory sessionFactory = entityManager.unwrap(org.hibernate.Session.class).getSessionFactory();
		
Session session = sessionFactory.withOptions().interceptor(new MyInterceptor()).openSession();

[H Paul]

1. Taking from (EE6 compliant)

https://docs.jboss.org/author/display/AS7/JPA+Reference+Guide

section Native Hibernate use

section Injection of Hibernate Session and SessionFactoryInjection of Hibernate Session and SessionFactory
You can inject a org.hibernate.Session and org.hibernate.SessionFactory directly, just as you can do with EntityManagers and EntityManagerFactorys.

import org.hibernate.Session;
import org.hibernate.SessionFactory;
@Stateful public class MyStatefulBean ... {
   @PersistenceContext(unitName="crm") Session session1;
   @PersistenceContext(unitName="crm2", type=EXTENDED) Session extendedpc;
   @PersistenceUnit(unitName="crm") SessionFactory factory;
}

2. Taking from

http://docs.jboss.org/ejb3/docs/tutorial/1.0.7/html/Hibernate_Session_In_EJB3.html

Injecting Hibernate Session and SessionFactory :
You can inject a org.hibernate.Session and org.hibernate.SessionFactory directly into your EJBs just as you can do with EntityManagers and EntityManagerFactorys. The behavior of a Session is just the same as the behavior of an injected EntityManager. The application server controls the lifecycle of the Session so that you do not have to open, flush, or close the session. Extended persistence contexts also work with injected Hibernate Sessions.

3. For your JBoss EJB container, check its version and its documentation to see its feasibility.
And try for point 1 and 2.

[Al Koch]

Hi H Paul,

I appreciate the post you made (sorry about the slowness of my responses - I am having to work several unrelated issues in our code and have to cycle between them).

I implemented you suggestion of:

@PersistenceContext(unitName=UtilitiesModel.JPA_PERSISTENCE_UNIT)   
private EntityManager em;   
...    
SessionFactory sessionFactory = entityManager.unwrap(org.hibernate.Session.class).getSessionFactory();  
Session session = sessionFactory.withOptions().interceptor(new MyInterceptor()).openSession();  

and I no longer have any errors for that code.

It is my understanding that I also need to "register" the Interceptor in persistence.xml and here is that is done (the full xml is in an earlier post)

<property name="hibernate.ejb.interceptor." value="com.MyCom.model.HibernateInterceptor." />

Finally, here is HibernateInterceptor:

public class HibernateInterceptor extends EmptyInterceptor {
HibernateInterceptor() {}

@Override
public void onDelete(...

...
}

Unfortunately, I now get the following error when I deploy (out of Eclipse - Kepler) to JBoss 7:

javax.persistence.PersistenceException: [PersistenceUnit: PU] Unable to find hibernate.ejb.interceptor: com.MyCom.model.HibernateInterceptor.

Do I need to annotate HibernateInterceptor in some fashion? Can you see what is wrong here? (It feels like we are almost there!)

As always, thanks for the continued help.

[H Paul]

Read Key Differences between below Point 1 and 2. Point 3 is what you need.

1.

Look at the posted September 6, 2014 1:15:10 PM PDT


That's for Native Hibernate Api, you extend

import org.hibernate.EmptyInterceptor;

public class NativeHibernateApiInterceptor extends EmptyInterceptor {
}

2.

For JPA Interceptor, you need to implement org.hibernate.Interceptor. <<<<<<<<< THIS IS WHAT YOU NEED TO IMPLEMENT. See below doc note.

import org.hibernate.Interceptor;

public class JPAInterceptor implements Interceptor {
}

Read this doc http://docs.jboss.org/hibernate/entitymanager/3.6/reference/en/html/configuration.html

There are two kinds of inteceptors: Session-scoped and SessionFactory-scoped.

hibernate.ejb.interceptor

An optional Hibernate interceptor. The interceptor instance is shared by all Session instances. T
his interceptor has to implement org.hibernate.Interceptor and have a no-arg constructor. T
his property can not be combined with hibernate.ejb.interceptor.session_scoped.

hibernate.ejb.interceptor.session_scoped

An optional Hibernate interceptor.
The interceptor instance is specific to a given Session instance (and hence can be non thread-safe).
This interceptor has to implement org.hibernate.Interceptor and have a no-arg constructor.
This property can not be combined with hibernate.ejb.interceptor.



3. After reading again, this is what you need:

		@PersistenceContext(unitName=UtilitiesModel.JPA_PERSISTENCE_UNIT)   
		private EntityManager em; 

with Yours: <property name="hibernate.ejb.interceptor" value="example.interceptor.JPAInterceptor"/> // for example

use em to work and you don't need to go thru an intermediate Session

for example: entityManager.persist( anyObject );

The interceptor configured on Point 2 will be called.

[H Paul]

In addition to above thread:

1. I just did 1 quick experiment and found that you can extends EmptyInterceptor

public class NativeHibernateApiInterceptor extends EmptyInterceptor {

because 

public class EmptyInterceptor implements Interceptor, Serializable {

2. If you test with the JPAInterceptor implements Interceptor
you will get an exception

ERROR: org.hibernate.AssertionFailure - HHH000099: an assertion failure occured (this may indicate a bug in Hibernate, but is more likely due to unsafe use of the session): 
org.hibernate.AssertionFailure: Interceptor.onPrepareStatement() returned null or empty string.

Googled:
http://forum.spring.io/forum/spring-projects/data/13059-hibernate-spring-transaction-flushing-issue
It turns out this was due to a change in the default behaviour of the Entity Interceptor in 3.x. Prior to 3.x, the on prepared statement could return null in the implementation.
However, in 3.x+ there is an assertion check which is what I was experiencing.

This was easily solved by extending one of the new helper base classes rather than implementing the interface directly.

3. If you test with NativeHibernateApiInterceptor extends EmptyInterceptor

it will be OK.

[Al Koch]

Hi H Paul,

Thanks for all of the info in your posts. Unfortunately I am missing what you feel I am doing wrong because I think I am doing what you suggest.

1) I am implementing from EmptyHibernator as:

public class HibernateInterceptor extends EmptyInterceptor {
HibernateInterceptor() {}
...

2) I am annotating as you suggest:

@PersistenceContext(unitName=UtilitiesModel.JPA_PERSISTENCE_UNIT)     
private EntityManager em;   

3) I am using the <property> in persistence.xml that you suggest:

<property name="hibernate.ejb.interceptor" value="com.MyCom.model.HibernateInterceptor"/>

The problem is that upon deployment to JBoss 7 I get:

Caused by: javax.persistence.PersistenceException: [PersistenceUnit: PU] Unable to find interceptor class: com.MyCom.model.HibernateInterceptor.

Can you see why this class is not being found? (Is there an annotation on HibernateInterceptor I am missing?)

Thank you!

[H Paul]

1. Already read what you wrote.
2. Can you post the full exception if you have it?

[Al Koch]

Here it is. (I included a little bit of console output prior to the error to provide a little context:

18:18:14,233 INFO  [org.jboss.as.ejb3.deployment.processors.EjbJndiBindingsDeploymentUnitProcessor] (MSC service thread 1-1) JNDI bindings for session bean named JPAFacade in deployment unit deployment "MyCom.war" are as follows:

	java:global/MyCom/JPAFacade!com.MyCom.model.JPAFacade
	java:app/MyCom/JPAFacade!com.MyCom.model.JPAFacade
	java:module/JPAFacade!com.MyCom.model.JPAFacade
	java:global/MyCom/JPAFacade
	java:app/MyCom/JPAFacade
	java:module/JPAFacade

18:18:14,235 INFO  [org.jboss.as.ejb3.deployment.processors.EjbJndiBindingsDeploymentUnitProcessor] (MSC service thread 1-1) JNDI bindings for session bean named MemberRegistration in deployment unit deployment "MyCom.war" are as follows:

	java:global/MyCom/MemberRegistration!com.MyCom.service.MemberRegistration
	java:app/MyCom/MemberRegistration!com.MyCom.service.MemberRegistration
	java:module/MemberRegistration!com.MyCom.service.MemberRegistration
	java:global/MyCom/MemberRegistration
	java:app/MyCom/MemberRegistration
	java:module/MemberRegistration

18:18:14,286 INFO  [org.jboss.as.connector.deployers.jdbc] (MSC service thread 1-1) JBAS010404: Deploying non-JDBC-compliant driver class com.sybase.jdbc4.jdbc.SybDriver (version 7.0)
18:18:14,287 INFO  [org.jboss.weld.deployer] (MSC service thread 1-1) JBAS016005: Starting Services for CDI deployment: MyCom.war
18:18:14,291 INFO  [org.jboss.as.jpa] (MSC service thread 1-1) JBAS011402: Starting Persistence Unit Service 'MyCom.war#PU'
18:18:14,295 INFO  [org.hibernate.ejb.Ejb3Configuration] (MSC service thread 1-1) HHH000204: Processing PersistenceUnitInfo [
	name: PU
	...]
18:18:14,474 ERROR [org.jboss.msc.service.fail] (MSC service thread 1-1) MSC00001: Failed to start service jboss.persistenceunit."MyCom.war#PU": org.jboss.msc.service.StartException in service jboss.persistenceunit."MyCom.war#PU": Failed to start service
	at org.jboss.msc.service.ServiceControllerImpl$StartTask.run(ServiceControllerImpl.java:1767) [jboss-msc-1.0.2.GA.jar:1.0.2.GA]
	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1110) [rt.jar:1.7.0_11]
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:603) [rt.jar:1.7.0_11]
	at java.lang.Thread.run(Thread.java:722) [rt.jar:1.7.0_11]
Caused by: javax.persistence.PersistenceException: [PersistenceUnit: PU] Unable to find interceptor class: com.MyCom.model.HibernateInterceptor.
	at org.hibernate.ejb.Ejb3Configuration.instantiateCustomClassFromConfiguration(Ejb3Configuration.java:1153)
	at org.hibernate.ejb.Ejb3Configuration.configure(Ejb3Configuration.java:1075)
	at org.hibernate.ejb.Ejb3Configuration.configure(Ejb3Configuration.java:692)
	at org.hibernate.ejb.HibernatePersistence.createContainerEntityManagerFactory(HibernatePersistence.java:72)
	at org.jboss.as.jpa.service.PersistenceUnitServiceImpl.createContainerEntityManagerFactory(PersistenceUnitServiceImpl.java:162)
	at org.jboss.as.jpa.service.PersistenceUnitServiceImpl.start(PersistenceUnitServiceImpl.java:85)
	at org.jboss.msc.service.ServiceControllerImpl$StartTask.startService(ServiceControllerImpl.java:1811) [jboss-msc-1.0.2.GA.jar:1.0.2.GA]
	at org.jboss.msc.service.ServiceControllerImpl$StartTask.run(ServiceControllerImpl.java:1746) [jboss-msc-1.0.2.GA.jar:1.0.2.GA]
	... 3 more
Caused by: java.lang.ClassNotFoundException: com.MyCom.model.HibernateInterceptor. from [Module "org.hibernate:main" from local module loader @1093d9e (roots: C:\MyComDev\jboss-as-7.1.1.Final\modules)]
	at org.jboss.modules.ModuleClassLoader.findClass(ModuleClassLoader.java:190)
	at org.jboss.modules.ConcurrentClassLoader.performLoadClassUnchecked(ConcurrentClassLoader.java:468)
	at org.jboss.modules.ConcurrentClassLoader.performLoadClassChecked(ConcurrentClassLoader.java:456)
	at org.jboss.modules.ConcurrentClassLoader.performLoadClass(ConcurrentClassLoader.java:398)
	at org.jboss.modules.ConcurrentClassLoader.loadClass(ConcurrentClassLoader.java:120)
	at java.lang.Class.forName0(Native Method) [rt.jar:1.7.0_11]
	at java.lang.Class.forName(Class.java:264) [rt.jar:1.7.0_11]
	at org.hibernate.internal.util.ReflectHelper.classForName(ReflectHelper.java:170)
	at org.hibernate.ejb.Ejb3Configuration.classForName(Ejb3Configuration.java:1317)
	at org.hibernate.ejb.Ejb3Configuration.instantiateCustomClassFromConfiguration(Ejb3Configuration.java:1148)
	... 10 more

18:18:14,486 INFO  [org.jboss.as.controller] (DeploymentScanner-threads - 1) JBAS014774: Service status report
JBAS014777:   Services which failed to start:      service jboss.persistenceunit."MyCom.war#PU": org.jboss.msc.service.StartException in service jboss.persistenceunit."MyCom.war#PU": Failed to start service

The error I have telling you about is at line 30.

If I remove <property name="hibernate.ejb.interceptor" value="com.MyCom.model.HibernateInterceptor"/> from persistence.xml all of my JPA/Hiberbate actions are working. I can fetch and insert so I think that my Persistence Unit is being managed correctly by JBoss and it seems that Hibernate is working properly. It's just when I include the <property> that we have a problem.

Thank you.

[H Paul]

See below point 1,2,3:



1.
I repeat There is NO issue with <property name="hibernate.ejb.interceptor"

Look at the source: Your Version is 4.1.0.Final

package org.hibernate.ejb;
public class AvailableSettings {

	/**
	 * Interceptor class name, the class has to have a no-arg constructor
	 * the interceptor instance is shared amongst all EntityManager of a given EntityManagerFactory
	 */
	public static final String INTERCEPTOR = "hibernate.ejb.interceptor";

	/**
	 * Interceptor class name, the class has to have a no-arg constructor
	 */
	public static final String SESSION_INTERCEPTOR = "hibernate.ejb.interceptor.session_scoped";

I tested with and WORKED fine because I have the java class concepts.interceptor.NativeHibernateApiInterceptor

<property name="hibernate.ejb.interceptor" value="concepts.interceptor.NativeHibernateApiInterceptor"/>



2.
I also did 1 experiment to see. I just put a NON EXISTING class concepts.interceptor.DoesNotExistInterceptor.java


<property name="hibernate.ejb.interceptor" value="concepts.interceptor.DoesNotExistInterceptor"/>

I also got the same exception like Yours.

javax.persistence.PersistenceException: [PersistenceUnit: nonjt] Unable to find interceptor class: concepts.interceptor.DoesNotExistInterceptor
	at org.hibernate.ejb.Ejb3Configuration.instantiateCustomClassFromConfiguration(Ejb3Configuration.java:1153)
	at org.hibernate.ejb.Ejb3Configuration.configure(Ejb3Configuration.java:1075)
	at org.hibernate.ejb.Ejb3Configuration.configure(Ejb3Configuration.java:290)
	at org.hibernate.ejb.Ejb3Configuration.configure(Ejb3Configuration.java:372)
.....

Caused by: java.lang.ClassNotFoundException: concepts.interceptor.DoesNotExistInterceptor
	at java.net.URLClassLoader$1.run(URLClassLoader.java:202)
	at java.security.AccessController.doPrivileged(Native Method)
	at java.net.URLClassLoader.findClass(URLClassLoader.java:190)
	at java.lang.ClassLoader.loadClass(ClassLoader.java:306)
	at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:301)
	at java.lang.ClassLoader.loadClass(ClassLoader.java:247)
	at java.lang.Class.forName0(Native Method)
	at java.lang.Class.forName(Class.java:249)
	at org.hibernate.internal.util.ReflectHelper.classForName(ReflectHelper.java:170)
	at org.hibernate.ejb.Ejb3Configuration.classForName(Ejb3Configuration.java:1317)
	at org.hibernate.ejb.Ejb3Configuration.instantiateCustomClassFromConfiguration(Ejb3Configuration.java:1148)
	... 32 more

3. Check to see if your Interceptor java class exist.

[Al Koch]

Hi H Paul,

GOT IT!!! The problem with the <property> was that there was a trailing "." on the value! That is, I had <property name="hibernate.ejb.interceptor" value="com.MyCom.model.HibernateInterceptor."/> My keystrokes for copying this from the file somehow missed that last dot and that is why it wasn't shown in my posting!

I apologize for that mistake. The interceptor is now running just fine.

Let me take a moment to say that I REALLY appreciate all of the time you took and for staying with this problem till it was solved. I've been in a lot of support forums over many years and you are one of the very few people who have shown such commitment to helping someone out. (Why can't I "award" you points of some type on this site?)

May I ask you a final question? I have been scrambling to get up to speed on Hibernate and have been reading a lot of blog posts and forum posts but it has all been rather haphazard. You have obviously mastered Hibernate so is there a book or other resource (in addition to the formal docs) you would recommend for me to read?

Again, thank you very much for all of your time and help!

[H Paul]

Many people from JPA Certification forum often mentioned:

1. Pro JPA 2: Mastering the Java™ Persistence API

2. Java Persistence with Hibernate

But you can use as a hint/pointer below:

3. Official document of Hibernate and Hibernate Entity Manager of your version

4. Official document of your EJB container which is specific: JBOSS AS 7

tried {} finally { GOOD LUCK !}

[Al Koch]

I'll go check these out.

Again, many, many thanks!