IcedTea-Web
NetX

net.sourceforge.jnlp
Class Launcher

java.lang.Object
  extended by net.sourceforge.jnlp.Launcher

public class Launcher
extends java.lang.Object

Launches JNLPFiles either in the foreground or background.

An optional LaunchHandler can be specified that is notified of warning and error condition while launching and that indicates whether a launch may proceed after a warning has occurred. If specified, the LaunchHandler is notified regardless of whether the file is launched in the foreground or background.


Constructor Summary
Launcher()
          Create a launcher with the runtime's default update policy and launch handler.
Launcher(boolean exitOnFailure)
          Create a launcher with the runtime's default update policy and launch handler.
Launcher(LaunchHandler handler)
          Create a launcher with the specified handler and the runtime's default update policy.
Launcher(LaunchHandler handler, UpdatePolicy policy)
          Create a launcher with an optional handler using the specified update policy and launch handler.
 
Method Summary
protected  AppletInstance createApplet(JNLPFile file, boolean enableCodeBase, java.awt.Container cont)
          Create an AppletInstance.
protected  java.applet.Applet createAppletObject(JNLPFile file, boolean enableCodeBase, java.awt.Container cont)
          Creates an Applet object from a JNLPFile.
protected  ApplicationInstance createApplication(JNLPFile file)
          Creates an Application.
protected  AppThreadGroup createThreadGroup(JNLPFile file)
          Create a thread group for the JNLP file.
protected  ApplicationInstance getApplet(JNLPFile file, boolean enableCodeBase, java.awt.Container cont)
          Gets an ApplicationInstance, but does not launch the applet.
 UpdatePolicy getUpdatePolicy()
          Returns the update policy used when launching applications.
 boolean isCreateAppContext()
          Returns whether applications are launched in their own AppContext.
 ApplicationInstance launch(JNLPFile file)
          Launches a JNLP file by calling the launch method for the appropriate file type.
 ApplicationInstance launch(JNLPFile file, java.awt.Container cont)
          Launches a JNLP file inside the given container if it is an applet.
 ApplicationInstance launch(java.net.URL location)
          Launches a JNLP file by calling the launch method for the appropriate file type.
 ApplicationInstance launch(java.net.URL location, boolean fromSource)
          Launches a JNLP file by calling the launch method for the appropriate file type.
protected  ApplicationInstance launchApplet(JNLPFile file, boolean enableCodeBase, java.awt.Container cont)
          Launches a JNLP applet.
protected  ApplicationInstance launchApplication(JNLPFile file)
          Launches a JNLP application.
 void launchBackground(JNLPFile file)
          Launches a JNLP file by calling the launch method for the appropriate file type in a different thread.
 void launchBackground(java.net.URL location)
          Launches the JNLP file at the specified location in the background by calling the launch method for its file type.
 void launchExternal(java.util.List<java.lang.String> vmArgs, JNLPFile file, java.util.List<java.lang.String> javawsArgs)
          Launches the JNLP file in a new JVM instance.
 void launchExternal(java.util.List<java.lang.String> vmArgs, java.util.List<java.lang.String> javawsArgs)
          Launches the JNLP file at the specified location in a new JVM instance.
 void launchExternal(java.net.URL url)
          Launches the JNLP file in a new JVM instance.
protected  ApplicationInstance launchInstaller(JNLPFile file)
          Launches a JNLP installer.
 void setCreateAppContext(boolean context)
          Sets whether to launch the application in a new AppContext (a separate event queue, look and feel, etc).
 void setInformationToMerge(java.util.Map<java.lang.String,java.lang.String[]> input)
          Set a map to use when trying to extract extra information, including arguments, properties and parameters, to be merged into the main JNLP
 void setParserSettings(ParserSettings settings)
          Set the parser settings to use when the Launcher initiates parsing of a JNLP file.
 void setUpdatePolicy(UpdatePolicy policy)
          Sets the update policy used by launched applications.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Launcher

public Launcher()
Create a launcher with the runtime's default update policy and launch handler.


Launcher

public Launcher(boolean exitOnFailure)
Create a launcher with the runtime's default update policy and launch handler.

Parameters:
exitOnFailure - Exit if there is an error (usually default, but false when being used from the plugin)

Launcher

public Launcher(LaunchHandler handler)
Create a launcher with the specified handler and the runtime's default update policy.

Parameters:
handler - the handler to use or null for no handler.

Launcher

public Launcher(LaunchHandler handler,
                UpdatePolicy policy)
Create a launcher with an optional handler using the specified update policy and launch handler.

Parameters:
handler - the handler to use or null for no handler.
policy - the update policy to use or null for default policy.
Method Detail

setUpdatePolicy

public void setUpdatePolicy(UpdatePolicy policy)
Sets the update policy used by launched applications.


getUpdatePolicy

public UpdatePolicy getUpdatePolicy()
Returns the update policy used when launching applications.


setCreateAppContext

public void setCreateAppContext(boolean context)
Sets whether to launch the application in a new AppContext (a separate event queue, look and feel, etc). If the sun.awt.SunToolkit class is not present then this method has no effect. The default value is true.


isCreateAppContext

public boolean isCreateAppContext()
Returns whether applications are launched in their own AppContext.


setParserSettings

public void setParserSettings(ParserSettings settings)
Set the parser settings to use when the Launcher initiates parsing of a JNLP file.

Parameters:
settings -

setInformationToMerge

public void setInformationToMerge(java.util.Map<java.lang.String,java.lang.String[]> input)
Set a map to use when trying to extract extra information, including arguments, properties and parameters, to be merged into the main JNLP

Parameters:
input - a map containing extra information to add to the main JNLP. the values for keys "arguments", "parameters", and "properties" are used.

