[hibernate-commits] [hibernate/hibernate-search] 6a8ad9: HSEARCH-1115 Changed use of ReflectHelper to speci...

Wed May 9 05:47:24 EDT 2012

  Branch: refs/heads/master
  Home:   https://github.com/hibernate/hibernate-search
  Commit: 6a8ad9f7baaeca446547c738ee9cb942ede85987
      https://github.com/hibernate/hibernate-search/commit/6a8ad9f7baaeca446547c738ee9cb942ede85987
  Author: Randall Hauch <rhauch at gmail.com>
  Date:   2012-05-08 (Tue, 08 May 2012)

  Changed paths:
    M hibernate-search-engine/src/main/java/org/hibernate/search/engine/impl/DocumentBuilderHelper.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/impl/ConfigContext.java

  Log Message:
  -----------
  HSEARCH-1115 Changed use of ReflectHelper to specify classloader

Two uses of ReflectHelper.classForName(String) were changed to use the
classForName(String,Class) form instead. In the latter method, if
the class cannot be found on the thread's context class loader then the
class will be loaded using the classloader of the class specified in
the second parameter.

In one of the cases (DocumentBuilderHelper), the DocumentBuilderHelper class
was passed, meaning that the same classloader used to load the Hibernate Search
classes will be used.

In the second case (ConfigContext), the second parameter is the class of
the SearchConfiguration implementation that was supplied to the ConfigContext.
This is better than the ConfigContext class, since the SearchConfiguration
implementation will be provided by the components using the SearchFactoryBuilder
to build a SearchFactory. This means that the components' classloader
will be used to load the Analyzer implementation class.

There are a few other uses of ReflectionHelper.classForName(String) in the Hibernate
Search codebase, but I don't think they require the same classloading logic.

When used in a Java SE environment, there is no net difference in classloading
behavior. However, in JBoss AS7 (or even OSGi) the different classloaders have
a significant effect. Specifically, when used in JBoss AS7, the modules might look
like this (where "-->" signifies 'depends on'):

  org.foo (uses Hibernate Search, implements SearchConfiguration)
   --> org.hibernate.search.engine
       --> org.hibernate (specifically the hibernate-commons-annotations JAR)
       --> org.apache.lucene
       --> others

