org.glassfish.appclient.client.packageappclient.PackageAppClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 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 [2017] [Payara Foundation and/or its affiliates]
package org.glassfish.appclient.client.packageappclient;
import com.sun.enterprise.universal.i18n.LocalStringsImpl;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileFilter;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.jar.Attributes;
import java.util.jar.Attributes.Name;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.jar.JarOutputStream;
import java.util.jar.Manifest;
import java.util.zip.ZipException;
/**
* Creates a JAR file containing the runtime bits required to run app clients
* remotely, on a system without a full GlassFish installation.
*
* The resulting file will contain:
*
* - the stand-alone ACC JAR file (the one containing this class)
*
- all JARs listed in the Class-Path of this JAR's manifest
*
- the contents of the ${installDir}/lib/dtds and schemas directories (for
* local resolution of schemas and DTDs on the remote client system)
*
- the specified sun-acc.xml file (the one from domains/domain1/config if unspecified)
*
- the handful of other config files to which sun-acc.xml refers
*
*
* Optional command-line options:
*
* -output path-to-output-file (default: ${installDir}/lib/appclient/appclient.jar)
* -xml path-to-sun-acc.xml-config-file (default: ${installDir}/domains/domain1/config/sun-acc.xml)
* -verbose reports progress and errors that are non-fatal
*
*
* @author tjquinn
*/
public class PackageAppClient {
private final static String OUTPUT_PREFIX = "appclient/";
private final static String GLASSFISH_LIB = "glassfish/lib";
private final static String GLASSFISH_BIN = "glassfish/bin";
private final static String GLASSFISH_CONFIG = "glassfish/config";
private final static String MODULES_ENDORSED_DIR = "glassfish/modules/endorsed";
private final static String MQ_LIB = "mq/lib";
private final static String DOMAIN_1_CONFIG = "glassfish/domains/domain1/config";
private final static String INDENT = " ";
private final static String ACC_CONFIG_FILE_DEFAULT = "/glassfish-acc.xml";
private final static String ACC_CONFIG_FILE_DEFAULT_OLD = "/sun-acc.xml";
/* DIRS_TO_COPY entries are all relative to the installation directory */
private final static String[] DIRS_TO_COPY = new String[] {
GLASSFISH_LIB + "/dtds",
GLASSFISH_LIB + "/schemas",
GLASSFISH_LIB + "/appclient"
};
/*
* relative path to the endorsed directory of the app server. Handled
* separately from other directorys because we do not include all files from
* the endorsed directory.
*/
private final static String LIB_ENDORSED_DIR = GLASSFISH_LIB + "/endorsed";
private final static String[] ENDORSED_DIRS_TO_COPY = new String[] {
LIB_ENDORSED_DIR,
MODULES_ENDORSED_DIR
};
/* default sun-acc.xml is relative to the installation directory */
private final static String DEFAULT_ACC_XML =
DOMAIN_1_CONFIG + ACC_CONFIG_FILE_DEFAULT;
private final static String OLD_ACC_XML =
DOMAIN_1_CONFIG + ACC_CONFIG_FILE_DEFAULT_OLD;
private final static String[] DEFAULT_ACC_CONFIG_FILES = {
DEFAULT_ACC_XML, OLD_ACC_XML
};
private final static String IMQJMSRA_APP =
GLASSFISH_LIB + "/install/applications/jmsra/imqjmsra.jar";
private final static String IMQ_JAR = MQ_LIB + "/imq.jar";
private final static String IMQADMIN_JAR = MQ_LIB + "/imqadmin.jar";
private final static String IMQUTIL_JAR = MQ_LIB + "/imqutil.jar";
private final static String FSCONTEXT_JAR = MQ_LIB + "/fscontext.jar";
private final static String WIN_SCRIPT = GLASSFISH_BIN + "/appclient.bat";
private final static String WIN_JS = GLASSFISH_BIN + "/appclient.js";
private final static String NONWIN_SCRIPT = GLASSFISH_BIN + "/appclient";
private final static String ASENV_CONF = GLASSFISH_CONFIG + "/asenv.conf";
private final static String ASENV_BAT = GLASSFISH_CONFIG + "/asenv.bat";
private static final char UNIX_SEPARATOR = '/';
private static final char WINDOWS_SEPARATOR = '\\';
private final static String[] SINGLE_FILES_TO_COPY = {
IMQJMSRA_APP,
IMQ_JAR,
IMQADMIN_JAR,
IMQUTIL_JAR,
FSCONTEXT_JAR,
WIN_SCRIPT,
WIN_JS,
NONWIN_SCRIPT,
ASENV_CONF,
ASENV_BAT};
/* default output file */
private final static String DEFAULT_OUTPUT_PATH = GLASSFISH_LIB + "/appclient.jar";
private final static LocalStringsImpl strings = new LocalStringsImpl(PackageAppClient.class);
private boolean isVerbose;
/**
* @param args the command line arguments
*/
public static void main(String[] args) {
try {
new PackageAppClient().run(args);
} catch (Exception e) {
e.printStackTrace();
System.exit(1);
}
}
private void run(final String[] args) throws URISyntaxException, IOException {
isVerbose = isVerboseOutputLevel(args);
final File thisJarFile = findCurrentJarFile();
File installDir = findInstallDir(thisJarFile);
File modulesDir = new File(installDir.toURI().resolve("glassfish/modules/"));
/*
* Write the new JAR to a temp file in the install directory. Then
* we can simply rename the file to the correct name. (Rename does not
* work on Windows systems across volumes.)
*/
final File tempFile = File.createTempFile("appc", ".tmp", installDir);
final File outputFile = chooseOutputFile(installDir, args);
final File[] configFiles = chooseConfigFiles(installDir, args);
String[] classPathElements = getJarClassPath(thisJarFile).split(" ");
JarOutputStream os = new JarOutputStream(new BufferedOutputStream(
new FileOutputStream(tempFile)));
/*
* Add this JAR file to the output.
*/
addFile(os, installDir.toURI(), thisJarFile.toURI(), tempFile, "");
/*
* JARs listed in the Class-Path are all relative to the modules
* directory so resolve each Class-Path entry against the modules
* directory.
*/
for (String classPathElement : classPathElements) {
final File classPathJAR = new File(modulesDir, classPathElement);
addFile(os, installDir.toURI(),
modulesDir.toURI().resolve(classPathJAR.toURI()), tempFile,
"");
}
/*
* The directories to copy are all relative to the installation directory,
* so resolve them against the installDir file.
*/
for (String dirToCopy : DIRS_TO_COPY) {
addDir(os, installDir.toURI(),
installDir.toURI().resolve(dirToCopy), tempFile,
"");
}
for (String endorsedDirToCopy : ENDORSED_DIRS_TO_COPY) {
addEndorsedFiles(os, installDir.toURI(),
installDir.toURI().resolve(endorsedDirToCopy), tempFile);
}
for (String singleFileToCopy : SINGLE_FILES_TO_COPY) {
addFile(os, installDir.toURI(),
installDir.toURI().resolve(singleFileToCopy), tempFile,
"");
}
/*
* The glassfish-acc.xml file and sun-acc.xml files.
*/
boolean customConfigFileProvided = argValue("-xml", args) != null;
for (File configFile : configFiles) {
if (!customConfigFileProvided) {
addFile(os, installDir.toURI(), configFile.toURI(), tempFile, "");
} else {
addFile(os, configFile.toURI(), tempFile, "",
DOMAIN_1_CONFIG + File.separator + getFileName(configFile.toURI().toString()));
}
}
os.close();
placeFile(tempFile, outputFile);
}
private void placeFile(final File tempFile, final File outputFile) {
if (outputFile.exists()) {
if ( ! outputFile.delete()) {
throw new RuntimeException(strings.get("errDel", outputFile.getAbsolutePath()));
}
System.out.println(strings.get("replacingFile", outputFile.getAbsolutePath()));
} else {
System.out.println(strings.get("creatingFile", outputFile.getAbsolutePath()));
}
if (isVerbose) {
System.out.println(strings.get("moving", tempFile.getAbsolutePath(), outputFile.getAbsolutePath()));
}
if ( ! tempFile.renameTo(outputFile)) {
throw new RuntimeException(strings.get("errRenaming", tempFile.getAbsolutePath(), outputFile.getAbsolutePath()));
}
}
/**
* Adds all endorsed JAR files in the app server's endorsed directory to
* the output JAR file.
* @param os
* @param installDirURI
* @param endorsedDirURI
* @param outputFile
* @throws java.io.IOException
*/
private void addEndorsedFiles(
final JarOutputStream os,
final URI installDirURI,
final URI endorsedDirURI,
final File outputFile) throws IOException {
addDir(os, installDirURI, endorsedDirURI,
new FileFilter() {
@Override
public boolean accept(File pathname) {
return pathname.getName().endsWith(".jar") ||
pathname.isDirectory();
}
},
outputFile, "");
}
/**
* Adds a single file to the output JAR, avoiding the output file itself (if
* by some chance the user is creating the output JAR in one of the
* places from which we gather input).
* @param os
* @param installDirURI
* @param absoluteURIToAdd
* @param outputFile
* @throws java.io.IOException
*/
private void addFile(
final JarOutputStream os,
final URI installDirURI,
final URI absoluteURIToAdd,
final File outputFile,
final String indent
) throws IOException {
addFile(os, absoluteURIToAdd, outputFile, indent, installDirURI.relativize(absoluteURIToAdd).toString());
}
private void addFile(
final JarOutputStream os,
final URI absoluteURIToAdd,
final File outputFile,
final String indent,
final String relativizedURL
) throws IOException {
try {
if (isVerbose) {
System.err.println(indent + strings.get("addingFile", absoluteURIToAdd));
}
final File fileToCopy = new File(absoluteURIToAdd);
if (fileToCopy.equals(outputFile)) {
return;
}
JarEntry entry = new JarEntry(OUTPUT_PREFIX + relativizedURL);
try {
/*
* Some modules in the GlassFish build are marked as optional
* dependencies, and the resulting JARs are not included in the
* GlassFish distribution. But the JAR file names do appear in
* the maven-generated Class-Path for the stand-alone client JAR
* library which this tool uses to find out what JARs to include
* in the generated appclient.jar file. So, if the Class-Path
* specifies a file we cannot find we keep going -- silently.
*/
if ( ! new File(absoluteURIToAdd).exists()) {
if (isVerbose) {
System.err.println(indent + strings.get("noFile", new File(absoluteURIToAdd).getAbsolutePath()));
}
return;
}
os.putNextEntry(entry);
if (new File(absoluteURIToAdd).isFile()) {
copyFileToStream(os, absoluteURIToAdd);
}
os.closeEntry();
} catch (ZipException e) {
/*
* Probably duplicate entry. Keep going after logging the error.
*/
if (isVerbose) {
System.err.println(indent + strings.get("zipExc", e.getLocalizedMessage()));
}
} catch (FileNotFoundException ignore) {
}
} catch (Exception ex) {
throw new IOException(absoluteURIToAdd.toASCIIString(), ex);
}
}
private String getFileName(String filename) {
if (filename == null) {
return null;
}
int index = indexOfLastSeparator(filename);
return filename.substring(index + 1);
}
private int indexOfLastSeparator(String filename) {
if (filename == null) {
return -1;
}
int lastUnixPos = filename.lastIndexOf(UNIX_SEPARATOR);
int lastWindowsPos = filename.lastIndexOf(WINDOWS_SEPARATOR);
return Math.max(lastUnixPos, lastWindowsPos);
}
/**
* Add all the files from the specified directory, recursing to lower-level
* subdirectories.
* @param os
* @param installDirURI
* @param absoluteDirURIToAdd
* @param outputFile
* @throws java.io.IOException
*/
private void addDir(
final JarOutputStream os,
final URI installDirURI,
final URI absoluteDirURIToAdd,
final File outputFile,
final String indent) throws IOException {
addDir(os, installDirURI, absoluteDirURIToAdd,
null /* with null filter File.listFiles accepts all files and directories */,
outputFile,
indent);
}
/**
* Add all files from a directory that meet the criteria of the specified
* file filter.
*
* @param os
* @param installDirURI
* @param absoluteDirURIToAdd
* @param fileFilter
* @param outputFile
* @throws java.io.IOException
*/
private void addDir(
final JarOutputStream os,
final URI installDirURI,
final URI absoluteDirURIToAdd,
final FileFilter fileFilter,
final File outputFile,
final String indent) throws IOException {
final File dirFile = new File(absoluteDirURIToAdd);
final File[] matchingFiles = dirFile.listFiles(fileFilter);
if (matchingFiles == null) {
/*
* The file does not exist or is not a directory. This could happen
* for example if the user has not created the endorsed directory.
*/
return;
}
if (isVerbose) {
System.err.println(indent + strings.get("addingDir", dirFile.getAbsolutePath()));
}
for (File fileToAdd : matchingFiles) {
if (fileToAdd.isFile()) {
addFile(os, installDirURI, fileToAdd.toURI(), outputFile, indent + INDENT);
} else if (fileToAdd.isDirectory()) {
addDir(os, installDirURI, fileToAdd.toURI(), outputFile, indent + INDENT);
}
}
}
/**
* Copies the contents of a given file to the output stream.
* @param os
* @param uriToCopy
* @throws java.io.FileNotFoundException
* @throws java.io.IOException
*/
private void copyFileToStream(
final OutputStream os,
final URI uriToCopy) throws IOException {
File fileToCopy = new File(uriToCopy);
InputStream is = new BufferedInputStream(new FileInputStream(fileToCopy));
try {
int bytesRead;
byte [] buffer = new byte[4096];
while ((bytesRead = is.read(buffer)) != -1) {
os.write(buffer, 0, bytesRead);
}
} finally {
if (is != null) {
is.close();
}
}
}
/**
* Returns the File to create. The user can optionally specify the output file as
* -output outFile on the command line. The default is
* ${installDir}/lib/appclient.jar
*
* @param args command-line arguments
* @return File for the file to create
*/
private File chooseOutputFile(final File installDir, final String[] args) {
return chooseFile("-output", DEFAULT_OUTPUT_PATH, installDir, args);
}
/**
* Returns a file, either a default value or one explicitly set via a
* user-provided option on the command line.
* @param option
* @param defaultRelativeURI
* @param installDir
* @param args
* @return
*/
private File chooseFile(
final String option,
final String defaultRelativeURI,
final File installDir,
final String[] args) {
File result;
/*
* Look for the option in the arguments.
*/
final String optionValue = argValue(option, args);
if (optionValue != null) {
result = new File(optionValue);
} else {
URI outputFileURI = installDir.toURI().resolve(defaultRelativeURI);
result = new File(outputFileURI);
}
return result;
}
/**
* Returns the user-specified or default *-acc.xml config files.
* @param installDir
* @param args
* @return
*/
private File[] chooseConfigFiles(final File installDir, final String[] args) {
final String xmlArg = argValue("-xml", args);
File[] files;
if (xmlArg == null) {
files = new File[DEFAULT_ACC_CONFIG_FILES.length];
int slot = 0;
for (String s : DEFAULT_ACC_CONFIG_FILES) {
files[slot++] = new File(installDir.toURI().resolve(s));
}
} else {
final File userSpecifiedFile = new File(xmlArg);
files = new File[] {userSpecifiedFile};
if ( ! userSpecifiedFile.exists()) {
System.err.println(strings.get("xmlNotFound", userSpecifiedFile.getAbsolutePath()));
}
}
return files;
}
private File findInstallDir(final File currentJarFile) throws URISyntaxException {
return currentJarFile.getParentFile().getParentFile().getParentFile();
}
private boolean isVerboseOutputLevel(final String[] args) {
for (String arg : args) {
if (arg.equals("-verbose")) {
return true;
}
}
return false;
}
/**
* Returns the value for the specified option.
* @param option option name to search the args for
* @param args args to search
* @return token after the specified optionon the command line, if any;
* @throws IllegalArgumentException if there is no value on the command line for the specified option
*/
private String argValue(final String option, final String[] args) {
for (int i = 0; i < args.length; i++) {
if (args[i].equals(option)) {
if (i + 1 < args.length) {
return args[i+1];
} else {
throw new IllegalArgumentException(option);
}
}
}
return null;
}
/**
* Returns a File object for the JAR file that contains this class.
*
* @return
* @throws java.net.URISyntaxException
*/
private File findCurrentJarFile() throws URISyntaxException {
URI thisJarURI = getClass().getProtectionDomain().getCodeSource().getLocation().toURI();
URI thisJarFileBasedURI = (thisJarURI.getScheme().startsWith("jar")) ?
URI.create("file:" + thisJarURI.getRawSchemeSpecificPart()) :
thisJarURI;
/*
* One getParent gives the modules directory; the second gives the
* installation directory.
*/
File result = new File(thisJarFileBasedURI);
return result;
}
/**
* Returns the Class-Path setting for the specified File, presumed to be
* a JAR.
* @param currentJarFile
* @return
* @throws java.io.IOException
*/
private String getJarClassPath(final File currentJarFile) throws IOException {
JarFile jf = null;
try {
jf = new JarFile(currentJarFile);
final Manifest mf = jf.getManifest();
final Attributes mainAttrs = mf.getMainAttributes();
final String classPath = mainAttrs.getValue(Name.CLASS_PATH);
return classPath;
}
finally {
if (jf != null)
jf.close();
}
}
}