launch

public ApplicationInstance launch(JNLPFile file)
                           throws LaunchException
Launches a JNLP file by calling the launch method for the appropriate file type. The application will be started in a new window.

Parameters:
file - the JNLP file to launch
Returns:
the application instance
Throws:
LaunchException - if an error occurred while launching (also sent to handler)

launch

public ApplicationInstance launch(JNLPFile file,
                                  java.awt.Container cont)
                           throws LaunchException
Launches a JNLP file inside the given container if it is an applet. Specifying a container has no effect for Applcations and Installers.

Parameters:
file - the JNLP file to launch
cont - the container in which to place the application, if it is an applet
Returns:
the application instance
Throws:
LaunchException - if an error occurred while launching (also sent to handler)

launch

public ApplicationInstance launch(java.net.URL location)
                           throws LaunchException
Launches a JNLP file by calling the launch method for the appropriate file type.

Parameters:
location - the URL of the JNLP file to launch
Returns:
the application instance
Throws:
LaunchException - if there was an exception

launch

public ApplicationInstance launch(java.net.URL location,
                                  boolean fromSource)
                           throws LaunchException
Launches a JNLP file by calling the launch method for the appropriate file type.

Parameters:
location - the URL of the JNLP file to launch
fromSource - if true, the JNLP file will be re-read from the source location to get the pristine version
Returns:
the application instance
Throws:
LaunchException - if there was an exception

launchBackground

public void launchBackground(JNLPFile file)
Launches a JNLP file by calling the launch method for the appropriate file type in a different thread.

Parameters:
file - the JNLP file to launch

launchBackground

public void launchBackground(java.net.URL location)
Launches the JNLP file at the specified location in the background by calling the launch method for its file type.

Parameters:
location - the location of the JNLP file

launchExternal

public void launchExternal(java.util.List<java.lang.String> vmArgs,
                           JNLPFile file,
                           java.util.List<java.lang.String> javawsArgs)
                    throws LaunchException
Launches the JNLP file in a new JVM instance. The launched application's output is sent to the system out and it's standard input channel is closed.

Parameters:
vmArgs - the arguments to pass to the new JVM. Can be empty but must not be null.
file - the JNLP file to launch
javawsArgs - the arguments to pass to the javaws command. Can be an empty list but must not be null.
Throws:
LaunchException - if there was an exception

launchExternal

public void launchExternal(java.net.URL url)
                    throws LaunchException
Launches the JNLP file in a new JVM instance. The launched application's output is sent to the system out and it's standard input channel is closed.

Parameters:
url - the URL of the JNLP file to launch
Throws:
LaunchException - if there was an exception

launchExternal

public void launchExternal(java.util.List<java.lang.String> vmArgs,
                           java.util.List<java.lang.String> javawsArgs)
                    throws LaunchException
Launches the JNLP file at the specified location in a new JVM instance. The launched application's output is sent to the system out and it's standard input channel is closed.

Parameters:
vmArgs - the arguments to pass to the jvm
javawsArgs - the arguments to pass to javaws (aka Netx)
Throws:
LaunchException - if there was an exception

launchApplication

protected ApplicationInstance launchApplication(JNLPFile file)
                                         throws LaunchException
Launches a JNLP application. This method should be called from a thread in the application's thread group.

Throws:
LaunchException

launchApplet

protected ApplicationInstance launchApplet(JNLPFile file,
                                           boolean enableCodeBase,
                                           java.awt.Container cont)
                                    throws LaunchException
Launches a JNLP applet. This method should be called from a thread in the application's thread group.

The enableCodeBase parameter adds the applet's codebase to the locations searched for resources and classes. This can slow down the applet loading but allows browser-style applets that don't use JAR files exclusively to be run from a applet JNLP file. If the applet JNLP file does not specify any resources then the code base will be enabled regardless of the specified value.

Parameters:
file - the JNLP file
enableCodeBase - whether to add the codebase URL to the classloader
Throws:
LaunchException

getApplet

protected ApplicationInstance getApplet(JNLPFile file,
                                        boolean enableCodeBase,
                                        java.awt.Container cont)
                                 throws LaunchException
Gets an ApplicationInstance, but does not launch the applet.

Throws:
LaunchException

launchInstaller

protected ApplicationInstance launchInstaller(JNLPFile file)
                                       throws LaunchException
Launches a JNLP installer. This method should be called from a thread in the application's thread group.

Throws:
LaunchException

createApplet

protected AppletInstance createApplet(JNLPFile file,
                                      boolean enableCodeBase,
                                      java.awt.Container cont)
                               throws LaunchException
Create an AppletInstance.

Parameters:
enableCodeBase - whether to add the code base URL to the classloader
Throws:
LaunchException

createAppletObject

protected java.applet.Applet createAppletObject(JNLPFile file,
                                                boolean enableCodeBase,
                                                java.awt.Container cont)
                                         throws LaunchException
Creates an Applet object from a JNLPFile. This is mainly to be used with gcjwebplugin.

Parameters:
file - the PluginBridge to be used.
enableCodeBase - whether to add the code base URL to the classloader.
Throws:
LaunchException

createApplication

protected ApplicationInstance createApplication(JNLPFile file)
                                         throws LaunchException
Creates an Application.

Throws:
LaunchException

createThreadGroup

protected AppThreadGroup createThreadGroup(JNLPFile file)
Create a thread group for the JNLP file. Note: if the JNLPFile is an applet (ie it is a subclass of PluginBridge) then this method simply returns the existing ThreadGroup. The applet ThreadGroup has to be created at an earlier point in the applet code.


IcedTea-Web
NetX

Submit a bug or feature