org.glassfish.persistence.jpa.JPADeployer Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html or
* glassfish/bootstrap/legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at glassfish/bootstrap/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2008 Sun Microsystems, Inc. All rights reserved.
*/
package org.glassfish.persistence.jpa;
import com.sun.appserv.connectors.internal.api.ConnectorRuntime;
import com.sun.enterprise.deployment.*;
import org.glassfish.api.deployment.DeploymentContext;
import org.glassfish.api.deployment.MetaData;
import org.glassfish.api.deployment.InstrumentableClassLoader;
import org.glassfish.api.deployment.OpsParams;
import org.glassfish.api.deployment.archive.ReadableArchive;
import org.glassfish.deployment.common.SimpleDeployer;
import org.glassfish.deployment.common.DeploymentException;
import org.glassfish.persistence.common.Java2DBProcessorHelper;
import org.jvnet.hk2.annotations.Inject;
import org.jvnet.hk2.annotations.Service;
import javax.naming.NamingException;
import javax.persistence.spi.ClassTransformer;
import javax.persistence.EntityManagerFactory;
import javax.sql.DataSource;
import javax.validation.ValidatorFactory;
import javax.validation.Validation;
import java.util.*;
import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.IllegalClassFormatException;
import java.security.ProtectionDomain;
/**
* Deployer for JPA applications
* @author Mitesh Meswani
*/
@Service
public class JPADeployer extends SimpleDeployer {
@Inject
private ConnectorRuntime connectorRuntime;
@Override public MetaData getMetaData() {
return new MetaData(true /*invalidateCL */ ,
null /* provides */,
new Class[] {Application.class} /* requires Application from dol */);
}
protected void generateArtifacts(DeploymentContext dc) throws DeploymentException {
// Noting to generate yet!!
}
protected void cleanArtifacts(DeploymentContext dc) throws DeploymentException {
// Drop tables if needed on undeploy.
OpsParams params = dc.getCommandParameters(OpsParams.class);
if (params.origin == OpsParams.Origin.undeploy) {
Java2DBProcessorHelper helper = new Java2DBProcessorHelper(dc);
helper.init();
helper.createOrDropTablesInDB(false, "JPA"); // NOI18N
}
}
/**
* @inheritDoc
*/
public V loadMetaData(Class type, DeploymentContext context) {
return null;
}
/**
* EMFs for refered pus are created and stored in JPAApplication instance.
* The JPAApplication instance is stored in given DeploymentContext to be retrieved by load
*/
@Override public boolean prepare(DeploymentContext context) {
boolean prepared = super.prepare(context);
if(prepared) {
Application application = context.getModuleMetaData(Application.class);
Set bundles = application.getBundleDescriptors();
// Iterate through all the bundles for the app and collect pu references in referencedPus
List referencedPus = new ArrayList();
for (BundleDescriptor bundle : bundles) {
Collection pusReferencedFromBundle = bundle.findReferencedPUs();
for(PersistenceUnitDescriptor pud : pusReferencedFromBundle) {
referencedPus.add(pud);
}
}
RootDeploymentDescriptor currentBundle = context.getModuleMetaData(BundleDescriptor.class);
if (currentBundle == null) {
// We are being called for an application
currentBundle = application;
}
// Initialize pus for only this bundle here to enable transformers to work properly.
// This is because classloader from deploymentcontext is for this bundle only
Collection pusDescriptorForThisBundle = currentBundle.getExtensionsDescriptors(PersistenceUnitsDescriptor.class);
for (PersistenceUnitsDescriptor persistenceUnitsDescriptor : pusDescriptorForThisBundle) {
for (PersistenceUnitDescriptor pud : persistenceUnitsDescriptor.getPersistenceUnitDescriptors()) {
if(referencedPus.contains(pud)) {
PersistenceUnitLoader puLoader = new PersistenceUnitLoader(pud, new ProviderContainerContractInfoImpl(context, connectorRuntime));
// Store the puLoader in context. It is retreived in load() to execute java2db and to
// store the loaded emfs in a JPAApplicationContainer object for cleanup
context.addTransientAppMetaData(getUniquePuIdentifier(pud), puLoader );
}
}
}
}
// StatsProviderManager.register("jpa", PluginPoint.SERVER, "jpa/eclipselink", new EclipseLinkStatsProvider());
return prepared;
}
/**
* @inheritDoc
*/
@Override
public JPApplicationContainer load(JPAContainer container, DeploymentContext context) {
RootDeploymentDescriptor currentBundle = context.getModuleMetaData(BundleDescriptor.class);
if (currentBundle == null) {
// We are being called for an application
currentBundle = context.getModuleMetaData(Application.class);
}
List emfsInitializedForThisBundle = new ArrayList();
Collection pusDescriptorForThisBundle = currentBundle.getExtensionsDescriptors(PersistenceUnitsDescriptor.class);
for (PersistenceUnitsDescriptor persistenceUnitsDescriptor : pusDescriptorForThisBundle) {
for (PersistenceUnitDescriptor pud : persistenceUnitsDescriptor.getPersistenceUnitDescriptors()) {
//PersistenceUnitsDescriptor corresponds to persistence.xml. A bundle can only have one persitence.xml except
// when the bundle is an application which can have multiple persitence.xml under jars in root of ear and lib.
PersistenceUnitLoader puLoader = context.getTransientAppMetaData(getUniquePuIdentifier(pud), PersistenceUnitLoader.class);
if (puLoader != null) {
emfsInitializedForThisBundle.add(puLoader.getEMF());
puLoader.doJava2DB();
}
}
}
return new JPApplicationContainer(emfsInitializedForThisBundle);
}
/**
* Returns unique identifier for this pu within application
* @param pud The given pu
* @return Absolute pu root + pu name
*/
private static String getUniquePuIdentifier(PersistenceUnitDescriptor pud) {
return pud.getAbsolutePuRoot() + pud.getName();
}
private static class ProviderContainerContractInfoImpl implements ProviderContainerContractInfo {
private final DeploymentContext deploymentContext;
private final ConnectorRuntime connectorRuntime;
private final ClassLoader finalClassLoader;
private ValidatorFactory validatorFactory;
public ProviderContainerContractInfoImpl(DeploymentContext deploymentContext, ConnectorRuntime connectorRuntime) {
this.deploymentContext = deploymentContext;
this.connectorRuntime = connectorRuntime;
// Cache finalClassLoader as deploymentContext.getFinalClassLoader() is expected to be called only once during deployment.
this.finalClassLoader=deploymentContext.getFinalClassLoader();
}
public ClassLoader getClassLoader() {
return finalClassLoader;
}
public ClassLoader getTempClassloader() {
return ( (InstrumentableClassLoader)deploymentContext.getClassLoader() ).copy();
}
public void addTransformer(final ClassTransformer transformer) {
// Bridge between java.lang.instrument.ClassFileTransformer that DeploymentContext accepts
// and javax.persistence.spi.ClassTransformer that JPA supplies.
deploymentContext.addTransformer(new ClassFileTransformer() {
public byte[] transform(ClassLoader loader, String className, Class classBeingRedefined,
ProtectionDomain protectionDomain, byte[] classfileBuffer)
throws IllegalClassFormatException {
return transformer.transform(loader, className, classBeingRedefined, protectionDomain, classfileBuffer);
}
});
}
/**
* Returns Application location for current application
* @return
*/
public String getApplicationLocation() {
// Get source for current bundle. If it has not parent, it is the top level application
// else continute traversing up till we find one with not parent.
ReadableArchive archive = deploymentContext.getSource();
boolean appRootFound = false;
while (!appRootFound) {
ReadableArchive parentArchive = archive.getParentArchive();
if(parentArchive != null) {
archive = parentArchive;
} else {
appRootFound = true;
}
}
return archive.getURI().getPath();
}
public DataSource lookupDataSource(String dataSourceName) throws NamingException {
return DataSource.class.cast(connectorRuntime.lookupPMResource(dataSourceName, false) );
}
public DataSource lookupNonTxDataSource(String dataSourceName) throws NamingException {
return DataSource.class.cast(connectorRuntime.lookupNonTxResource(dataSourceName, false));
}
public ValidatorFactory getValidatorFactory() {
// TODO Once discussion about BeanValidation in JavaEE is done, ValidatorFactory should be available from deployment context
// We only create one validator factory per bundle.
if (validatorFactory == null) {
validatorFactory = Validation.buildDefaultValidatorFactory();
}
return validatorFactory;
}
/**
* @return true if applicationj is being deployed false other wise (for example if it is an appserver restart)
*/
public boolean isDeploy() {
OpsParams params = deploymentContext.getCommandParameters(OpsParams.class);
return params.origin == OpsParams.Origin.deploy;
}
public DeploymentContext getDeploymentContext() {
return deploymentContext;
}
public void registerEMF(String unitName, String persistenceRootUri, RootDeploymentDescriptor containingBundle, EntityManagerFactory emf) {
// We register the EMF into the bundle that declared the corresponding PU. This limits visibility of the emf
// to containing module.
// See EMFWrapper.lookupEntityManagerFactory() for corresponding look up logic
if (containingBundle.isApplication()) {
// ear level pu
Application.class.cast(containingBundle).addEntityManagerFactory(
unitName, persistenceRootUri, emf);
} else {
BundleDescriptor.class.cast(containingBundle).addEntityManagerFactory(
unitName, emf);
}
}
} // class ProviderContainerContractInfoImpl
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy