org.jbpm.db.hibernate.HibernateHelper Maven / Gradle / Ivy

Go to download
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2005, JBoss Inc., and individual contributors as indicated
 * by the @authors tag. See the copyright.txt 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.jbpm.db.hibernate;

import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
import org.jbpm.util.ClassLoaderUtil;

public class HibernateHelper {

  private HibernateHelper() {
    // prevent instantiation
  }

  private static Map jbpmHibernateConfigurations = new HashMap<>();

  /**
   * maps SessionFactory's to Configurations.

   * by default, configuration lookup will be enabled
   */
  private static Map configurations = new HashMap<>();

  public static void clearConfigurationsCache() {
    configurations.clear();
  }

  public static SessionFactory createSessionFactory() {
    return createSessionFactory(null, null, true);
  }

  public static SessionFactory createSessionFactory(String cfgXmlResource) {
    return createSessionFactory(cfgXmlResource, null, true);
  }

  public static SessionFactory createSessionFactory(String cfgXmlResource,
    String propertiesResource) {
    return createSessionFactory(cfgXmlResource, propertiesResource, true);
  }

  public static SessionFactory createSessionFactory(String cfgXmlResource,
    String propertiesResource, boolean isConfigLookupEnabled) {

    JbpmHibernateConfiguration jbpmHibernateConfiguration = createConfiguration(cfgXmlResource, propertiesResource);
    Configuration configuration = jbpmHibernateConfiguration.getConfigurationProxy();
    jbpmHibernateConfigurations.put( configuration, jbpmHibernateConfiguration );

    return createSessionFactory(configuration, isConfigLookupEnabled);
  }

  public static SessionFactory createSessionFactory(Configuration configuration,
    boolean isConfigLookupEnabled) {
    SessionFactory sessionFactory = configuration.buildSessionFactory();
    if (isConfigLookupEnabled) {
      configurations.put(sessionFactory, configuration);
    }
    return sessionFactory;
  }

  public static JbpmHibernateConfiguration createConfiguration(String cfgXmlResource,
    String propertiesResource) {

    JbpmHibernateConfiguration jbpmHibernateConfiguration = new JbpmHibernateConfiguration();

    Configuration configuration = jbpmHibernateConfiguration.getConfigurationProxy();
    jbpmHibernateConfigurations.put(configuration, jbpmHibernateConfiguration);

    // if a special hibernate configuration xml file is specified,
    if (cfgXmlResource != null) {
      // use the configured file name
      configuration.configure(cfgXmlResource);
    }
    else {
      configuration.configure();
    }

    // if the properties are specified in a separate file
    if (propertiesResource != null) {
      if (log.isDebugEnabled()) {
        log.debug("loading hibernate properties from resource: " + propertiesResource);
      }
      // load the properties
      Properties properties = loadPropertiesFromResource(propertiesResource);
      if (!properties.isEmpty()) {
        // add the properties to the configuration, replacing any existing values
        configuration.addProperties(properties);
      }
    }

    return jbpmHibernateConfiguration;
  }

  public static Configuration getConfiguration(SessionFactory sessionFactory) {
    return (Configuration) configurations.get(sessionFactory);
  }

  public static JbpmHibernateConfiguration getHibernateConfiguration(Configuration configuration) {
      return jbpmHibernateConfigurations.get( configuration );
  }

  public static boolean createSchemaExportScript(SessionFactory sessionFactory) {
    String showSql = getConfiguration(sessionFactory).getProperty("hibernate.show_sql");
    return "true".equalsIgnoreCase(showSql);
  }

  public static void clearHibernateCache(SessionFactory sessionFactory) {
    sessionFactory.getCache().evictAllRegions();
  }

  private static Properties loadPropertiesFromResource(String resource) {
    Properties properties = new Properties();
    InputStream inputStream = ClassLoaderUtil.getStream(resource);
    if (inputStream != null) {
      try {
        properties.load(inputStream);
      }
      catch (IOException e) {
        log.warn("could not load hibernate properties from resource: " + resource, e);
      }
    }
    else {
      log.warn("hibernate properties resource not found: " + resource);
    }
    return properties;
  }

  private static final Log log = LogFactory.getLog(HibernateHelper.class);
}