Custom OpenEntityManagerInViewInterceptor [DATAREST-719]

Mathias D opened DATAREST-719 and commented

We are using a custom OpenEntityManagerInViewInterceptor to bring in tenant related properties that we are using for Tenancy on JPA level. This was pretty easy to register in a spring-boot/spring-web-mvc based application.

This was our approach with spring-web-mvc:

@Configuration
    @ConditionalOnWebApplication
    static class TenantAwareOpenEntityManagerInViewConfiguration extends WebMvcConfigurerAdapter {

        @Autowired
        private TenantJpaPropertyMapBuilder jpaPropertyMapBuilder;

        @Bean
        public OpenEntityManagerInViewInterceptor openEntityManagerInViewInterceptor() {
            return new TenantAwareOpenEntityManagerInViewInterceptor(jpaPropertyMapBuilder);
        }

        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            registry.addWebRequestInterceptor(openEntityManagerInViewInterceptor());
        }
    }

With spring-data-rest this does not work anymore:

@Configuration
    @ConditionalOnWebApplication
    static class TenantAwareOpenEntityManagerInViewConfiguration extends RepositoryRestMvcConfiguration {

        @Autowired
        private TenantJpaPropertyMapBuilder jpaPropertyMapBuilder;

        @Bean
        public OpenEntityManagerInViewInterceptor openEntityManagerInViewInterceptor() {
            return new TenantAwareOpenEntityManagerInViewInterceptor(jpaPropertyMapBuilder);
        }

        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            registry.addWebRequestInterceptor(openEntityManagerInViewInterceptor());
        }
    }

The addInterceptors method is called but our TenantAwareOpenEntityManagerInViewInterceptor is not used.

I think the reason is that spring-data-rest always creates and registers the standard org.springframework.orm.jpa.support.OpenEntityManagerInViewInterceptor in their org.springframework.data.rest.webmvc.support.JpaHelper. We think it should not create the interceptor but get the bean from the application context.

Our workaround is to extend the JpaHelper and override the jpaHelper() method in RepositoryRestMvcConfiguration.

This looks like this:

@Configuration
    @ConditionalOnWebApplication
    static class TenantAwareOpenEntityManagerInViewConfiguration extends RepositoryRestMvcConfiguration {

        @Autowired
        private TenantJpaPropertyMapBuilder jpaPropertyMapBuilder;

        @Override
        @Bean
        public TenantJpaHelper jpaHelper() {
            return new TenantJpaHelper(openEntityManagerInViewInterceptor());
        }

        @Bean
        public OpenEntityManagerInViewInterceptor openEntityManagerInViewInterceptor() {
            return new TenantAwareOpenEntityManagerInViewInterceptor(jpaPropertyMapBuilder);
        }

        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            registry.addWebRequestInterceptor(openEntityManagerInViewInterceptor());
        }
    }

We think that this is not very robust.

It would be convenient to use the same mechanism to customize the OpenEntityManagerInViewInterceptor in spring-data-rest as in spring-web-mvc

Affects: 2.4.1 (Gosling SR1)

1 votes, 1 watchers