org.glassfish.internal.deployment.GenericHandler Maven / Gradle / Ivy
Show all versions of payara-micro Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2009-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, 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/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
// Portions Copyright [2019-2021] [Payara Foundation and/or its affiliates]
package org.glassfish.internal.deployment;
import com.sun.enterprise.util.io.FileUtils;
import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URI;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.jar.JarFile;
import java.util.jar.Manifest;
import jakarta.inject.Inject;
import org.glassfish.api.deployment.DeploymentContext;
import org.glassfish.api.deployment.archive.ArchiveHandler;
import org.glassfish.api.deployment.archive.ReadableArchive;
import org.glassfish.api.deployment.archive.WritableArchive;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.internal.deployment.analysis.DeploymentSpan;
import org.glassfish.internal.deployment.analysis.StructuredDeploymentTracing;
/**
* Pretty generic implementation of some ArchiveHandler methods
*
* @author Jerome Dochez
*/
public abstract class GenericHandler implements ArchiveHandler {
@Inject
protected ServiceLocator habitat;
/**
* Prepares the jar file to a format the ApplicationContainer is
* expecting. This could be just a pure unzipping of the jar or
* nothing at all.
*
* @param source of the expanding
* @param target of the expanding
* @param context deployment context
* @throws IOException when the archive is corrupted
*/
@Override
public void expand(ReadableArchive source, WritableArchive target,
DeploymentContext context) throws IOException {
Enumeration e = source.entries();
while (e.hasMoreElements()) {
String entryName = e.nextElement();
InputStream entry = source.getEntry(entryName);
if (entry != null) {
InputStream is = new BufferedInputStream(entry);
OutputStream os = null;
try {
os = target.putNextEntry(entryName);
FileUtils.copy(is, os, source.getEntrySize(entryName));
} finally {
if (os!=null) {
target.closeEntry();
}
is.close();
}
}
}
// last is manifest is existing.
Manifest m = source.getManifest();
if (m!=null) {
OutputStream os = target.putNextEntry(JarFile.MANIFEST_NAME);
m.write(os);
target.closeEntry();
}
}
@Override
public String getDefaultApplicationName(ReadableArchive archive,
DeploymentContext context) {
return getDefaultApplicationName(archive, context, null);
}
/**
* Returns the default application name usable for identifying the archive.
*
* This default implementation returns the name portion of
* the archive's URI. The archive's name depends on the type of archive
* (FileArchive vs. JarArchive vs. MemoryMappedArchive, for example).
*
* A concrete subclass can override this method to provide an alternative
* way of deriving the default application name.
*
* @param archive the archive for which the default name is needed
* @param context deployment context
* @return the default application name for the specified archive
*/
@Override
public String getDefaultApplicationName(ReadableArchive archive,
DeploymentContext context, String originalAppName ) {
StructuredDeploymentTracing tracing = StructuredDeploymentTracing.load(context);
DeploymentSpan span = tracing.startSpan(DeploymentTracing.AppStage.DETERMINE_APP_NAME, "ApplicationInfoProvider");
// first try to get the name from ApplicationInfoProvider if
// we can find an implementation of this service
ApplicationInfoProvider nameProvider = habitat.getService(ApplicationInfoProvider.class);
span.close();
String appName = null;
if (nameProvider != null) {
appName = nameProvider.getNameFor(archive, context);
if (appName != null) {
if (originalAppName != null && appName.equals(archive.getName())) {
appName = originalAppName;
}
return appName;
}
}
if (originalAppName != null) {
return originalAppName;
}
// now try to get the default
return getDefaultApplicationNameFromArchiveName(archive);
}
public String getDefaultApplicationNameFromArchiveName(ReadableArchive archive) {
String appName = archive.getName();
int lastDot = appName.lastIndexOf('.');
if (lastDot != -1) {
if (appName.substring(lastDot).equalsIgnoreCase("." + getArchiveType())) {
appName = appName.substring(0, lastDot);
}
}
return appName;
}
@Override
public String getDefaultApplicationName(ReadableArchive archive) {
return getDefaultApplicationName(archive, null);
}
/**
* Returns the default value for versionIdentifier. This allows us to
* override the method only where thhe version-identifier element is
* supported.
*
* @return null
*/
public String getVersionIdentifier(ReadableArchive archive){
return null;
}
/**
* Returns the manifest file for this archive, this file is usually located at
* the META-INF/MANIFEST location, however, certain archive type can change this
* default location or use another mean of expressing manifest information.
*
* @param archive file
* @return manifest instance or null if this archive has no manifest
*/
public Manifest getManifest(ReadableArchive archive) throws IOException {
return archive.getManifest();
}
/**
* Returns the classpath URIs for this archive.
*
* @param archive file
* @return classpath URIs for this archive
*/
public List getClassPathURIs(ReadableArchive archive) {
List uris = new ArrayList();
// add the archive itself
uris.add(archive.getURI());
return uris;
}
/**
* Returns whether this archive requires annotation scanning.
*
* @param archive file
* @return whether this archive requires annotation scanning
*/
public boolean requiresAnnotationScanning(ReadableArchive archive) {
return true;
}
}