org.hibernate.jpa.boot.spi.ProviderChecker Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation
Show all versions of hibernate-core Show documentation
Hibernate's core ORM functionality
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or .
*/
package org.hibernate.jpa.boot.spi;
import java.util.Map;
import org.hibernate.cfg.AvailableSettings;
import org.hibernate.internal.EntityManagerMessageLogger;
import org.hibernate.internal.HEMLogging;
import org.hibernate.jpa.HibernatePersistenceProvider;
import org.jboss.logging.Logger;
/**
* Helper for handling checks to see whether Hibernate is the requested
* {@link javax.persistence.spi.PersistenceProvider}
*
* @author Steve Ebersole
*/
public final class ProviderChecker {
private static final Logger log = Logger.getLogger( ProviderChecker.class );
/**
* Does the descriptor and/or integration request Hibernate as the
* {@link javax.persistence.spi.PersistenceProvider}? Note that in the case of no requested provider being named
* we assume we are the provider (the calls got to us somehow...)
*
* @param persistenceUnit The {@code } descriptor.
* @param integration The integration values.
*
* @return {@code true} if Hibernate should be the provider; {@code false} otherwise.
*/
public static boolean isProvider(PersistenceUnitDescriptor persistenceUnit, Map integration) {
// See if we (Hibernate) are the persistence provider
return hibernateProviderNamesContain( extractRequestedProviderName( persistenceUnit, integration ) );
}
/**
* Is the requested provider name one of the recognized Hibernate provider names?
*
* @param requestedProviderName The requested provider name to check against the recognized Hibernate names.
*
* @return {@code true} if Hibernate should be the provider; {@code false} otherwise.
*/
public static boolean hibernateProviderNamesContain(String requestedProviderName) {
log.tracef(
"Checking requested PersistenceProvider name [%s] against Hibernate provider names",
requestedProviderName
);
final String deprecatedPersistenceProvider = "org.hibernate.ejb.HibernatePersistence";
if ( deprecatedPersistenceProvider.equals( requestedProviderName) ) {
HEMLogging.messageLogger( ProviderChecker.class )
.deprecatedPersistenceProvider(
deprecatedPersistenceProvider,
HibernatePersistenceProvider.class.getName()
);
return true;
}
return HibernatePersistenceProvider.class.getName().equals( requestedProviderName );
}
/**
* Extract the requested persistence provider name using the algorithm Hibernate uses. Namely, a provider named
* in the 'integration' map (under the key '{@value AvailableSettings#JPA_PERSISTENCE_PROVIDER}') is preferred, as per-spec, over
* value specified in persistence unit.
*
* @param persistenceUnit The {@code } descriptor.
* @param integration The integration values.
*
* @return The extracted provider name, or {@code null} if none found.
*/
public static String extractRequestedProviderName(PersistenceUnitDescriptor persistenceUnit, Map integration) {
final String integrationProviderName = extractProviderName( integration );
if ( integrationProviderName != null ) {
log.debugf( "Integration provided explicit PersistenceProvider [%s]", integrationProviderName );
return integrationProviderName;
}
final String persistenceUnitRequestedProvider = extractProviderName( persistenceUnit );
if ( persistenceUnitRequestedProvider != null ) {
log.debugf(
"Persistence-unit [%s] requested PersistenceProvider [%s]",
persistenceUnit.getName(),
persistenceUnitRequestedProvider
);
return persistenceUnitRequestedProvider;
}
// NOTE : if no provider requested we assume we are the provider (the calls got to us somehow...)
log.debug( "No PersistenceProvider explicitly requested, assuming Hibernate" );
return HibernatePersistenceProvider.class.getName();
}
private static String extractProviderName(Map integration) {
if ( integration == null ) {
return null;
}
final String setting = (String) integration.get( AvailableSettings.JPA_PERSISTENCE_PROVIDER );
return setting == null ? null : setting.trim();
}
private static String extractProviderName(PersistenceUnitDescriptor persistenceUnit) {
final String persistenceUnitRequestedProvider = persistenceUnit.getProviderClassName();
return persistenceUnitRequestedProvider == null ? null : persistenceUnitRequestedProvider.trim();
}
private ProviderChecker() {
}
}