/*
* JBoss, Home of Professional Open Source.
* Copyright 2011, 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.jboss.as.jpa.processor;
import org.jboss.as.connector.subsystems.datasources.AbstractDataSourceService;
import org.jboss.as.ee.component.ComponentDescription;
import org.jboss.as.ee.component.EEModuleDescription;
import org.jboss.as.ee.structure.DeploymentType;
import org.jboss.as.ee.structure.DeploymentTypeMarker;
import org.jboss.as.jpa.classloader.TempClassLoader;
import org.jboss.as.jpa.config.PersistenceUnitMetadata;
import org.jboss.as.jpa.config.PersistenceUnitMetadataHolder;
import org.jboss.as.jpa.persistenceprovider.PersistenceProviderAdapterRegistry;
import org.jboss.as.jpa.service.JPAService;
import org.jboss.as.jpa.service.PersistenceUnitService;
import org.jboss.as.jpa.spi.PersistenceProviderAdaptor;
import org.jboss.as.jpa.transaction.TransactionUtil;
import org.jboss.as.jpa.validator.SerializableValidatorFactory;
import org.jboss.as.naming.ManagedReference;
import org.jboss.as.naming.ManagedReferenceFactory;
import org.jboss.as.naming.NamingStore;
import org.jboss.as.naming.ValueManagedReferenceFactory;
import org.jboss.as.naming.deployment.ContextNames;
import org.jboss.as.naming.service.BinderService;
import org.jboss.as.server.deployment.Attachments;
import org.jboss.as.server.deployment.DeploymentPhaseContext;
import org.jboss.as.server.deployment.DeploymentUnit;
import org.jboss.as.server.deployment.DeploymentUnitProcessingException;
import org.jboss.as.server.deployment.DeploymentUnitProcessor;
import org.jboss.as.server.deployment.DeploymentUtils;
import org.jboss.as.server.deployment.SubDeploymentMarker;
import org.jboss.as.server.deployment.module.ResourceRoot;
import org.jboss.as.txn.TransactionManagerService;
import org.jboss.as.txn.TransactionSynchronizationRegistryService;
import org.jboss.as.web.deployment.WarMetaData;
import org.jboss.logging.Logger;
import org.jboss.metadata.web.jboss.ValveMetaData;
import org.jboss.modules.Module;
import org.jboss.modules.ModuleClassLoader;
import org.jboss.msc.inject.CastingInjector;
import org.jboss.msc.inject.InjectionException;
import org.jboss.msc.inject.Injector;
import org.jboss.msc.service.ServiceBuilder;
import org.jboss.msc.service.ServiceController;
import org.jboss.msc.service.ServiceName;
import org.jboss.msc.service.ServiceRegistryException;
import org.jboss.msc.service.ServiceTarget;
import org.jboss.msc.value.ImmediateValue;
import javax.persistence.ValidationMode;
import javax.sql.DataSource;
import javax.transaction.TransactionManager;
import javax.transaction.TransactionSynchronizationRegistry;
import javax.validation.ValidatorFactory;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Handle the installation of the Persistence Unit service
*
* @author Scott Marlow
*/
public class PersistenceUnitDeploymentProcessor implements DeploymentUnitProcessor {
private static final Logger log = Logger.getLogger("org.jboss.jpa");
public static final String JNDI_PROPERTY = "jboss.entity.manager.factory.jndi.name";
@Override
public void deploy(DeploymentPhaseContext phaseContext) throws DeploymentUnitProcessingException {
handleWarDeployment(phaseContext);
handleEarDeployment(phaseContext);
handleJarDeployment(phaseContext);
}
@Override
public void undeploy(DeploymentUnit context) {
}
private void handleJarDeployment(DeploymentPhaseContext phaseContext) throws DeploymentUnitProcessingException {
final DeploymentUnit deploymentUnit = phaseContext.getDeploymentUnit();
if (!isEarDeployment(deploymentUnit) && !isWarDeployment(deploymentUnit) && JPADeploymentMarker.isJPADeployment(deploymentUnit)) {
final ResourceRoot deploymentRoot = deploymentUnit.getAttachment(Attachments.DEPLOYMENT_ROOT);
PersistenceUnitMetadataHolder holder;
if (deploymentRoot != null &&
(holder = deploymentRoot.getAttachment(PersistenceUnitMetadataHolder.PERSISTENCE_UNITS)) != null &&
holder.getPersistenceUnits().size() > 0) {
ArrayList<PersistenceUnitMetadataHolder> puList = new ArrayList<PersistenceUnitMetadataHolder>(1);
puList.add(holder);
log.trace("install persistence unit definition for jar " + deploymentRoot.getRootName());
// assemble and install the PU service
addPuService(phaseContext, deploymentRoot, puList);
}
}
}
private void handleWarDeployment(DeploymentPhaseContext phaseContext) throws DeploymentUnitProcessingException {
final DeploymentUnit deploymentUnit = phaseContext.getDeploymentUnit();
if (isWarDeployment(deploymentUnit) && JPADeploymentMarker.isJPADeployment(deploymentUnit)) {
final ResourceRoot deploymentRoot = deploymentUnit.getAttachment(Attachments.DEPLOYMENT_ROOT);
PersistenceUnitMetadataHolder holder;
ArrayList<PersistenceUnitMetadataHolder> puList = new ArrayList<PersistenceUnitMetadataHolder>(1);
// handle persistence.xml definition in the root of the war
if (deploymentRoot != null &&
(holder = deploymentRoot.getAttachment(PersistenceUnitMetadataHolder.PERSISTENCE_UNITS)) != null &&
holder.getPersistenceUnits().size() > 0) {
// assemble and install the PU service
puList.add(holder);
}
// look for persistence.xml in war files in the META-INF/persistence.xml directory
List<ResourceRoot> resourceRoots = deploymentUnit.getAttachment(Attachments.RESOURCE_ROOTS);
assert resourceRoots != null;
for (ResourceRoot resourceRoot : resourceRoots) {
if (resourceRoot.getRoot().getLowerCaseName().endsWith(".jar")) {
if ((holder = resourceRoot.getAttachment(PersistenceUnitMetadataHolder.PERSISTENCE_UNITS)) != null
&& holder.getPersistenceUnits().size() > 0) {
// assemble and install the PU service
puList.add(holder);
}
}
}
// Add EM valve
final WarMetaData warMetaData = deploymentUnit.getAttachment(WarMetaData.ATTACHMENT_KEY);
if (warMetaData != null && warMetaData.getMergedJBossWebMetaData() != null) {
List<ValveMetaData> valves = warMetaData.getMergedJBossWebMetaData().getValves();
if (valves == null) {
valves = new ArrayList<ValveMetaData>();
warMetaData.getMergedJBossWebMetaData().setValves(valves);
}
ValveMetaData valve = new ValveMetaData();
valve.setModule("org.jboss.as.jpa");
valve.setValveClass("org.jboss.as.jpa.interceptor.WebNonTxEmCloserValve");
valves.add(valve);
}
log.trace("install persistence unit definitions for war " + deploymentRoot.getRootName());
addPuService(phaseContext, deploymentRoot, puList);
}
}
private void handleEarDeployment(DeploymentPhaseContext phaseContext) throws DeploymentUnitProcessingException {
final DeploymentUnit deploymentUnit = phaseContext.getDeploymentUnit();
if (isEarDeployment(deploymentUnit) && JPADeploymentMarker.isJPADeployment(deploymentUnit)) {
// handle META-INF/persistence.xml
final List<ResourceRoot> deploymentRoots = DeploymentUtils.allResourceRoots(deploymentUnit);
for (final ResourceRoot root : deploymentRoots) {
if (!SubDeploymentMarker.isSubDeployment(root)) {
PersistenceUnitMetadataHolder holder;
ArrayList<PersistenceUnitMetadataHolder> puList = new ArrayList<PersistenceUnitMetadataHolder>(1);
if (root != null &&
(holder = root.getAttachment(PersistenceUnitMetadataHolder.PERSISTENCE_UNITS)) != null &&
holder.getPersistenceUnits().size() > 0) {
// assemble and install the PU service
puList.add(holder);
}
log.trace("install persistence unit definitions for ear " + root.getRootName());
addPuService(phaseContext, root, puList);
}
}
}
}
/**
* Add one PU service per top level deployment that represents
*
* @param phaseContext
* @param resourceRoot
* @param puList
* @throws DeploymentUnitProcessingException
*
*/
private void addPuService(DeploymentPhaseContext phaseContext, ResourceRoot resourceRoot,
ArrayList<PersistenceUnitMetadataHolder> puList
)
throws DeploymentUnitProcessingException {
if (puList.size() > 0) {
final DeploymentUnit deploymentUnit = phaseContext.getDeploymentUnit();
final Module module = deploymentUnit.getAttachment(Attachments.MODULE);
final EEModuleDescription eeModuleDescription = deploymentUnit.getAttachment(org.jboss.as.ee.component.Attachments.EE_MODULE_DESCRIPTION);
final Collection<ComponentDescription> components = eeModuleDescription.getComponentDescriptions();
if (module == null)
throw new DeploymentUnitProcessingException("Failed to get module attachment for " + phaseContext.getDeploymentUnit());
final ServiceTarget serviceTarget = phaseContext.getServiceTarget();
final ModuleClassLoader classLoader = module.getClassLoader();
for (PersistenceUnitMetadataHolder holder : puList) {
for (PersistenceUnitMetadata pu : holder.getPersistenceUnits()) {
pu.setClassLoader(classLoader);
pu.setTempClassloader(new TempClassLoader(classLoader));
try {
final PersistenceUnitService service = new PersistenceUnitService(pu);
// TODO: move this to a standalone service
final Injector<TransactionManager> transactionManagerInjector =
new Injector<TransactionManager>() {
public void inject(final TransactionManager value) throws InjectionException {
TransactionUtil.setTransactionManager(value);
}
public void uninject() {
// injector.uninject();
}
};
final Injector<TransactionSynchronizationRegistry> transactionRegistryInjector =
new Injector<TransactionSynchronizationRegistry>() {
public void inject(final TransactionSynchronizationRegistry value) throws
InjectionException {
TransactionUtil.setTransactionSynchronizationRegistry(value);
}
public void uninject() {
// injector.uninject();
}
};
final HashMap properties = new HashMap();
if (!ValidationMode.NONE.equals(pu.getValidationMode())) {
ValidatorFactory validatorFactory = SerializableValidatorFactory.getINSTANCE();
properties.put("javax.persistence.validation.factory", validatorFactory);
}
addProviderProperties(pu, properties);
final ServiceName puServiceName = PersistenceUnitService.getPUServiceName(pu);
// add the PU service as a dependency to all EE components in this scope
this.addPUServiceDependencyToComponents(components, puServiceName);
deploymentUnit.addToAttachmentList(Attachments.WEB_DEPENDENCIES, puServiceName);
ServiceBuilder builder = serviceTarget.addService(puServiceName, service);
boolean useDefaultDataSource = true;
final String jtaDataSource = adjustJndi(pu.getJtaDataSourceName());
final String nonJtaDataSource = adjustJndi(pu.getNonJtaDataSourceName());
if (jtaDataSource != null) {
if (jtaDataSource.startsWith("java:")) {
builder.addDependency(ContextNames.serviceNameOfContext(eeModuleDescription.getApplicationName(), eeModuleDescription.getModuleName(), eeModuleDescription.getModuleName(), jtaDataSource), ManagedReferenceFactory.class, new ManagedReferenceFactoryInjector(service.getJtaDataSourceInjector()));
useDefaultDataSource = false;
} else {
builder.addDependency(AbstractDataSourceService.SERVICE_NAME_BASE.append(jtaDataSource), new CastingInjector<DataSource>(service.getJtaDataSourceInjector(), DataSource.class));
useDefaultDataSource = false;
}
}
if (nonJtaDataSource != null) {
if (nonJtaDataSource.startsWith("java:")) {
builder.addDependency(ContextNames.serviceNameOfContext(eeModuleDescription.getApplicationName(), eeModuleDescription.getModuleName(), eeModuleDescription.getModuleName(), nonJtaDataSource), ManagedReferenceFactory.class, new ManagedReferenceFactoryInjector(service.getNonJtaDataSourceInjector()));
useDefaultDataSource = false;
} else {
builder.addDependency(AbstractDataSourceService.SERVICE_NAME_BASE.append(nonJtaDataSource), new CastingInjector<DataSource>(service.getNonJtaDataSourceInjector(), DataSource.class));
useDefaultDataSource = false;
}
}
// JPA 2.0 8.2.1.5, container provides default JTA datasource
if (useDefaultDataSource) {
final String defaultJtaDataSource = adjustJndi(JPAService.getDefaultDataSourceName());
if (defaultJtaDataSource != null &&
defaultJtaDataSource.length() > 0) {
builder.addDependency(AbstractDataSourceService.SERVICE_NAME_BASE.append(defaultJtaDataSource), new CastingInjector<DataSource>(service.getJtaDataSourceInjector(), DataSource.class));
log.trace(puServiceName + " is using the default data source '" + defaultJtaDataSource + "'");
}
}
Iterable<ServiceName> providerDependencies = getProviderDependencies(pu);
if (providerDependencies != null) {
builder.addDependencies(providerDependencies);
}
if (pu.getProperties().containsKey(JNDI_PROPERTY)) {
String jndiName = pu.getProperties().get(JNDI_PROPERTY).toString();
final ServiceName bindingServiceName = ContextNames.serviceNameOfContext(eeModuleDescription.getApplicationName(), eeModuleDescription.getModuleName(), eeModuleDescription.getModuleName(), jndiName);
final BinderService binderService = new BinderService(jndiName);
serviceTarget.addService(bindingServiceName, binderService)
.addDependency(ContextNames.serviceNameOfNamingStore(eeModuleDescription.getApplicationName(), eeModuleDescription.getModuleName(), eeModuleDescription.getModuleName(), jndiName), NamingStore.class, binderService.getNamingStoreInjector())
.addDependency(puServiceName, PersistenceUnitService.class, new Injector<PersistenceUnitService>() {
@Override
public void inject(final PersistenceUnitService value) throws InjectionException {
binderService.getManagedObjectInjector().inject(new ValueManagedReferenceFactory(new ImmediateValue<Object>(value.getEntityManagerFactory())));
}
@Override
public void uninject() {
binderService.getNamingStoreInjector().uninject();
}
}).install();
}
builder.addDependency(TransactionManagerService.SERVICE_NAME, new CastingInjector<TransactionManager>(transactionManagerInjector, TransactionManager.class))
.addDependency(TransactionSynchronizationRegistryService.SERVICE_NAME, new CastingInjector<TransactionSynchronizationRegistry>(transactionRegistryInjector, TransactionSynchronizationRegistry.class))
.setInitialMode(ServiceController.Mode.ACTIVE)
.addInjection(service.getPropertiesInjector(), properties)
.install();
log.trace("added PersistenceUnitService for '" + puServiceName + "'. PU is ready for injector action. ");
} catch (ServiceRegistryException e) {
throw new DeploymentUnitProcessingException("Failed to add persistence unit service for " + pu.getPersistenceUnitName(), e);
}
}
}
}
}
private String adjustJndi(String dataSourceName) {
if (dataSourceName != null && !dataSourceName.startsWith("java:")) {
if (dataSourceName.startsWith("jboss/")) {
return "java:" + dataSourceName;
}
return "java:/" + dataSourceName;
}
return dataSourceName;
}
private void addProviderProperties(PersistenceUnitMetadata pu, Map properties) {
PersistenceProviderAdaptor adaptor = PersistenceProviderAdapterRegistry.getPersistenceProviderAdaptor(pu.getPersistenceProviderClassName());
adaptor.addProviderProperties(properties, pu);
}
private Iterable<ServiceName> getProviderDependencies(PersistenceUnitMetadata pu) {
PersistenceProviderAdaptor adaptor = PersistenceProviderAdapterRegistry.getPersistenceProviderAdaptor(pu.getPersistenceProviderClassName());
Iterable<ServiceName> providerDependencies = adaptor.getProviderDependencies(pu);
return providerDependencies;
}
static boolean isEarDeployment(final DeploymentUnit context) {
return (DeploymentTypeMarker.isType(DeploymentType.EAR, context));
}
static boolean isWarDeployment(final DeploymentUnit context) {
return (DeploymentTypeMarker.isType(DeploymentType.WAR, context));
}
private static class ManagedReferenceFactoryInjector implements Injector<ManagedReferenceFactory> {
private volatile ManagedReference reference;
private final Injector<DataSource> dataSourceInjector;
public ManagedReferenceFactoryInjector(Injector<DataSource> dataSourceInjector) {
this.dataSourceInjector = dataSourceInjector;
}
@Override
public void inject(final ManagedReferenceFactory value) throws InjectionException {
this.reference = value.getReference();
dataSourceInjector.inject((DataSource) reference.getInstance());
}
@Override
public void uninject() {
reference.release();
reference = null;
}
}
/**
* Add the <code>puServiceName</code> as a dependency on each of the passed <code>components</code>
*
* @param components The components to which the PU service is added as a dependency
* @param puServiceName The persistence unit service name
*/
private void addPUServiceDependencyToComponents(final Collection<ComponentDescription> components, final ServiceName puServiceName) {
if (components == null || components.isEmpty()) {
return;
}
for (final ComponentDescription component : components) {
log.debug("Adding dependency on PU service " + puServiceName + " for component " + component.getComponentClassName());
component.addDependency(puServiceName, ServiceBuilder.DependencyType.REQUIRED);
}
}
}