/*
* Copyright 2002-2012 the original author or authors.
*
* 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 org.springframework.orm.jpa;
import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.spi.PersistenceProvider;
import javax.persistence.spi.PersistenceUnitInfo;
import javax.sql.DataSource;
import org.springframework.lang.Nullable;
Metadata interface for a Spring-managed JPA EntityManagerFactory
. This facility can be obtained from Spring-managed EntityManagerFactory
proxies through casting the EntityManagerFactory handle to this interface.
Author: Rod Johnson, Juergen Hoeller Since: 2.0
/**
* Metadata interface for a Spring-managed JPA {@link EntityManagerFactory}.
*
* <p>This facility can be obtained from Spring-managed EntityManagerFactory
* proxies through casting the EntityManagerFactory handle to this interface.
*
* @author Rod Johnson
* @author Juergen Hoeller
* @since 2.0
*/
public interface EntityManagerFactoryInfo {
Return the raw underlying EntityManagerFactory.
Returns: the unadorned EntityManagerFactory (never null
)
/**
* Return the raw underlying EntityManagerFactory.
* @return the unadorned EntityManagerFactory (never {@code null})
*/
EntityManagerFactory getNativeEntityManagerFactory();
Return the underlying PersistenceProvider that the underlying
EntityManagerFactory was created with.
Returns: the PersistenceProvider used to create this EntityManagerFactory, or null
if the standard JPA provider autodetection process was used to configure the EntityManagerFactory
/**
* Return the underlying PersistenceProvider that the underlying
* EntityManagerFactory was created with.
* @return the PersistenceProvider used to create this EntityManagerFactory,
* or {@code null} if the standard JPA provider autodetection process
* was used to configure the EntityManagerFactory
*/
@Nullable
PersistenceProvider getPersistenceProvider();
Return the PersistenceUnitInfo used to create this
EntityManagerFactory, if the in-container API was used.
Returns: the PersistenceUnitInfo used to create this EntityManagerFactory, or null
if the in-container contract was not used to configure the EntityManagerFactory
/**
* Return the PersistenceUnitInfo used to create this
* EntityManagerFactory, if the in-container API was used.
* @return the PersistenceUnitInfo used to create this EntityManagerFactory,
* or {@code null} if the in-container contract was not used to
* configure the EntityManagerFactory
*/
@Nullable
PersistenceUnitInfo getPersistenceUnitInfo();
Return the name of the persistence unit used to create this EntityManagerFactory, or null
if it is an unnamed default. If getPersistenceUnitInfo()
returns non-null, the result of getPersistenceUnitName()
must be equal to the value returned by PersistenceUnitInfo.getPersistenceUnitName()
.
See Also:
/**
* Return the name of the persistence unit used to create this
* EntityManagerFactory, or {@code null} if it is an unnamed default.
* <p>If {@code getPersistenceUnitInfo()} returns non-null, the result of
* {@code getPersistenceUnitName()} must be equal to the value returned by
* {@code PersistenceUnitInfo.getPersistenceUnitName()}.
* @see #getPersistenceUnitInfo()
* @see javax.persistence.spi.PersistenceUnitInfo#getPersistenceUnitName()
*/
@Nullable
String getPersistenceUnitName();
Return the JDBC DataSource that this EntityManagerFactory
obtains its JDBC Connections from.
Returns: the JDBC DataSource, or null
if not known
/**
* Return the JDBC DataSource that this EntityManagerFactory
* obtains its JDBC Connections from.
* @return the JDBC DataSource, or {@code null} if not known
*/
@Nullable
DataSource getDataSource();
Return the (potentially vendor-specific) EntityManager interface
that this factory's EntityManagers will implement.
A null
return value suggests that autodetection is supposed to happen: either based on a target EntityManager
instance or simply defaulting to javax.persistence.EntityManager
.
/**
* Return the (potentially vendor-specific) EntityManager interface
* that this factory's EntityManagers will implement.
* <p>A {@code null} return value suggests that autodetection is supposed
* to happen: either based on a target {@code EntityManager} instance
* or simply defaulting to {@code javax.persistence.EntityManager}.
*/
@Nullable
Class<? extends EntityManager> getEntityManagerInterface();
Return the vendor-specific JpaDialect implementation for this EntityManagerFactory, or null
if not known. /**
* Return the vendor-specific JpaDialect implementation for this
* EntityManagerFactory, or {@code null} if not known.
*/
@Nullable
JpaDialect getJpaDialect();
Return the ClassLoader that the application's beans are loaded with.
Proxies will be generated in this ClassLoader.
/**
* Return the ClassLoader that the application's beans are loaded with.
* <p>Proxies will be generated in this ClassLoader.
*/
ClassLoader getBeanClassLoader();
}