notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

svn commit: r1372 - in development/main/central/site/src/docs/products/transit: launcher properties

From: mcconnell AT netcompartner.com
To: notify-dpml AT lists.ibiblio.org
Subject: svn commit: r1372 - in development/main/central/site/src/docs/products/transit: launcher properties
Date: Tue, 04 Jan 2005 08:15:47 +0100

Author: mcconnell
Date: Tue Jan 4 08:15:47 2005
New Revision: 1372

Modified:
development/main/central/site/src/docs/products/transit/launcher/index.xml

development/main/central/site/src/docs/products/transit/properties/runtime.xml
Log:
Update the application launcher docs.

Modified:
development/main/central/site/src/docs/products/transit/launcher/index.xml
==============================================================================
---
development/main/central/site/src/docs/products/transit/launcher/index.xml
(original)
+++
development/main/central/site/src/docs/products/transit/launcher/index.xml
Tue Jan 4 08:15:47 2005
@@ -28,83 +28,159 @@
<section name="Transit Application Launcher">

<source>@METRO-PLUGIN-URI@</source>
- <subsection name="Environment variables">
+
+ <subsection name="Overview">
+
+ <p>
+ The application launcher is a plugin established by the Transit handler
+ that is responsible for the deployment of application plugins. The
+ launcher is responsible for low-level debug tracing, assignment of a
+ shutdown hook, the instantiation and deployment of a target
+ application, and a number of utility tasks.
+ </p>
+ <p>
+ The transit application launcher may be initialized via a command line
script
+ or through direct invocation with a java programe.
+ </p>
+ <p><i>CLI Usage example:</i></p>
+<source>$ transit [-load uri] [arg1 arg2 arg3 ...]</source>
+ </subsection>
+
+ <subsection name="Standard CLI Options">

<p>
+ The transit application launcher evaluates the supplied commandline
arguments
+ and processes only those arguments applicable to itself. Remaining
arguments
+ are forwarded on to the application that is the target of a launch
request.
+ </p>

+ <p>
+ The standard CLI Options recognized by the launcher are listed in
the following table.
+ </p>
<table>
<tr>
- <th>Property</th>
- <th>Default Value</th>
+ <th>Option</th>
+ <th width="170">Argument Type</th>
<th>Description</th>
</tr>
<tr>
- <td>DPML_HOME</td>
- <td>${user.home}/.dpml</td>
- <td>The DPML home directory</td>
+ <td>-debug</td>
+ <td>none</td>
+ <td>
+ Enable stacktrace and debug message reporting.
+ </td>
+ </tr>
+ <tr>
+ <td>-lang</td>
+ <td><code>language code</code></td>
+ <td>A two-letter language code to provide hooks for I18N.</td>
+ </tr>
+ 
+ <tr>
+ <td>-load</td>
+ <td>plugin uri</td>
+ <td>
+ Transit loads the (single) plugin from the supplied artifact
URI.
+ If the plugin is an instance of
<code>java.lang.Runnable</code>, it
+ will be started by the controller using the
<code>start()</code>
+ method. A shutdown hook is added to the newly loaded plugin
to
+ enable clean shutdown together with the transit instance.
+ <br/><br/>For example, Metro is started via:
+ <br/><code>transit -load
artifact:meta:dpml/metro/tools/dpml-metro-main#SNAPSHOT</code>
+ </td>
</tr>
</table>
- </p>
+
</subsection>
- <subsection name="CLI Options">
- <p>
- The CLI Options include both the setting of system properties using
the -Xfoo=bar method,
- and "real" command line options understood by the Transit system.
- <table>
+
+ <subsection name="-XOptions">
+
+ <p>Supplimentary CLI arguments that are processed by the launcher
include:</p>
+
+ <table>
<tr>
<th>Option</th>
- <th>Value</th>
<th>Description</th>
</tr>
<tr>
- <td>-lang</td>
- <td><code>language-code</code></td>
- <td>A two-letter language code to provide hooks for I18N.</td>
+ <td>-Xhelp</td>
+ <td>
+ Prints a help message on the available transit launcher plugin
CLI options
+ </td>
</tr>
<tr>
- <td>-debug</td>
- <td>none, is a switch</td>
+ <td>-Xversion</td>
<td>
- Enable stacktrace and debug message reporting.
+ Prints version information of the transit launcher plugin
version
</td>
</tr>
+ </table>
+
+ </subsection>
+
+ <subsection name="Deployment Model">
+
+ <p>Using information derived from system properties and command line
options, the
+ Transit Application Launcher will build up a map containing keys
and options
+ to be supplied as an optional constructor argument.</p>
+
+ <p>Constructor argument values populated by the launcher and
supplied to
+ the transit repository plugin handler are detailed in the
following table.</p>
+
+ <table>
<tr>
- <td>-Xhelp</td>
- <td>none, is a switch</td>
+ <th>Argument</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>Map</td>
<td>
- Prints a help message on the available transit plugin CLI
options
+ Will be supplied with the Transit context map.
</td>
</tr>
<tr>
- <td>-Xversion</td>
- <td>not activated</td>
+ <td>String[]</td>
<td>
- Prints version information of the transit plugin version
+ Will be supplied with the remaining command line arguments
following
+ removal of standard and -X cli options recognized by Transit.
</td>
</tr>
+ </table>
+
+ <p>Transit context map keys and values are detailed in the following
table.</p>
+
+ <table>
<tr>
- <td>-get [URI1, URI2, ...]</td>
- <td>none</td>
+ <th>Key</th>
+ <th>Value</th>
+ </tr>
+ <tr>
+ <td>urn:transit.debug.policy</td>
<td>
- downloads the supplied artifacts into the local cache
+ A Boolean value declaring the debug policy.
</td>
</tr>
<tr>
- <td>-load [URI] [arg1 arg2 ...]</td>
- <td></td>
+ <td>urn:transit.cli.args</td>
<td>
- Transit loads the (single) plugin from the supplied artifact
URI.
- If the plugin is an instance of
<code>java.lang.Runnable</code>, it will be started by the controller using
the <code>start()</code>
- method. The arguments after the URI specification are
forwarded to the plugin.
- A shutdown hook is added to the newly loaded plugin to
enable clean shutdown together with the transit instance.
- <br/>For instance, Metro is started via:
- <br/><code>transit -load
artifact:meta:dpml/metro/tools/dpml-metro-main#SNAPSHOT</code>
+ The non-processed cli arguments.
</td>
</tr>
</table>
- </p>
+
</subsection>
+
</section>
+
</body>
+
</document>

Modified:
development/main/central/site/src/docs/products/transit/properties/runtime.xml
==============================================================================
---
development/main/central/site/src/docs/products/transit/properties/runtime.xml
(original)
+++
development/main/central/site/src/docs/products/transit/properties/runtime.xml
Tue Jan 4 08:15:47 2005
@@ -35,10 +35,11 @@
Transit Main</a> handler class. This class looks for the
"dpml.transit.bootstrap.uri" system property and value corresponding
to
a uri of a bootstrap plugin that handles the deployment of
application
- plugins.
+ plugins (the bootstrap uri may be overriden with the -Xbootstrap cli
+ argument in command-line scenarios).
</p>

- <subsection name="Properties" >
+ <subsection name="Properties">
<table>
<tr>
<th>Property</th>
@@ -55,8 +56,11 @@
</tr>
</table>
</subsection>
+
</section>
+
</body>
+
</document>

svn commit: r1372 - in development/main/central/site/src/docs/products/transit: launcher properties, mcconnell, 01/04/2005