In this case, the result of the code before this change is that ConfigContext
would expect to find the Analyzer implementation using the 'org.hibernate'
module (where the ReflectHelper class exists), which does cannot see any of
the 'org.apache.lucene' Analyzer implementations nor any implementations
provided by 'org.foo'. After this change, ConfigContext uses 'org.foo' classloader
(since that's where the SearchConfiguration class exists), and thus can see
any Analyzer implementation provide in 'org.foo', 'org.hibernate.search.engine',
'org.apache.lucene', 'org.hibernate' (if there were any), or any of the other
modules.

All unit tests run by the build pass successfully with these changes.

  Commit: 7e087e5a6aff4c42c796781ef7c6b96922b46fa1
      https://github.com/hibernate/hibernate-search/commit/7e087e5a6aff4c42c796781ef7c6b96922b46fa1
  Author: Emmanuel Bernard <emmanuel at hibernate.org>
  Date:   2012-05-08 (Tue, 08 May 2012)

  Changed paths:
    M hibernate-search-orm/src/main/java/org/hibernate/search/query/hibernate/impl/ObjectLoaderBuilder.java

  Log Message:
  -----------
  HSEARCH-1115 Avoid reflection when we have the data and pass the right caller for modular environments

Since ReflectHelper is in Commons Annotations which depends on nothing, it's critical
to provider the right caller

  Commit: d2239d6a8cf98456564015d0fc25828c21847fe4
      https://github.com/hibernate/hibernate-search/commit/d2239d6a8cf98456564015d0fc25828c21847fe4
  Author: Emmanuel Bernard <emmanuel at hibernate.org>
  Date:   2012-05-08 (Tue, 08 May 2012)

  Changed paths:
    M hibernate-search-orm/src/main/java/org/hibernate/search/cfg/impl/SearchConfigurationFromHibernateCore.java
    M hibernate-search-orm/src/main/java/org/hibernate/search/query/hibernate/impl/LoaderHelper.java

  Log Message:
  -----------
  HSEARCH-1115 Make sure to load Hibernate / JPA exceptions with the "best" classloader

commons-annotations is not the correct classloader in a modular environment

  Commit: e814cb0f648758dbff2c4898539bd0825e9bf85f
      https://github.com/hibernate/hibernate-search/commit/e814cb0f648758dbff2c4898539bd0825e9bf85f
  Author: Hardy Ferentschik <hibernate at ferentschik.de>
  Date:   2012-05-08 (Tue, 08 May 2012)

  Changed paths:
    M hibernate-search-engine/src/main/java/org/hibernate/search/bridge/builtin/ClassBridge.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/engine/impl/DocumentBuilderHelper.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/engine/spi/DocumentBuilderIndexedEntity.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/impl/ConfigContext.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/impl/SearchMappingBuilder.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/stat/impl/StatisticsImpl.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/util/impl/ClassLoaderHelper.java
    M hibernate-search-orm/src/main/java/org/hibernate/search/batchindexing/impl/Helper.java
    M hibernate-search-orm/src/main/java/org/hibernate/search/jmx/IndexControl.java
    M hibernate-search-orm/src/main/java/org/hibernate/search/query/hibernate/impl/LoaderHelper.java
    M hibernate-search-orm/src/main/java/org/hibernate/search/query/hibernate/impl/ObjectLoaderBuilder.java
    M hibernate-search-orm/src/test/java/org/hibernate/search/test/configuration/mutablefactory/MutableFactoryTest.java

  Log Message:
  -----------
  HSEARCH-1115 Doing all class loading via ClassLoaderHelper. Also doing moving the classForName methods from commons annotations into ClassLoaderHelper.

  Commit: 9dd015c5d2a2c5d531f141a410964f53442de7f8
      https://github.com/hibernate/hibernate-search/commit/9dd015c5d2a2c5d531f141a410964f53442de7f8
  Author: Hardy Ferentschik <hibernate at ferentschik.de>
  Date:   2012-05-08 (Tue, 08 May 2012)

  Changed paths:
    M hibernate-search-engine/src/main/java/org/hibernate/search/backend/impl/jgroups/JGroupsChannelProvider.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/backend/impl/jgroups/JGroupsMasterMessageListener.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/backend/impl/lucene/LuceneBackendResources.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/exception/impl/LogErrorHandler.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/indexes/impl/SharingBufferReaderProvider.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/util/logging/impl/Log.java
    M hibernate-search-orm/src/main/java/org/hibernate/search/batchindexing/impl/OptionallyWrapInJTATransaction.java

  Log Message:
  -----------
  HSEARCH-1115 Fixing some typos in log method names

  Commit: df56e11f79492d3eeba36ac56280edcb2a66afac
      https://github.com/hibernate/hibernate-search/commit/df56e11f79492d3eeba36ac56280edcb2a66afac
  Author: Hardy Ferentschik <hibernate at ferentschik.de>
  Date:   2012-05-08 (Tue, 08 May 2012)

  Changed paths:
    M hibernate-search-engine/src/main/java/org/hibernate/search/bridge/builtin/ClassBridge.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/engine/ServiceManager.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/engine/impl/DocumentBuilderHelper.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/engine/spi/DocumentBuilderIndexedEntity.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/impl/ConfigContext.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/impl/SearchMappingBuilder.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/indexes/serialization/impl/LuceneWorkHydrator.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/stat/impl/StatisticsImpl.java
    M hibernate-search-engine/src/main/java/org/hibernate/search/util/impl/ClassLoaderHelper.java
    M hibernate-search-orm/src/main/java/org/hibernate/search/batchindexing/impl/Helper.java
    M hibernate-search-orm/src/main/java/org/hibernate/search/jmx/IndexControl.java
    M hibernate-search-orm/src/main/java/org/hibernate/search/query/hibernate/impl/LoaderHelper.java
    M hibernate-search-orm/src/main/java/org/hibernate/search/query/hibernate/impl/ObjectLoaderBuilder.java

  Log Message:
  -----------
  HSEARCH-1115 ClassLoaderHelper#classForName takes now the classloader as second parameter instead of the caller class

Re-added the explicit passing of the caller's classloader to ConfigContext and DocumentBuilderHelper

  Commit: 79b647c80a2569ab2af04f72a3413bf0e840046e
      https://github.com/hibernate/hibernate-search/commit/79b647c80a2569ab2af04f72a3413bf0e840046e
  Author: Sanne Grinovero <sanne at hibernate.org>
  Date:   2012-05-09 (Wed, 09 May 2012)

  Changed paths:
    M hibernate-search-orm/src/main/java/org/hibernate/search/cfg/impl/SearchConfigurationFromHibernateCore.java
    M hibernate-search-orm/src/main/java/org/hibernate/search/query/hibernate/impl/LoaderHelper.java

  Log Message:
  -----------
  HSEARCH-1115 Avoid holding on foreign classloader from LoaderHelper

Compare: https://github.com/hibernate/hibernate-search/compare/5acd517...79b647c