EntityManagerFactoryAccess.java

/*
 * 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.jipijapa.management.spi;

import javax.persistence.EntityManagerFactory;

/**
 * EntityManagerFactoryAccess
 *
 * @author Scott Marlow
 */
public interface EntityManagerFactoryAccess {
    /**
     * returns the entity manager factory that statistics should be obtained for.
     *
     * @throws IllegalStateException if scopedPersistenceUnitName is not found
     *
     * @param scopedPersistenceUnitName is persistence unit name scoped to the current platform
     *
     * @return EntityManagerFactory
     */
    EntityManagerFactory entityManagerFactory(String scopedPersistenceUnitName) throws IllegalStateException;

}