org.glassfish.appclient.client.jws.boot.JWSACCMain Maven / Gradle / Ivy
Show all versions of payara-micro Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-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.
*/
package org.glassfish.appclient.client.jws.boot;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLClassLoader;
import java.security.Policy;
import java.text.MessageFormat;
import java.util.ResourceBundle;
import java.util.Vector;
import javax.swing.SwingUtilities;
import org.glassfish.appclient.client.acc.AppClientContainer;
import org.glassfish.appclient.common.Util;
import org.glassfish.appclient.client.acc.JWSACCClassLoader;
/**
*Alternate main class for ACC, used when launched by Java Web Start.
*
*This class assigns security permissions needed by the app server code and
*by the app client code, then starts the regular app client container.
*
*Note that any logic this class executes that requires privileged access
*must occur either:
*- from a class in the signed jar containing this class, or
*- after setPermissions has been invoked.
*This is because Java Web Start grants elevated permissions only to the classes
*in the appserv-jwsacc-signed.jar at the beginning. Only after setPermissions
*has been invoked can other app server-provided code run with all permissions.
*
* @author tjquinn
*/
public class JWSACCMain implements Runnable {
// /** path to a class in one of the app server lib jars downloaded by Java Web Start */
// private static final String APPSERVER_LIB_CLASS_NAME = "com.sun.enterprise.server.ApplicationServer";
/** name of the permissions template */
private static final String PERMISSIONS_TEMPLATE_NAME = "jwsclient.policy";
/** placeholder used in the policy template to substitute dynamically-generated grant clauses */
private static final String GRANT_CLAUSES_PROPERTY_EXPR = "${grant.clauses}";
/** line separator */
private static final String lineSep = System.getProperty("line.separator");
/** the user-specified security policy template to use */
private static String jwsPolicyTemplateURL = null;
/** unpublished command-line argument conveying jwsacc information */
private static final String JWSACC_ARGUMENT_PREFIX = "-jwsacc";
private static final String JWSACC_EXIT_AFTER_RETURN = "ExitAfterReturn";
private static final String JWSACC_FORCE_ERROR = "ForceError";
private static final String JWSACC_KEEP_JWS_CLASS_LOADER = "KeepJWSClassLoader";
private static final String JWSACC_RUN_ON_SWING_THREAD = "RunOnSwingThread";
/** grant clause template for dynamically populating the policy */
private static final String GRANT_CLAUSE_TEMPLATE = "grant codeBase \"{0}\" '{'\n" +
" permission java.security.AllPermission;\n" +
"'}';";
/**
* request to exit the JVM upon return from the client - should be set (via
* the -jwsacc command-line argument value) only for
* command-line clients; otherwise it can prematurely end the JVM when
* the GUI and other user work is continuing
*/
private static boolean exitAfterReturn = false;
/*
*Normally the ACC is not run with the Java Web Start classloader as the
*parent class loader because this causes problems loading dynamic stubs.
*To profile performance, though, sometimes we need to keep the JWS
*class loader as the parent rather than skipping it.
*/
private static boolean keepJWSClassLoader = false;
private static boolean runOnSwingThread = false;
/** helper for building the class loader and policy changes */
private static ClassPathManager classPathManager = null;
/** URLs for downloaded JAR files to be used in the class path */
private static URL [] downloadedJarURLs;
/** URLs for persistence-related JAR files for the class path and permissions */
private static URL [] persistenceJarURLs;
/** localizable strings */
private static final ResourceBundle rb =
ResourceBundle.getBundle(
dotToSlash(JWSACCMain.class.getPackage().getName() + ".LocalStrings"));
/** make the arguments passed to the constructor available to the main method */
private String args[];
/** Creates a new instance of JWSMain */
public JWSACCMain(String[] args) {
this.args = args;
}
/**
* @param args the command line arguments
*/
public static void main(String[] args) {
try {
args = prepareJWSArgs(args);
try {
classPathManager = getClassPathManager();
downloadedJarURLs = classPathManager.locateDownloadedJars();
persistenceJarURLs = classPathManager.locatePersistenceJARs();
} catch (Throwable thr) {
throw new IllegalArgumentException(rb.getString("jwsacc.errorLocJARs"), thr);
}
/*
*Before creating the new instance of the real ACC main, set permissions
*so ACC and the user's app client can function properly.
*/
setPermissions();
/*
*Make sure that the main ACC class is instantiated and run in the
*same thread. Java Web Start may not normally do so.
*/
JWSACCMain jwsACCMain = new JWSACCMain(args);
if (runOnSwingThread) {
SwingUtilities.invokeAndWait(jwsACCMain);
} else {
jwsACCMain.run();
}
/*
*Note that the app client is responsible for closing all GUI
*components or the JVM will never exit.
*/
} catch (Throwable thr) {
System.exit(1);
}
}
private static String dotToSlash(String orig) {
return orig.replaceAll("\\.","/");
}
public void run() {
// Main.main(args);
int exitValue = 0;
try {
File downloadedAppclientJarFile = findAppClientFileForJWSLaunch(getClass().getClassLoader());
ClassLoader loader = prepareClassLoader(downloadedAppclientJarFile);
/*
*Set a property that the ACC will retrieve during a JWS launch
*to locate the app client jar file.
*/
System.setProperty("com.sun.aas.downloaded.appclient.jar", downloadedAppclientJarFile.getAbsolutePath());
Thread.currentThread().setContextClassLoader(loader);
/*
*Use the prepared class loader to load the ACC main method, prepare
*the arguments to the constructor, and invoke the static main method.
*/
Constructor constr = null;
Class mainClass = Class.forName("com.sun.enterprise.appclient.MainWithModuleSupport", true /* initialize */, loader);
constr = mainClass.getConstructor(
new Class[] { String[].class, URL[].class } );
constr.newInstance(args, persistenceJarURLs);
} catch(Throwable thr) {
exitValue = 1;
/*
*Display the throwable and stack trace to System.err, then
*display it to the user using the GUI dialog box.
*/
System.err.println(rb.getString("jwsacc.errorLaunch"));
System.err.println(thr.toString());
thr.printStackTrace();
ErrorDisplayDialog.showErrors(thr, rb);
} finally {
/*
*If the user has requested, invoke System.exit as soon as the main
*method returns. Do so on the Swing event thread so the ACC
*main can complete whatever it may be doing.
*/
if (exitAfterReturn || (exitValue != 0)) {
Runnable exit = new Runnable() {
private int statusValue;
public void run() {
System.out.printf("Exiting after return from client with status %1$d%n", statusValue);
System.exit(statusValue);
}
public Runnable init(int exitStatus) {
statusValue = exitStatus;
return this;
}
}.init(exitValue);
if (runOnSwingThread) {
SwingUtilities.invokeLater(exit);
} else {
exit.run();
}
}
}
}
/**
*Process any command line arguments that are targeted for the
*Java Web Start ACC main program (this class) as opposed to the
*regular ACC or the client itself.
*@param args the original command line arguments
*@return command arguments with any handled by JWS ACC removed
*/
private static String[] prepareJWSArgs(String[] args) {
Vector JWSACCArgs = new Vector();
Vector nonJWSACCArgs = new Vector();
for (String arg : args) {
if (arg.startsWith(JWSACC_ARGUMENT_PREFIX)) {
JWSACCArgs.add(arg.substring(JWSACC_ARGUMENT_PREFIX.length()));
} else {
nonJWSACCArgs.add(arg);
}
}
processJWSArgs(JWSACCArgs);
return nonJWSACCArgs.toArray(new String[nonJWSACCArgs.size()]);
}
/**
*Interpret the JWSACC arguments (if any) supplied on the command line.
*@param args the JWSACC arguments
*/
private static void processJWSArgs(Vector args) {
for (String arg : args) {
if (arg.equals(JWSACC_EXIT_AFTER_RETURN)) {
exitAfterReturn = true;
} else if (arg.equals(JWSACC_FORCE_ERROR)) {
throw new RuntimeException("Forced error - testing only");
} else if (arg.equals(JWSACC_KEEP_JWS_CLASS_LOADER)) {
keepJWSClassLoader = true;
} else if (arg.equals(JWSACC_RUN_ON_SWING_THREAD)) {
runOnSwingThread = true;
}
}
}
private static void setPermissions() {
try {
/*
*Get the permissions template and write it to a temporary file.
*/
String permissionsTemplate = Util.loadResource(JWSACCMain.class, PERMISSIONS_TEMPLATE_NAME);
/*
*Prepare the grant clauses for the downloaded jars and substitute
*those clauses into the policy template.
*/
StringBuilder grantClauses = new StringBuilder();
for (URL url : downloadedJarURLs) {
grantClauses.append(MessageFormat.format(GRANT_CLAUSE_TEMPLATE, url.toExternalForm()));
}
for (URL url : persistenceJarURLs) {
grantClauses.append(MessageFormat.format(GRANT_CLAUSE_TEMPLATE, url.toExternalForm()));
}
String substitutedPermissionsTemplate = permissionsTemplate.replace(GRANT_CLAUSES_PROPERTY_EXPR, grantClauses.toString());
boolean retainTempFiles = Boolean.getBoolean(AppClientContainer.APPCLIENT_RETAIN_TEMP_FILES_PROPERTYNAME);
File policyFile = writeTextToTempFile(substitutedPermissionsTemplate, "jwsacc", ".policy", retainTempFiles);
refreshPolicy(policyFile);
} catch (IOException ioe) {
throw new RuntimeException("Error loading permissions template", ioe);
}
}
/**
*Locates the first free policy.url.x setting.
*@return the int value for the first unused policy setting
*/
public static int firstFreePolicyIndex() {
int i = 0;
String propValue;
do {
propValue = java.security.Security.getProperty("policy.url." + String.valueOf(++i));
} while ((propValue != null) && ( ! propValue.equals("")));
return i;
}
/**
*Refreshes the current policy object using the contents of the specified file
*as additional policy.
*@param policyFile the file containing additional policy
*/
public static void refreshPolicy(File policyFile) {
int idx = firstFreePolicyIndex();
URI policyFileURI = policyFile.toURI();
java.security.Security.setProperty("policy.url." + idx, policyFileURI.toASCIIString());
Policy p = Policy.getPolicy();
p.refresh();
}
/**
*The methods below are duplicates from the com.sun.enterprise.appclient.jws.Util class.
*At the time this class is running, Java Web Start will not yet permit the Util class to
*use the elevated permissions. In fact, this class is in the process of granting
*those permissions to all app server code. By including the code here, Java Web Start
*will permit it to run because this class was loaded from a trusted jar file.
*/
/**
*Writes the provided text to a temporary file marked for deletion on exit.
*@param the content to be written
*@param prefix for the temp file, conforming to the File.createTempFile requirements
*@param suffix for the temp file
*@return File object for the newly-created temp file
*@throws IOException for any errors writing the temporary file
*@throws FileNotFoundException if the temp file cannot be opened for any reason
*/
private static File writeTextToTempFile(String content, String prefix, String suffix, boolean retainTempFiles) throws IOException, FileNotFoundException {
BufferedWriter wtr = null;
try {
File result = File.createTempFile(prefix, suffix);
if ( ! retainTempFiles) {
result.deleteOnExit();
}
FileOutputStream fos = new FileOutputStream(result);
wtr = new BufferedWriter(new OutputStreamWriter(fos));
wtr.write(content);
wtr.close();
return result;
} finally {
if (wtr != null) {
wtr.close();
}
}
}
/**
*Create the class loader for loading code from the unsigned downloaded
*app server jars.
*
*During a Java Web Start launch the ACC will be run under this class loader.
*Otherwise the JNLPClassLoader will load any stub classes that are
*packaged at the top-level of the generated app client jar file. (It can
*see them because it downloaded the gen'd app client jar, and therefore
*includes the downloaded jar in its class path. This allows it to see the
*classes at the top level of the jar but does not automatically let it see
*classes in the jars nested within the gen'd app client jar. As a result,
*the JNLPClassLoader would be the one to try to define the class for a
*web services stub, for instance. But the loader will not be able to find
*other classes and interfaces needed to completely define the class -
*because these are in the jars nested inside the gen'd app client jar. So
*the attempt to define the class would fail.
*@param downloadedAppclientJarFile the app client jar file
*@return the class loader
*/
private static ClassLoader prepareClassLoader(File downloadedAppclientJarFile) throws IOException, URISyntaxException, ClassNotFoundException, NoSuchMethodException, IllegalAccessException, InvocationTargetException {
ClassLoader ldr = new JWSACCClassLoader(downloadedJarURLs, classPathManager.getParentClassLoader());
return ldr;
}
/*
*Returns the jar that contains the specified resource.
*@param target entry name to look for
*@param loader the class loader to use in finding the resource
*@return File object for the jar or directory containing the entry
*/
private static File findContainingJar(String target, ClassLoader loader) throws IllegalArgumentException, URISyntaxException, MalformedURLException, IllegalAccessException, InvocationTargetException {
File result = null;
/*
*Use the specified class loader to find the resource.
*/
URL resourceURL = loader.getResource(target);
if (resourceURL != null) {
result = classPathManager.findContainingJar(resourceURL);
}
return result;
}
/**
*Locate the app client jar file during a Java Web Start launch.
*@param loader the class loader to use in searching for the descriptor entries
*@return File object for the client jar file
*@throws IllegalArgumentException if the loader finds neither descriptor
*/
private File findAppClientFileForJWSLaunch(ClassLoader loader) throws URISyntaxException, MalformedURLException, IllegalAccessException, InvocationTargetException {
/*
*The downloaded jar should contain either META-INF/application.xml or
*META-INF/application-client.xml. Look for either one and locate the
*jar from the URL.
*/
File containingJar = findContainingJar("META-INF/application.xml", loader);
if (containingJar == null) {
containingJar = findContainingJar("META-INF/application-client.xml", loader);
}
if (containingJar == null) {
// needs i18n
// throw new IllegalArgumentException(localStrings.getString("appclient.JWSnoDownloadedDescr"));
throw new IllegalArgumentException("Could not locate META-INF/application.xml or META-INF/application-client.xml");
}
return containingJar;
}
/**
*Return the class path manager appropriate to the current version.
*@return the correct type of ClassPathManager
*/
public static ClassPathManager getClassPathManager() throws ClassNotFoundException, NoSuchMethodException {
return ClassPathManager.getClassPathManager(keepJWSClassLoader);
}
}