* * The JNLP runtime can be locked to prevent further changes to * the runtime environment except by a specified class. If set, * only instances of the exit class can exit the JVM or * change the JNLP runtime settings once the runtime has been * initialized.
*
* @author Jon A. Maxwell (JAM) - initial author
* @version $Revision: 1.19 $
*/
public class JNLPRuntime {
static {
loadResources();
}
/** the localized resource strings */
private static ResourceBundle resources;
private static final DeploymentConfiguration config = new DeploymentConfiguration();
/** the security manager */
private static JNLPSecurityManager security;
/** the security policy */
private static JNLPPolicy policy;
/** handles all security message to show appropriate security dialogs */
private static SecurityDialogMessageHandler securityDialogMessageHandler;
/** the base dir for cache, etc */
private static File baseDir;
/** a default launch handler */
private static LaunchHandler handler = null;
/** default download indicator */
private static DownloadIndicator indicator = null;
/** update policy that controls when to check for updates */
private static UpdatePolicy updatePolicy = UpdatePolicy.ALWAYS;
/** netx window icon */
private static Image windowIcon = null;
/** whether initialized */
private static boolean initialized = false;
/** whether netx is in command-line mode (headless) */
private static boolean headless = false;
/** whether we'll be checking for jar signing */
private static boolean verify = true;
/** whether the runtime uses security */
private static boolean securityEnabled = true;
/** whether debug mode is on */
private static boolean debug = false; // package access by Boot
/** mutex to wait on, for initialization */
public static Object initMutex = new Object();
/** set to true if this is a webstart application. */
private static boolean isWebstartApplication;
/** set to false to indicate another JVM should not be spawned, even if necessary */
private static boolean forksAllowed = true;
/** contains the arguments passed to the jnlp runtime */
private static List
*
* This method should be called from the main AppContext/Thread.
*
* This method cannot be called more than once. Once
* initialized, methods that alter the runtime can only be
* called by the exit class.
*
* @param isApplication is true if a webstart application is being initialized
*
* @throws IllegalStateException if the runtime was previously initialized
*/
public static void initialize(boolean isApplication) throws IllegalStateException {
checkInitialized();
try {
config.load();
} catch (ConfigurationException e) {
/* exit if there is a fatal exception loading the configuration */
if (isApplication) {
System.out.println(getMessage("RConfigurationError"));
System.exit(1);
}
}
isWebstartApplication = isApplication;
//Setting the system property for javawebstart's version.
//The version stored will be the same as java's version.
System.setProperty("javawebstart.version", "javaws-" +
System.getProperty("java.version"));
if (headless == false)
checkHeadless();
if (!headless && windowIcon == null)
loadWindowIcon();
if (!headless && indicator == null)
indicator = new DefaultDownloadIndicator();
if (handler == null)
handler = new DefaultLaunchHandler();
if (baseDir == null)
baseDir = getDefaultBaseDir();
if (baseDir == null)
throw new IllegalStateException(JNLPRuntime.getMessage("BNoBase"));
ServiceManager.setServiceManagerStub(new XServiceManagerStub()); // ignored if we're running under Web Start
policy = new JNLPPolicy();
security = new JNLPSecurityManager(); // side effect: create JWindow
try {
UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
} catch (Exception e) {
// ignore it
}
if (securityEnabled) {
Policy.setPolicy(policy); // do first b/c our SM blocks setPolicy
System.setSecurityManager(security);
}
securityDialogMessageHandler = startSecurityThreads();
initialized = true;
}
/**
* This must NOT be called form the application ThreadGroup. An application
* can inject events into its {@link EventQueue} and bypass the security
* dialogs.
*
* @return a {@link SecurityDialogMessageHandler} that can be used to post
* security messages
*/
private static SecurityDialogMessageHandler startSecurityThreads() {
ThreadGroup securityThreadGroup = new ThreadGroup("NetxSecurityThreadGroup");
SecurityDialogMessageHandler runner = new SecurityDialogMessageHandler();
Thread securityThread = new Thread(securityThreadGroup, runner, "NetxSecurityThread");
securityThread.setDaemon(true);
securityThread.start();
return runner;
}
/**
* Gets the Configuration associated with this runtime
* @return a {@link DeploymentConfiguration} object that can be queried to
* find relevant configuration settings
*/
public static DeploymentConfiguration getConfiguration() {
return config;
}
/**
* Returns true if a webstart application has been initialized, and false
* for a plugin applet.
*/
public static boolean isWebstartApplication() {
return isWebstartApplication;
}
/**
* Returns the window icon.
*/
public static Image getWindowIcon() {
return windowIcon;
}
/**
* Sets the window icon that is displayed in Java applications
* and applets instead of the default Java icon.
*
* @throws IllegalStateException if caller is not the exit class
*/
public static void setWindowIcon(Image image) {
checkExitClass();
windowIcon = image;
}
/**
* Returns whether the JNLP client will use any AWT/Swing
* components.
*/
public static boolean isHeadless() {
return headless;
}
/**
* Returns whether we are verifying code signing.
*/
public static boolean isVerifying() {
return verify;
}
/**
* Sets whether the JNLP client will use any AWT/Swing
* components. In headless mode, client features that use the
* AWT are disabled such that the client can be used in
* headless mode (
*
* @param enabled whether security should be enabled
* @throws IllegalStateException if the runtime is already initialized
*/
public static void setSecurityEnabled(boolean enabled) {
checkInitialized();
securityEnabled = enabled;
}
/**
*
* @return the {@link SecurityDialogMessageHandler} that should be used to
* post security dialog messages
*/
public static SecurityDialogMessageHandler getSecurityDialogHandler() {
SecurityManager sm = System.getSecurityManager();
if (sm != null) {
sm.checkPermission(new AllPermission());
}
return securityDialogMessageHandler;
}
/**
* Returns the system default base dir for or if not set,
* prompts the user for the location.
*
* @return the base dir, or null if the user canceled the dialog
* @throws IOException if there was an io exception
*/
public static File getDefaultBaseDir() {
PropertiesFile props = JNLPRuntime.getProperties();
String baseStr = props.getProperty("basedir");
if (baseStr != null)
return new File(baseStr);
String homeDir = HOME_DIR;
File baseDir = new File(NETX_DIR);
if (homeDir == null || (!baseDir.isDirectory() && !baseDir.mkdir()))
return null;
props.setProperty("basedir", baseDir.toString());
props.store();
return baseDir;
}
/**
* Set a class that can exit the JVM; if not set then any class
* can exit the JVM.
*
* @throws IllegalStateException if caller is not the exit class
*/
public static void setExitClass(Class exitClass) {
checkExitClass();
security.setExitClass(exitClass);
}
/**
* Disables applets from calling exit.
*
* Once disabled, exit cannot be re-enabled for the duration of the JVM instance
*/
public static void disableExit() {
security.disableExit();
}
/**
* Return the current Application, or null if none can be
* determined.
*/
public static ApplicationInstance getApplication() {
return security.getApplication();
}
/**
* Return a PropertiesFile object backed by the runtime's
* properties file.
*/
public static PropertiesFile getProperties() {
File netxrc = new File(NETXRC_FILE);
return new PropertiesFile(netxrc);
}
/**
* Return whether debug statements for the JNLP client code
* should be printed.
*/
public static boolean isDebug() {
return debug;
}
/**
* Sets whether debug statements for the JNLP client code
* should be printed to the standard output.
*
* @throws IllegalStateException if caller is not the exit class
*/
public static void setDebug(boolean enabled) {
checkExitClass();
debug = enabled;
}
/**
* Sets the default update policy.
*
* @throws IllegalStateException if caller is not the exit class
*/
public static void setDefaultUpdatePolicy(UpdatePolicy policy) {
checkExitClass();
updatePolicy = policy;
}
/**
* Returns the default update policy.
*/
public static UpdatePolicy getDefaultUpdatePolicy() {
return updatePolicy;
}
/**
* Sets the default launch handler.
*/
public static void setDefaultLaunchHandler(LaunchHandler handler) {
checkExitClass();
JNLPRuntime.handler = handler;
}
/**
* Returns the default launch handler.
*/
public static LaunchHandler getDefaultLaunchHandler() {
return handler;
}
/**
* Sets the default download indicator.
*
* @throws IllegalStateException if caller is not the exit class
*/
public static void setDefaultDownloadIndicator(DownloadIndicator indicator) {
checkExitClass();
JNLPRuntime.indicator = indicator;
}
/**
* Returns the default download indicator.
*/
public static DownloadIndicator getDefaultDownloadIndicator() {
return indicator;
}
/**
* Returns the localized resource string identified by the
* specified key. If the message is empty, a null is
* returned.
*/
public static String getMessage(String key) {
try {
String result = resources.getString(key);
if (result.length() == 0)
return null;
else
return result;
}
catch (Exception ex) {
if (!key.equals("RNoResource"))
return getMessage("RNoResource", new Object[] {key});
else
return "Missing resource: "+key;
}
}
/**
* Returns the localized resource string using the specified
* arguments.
*
* @param args the formatting arguments to the resource string
*/
public static String getMessage(String key, Object... args) {
return MessageFormat.format(getMessage(key), args);
}
/**
* Returns true if the current runtime will fork
*/
public static boolean getForksAllowed() {
return forksAllowed;
}
public static void setForksAllowed(boolean value) {
checkInitialized();
forksAllowed = value;
}
/**
* Throws an exception if called when the runtime is
* already initialized.
*/
private static void checkInitialized() {
if (initialized)
throw new IllegalStateException("JNLPRuntime already initialized.");
}
/**
* Throws an exception if called with security enabled but
* a caller is not the exit class and the runtime has been
* initialized.
*/
private static void checkExitClass() {
if (securityEnabled && initialized)
if (!security.isExitClass())
throw new IllegalStateException("Caller is not the exit class");
}
/**
* Check whether the VM is in headless mode.
*/
private static void checkHeadless() {
//if (GraphicsEnvironment.isHeadless()) // jdk1.4+ only
// headless = true;
try {
if ("true".equalsIgnoreCase(System.getProperty("java.awt.headless")))
headless = true;
}
catch (SecurityException ex) {
}
}
/**
* Load the resources.
*/
private static void loadResources() {
try {
resources = ResourceBundle.getBundle("net.sourceforge.jnlp.resources.Messages");
}
catch (Exception ex) {
throw new IllegalStateException("Missing resource bundle in netx.jar:net/sourceforge/jnlp/resource/Messages.properties");
}
}
/**
* Load the window icon.
*/
private static void loadWindowIcon() {
if (windowIcon != null)
return;
try {
windowIcon = new javax.swing.ImageIcon((new sun.misc.Launcher())
.getClassLoader().getResource("net/sourceforge/jnlp/resources/netx-icon.png")).getImage();
}
catch (Exception ex) {
if (JNLPRuntime.isDebug())
ex.printStackTrace();
}
}
public static void setInitialArgments(Listjava.awt.headless=true).
*
* @throws IllegalStateException if the runtime was previously initialized
*/
public static void setHeadless(boolean enabled) {
checkInitialized();
headless = enabled;
}
/**
* Sets whether we will verify code signing.
* @throws IllegalStateException if the runtime was previously initialized
*/
public static void setVerify(boolean enabled) {
checkInitialized();
verify = enabled;
}
/**
* Return the base directory containing the cache, persistence
* store, etc.
*/
public static File getBaseDir() {
return baseDir;
}
/**
* Sets the base directory containing the cache, persistence
* store, etc.
*
* @throws IllegalStateException if caller is not the exit class
*/
public static void setBaseDir(File baseDirectory) {
checkInitialized();
baseDir = baseDirectory;
}
/**
* Returns whether the secure runtime environment is enabled.
*/
public static boolean isSecurityEnabled() {
return securityEnabled;
}
/**
* Sets whether to enable the secure runtime environment.
* Disabling security can increase performance for some
* applications, and can be used to use netx with other code
* that uses its own security manager or policy.
*
* Disabling security is not recommended and should only be
* used if the JNLP files opened are trusted. This method can
* only be called before initalizing the runtime.