/*
* JBoss, Home of Professional Open Source.
* Copyright 2015, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.jpa.hibernate4;
import static org.jipijapa.JipiLogger.JPA_LOGGER;
import java.util.Map;
import java.util.Properties;
import javax.enterprise.inject.spi.BeanManager;
import javax.persistence.SharedCacheMode;
import org.hibernate.cfg.AvailableSettings;
import org.hibernate.cfg.Configuration;
import org.jboss.as.jpa.hibernate4.management.HibernateManagementAdaptor;
import org.jipijapa.cache.spi.Classification;
import org.jipijapa.plugin.spi.JtaManager;
import org.jipijapa.plugin.spi.ManagementAdaptor;
import org.jipijapa.plugin.spi.PersistenceProviderAdaptor;
import org.jipijapa.plugin.spi.PersistenceUnitMetadata;
import org.jipijapa.plugin.spi.Platform;
/**
* Implements the PersistenceProviderAdaptor for Hibernate
*
* @author Scott Marlow
*/
public class HibernatePersistenceProviderAdaptor implements PersistenceProviderAdaptor {
private volatile JBossAppServerJtaPlatform appServerJtaPlatform;
private volatile Platform platform;
private static final String SHARED_CACHE_MODE = "javax.persistence.sharedCache.mode";
private static final String NONE = SharedCacheMode.NONE.name();
@Override
public void injectJtaManager(JtaManager jtaManager) {
appServerJtaPlatform = new JBossAppServerJtaPlatform(jtaManager);
}
@Override
public void injectPlatform(Platform platform) {
if (this.platform != platform) {
this.platform = platform;
}
}
@SuppressWarnings("deprecation")
@Override
public void addProviderProperties(Map properties, PersistenceUnitMetadata pu) {
putPropertyIfAbsent(pu, properties, AvailableSettings.JPAQL_STRICT_COMPLIANCE, "true"); // JIPI-24 ignore jpql aliases case
putPropertyIfAbsent(pu, properties, Configuration.USE_NEW_ID_GENERATOR_MAPPINGS, "true");
putPropertyIfAbsent(pu, properties, org.hibernate.ejb.AvailableSettings.SCANNER, HibernateAnnotationScanner.class.getName());
properties.put(AvailableSettings.APP_CLASSLOADER, pu.getClassLoader());
putPropertyIfAbsent(pu, properties, AvailableSettings.JTA_PLATFORM, appServerJtaPlatform);
properties.remove(AvailableSettings.TRANSACTION_MANAGER_STRATEGY); // remove legacy way of specifying TX manager (conflicts with JTA_PLATFORM)
putPropertyIfAbsent(pu,properties, org.hibernate.ejb.AvailableSettings.ENTITY_MANAGER_FACTORY_NAME, pu.getScopedPersistenceUnitName());
putPropertyIfAbsent(pu, properties, AvailableSettings.SESSION_FACTORY_NAME, pu.getScopedPersistenceUnitName());
if (!pu.getProperties().containsKey(AvailableSettings.SESSION_FACTORY_NAME)) {
putPropertyIfAbsent(pu, properties, AvailableSettings.SESSION_FACTORY_NAME_IS_JNDI, Boolean.FALSE);
}
}
@Override
public void addProviderDependencies(PersistenceUnitMetadata pu) {
final Properties properties = pu.getProperties();
final String sharedCacheMode = properties.getProperty(SHARED_CACHE_MODE);
if ( Classification.NONE.equals(platform.defaultCacheClassification())) {
if (!SharedCacheMode.NONE.equals(pu.getSharedCacheMode())) {
JPA_LOGGER.tracef("second level cache is not supported in platform, ignoring shared cache mode");
}
pu.setSharedCacheMode(SharedCacheMode.NONE);
}
// check if 2lc is explicitly disabled which takes precedence over other settings
boolean sharedCacheDisabled = SharedCacheMode.NONE.equals(pu.getSharedCacheMode())
||
NONE.equals(sharedCacheMode);
if (!sharedCacheDisabled &&
Boolean.parseBoolean(properties.getProperty(AvailableSettings.USE_SECOND_LEVEL_CACHE))
||
(sharedCacheMode != null && (!NONE.equals(sharedCacheMode)))
|| (!SharedCacheMode.NONE.equals(pu.getSharedCacheMode()) && (!SharedCacheMode.UNSPECIFIED.equals(pu.getSharedCacheMode())))) {
HibernateSecondLevelCache.addSecondLevelCacheDependencies(pu.getProperties(), pu.getScopedPersistenceUnitName());
JPA_LOGGER.tracef("second level cache enabled for %s", pu.getScopedPersistenceUnitName());
} else {
JPA_LOGGER.tracef("second level cache disabled for %s, pu %s property = %s, pu.getSharedCacheMode = %s",
pu.getScopedPersistenceUnitName(),
SHARED_CACHE_MODE,
sharedCacheMode,
pu.getSharedCacheMode().toString());
}
}
private void putPropertyIfAbsent(PersistenceUnitMetadata pu, Map properties, String property, Object value) {
if (!pu.getProperties().containsKey(property)) {
properties.put(property, value);
}
}
@Override
public void beforeCreateContainerEntityManagerFactory(PersistenceUnitMetadata pu) {
// set backdoor annotation scanner access to pu
HibernateAnnotationScanner.setThreadLocalPersistenceUnitMetadata(pu);
}
@Override
public void afterCreateContainerEntityManagerFactory(PersistenceUnitMetadata pu) {
// clear backdoor annotation scanner access to pu
HibernateAnnotationScanner.clearThreadLocalPersistenceUnitMetadata();
}
@Override
public ManagementAdaptor getManagementAdaptor() {
return HibernateManagementAdaptor.getInstance();
}
/**
* determine if management console can display the second level cache entries
*
* @param pu
* @return false if a custom AvailableSettings.CACHE_REGION_PREFIX property is specified.
* true if the scoped persistence unit name is used to prefix cache entries.
*/
@Override
public boolean doesScopedPersistenceUnitNameIdentifyCacheRegionName(PersistenceUnitMetadata pu) {
String cacheRegionPrefix = pu.getProperties().getProperty(AvailableSettings.CACHE_REGION_PREFIX);
return cacheRegionPrefix == null || cacheRegionPrefix.equals(pu.getScopedPersistenceUnitName());
}
public void cleanup(PersistenceUnitMetadata pu) {
HibernateAnnotationScanner.cleanup(pu);
}
@Override
public Object beanManagerLifeCycle(BeanManager beanManager) {
return null;
}
@Override
public void markPersistenceUnitAvailable(Object wrapperBeanManagerLifeCycle) {
}
}