org.glassfish.javaee.full.deployment.EarHandler Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2022, 2023 Contributors to the Eclipse Foundation.
* Copyright (c) 1997, 2022 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.javaee.full.deployment;
import com.sun.enterprise.config.serverbeans.DasConfig;
import com.sun.enterprise.deploy.shared.AbstractArchiveHandler;
import com.sun.enterprise.deploy.shared.ArchiveFactory;
import com.sun.enterprise.deploy.shared.FileArchive;
import com.sun.enterprise.deployment.BundleDescriptor;
import com.sun.enterprise.deployment.archivist.ApplicationArchivist;
import com.sun.enterprise.deployment.deploy.shared.InputJarArchive;
import com.sun.enterprise.deployment.deploy.shared.JarArchive;
import com.sun.enterprise.deployment.deploy.shared.Util;
import com.sun.enterprise.deployment.io.DescriptorConstants;
import com.sun.enterprise.deployment.util.DOLUtils;
import com.sun.enterprise.universal.i18n.LocalStringsImpl;
import com.sun.enterprise.util.LocalStringManagerImpl;
import com.sun.enterprise.util.io.FileUtils;
import jakarta.inject.Inject;
import jakarta.inject.Named;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.net.URL;
import java.net.URLClassLoader;
import java.security.PermissionCollection;
import java.text.MessageFormat;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import org.glassfish.api.ActionReport;
import org.glassfish.api.admin.ServerEnvironment;
import org.glassfish.api.deployment.DeployCommandParameters;
import org.glassfish.api.deployment.DeploymentContext;
import org.glassfish.api.deployment.archive.Archive;
import org.glassfish.api.deployment.archive.ArchiveDetector;
import org.glassfish.api.deployment.archive.ArchiveHandler;
import org.glassfish.api.deployment.archive.ArchiveType;
import org.glassfish.api.deployment.archive.CarArchiveType;
import org.glassfish.api.deployment.archive.CompositeHandler;
import org.glassfish.api.deployment.archive.EjbArchiveType;
import org.glassfish.api.deployment.archive.RarArchiveType;
import org.glassfish.api.deployment.archive.ReadableArchive;
import org.glassfish.api.deployment.archive.WarArchiveType;
import org.glassfish.api.deployment.archive.WritableArchive;
import org.glassfish.deployment.common.DeploymentContextImpl;
import org.glassfish.deployment.common.DeploymentProperties;
import org.glassfish.deployment.common.ModuleDescriptor;
import org.glassfish.hk2.api.PreDestroy;
import org.glassfish.internal.api.DelegatingClassLoader;
import org.glassfish.internal.deployment.Deployment;
import org.glassfish.internal.deployment.ExtendedDeploymentContext;
import org.glassfish.javaee.core.deployment.ApplicationHolder;
import org.jvnet.hk2.annotations.Service;
import org.xml.sax.SAXException;
import static java.util.logging.Level.SEVERE;
import static javax.xml.stream.XMLStreamConstants.END_DOCUMENT;
import static javax.xml.stream.XMLStreamConstants.END_ELEMENT;
import static javax.xml.stream.XMLStreamConstants.START_ELEMENT;
import static org.glassfish.loader.util.ASClassLoaderUtil.getAppLibDirLibraries;
@Service(name = EarDetector.ARCHIVE_TYPE)
public class EarHandler extends AbstractArchiveHandler implements CompositeHandler {
@Inject
Deployment deployment;
@Inject
ArchiveFactory archiveFactory;
@Inject
ServerEnvironment env;
@Inject
DasConfig dasConfig;
@Inject
@Named(EarDetector.ARCHIVE_TYPE)
ArchiveDetector detector;
private static final String EAR_LIB = "ear_lib";
private static LocalStringsImpl strings = new LocalStringsImpl(EarHandler.class);
final private static LocalStringManagerImpl localStrings = new LocalStringManagerImpl(EarHandler.class);
private static final Logger _logger = EarDeployer.deplLogger;
// declaredPermission
protected PermissionCollection earDeclaredPC;
@Override
public String getArchiveType() {
return EarDetector.ARCHIVE_TYPE;
}
@Override
public String getVersionIdentifier(ReadableArchive archive) {
String versionIdentifier = null;
try {
versionIdentifier = new GFApplicationXmlParser(archive).extractVersionIdentifierValue(archive);
} catch (XMLStreamException | IOException e) {
_logger.log(SEVERE, e.getMessage());
}
return versionIdentifier;
}
@Override
public boolean handles(ReadableArchive archive) throws IOException {
return detector.handles(archive);
}
@Override
public void expand(ReadableArchive source, WritableArchive target, DeploymentContext context) throws IOException {
// expand the top level first so we could read application.xml
super.expand(source, target, context);
ReadableArchive source2 = null;
try {
/*
* We know that the expansion is into a directory, so we should know that target is a FileArchive which is also readable
* as-is.
*/
source2 = (FileArchive) target;
ApplicationHolder holder = getApplicationHolder(source2, context, false);
// now start to expand the sub modules
for (ModuleDescriptor md : holder.app.getModules()) {
String moduleUri = md.getArchiveUri();
ReadableArchive subArchive = null;
ReadableArchive subArchiveToExpand = null;
try {
subArchive = source2.getSubArchive(moduleUri);
if (subArchive == null) {
_logger.log(Level.WARNING, "Exception while locating sub archive: " + moduleUri);
continue;
}
// optimize performance by retrieving the archive handler
// based on module type first
ArchiveHandler subHandler = getArchiveHandlerFromModuleType(md.getModuleType());
if (subHandler == null) {
subHandler = deployment.getArchiveHandler(subArchive);
}
context.getModuleArchiveHandlers().put(moduleUri, subHandler);
if (subHandler == null) {
return;
}
try (WritableArchive subTarget = target.createSubArchive(FileUtils.makeFriendlyFilenameExtension(moduleUri))) {
/*
* A subarchive might be packaged as a subdirectory (instead of a nested JAR) in an EAR. If so and if it has the
* same name as the directory into which we'll expand the submodule, make sure it is also of the correct archive
* type (i.e., directory and not JAR) in which case we don't need to expand it because the developer already did so
* before packaging.
*/
subArchiveToExpand = chooseSubArchiveToExpand(moduleUri, subTarget, subArchive, source2);
if (subArchiveToExpand != null) {
subHandler.expand(subArchiveToExpand, subTarget, context);
} else {
/*
* The target for expansion is the same URI as the subarchive. Make sure they are the same type; if so, we just
* skip the expansion. Otherwise, we would leave a JAR where the rest of deployment expects a subdirectory so
* throw an exception in that case.
*/
if (!areSameStorageType(subTarget, subArchive)) {
final String msg = MessageFormat.format(
_logger.getResourceBundle().getString("enterprise.deployment.backend.badSubModPackaging"),
subArchive.getURI().toASCIIString(), subArchive.getClass().getName());
throw new RuntimeException(msg);
}
}
}
} catch (IOException ioe) {
_logger.log(Level.FINE, "Exception while processing " + moduleUri, ioe);
} finally {
try {
if (subArchive != null) {
subArchive.close();
}
if (subArchiveToExpand != null) {
subArchiveToExpand.close();
}
} catch (IOException ioe) {
// ignore
}
}
}
} finally {
if (source2 != null) {
source2.close();
}
}
}
private ReadableArchive chooseSubArchiveToExpand(final String moduleURI, final WritableArchive subTarget,
final ReadableArchive subArchive, final ReadableArchive expandedOriginalArchive) throws IOException {
/*
* The subArchive will normally be xxx.jar (or .rar, etc.) In this case, its URI differs from the URI of the target
* (which will be xxx_jar) and we should expand subArchive into subTarget. But the developer might have pre-expanded the
* archive in which case subArchive and subTarget will both be xxx_jar. In such a case we do not want to expand the
* directory onto itself.
*
* Yet, on Windows, it is possible that the xxx_jar directory is left over from a previous expansion from xxx.jar to
* xxx_jar, in which case we DO want to expand xxx.jar into xxx_jar.
*/
if (!subTarget.getURI().equals(subArchive.getURI())) {
/*
* The URIs are not the same, so the subArchive is probably xxx.jar and the target is probably xxx_jar.
*/
return subArchive;
}
/*
* Try to find the xxx.jar entry in the file archive that is the expanded version of the original archive. If that entry
* exists, then the xxx_jar entry in the already-expanded directory is probably a left-over from a previous deployment
* and we should expand the original subarchive into it. If, on the other hand, the xxx.jar entry does not exist in the
* expansion, then the developer probably packaged the EAR with a pre-expanded module directory instead of the module
* JAR; in that case there is no need to expand the pre-expanded directory into itself.
*/
if (expandedOriginalArchive.exists(moduleURI)) {
final URI unexpandedSubArchiveURI = expandedOriginalArchive.getURI().resolve(moduleURI);
return archiveFactory.openArchive(unexpandedSubArchiveURI);
}
return null;
}
private static boolean areSameStorageType(final Archive arch1, final Archive arch2) {
return ((arch1 instanceof FileArchive && arch2 instanceof FileArchive)
|| (arch1 instanceof JarArchive && arch2 instanceof JarArchive));
}
@Override
public ClassLoader getClassLoader(final ClassLoader parent, DeploymentContext context) {
final ReadableArchive archive = context.getSource();
ApplicationHolder holder = getApplicationHolder(archive, context, true);
// the ear classloader hierachy will be
// ear lib classloader <- embedded rar classloader <-
// ear classloader <- various module classloaders
final DelegatingClassLoader embeddedConnCl;
final EarClassLoader earClassLoader;
// Add the libraries packaged in the application library directory
try {
String compatProp = context.getAppProps().getProperty(DeploymentProperties.COMPATIBILITY);
// If user does not specify the compatibility property
// let's see if it's defined in glassfish-application.xml
if (compatProp == null) {
GFApplicationXmlParser gfApplicationXmlParser = new GFApplicationXmlParser(context.getSource());
compatProp = gfApplicationXmlParser.getCompatibilityValue();
if (compatProp != null) {
context.getAppProps().put(DeploymentProperties.COMPATIBILITY, compatProp);
}
}
// If user does not specify the compatibility property
// let's see if it's defined in sun-application.xml
if (compatProp == null) {
SunApplicationXmlParser sunApplicationXmlParser = new SunApplicationXmlParser(context.getSourceDir());
compatProp = sunApplicationXmlParser.getCompatibilityValue();
if (compatProp != null) {
context.getAppProps().put(DeploymentProperties.COMPATIBILITY, compatProp);
}
}
final URL[] earLibURLs = getAppLibDirLibraries(context.getSourceDir(), holder.app.getLibraryDirectory(),
compatProp);
final EarLibClassLoader earLibClassLoader = new EarLibClassLoader(earLibURLs, parent);
embeddedConnCl = new DelegatingClassLoader(earLibClassLoader);
earClassLoader = new EarClassLoader(embeddedConnCl);
// add ear lib to module classloader list so we can
// clean it up later
earClassLoader.addModuleClassLoader(EAR_LIB, earLibClassLoader);
} catch (Exception e) {
_logger.log(SEVERE, strings.get("errAddLibs"), e);
throw new RuntimeException(e);
}
for (ModuleDescriptor moduleDescriptor : holder.app.getModules()) {
String moduleUri = moduleDescriptor.getArchiveUri();
try (ReadableArchive sub = archive.getSubArchive(moduleUri)) {
if (sub == null) {
throw new IllegalArgumentException(strings.get("noSubModuleArchiveFound", moduleUri));
}
if (sub instanceof InputJarArchive) {
throw new IllegalArgumentException(strings.get("wrongArchType", moduleUri));
}
ArchiveHandler handler = context.getModuleArchiveHandlers().get(moduleUri);
if (handler == null) {
handler = getArchiveHandlerFromModuleType(moduleDescriptor.getModuleType());
if (handler == null) {
handler = deployment.getArchiveHandler(sub);
}
context.getModuleArchiveHandlers().put(moduleUri, handler);
}
if (handler != null) {
ActionReport subReport = context.getActionReport().addSubActionsReport();
// todo : this is a hack, once again,
// the handler is assuming a file:// url
ExtendedDeploymentContext subContext = new DeploymentContextImpl(subReport, sub,
context.getCommandParameters(DeployCommandParameters.class), env) {
@Override
public File getScratchDir(String subDirName) {
String modulePortion = Util.getURIName(getSource().getURI());
return (new File(super.getScratchDir(subDirName), modulePortion));
}
};
// sub context will store the root archive handler also
// so we can figure out the enclosing archive type
subContext.setArchiveHandler(context.getArchiveHandler());
subContext.setParentContext((ExtendedDeploymentContext) context);
sub.setParentArchive(context.getSource());
ClassLoader subCl = handler.getClassLoader(earClassLoader, subContext);
if (moduleDescriptor.getModuleType().equals(DOLUtils.ejbType())) {
// for ejb module, we just add the ejb urls
// to EarClassLoader and use that to load
// ejb module
URL[] moduleURLs = ((URLClassLoader) subCl).getURLs();
for (URL moduleURL : moduleURLs) {
earClassLoader.addURL(moduleURL);
}
earClassLoader.addModuleClassLoader(moduleUri, earClassLoader);
PreDestroy.class.cast(subCl).preDestroy();
} else if (moduleDescriptor.getModuleType().equals(DOLUtils.rarType())) {
embeddedConnCl.addDelegate((DelegatingClassLoader.ClassFinder) subCl);
earClassLoader.addModuleClassLoader(moduleUri, subCl);
} else {
Boolean isTempClassLoader = context.getTransientAppMetaData(ExtendedDeploymentContext.IS_TEMP_CLASSLOADER,
Boolean.class);
if (subCl instanceof URLClassLoader && (isTempClassLoader != null) && isTempClassLoader) {
// for temp classloader, we add all the module
// urls to the top level EarClassLoader
URL[] moduleURLs = ((URLClassLoader) subCl).getURLs();
for (URL moduleURL : moduleURLs) {
earClassLoader.addURL(moduleURL);
}
}
earClassLoader.addModuleClassLoader(moduleUri, subCl);
}
}
} catch (IOException e) {
_logger.log(SEVERE, strings.get("noClassLoader", moduleUri), e);
}
}
return earClassLoader;
}
@Override
public boolean accept(ReadableArchive source, String entryName) {
// Hide everything but the metadata.
return entryName.startsWith("META-INF");
}
// Do any necessary meta data initialization for composite handler
@Override
public void initCompositeMetaData(DeploymentContext context) {
// populate ear level metadata
getApplicationHolder(context.getSource(), context, true);
}
private ApplicationHolder getApplicationHolder(ReadableArchive source, DeploymentContext context, boolean isDirectory) {
ApplicationHolder holder = context.getModuleMetaData(ApplicationHolder.class);
if (holder == null || holder.app == null) {
try {
DeployCommandParameters params = context.getCommandParameters(DeployCommandParameters.class);
if (params != null && params.altdd != null) {
source.addArchiveMetaData(DeploymentProperties.ALT_DD, params.altdd);
}
long start = System.currentTimeMillis();
ApplicationArchivist archivist = habitat.getService(ApplicationArchivist.class);
archivist.setAnnotationProcessingRequested(true);
String xmlValidationLevel = dasConfig.getDeployXmlValidation();
archivist.setXMLValidationLevel(xmlValidationLevel);
if (xmlValidationLevel.equals("none")) {
archivist.setXMLValidation(false);
}
holder = new ApplicationHolder(archivist.createApplication(source, isDirectory));
_logger.fine("time to read application.xml " + (System.currentTimeMillis() - start));
} catch (IOException e) {
throw new RuntimeException(e);
} catch (SAXException e) {
throw new RuntimeException(e);
}
context.addModuleMetaData(holder);
}
if (holder.app == null) {
throw new RuntimeException(strings.get("errReadMetadata"));
}
return holder;
}
// get archive handler from module type
// performance optimization so we don't need to retrieve archive handler
// the normal way which might involve annotation scanning
private ArchiveHandler getArchiveHandlerFromModuleType(ArchiveType type) {
if (type.equals(DOLUtils.warType())) {
return habitat.getService(ArchiveHandler.class, WarArchiveType.ARCHIVE_TYPE);
}
if (type.equals(DOLUtils.rarType())) {
return habitat.getService(ArchiveHandler.class, RarArchiveType.ARCHIVE_TYPE);
}
if (type.equals(DOLUtils.ejbType())) {
return habitat.getService(ArchiveHandler.class, EjbArchiveType.ARCHIVE_TYPE);
}
if (type.equals(DOLUtils.carType())) {
return habitat.getService(ArchiveHandler.class, CarArchiveType.ARCHIVE_TYPE);
}
return null;
}
private static class GFApplicationXmlParser {
private XMLStreamReader parser;
private String compatValue;
GFApplicationXmlParser(ReadableArchive archive) throws FileNotFoundException, IOException {
InputStream input = null;
File runtimeAltDDFile = archive.getArchiveMetaData(DeploymentProperties.RUNTIME_ALT_DD, File.class);
if (runtimeAltDDFile != null && runtimeAltDDFile.getPath().indexOf(DescriptorConstants.GF_PREFIX) != -1
&& runtimeAltDDFile.exists() && runtimeAltDDFile.isFile()) {
DOLUtils.validateRuntimeAltDDPath(runtimeAltDDFile.getPath());
input = new FileInputStream(runtimeAltDDFile);
} else {
input = archive.getEntry("META-INF/glassfish-application.xml");
}
if (input != null) {
try {
read(input);
} catch (Throwable t) {
String msg = localStrings.getLocalString("exception_parsing_glassfishapplicationxml",
"Error in parsing sun-application.xml for archive [{0}]: {1}", archive.getURI(), t.getMessage());
throw new RuntimeException(msg);
} finally {
if (parser != null) {
try {
parser.close();
} catch (Exception ex) {
// ignore
}
}
try {
input.close();
} catch (Exception ex) {
// ignore
}
}
}
}
protected String extractVersionIdentifierValue(ReadableArchive archive) throws XMLStreamException, IOException {
InputStream input = null;
String versionIdentifierValue = null;
try {
File runtimeAltDDFile = archive.getArchiveMetaData(DeploymentProperties.RUNTIME_ALT_DD, File.class);
if (runtimeAltDDFile != null && runtimeAltDDFile.getPath().indexOf(DescriptorConstants.GF_PREFIX) != -1
&& runtimeAltDDFile.exists() && runtimeAltDDFile.isFile()) {
DOLUtils.validateRuntimeAltDDPath(runtimeAltDDFile.getPath());
input = new FileInputStream(runtimeAltDDFile);
} else {
input = archive.getEntry("META-INF/glassfish-application.xml");
}
if (input != null) {
// parse elements only from glassfish-web
parser = getXMLInputFactory().createXMLStreamReader(input);
int event = 0;
skipRoot("glassfish-application");
while (parser.hasNext() && (event = parser.next()) != END_DOCUMENT) {
if (event == START_ELEMENT) {
String name = parser.getLocalName();
if ("version-identifier".equals(name)) {
versionIdentifierValue = parser.getElementText();
} else {
skipSubTree(name);
}
}
}
}
} finally {
if (input != null) {
try {
input.close();
} catch (Exception e) {
// ignore
}
}
}
return versionIdentifierValue;
}
private void read(InputStream input) throws XMLStreamException {
parser = getXMLInputFactory().createXMLStreamReader(input);
int event = 0;
boolean done = false;
skipRoot("glassfish-application");
while (!done && (event = parser.next()) != END_DOCUMENT) {
if (event == START_ELEMENT) {
String name = parser.getLocalName();
if (DeploymentProperties.COMPATIBILITY.equals(name)) {
compatValue = parser.getElementText();
done = true;
} else {
skipSubTree(name);
}
}
}
}
private void skipRoot(String name) throws XMLStreamException {
while (true) {
int event = parser.next();
if (event == START_ELEMENT) {
if (!name.equals(parser.getLocalName())) {
throw new XMLStreamException();
}
return;
}
}
}
private void skipSubTree(String name) throws XMLStreamException {
while (true) {
int event = parser.next();
if (event == END_DOCUMENT) {
throw new XMLStreamException();
} else if (event == END_ELEMENT && name.equals(parser.getLocalName())) {
return;
}
}
}
String getCompatibilityValue() {
return compatValue;
}
}
private static class SunApplicationXmlParser {
private XMLStreamReader parser = null;
private String compatValue = null;
SunApplicationXmlParser(File baseDir) throws FileNotFoundException {
InputStream input = null;
File f = new File(baseDir, "META-INF/sun-application.xml");
if (f.exists()) {
input = new FileInputStream(f);
try {
read(input);
} catch (Throwable t) {
String msg = localStrings.getLocalString("exception_parsing_sunapplicationxml",
"Error in parsing glassfish-application.xml for archive [{0}]: {1}", baseDir.getPath(), t.getMessage());
throw new RuntimeException(msg);
} finally {
if (parser != null) {
try {
parser.close();
} catch (Exception ex) {
// ignore
}
}
try {
input.close();
} catch (Exception ex) {
// ignore
}
}
}
}
private void read(InputStream input) throws XMLStreamException {
parser = getXMLInputFactory().createXMLStreamReader(input);
int event = 0;
boolean done = false;
skipRoot("sun-application");
while (!done && (event = parser.next()) != END_DOCUMENT) {
if (event == START_ELEMENT) {
String name = parser.getLocalName();
if (DeploymentProperties.COMPATIBILITY.equals(name)) {
compatValue = parser.getElementText();
done = true;
} else {
skipSubTree(name);
}
}
}
}
private void skipRoot(String name) throws XMLStreamException {
while (true) {
int event = parser.next();
if (event == START_ELEMENT) {
if (!name.equals(parser.getLocalName())) {
throw new XMLStreamException();
}
return;
}
}
}
private void skipSubTree(String name) throws XMLStreamException {
while (true) {
int event = parser.next();
if (event == END_DOCUMENT) {
throw new XMLStreamException();
} else if (event == END_ELEMENT && name.equals(parser.getLocalName())) {
return;
}
}
}
String getCompatibilityValue() {
return compatValue;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy