br.com.caelum.vraptor.plugin.hibernate4.ConfigurationCreator.java Source code

Introduction

Here is the source code for br.com.caelum.vraptor.plugin.hibernate4.ConfigurationCreator.java

Source

/***
 * Copyright (c) 2011 Caelum - www.caelum.com.br/opensource
 * All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package br.com.caelum.vraptor.plugin.hibernate4;

import java.net.URL;

import javax.annotation.PostConstruct;

import org.hibernate.cfg.Configuration;

import br.com.caelum.vraptor.environment.Environment;
import br.com.caelum.vraptor.ioc.ApplicationScoped;
import br.com.caelum.vraptor.ioc.Component;
import br.com.caelum.vraptor.ioc.ComponentFactory;
import br.com.caelum.vraptor.ioc.Container;

/**
 * Creates a Hibernate {@link Configuration}, once when application starts.
 * 
 * @author Otvio Scherer Garcia
 */
@Component
@ApplicationScoped
public class ConfigurationCreator implements ComponentFactory<Configuration> {

    private Configuration cfg;
    private Container container;

    public ConfigurationCreator(Container container) {
        this.container = container;
    }

    /**
     * Create a new instance for {@link Configuration}, and after call the
     * {@link ConfigurationCreator#configureExtras()} method, that you can override to configure extra guys.
     * If vraptor-environment is available on classpath, this method will use then to locate hibernate cfg
     * file.
     */
    @PostConstruct
    public void create() {
        cfg = new Configuration().configure(getHibernateCfgLocation());
        configureExtras();
    }

    protected URL getHibernateCfgLocation() {
        if (isEnvironmentAvailable()) {
            Environment env = container.instanceFor(Environment.class);
            return env.getResource(getHibernateCfgName());
        }

        return getClass().getResource(getHibernateCfgName());
    }

    protected String getHibernateCfgName() {
        return "/hibernate.cfg.xml";
    }

    protected boolean isEnvironmentAvailable() {
        try {
            Class.forName("br.com.caelum.vraptor.environment.Environment");
            return true;
        } catch (ClassNotFoundException e) {
            return false;
        }
    }

    /**
     * This method can override if you want to configure more things.
     */
    public void configureExtras() {

    }

    public Configuration getInstance() {
        return cfg;
    }
}