br.gov.frameworkdemoiselle.internal.configuration.EntityManagerConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of demoiselle-jpa Show documentation
Demoiselle Framework JPA Extension
There is a newer version: 2.5.4
/*
 * Demoiselle Framework
 * Copyright (C) 2010 SERPRO
 * ----------------------------------------------------------------------------
 * This file is part of Demoiselle Framework.
 * 
 * Demoiselle Framework is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License version 3
 * as published by the Free Software Foundation.
 * 
 * This program 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License version 3
 * along with this program; if not,  see 
 * or write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA  02110-1301, USA.
 * ----------------------------------------------------------------------------
 * Este arquivo é parte do Framework Demoiselle.
 * 
 * O Framework Demoiselle é um software livre; você pode redistribuí-lo e/ou
 * modificá-lo dentro dos termos da GNU LGPL versão 3 como publicada pela Fundação
 * do Software Livre (FSF).
 * 
 * Este programa é distribuído na esperança que possa ser útil, mas SEM NENHUMA
 * GARANTIA; sem uma garantia implícita de ADEQUAÇÃO a qualquer MERCADO ou
 * APLICAÇÃO EM PARTICULAR. Veja a Licença Pública Geral GNU/LGPL em português
 * para maiores detalhes.
 * 
 * Você deve ter recebido uma cópia da GNU LGPL versão 3, sob o título
 * "LICENCA.txt", junto com esse programa. Se não, acesse 
 * ou escreva para a Fundação do Software Livre (FSF) Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02111-1301, USA.
 */
package br.gov.frameworkdemoiselle.internal.configuration;

import java.io.Serializable;

import javax.persistence.EntityManager;

import org.slf4j.Logger;

import br.gov.frameworkdemoiselle.annotation.Name;
import br.gov.frameworkdemoiselle.configuration.Configuration;
import br.gov.frameworkdemoiselle.util.Beans;
import br.gov.frameworkdemoiselle.util.Strings;

/**
 * Configuration class responsible for retrieving specific entity manager parameter values from properties file.
 */
@Configuration(prefix = "frameworkdemoiselle.persistence")
public class EntityManagerConfig implements Serializable {

	private static final long serialVersionUID = 1L;
	
	/**
	 * @deprecated
	 */
	// TODO Implementação apenas para manter a compatibilidade entre a versão 2.3 com a 2.4.
	@Name("unit.name")
	@Deprecated
	private String persistenceUnitName;

	@Name("default.unit.name")
	private String defaultPersistenceUnitName;
	
	@Name("entitymanager.scope")
	private EntityManagerScope entityManagerScope = EntityManagerScope.REQUEST;
	
	/**
	 * Getter for persistence unit name.
	 */
	// TODO Implementação apenas para manter a compatibilidade entre a versão 2.3 com a 2.4.
	/**
	 * @deprecated
	 * @return
	 */
	@Deprecated
	public String getPersistenceUnitName() {
		return persistenceUnitName;
	}

	/**
	 * Getter for persistence unit name.
	 */
	public String getDefaultPersistenceUnitName() {
		// TODO Implementação apenas para manter a compatibilidade entre a versão 2.3 com a 2.4.
		if (!Strings.isEmpty(getPersistenceUnitName())) {
			Logger logger = Beans.getReference(Logger.class);
			logger.warn("A propriedade frameworkdemoiselle.persistence.unit.name="
					+ getPersistenceUnitName()
					+ " não será suportada nas próximas versões do framework. Para evitar futuros problemas atualize a propriedade para frameworkdemoiselle.persistence.default.unit.name="
					+ getPersistenceUnitName());

			return getPersistenceUnitName();
		}

		return defaultPersistenceUnitName;
	}

	/**
	 * Defines the scope of {@link EntityManager}'s produced by the internal producer.
	 * 
	 * Valid values are NOSCOPE,REQUEST,SESSION,VIEW,CONVERSATION and APPLICATION.
	 * 
	 * NOSCOPE means every injected entity manager will be a different instance.  
	 * 
	 * The default value is REQUEST, meaning the producer will create the same
	 * entity manager for the duration of the request.
	 * 
	 */
	public EntityManagerScope getEntityManagerScope() {
		return entityManagerScope;
	}

	public void setEntityManagerScope(EntityManagerScope entityManagerScope) {
		this.entityManagerScope = entityManagerScope;
	}

	/**
	 * Supported scopes for the entity manager
	 * 
	 * @author serpro
	 *
	 */
	public enum EntityManagerScope{
		NOSCOPE,REQUEST,SESSION,VIEW,CONVERSATION,APPLICATION;
	}
}