notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

r1928 - in trunk: central/site/src/docs/station central/site/src/docs/station/appliance central/site/src/docs/station/appliance/process central/site/src/docs/station/cli central/site/src/docs/station/concepts central/site/src/docs/station/plan main/metro/appliance/etc/xsds main/metro/station/etc/prefs/plans

From: mcconnell at BerliOS <mcconnell AT mail.berlios.de>
To: notify-dpml AT lists.ibiblio.org
Subject: r1928 - in trunk: central/site/src/docs/station central/site/src/docs/station/appliance central/site/src/docs/station/appliance/process central/site/src/docs/station/cli central/site/src/docs/station/concepts central/site/src/docs/station/plan main/metro/appliance/etc/xsds main/metro/station/etc/prefs/plans
Date: Sat, 24 Mar 2007 04:57:02 +0100

Author: mcconnell
Date: 2007-03-24 04:56:58 +0100 (Sat, 24 Mar 2007)
New Revision: 1928

Added:
trunk/central/site/src/docs/station/appliance/
trunk/central/site/src/docs/station/appliance/appliance.xml
trunk/central/site/src/docs/station/appliance/codebase.xml
trunk/central/site/src/docs/station/appliance/index.xml
trunk/central/site/src/docs/station/appliance/info.xml
trunk/central/site/src/docs/station/appliance/navigation.xml
trunk/central/site/src/docs/station/appliance/process/
trunk/central/site/src/docs/station/appliance/process/arg.xml
trunk/central/site/src/docs/station/appliance/process/arguments.xml
trunk/central/site/src/docs/station/appliance/process/environment.xml
trunk/central/site/src/docs/station/appliance/process/index.xml
trunk/central/site/src/docs/station/appliance/process/navigation.xml
trunk/central/site/src/docs/station/appliance/process/properties.xml
trunk/central/site/src/docs/station/appliance/process/property.xml
trunk/central/site/src/docs/station/appliance/process/variable.xml
trunk/central/site/src/docs/station/plan/
trunk/central/site/src/docs/station/plan/entry.xml
trunk/central/site/src/docs/station/plan/index.xml
trunk/central/site/src/docs/station/plan/navigation.xml
trunk/central/site/src/docs/station/plan/plan.xml
Removed:
trunk/central/site/src/docs/station/applications/
trunk/central/site/src/docs/station/profiles/
Modified:
trunk/central/site/src/docs/station/cli/index.xml
trunk/central/site/src/docs/station/cli/info.xml
trunk/central/site/src/docs/station/cli/navigation.xml
trunk/central/site/src/docs/station/concepts/index.xml
trunk/central/site/src/docs/station/index.xml
trunk/central/site/src/docs/station/navigation.xml
trunk/main/metro/appliance/etc/xsds/appliance.xsd
trunk/main/metro/station/etc/prefs/plans/default.plan
Log:
getting station documentation up-to-date

Added: trunk/central/site/src/docs/station/appliance/appliance.xml
===================================================================
--- trunk/central/site/src/docs/station/appliance/appliance.xml 2007-03-20
17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/appliance/appliance.xml 2007-03-24
03:56:58 UTC (rev 1928)
@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Station Appliance Descriptor</title>
+ </properties>
+
+ <body>
+
+ <section name="Appliance Descriptor">
+
+ <subsection name="Description">
+
+ <p>
+ Definition of a deployment scenario including the configuration of
+ the virtural machine and the codebase to be deployed in the machine.
+ </p>
+
+ </subsection>
+
+ <subsection name="Nested Elements">
+
+ <table>
+ <tr>
+ <td><tt><a href="info.html">info</a></tt></td>
+ <td>
+ Descripton of the appliance.
+ </td>
+ </tr>
+ <tr>
+ <td><tt><a href="process/index.html">process</a></tt></td>
+ <td>
+ Java virtual machine configuration.
+ </td>
+ </tr>
+ <tr>
+ <td><tt><a href="codebase.html">codebase</a></tt></td>
+ <td>
+ The application codebase to be deployed on the virtual machine.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
+

Added: trunk/central/site/src/docs/station/appliance/codebase.xml
===================================================================
--- trunk/central/site/src/docs/station/appliance/codebase.xml 2007-03-20
17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/appliance/codebase.xml 2007-03-24
03:56:58 UTC (rev 1928)
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Station Appliance Codebase Descriptor</title>
+ </properties>
+
+ <body>
+
+ <section name="Codebase Descriptor">
+
+ <subsection name="Description">
+
+ <p>
+ Declaration of an application codebase.
+ </p>
+
+ </subsection>
+
+ <subsection name="Attributes">
+ <table>
+ <tr>
+ <td><tt>uri</tt></td>
+ <td>The codebase uri.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
+

Added: trunk/central/site/src/docs/station/appliance/index.xml
===================================================================
--- trunk/central/site/src/docs/station/appliance/index.xml 2007-03-20
17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/appliance/index.xml 2007-03-24
03:56:58 UTC (rev 1928)
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Station Appliance Datatype</title>
+ </properties>
+
+ <body>
+
+ <section name="Appliance Datatype">
+
+ <p>
+ An appliance datatype defines the configuration to be used in the
establishment
+ of a Java Virtual Machine. An appliance datatype is an XML document
that contains a
+ root <a href="appliance.html">appliance</a> element. The appliance
element
+ contains an <a href="info.html">info</a> block, a defintion of the
configuration
+ of the virtual machine <a href="process/index.html">process</a>, and a
+ <a href="codebase.html">codebase</a> reference.
+ </p>
+
+ </section>
+
+ <section name="Examples">
+
+ <p>
+ The following sample appliance defines a virtual machine configuration
named
+ <tt>hello</tt>, a virtual machine configuratured with two environment
+ variables FOO and foo, and a codebase referencing a part defintion.
+ </p>
+
+<source><![CDATA[
+<?xml version="1.0"?>
+
+<appliance xmlns="dpml:appliance">
+
+ <info name="hello"/>
+
+ <process startup="0" shutdown="0">
+ <environment>
+ <variable name="FOO" value="BAR"/>
+ </environment>
+ <properties>
+ <property name="foo" value="bar"/>
+ </properties>
+ </process>
+
+ <codebase
uri="link:part:dpml/metro/dpml-metro-sample?message=Hello%20World&port=1024"/>
+
+</appliance>
+]]></source>
+ </section>
+ </body>
+
+</document>
+

Added: trunk/central/site/src/docs/station/appliance/info.xml
===================================================================
--- trunk/central/site/src/docs/station/appliance/info.xml 2007-03-20
17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/appliance/info.xml 2007-03-24
03:56:58 UTC (rev 1928)
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Station Appliance Datatype Info Descriptor</title>
+ </properties>
+
+ <body>
+
+ <section name="Info Descriptor">
+
+ <subsection name="Description">
+
+ <p>
+ Description of an appliance.
+ </p>
+
+ </subsection>
+
+ <subsection name="Attributes">
+ <table>
+ <tr>
+ <td><tt>name</tt></td>
+ <td>Short name identifying the appliance.</td>
+ </tr>
+ <tr>
+ <td><tt>title</tt></td>
+ <td>Short description of the appliance.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ <subsection name="Nested Elements">
+
+ <table>
+ <tr>
+ <td><tt>description</tt></td>
+ <td>
+ Nested text value containing a full textual description of the
appliance.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
+

Added: trunk/central/site/src/docs/station/appliance/navigation.xml
===================================================================
--- trunk/central/site/src/docs/station/appliance/navigation.xml
2007-03-20 17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/appliance/navigation.xml
2007-03-24 03:56:58 UTC (rev 1928)
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+
+
+<project>
+
+ <title>DPML Central</title>
+
+ <body>
+
+ <menu>
+ <item name="Appliance" href="appliance.html"/>
+ <item name="Info" href="info.html"/>
+ <item name="Process" href="process/index.html"/>
+ <item name="Codebase" href="codebase.html"/>
+ </menu>
+
+ </body>
+
+</project>

Added: trunk/central/site/src/docs/station/appliance/process/arg.xml
===================================================================
--- trunk/central/site/src/docs/station/appliance/process/arg.xml
2007-03-20 17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/appliance/process/arg.xml
2007-03-24 03:56:58 UTC (rev 1928)
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Station Virtual Machine Argument Value Descriptor</title>
+ </properties>
+
+ <body>
+
+ <section name="Virtual Machine Argument Value Descriptor">
+
+ <subsection name="Description">
+
+ <p>
+ Definition of a singl vitual machine argument.
+ </p>
+
+ </subsection>
+
+ <subsection name="Attributes">
+ <table>
+ <tr>
+ <td><tt>value</tt></td>
+ <td>The argument value.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
+

Added: trunk/central/site/src/docs/station/appliance/process/arguments.xml
===================================================================
--- trunk/central/site/src/docs/station/appliance/process/arguments.xml
2007-03-20 17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/appliance/process/arguments.xml
2007-03-24 03:56:58 UTC (rev 1928)
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Station Virtual Machine Arguments Descriptor</title>
+ </properties>
+
+ <body>
+
+ <section name="Virtual Machine Arguments Descriptor">
+
+ <subsection name="Description">
+
+ <p>
+ Definition of java virtual machine command aguments.
+ </p>
+
+ </subsection>
+
+ <subsection name="Nested Elements">
+
+ <table>
+ <tr>
+ <td><tt><a href="arg.html">arg</a></tt></td>
+ <td>
+ Declaration of an argument value.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+ </section>
+
+ </body>
+
+</document>
+

Added: trunk/central/site/src/docs/station/appliance/process/environment.xml
===================================================================
--- trunk/central/site/src/docs/station/appliance/process/environment.xml
2007-03-20 17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/appliance/process/environment.xml
2007-03-24 03:56:58 UTC (rev 1928)
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Station Vitual Machine Environment Descriptor</title>
+ </properties>
+
+ <body>
+
+ <section name="Vitual Machine Environment Descriptor">
+
+ <subsection name="Description">
+
+ <p>
+ Definition of zero or more environment variables to be declared
+ on creation of a new virtual machine.
+ </p>
+
+ </subsection>
+
+ <subsection name="Nested Elements">
+
+ <table>
+ <tr>
+ <td><tt><a href="variable.html">variable</a></tt></td>
+ <td>
+ Declaration of an environment variable name and value.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
+

Added: trunk/central/site/src/docs/station/appliance/process/index.xml
===================================================================
--- trunk/central/site/src/docs/station/appliance/process/index.xml
2007-03-20 17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/appliance/process/index.xml
2007-03-24 03:56:58 UTC (rev 1928)
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Station Appliance Virtual Machine Process Descriptor</title>
+ </properties>
+
+ <body>
+
+ <section name="Process Descriptor">
+
+ <subsection name="Description">
+
+ <p>
+ Definition of a virtual machine process.
+ </p>
+
+ </subsection>
+
+ <subsection name="Attributes">
+ <table>
+ <tr>
+ <td><tt>startup</tt></td>
+ <td>The startup timeout value. The default value is 0
(uncondition wait).</td>
+ </tr>
+ <tr>
+ <td><tt>shutdown</tt></td>
+ <td>The shutdown timeout value. The default value is 0
(uncondition wait).</td>
+ </tr>
+ <tr>
+ <td><tt>path</tt></td>
+ <td>An absolute or relative path defining the basedir for
deployment of the
+ Java Virtual Machine. The default value is the current
derectory
+ of the application executing the deployment process.</td>
+ </tr>
+ <tr>
+ <td><tt>executable</tt></td>
+ <td>AThe name of the executable to use for deployment. The
default value
+ is the <tt>metro</tt> application.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ <subsection name="Nested Elements">
+
+ <table>
+ <tr>
+ <td><tt><a href="environment.html">environment</a></tt></td>
+ <td>
+ Declaration of environment variable assertions to be applied to
the
+ virtual machine on creation.
+ </td>
+ </tr>
+ <tr>
+ <td><tt><a href="properties.html">properties</a></tt></td>
+ <td>
+ Zero or more system property assertions to be assigned to the
Java
+ Virtual Machine on creation.
+ </td>
+ </tr>
+ <tr>
+ <td><tt><a href="arguments.html">arguments</a></tt></td>
+ <td>
+ Zero or more command line arguments to be supplied to the
+ virtual machine on creation.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
+

Added: trunk/central/site/src/docs/station/appliance/process/navigation.xml
===================================================================
--- trunk/central/site/src/docs/station/appliance/process/navigation.xml
2007-03-20 17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/appliance/process/navigation.xml
2007-03-24 03:56:58 UTC (rev 1928)
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+
+
+<project>
+
+ <title>DPML Central</title>
+
+ <body>
+
+ <menu>
+ <item name="Environment" href="environment.html"/>
+ <item name="Properties" href="properties.html"/>
+ <item name="Arguments" href="arguments.html"/>
+ <item name="Property" href="property.html"/>
+ <item name="Variable" href="variable.html"/>
+ <item name="Arg" href="arg.html"/>
+ </menu>
+
+ </body>
+
+</project>

Added: trunk/central/site/src/docs/station/appliance/process/properties.xml
===================================================================
--- trunk/central/site/src/docs/station/appliance/process/properties.xml
2007-03-20 17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/appliance/process/properties.xml
2007-03-24 03:56:58 UTC (rev 1928)
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Station Vitural Machine Properties Descriptor</title>
+ </properties>
+
+ <body>
+
+ <section name="Vitural Machine Properties Descriptor">
+
+ <subsection name="Description">
+
+ <p>
+ Definition of the system properties to be supplied to the virtual
machine
+ on creation.
+ </p>
+
+ </subsection>
+
+ <subsection name="Nested Elements">
+
+ <table>
+ <tr>
+ <td><tt><a href="property.html">property</a></tt></td>
+ <td>
+ Declaration of system property assertions to be applied to the
+ virtual machine on creation.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
+

Added: trunk/central/site/src/docs/station/appliance/process/property.xml
===================================================================
--- trunk/central/site/src/docs/station/appliance/process/property.xml
2007-03-20 17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/appliance/process/property.xml
2007-03-24 03:56:58 UTC (rev 1928)
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Station System Property Descriptor</title>
+ </properties>
+
+ <body>
+
+ <section name="System Property Descriptor">
+
+ <subsection name="Description">
+
+ <p>
+ Definition of a system property name and value.
+ </p>
+
+ </subsection>
+
+ <subsection name="Attributes">
+ <table>
+ <tr>
+ <td><tt>name</tt></td>
+ <td>The system property name.</td>
+ </tr>
+ <tr>
+ <td><tt>value</tt></td>
+ <td>The system property value.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
+

Added: trunk/central/site/src/docs/station/appliance/process/variable.xml
===================================================================
--- trunk/central/site/src/docs/station/appliance/process/variable.xml
2007-03-20 17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/appliance/process/variable.xml
2007-03-24 03:56:58 UTC (rev 1928)
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Station Environment Variable Directive</title>
+ </properties>
+
+ <body>
+
+ <section name="Environment Variable Directive">
+
+ <subsection name="Description">
+
+ <p>
+ Definition of the name and value of a an environment variable.
+ </p>
+
+ </subsection>
+
+ <subsection name="Attributes">
+ <table>
+ <tr>
+ <td><tt>name</tt></td>
+ <td>The environment variable name.</td>
+ </tr>
+ <tr>
+ <td><tt>value</tt></td>
+ <td>The environment variable value.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
+

Modified: trunk/central/site/src/docs/station/cli/index.xml
===================================================================
--- trunk/central/site/src/docs/station/cli/index.xml 2007-03-20 17:35:28
UTC (rev 1927)
+++ trunk/central/site/src/docs/station/cli/index.xml 2007-03-24 03:56:58
UTC (rev 1928)
@@ -15,23 +15,46 @@

<p>
The station commandline handler provides support for the startup and
shutdown of
- the station as a background process, the addition, modification and
removal of
- application profiles, and the starting, stopping and restarting of
applications
- under dedicated virtual machines. In a production environment the
station would
- normally be setup as a background service (e.g. on Windows resources
are provided
- for the deployment of the Station as an NT service). During station
startup
- any application profile declaring a <tt>AUTOMATIC</tt> startup
policy will be
- deployed. Applications register themselves with the station
following which
- subsequent management operations invoked by the Station CLI are
mediated through
- the station server process.
+ a collection of background applications runing under dedicated
virtual machines.
+ In a production environment the station is normally setup as a
background service
+ (e.g. on Windows resources are provided for the deployment of the
Station as an
+ NT service). During station startup any application profile
declaring a
+ <tt>AUTOMATIC</tt> startup policy will be deployed. Applications
handled by the
+ station are declared under a station deployment plan.
</p>

</subsection>

<subsection name="Commandline">

-<pre><![CDATA[$ station startup | add <key> | set <key> | start <key> |
control <key>
-| stop <key> | restart <key> | info <key> | remove <key> | shutdown | help
+<pre><![CDATA[$ station -help
+
+ Description:
+
+ Process management controller.
+
+ Usage: $ station startup [<uri>] | info | shutdown | -help | -version
+
+ Common Options:
+
+ -help list command help and exit
+ -version list version info and exit
+ -port override the RMI Registry port value
+
+ Commands:
+
+ startup [<uri>] startup the station
+
+ <uri> uri referencing a plan datatype
+ if not supplied the default station deployment
+ plan (local:plan:dpml/station/default) will
+ be selected
+
+ -server enables server execution mode
+
+ info list station operational status and exit
+
+ shutdown shutdown the station
]]></pre>

</subsection>
@@ -41,74 +64,53 @@
<table>
<tr><td width="100">startup</td><td>Start the station server
(implying
starup of all applications with an AUTOMATIC startup
policy).</td></tr>
- <tr><td>add </td><td>Add a new application profile to the station
registry.</td></tr>
- <tr><td>set</td><td>Set of feature of an application.</td></tr>
- <tr><td>start</td><td>Start an application.</td></tr>
- <tr><td>control</td><td>Manage the component.</td></tr>
- <tr><td>stop</td><td>Stop an application.</td></tr>
- <tr><td>restart</td><td>Restart an application.</td></tr>
<tr><td>info</td><td>List information about registered
applications.</td></tr>
- <tr><td>remove</td><td>Remove an application from the
registry.</td></tr>
<tr><td>shutdown</td><td>Shutdown the station (implying shutdown
of all
applications under the control of the station).</td></tr>
</table>

</subsection>

- <subsection name="Example">
+ </section>
+
+ <section name="Examples">
+
+ <subsection name="Station Startup">
+
+ <p>
+ The following commandline demonstrates the startup of the station
using
+ the deployment profile declared under the default value
<tt>local:plan:dpml/station/default</tt>
+ (a plan defintion stored in the local DPML preferences directory).
+ </p>
+
+
+<pre>$ station startup
+[2380 ] [INFO ] (dpml.station): station startup
+[3196 ] [INFO ] (dpml.station): created local registry on port 1099
+[3196 ] [INFO ] (dpml.station.plan): commissioning plan
+[3196 ] [INFO ] (dpml.station.plan): plan commissioning complete
+[2380 ] [INFO ] (dpml.station): startup complete
+</pre>

-<pre>$ station help</pre>
-<source><![CDATA[
-Usage:
-station startup | add <key> | set <key> | start <key> | control <key>
-| stop <key> | restart <key> | info <key> | remove <key> | shutdown | help
-options
- startup
Startup the station.
- -port -registry
- -port <port> RMI
Registry port.
- -registry <artifact>
Application registry store.
- -D<property>=<value> Set
property values.
- add <key> Add a
profile.
- -uri -policy -dir -title -registry -startup -shutdown -config
- -uri <artifact>
Codebase uri.
- -policy <policy>
Startup policy.
- -D<property>=<value> Set
property values.
- -dir (-basedir) <path> Base
directory.
- -title <title>
Application title.
- -registry <artifact>
Application registry store.
- -startup <seconds>
Startup timeout.
- -shutdown <seconds>
Shutdown timeout.
- -config <uri>
Application configuration.
- set <key> Set an
application feature.
- -uri -policy -dir -title -registry -startup -shutdown -config
- -uri <artifact>
Codebase uri.
- -policy <policy>
Startup policy.
- -D<property>=<value> Set
property values.
- -dir (-basedir) <path> Base
directory.
- -title <title>
Application title.
- -registry <artifact>
Application registry store.
- -startup <seconds>
Startup timeout.
- -shutdown <seconds>
Shutdown timeout.
- -config <uri>
Application configuration.
- start <key> Start
application.
- control <key> Manage
the application.
- stop <key> Stop
application.
- restart <key>
Restart application.
- info <key>
Station or profile info.
- -port|-registry
- -port <port> RMI
Registry port.
- -registry <artifact>
Application registry store.
- remove <key> Remove
profile.
- -port|-registry
- -port <port> RMI
Registry port.
- -registry <artifact>
Application registry store.
- shutdown
Shutdown the station.
- help Print
command help.]]></source>
+ </subsection>
+
+ <subsection name="Station Startup">
+
+ <p>
+ Assuming a station instance is up and running, the following command
+ trigger the establishment of a connection to the remote station and
the
+ iniation of a shutdown sequence.
+ </p>
+
+<pre>$ station shutdown
+[3776 ] [INFO ] (dpml.station): initiating remote shutdown
+[3776 ] [INFO ] (dpml.station): remote shutdown request completed
+</pre>

</subsection>
-
+
</section>
-
+
</body>

</document>

Modified: trunk/central/site/src/docs/station/cli/info.xml
===================================================================
--- trunk/central/site/src/docs/station/cli/info.xml 2007-03-20 17:35:28
UTC (rev 1927)
+++ trunk/central/site/src/docs/station/cli/info.xml 2007-03-24 03:56:58
UTC (rev 1928)
@@ -55,28 +55,26 @@

<subsection name="Example - General Listing">

-<pre>$ station info</pre>
+<pre>$ station info

-<source>
- Server is operational.
+ <font color="blue">Server is operational.
Port: 1099
Store: local:xml:dpml/station/registry
Basedir: c:\dev\dpml\main
Codebase: artifact:jar:dpml/metro/dpml-station-server#SNAPSHOT

-Profile count: 1
+ Profile count: 1

- (1) demo STARTED link:part:dpml/planet/http/dpml-http-demo
-</source>
+ (1) demo STARTED link:part:dpml/planet/http/dpml-http-demo</font>
+</pre>

</subsection>

<subsection name="Example - Named Application Listing">

-<pre>$ station info demo</pre>
+<pre>$ station info demo

-<source>
- Server is operational.
+ <font color="blue">Server is operational.
Port: 1099
Store: local:xml:dpml/station/registry
Basedir: c:\dev\dpml\main
@@ -92,8 +90,8 @@
Process: [3452] (STARTED)
State: [started]
Transitions: (1)
- transition:stop (target=../stopped)
-</source>
+ transition:stop (target=../stopped)</font>
+</pre>

</subsection>

Modified: trunk/central/site/src/docs/station/cli/navigation.xml
===================================================================
--- trunk/central/site/src/docs/station/cli/navigation.xml 2007-03-20
17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/cli/navigation.xml 2007-03-24
03:56:58 UTC (rev 1928)
@@ -25,16 +25,18 @@
<body>

<menu>
+ <item name="Info" href="info.html"/>
<item name="Startup" href="startup.html"/>
+ <item name="Shutdown" href="shutdown.html"/>
+ 
</menu>

</body>

Modified: trunk/central/site/src/docs/station/concepts/index.xml
===================================================================
--- trunk/central/site/src/docs/station/concepts/index.xml 2007-03-20
17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/concepts/index.xml 2007-03-24
03:56:58 UTC (rev 1928)
@@ -12,26 +12,40 @@
<section name="DPML Station">

<p>
- The DPML Station is system supporting the maintenance of multiple
- applications. It is composed of an remotely accessible registry
- of <a href="../applications/index.html">applications</a> and a
- supporting <a href="../cli/index.html">commandline tool</a>.
- Applications are defined using network resolvable
- <a href="../profiles/index.html">profiles</a> that contain information
about
- the application environment, JVM settings, and application codebase.
+ The Metro Station is application that handles the deployment of
+ multiple applications.
</p>
-
- <p>
- Capabilities of the station include:
- </p>
-
- <ul>
- <li>Ability to run as a background process.</li>
- <li>Add, remove and update application profiles.</li>
- <li>Start, stop and restart registered applications.</li>
- <li>List information about running applications and/or profiles</li>
- </ul>
-
+
+ <subsection name="General Concepts">
+
+ <p>
+ The station configuration is defined in an XML document called a
<tt>plan</tt>.
+ A plan contains zero or more entries. Each entry defines deployment
+ objective such as the deployment of a component part into the
station
+ JVM or an application under a seperate jvm managed by the station.
+ </p>
+
+ <ol>
+
+ <li>
+ A <a href="../plan/index.html">plan</a> is a uri resolvable
+ artifact that defines the station configuration.
+ </li>
+
+ <li>
+ A <a href="../cli/index.html">commandline tool</a> provides
support
+ for the startup and shutdown of the station.
+ </li>
+
+ <li>
+ An <a href="../scm.html">SCM</a> controller is provider for the
+ deployment of the station as a Windows NT Service.
+ </li>
+
+ </ol>
+
+ </subsection>
+
</section>

</body>

Modified: trunk/central/site/src/docs/station/index.xml
===================================================================
--- trunk/central/site/src/docs/station/index.xml 2007-03-20 17:35:28
UTC (rev 1927)
+++ trunk/central/site/src/docs/station/index.xml 2007-03-24 03:56:58
UTC (rev 1928)
@@ -11,27 +11,7 @@

<section name="DPML Station">

- <p>
- The Metro Station is system supporting the maintenance of multiple
- applications. It is composed of an remotely accessible registry
- of <a href="applications/index.html">applications</a> and a
- supporting <a href="cli/index.html">commandline tool</a>.
- Applications are defined using network resolvable
- <a href="profiles/index.html">profiles</a> that contain information
about
- the application environment, JVM settings, and application codebase.
- </p>

- <p>
- Capabilities of the station include:
- </p>
-
- <ul>
- <li>Ability to run as a background process.</li>
- <li>Add, remove and update application profiles.</li>
- <li>Start, stop and restart registered applications.</li>
- <li>List information about running applications and/or profiles</li>
- </ul>
-
</section>

</body>

Modified: trunk/central/site/src/docs/station/navigation.xml
===================================================================
--- trunk/central/site/src/docs/station/navigation.xml 2007-03-20 17:35:28
UTC (rev 1927)
+++ trunk/central/site/src/docs/station/navigation.xml 2007-03-24 03:56:58
UTC (rev 1928)
@@ -26,8 +26,8 @@

<menu>
<item name="Overview" href="concepts/index.html"/>
- <item name="Profiles" href="profiles/index.html"/>
- <item name="Applications" href="applications/index.html"/>
+ <item name="Plan Datatype" href="plan/index.html"/>
+ <item name="Appliance Datatype" href="appliance/index.html"/>
<item name="CLI" href="cli/index.html"/>
<item name="SCM" href="scm.html"/>
</menu>

Added: trunk/central/site/src/docs/station/plan/entry.xml
===================================================================
--- trunk/central/site/src/docs/station/plan/entry.xml 2007-03-20 17:35:28
UTC (rev 1927)
+++ trunk/central/site/src/docs/station/plan/entry.xml 2007-03-24 03:56:58
UTC (rev 1928)
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Station Deployment Plan Entry Directive</title>
+ </properties>
+
+ <body>
+
+ <section name="Entry Directive">
+
+ <subsection name="Description">
+
+ <p>
+ Definition of a deployment entry.
+ </p>
+
+ </subsection>
+
+ <subsection name="Attributes">
+ <table>
+ <tr>
+ <td><tt>key</tt></td>
+ <td>A unique key identitying the deployment entry.</td>
+ </tr>
+ <tr>
+ <td><tt>uri</tt></td>
+ <td>A uri identifying a <tt>part</tt> or <tt>appliance</tt>
datatype.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
+

Added: trunk/central/site/src/docs/station/plan/index.xml
===================================================================
--- trunk/central/site/src/docs/station/plan/index.xml 2007-03-20 17:35:28
UTC (rev 1927)
+++ trunk/central/site/src/docs/station/plan/index.xml 2007-03-24 03:56:58
UTC (rev 1928)
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Station Application Profiles</title>
+ </properties>
+
+ <body>
+
+ <section name="Deployment Plans">
+
+ <p>
+ A deployment plan is an XML document referenced as an artificat that
+ defines the configuration of a station instance. The plan datatype
+ declares a root <a href="plan.html"><tt><plan></tt></a> element
+ which contains zero or more <a
href="entry.html"><tt><entry></tt></a>
+ elements where each entry associates a key with a codebase uri.
+ A plan is referenced as an artifact using the <a
href="../cli/index.html">
+ station</a> command line tool.
+ </p>
+
+ <subsection name="Executing a Plan">
+
+ <p>
+ The following command starts the station using plan stored in the
+ users preference directory:
+ </p>
+
+ <pre>$ station startup <font
color="darkred">local:plan:org/acme/sample</font></pre>
+
+ </subsection>
+
+ </section>
+
+ <section name="Examples">
+
+ <p>
+ The following example plan includes three deployment entries. The
first two entries
+ reference <a href="../appliance/index.html">appliance</a> datatypes
which trigger the
+ establishment of the respective applications in their own JVMs. The
third entry is a
+ <a href="../../metro/parts/index.html">part</a> datatype to be loaded
into the current
+ virtual machine.
+ </p>
+
+<source><plan xmlns="dpml:plan" name="demo" title="Plan Demo">
+
+ <entry key="foo" uri="link:appliance:dpml/metro/demo-foo"/>
+ <entry key="bar" uri="link:appliance:dpml/metro/demo-bar"/>
+ <entry key="toto"
uri="link:part:dpml/metro/dpml-metro-sample?message=Hello%20World&port=1024"/>
+
+</plan>
+</source>
+
+ </section>
+
+ </body>
+
+</document>
+

Added: trunk/central/site/src/docs/station/plan/navigation.xml
===================================================================
--- trunk/central/site/src/docs/station/plan/navigation.xml 2007-03-20
17:35:28 UTC (rev 1927)
+++ trunk/central/site/src/docs/station/plan/navigation.xml 2007-03-24
03:56:58 UTC (rev 1928)
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+
+
+<project>
+
+ <title>DPML Central</title>
+
+ <body>
+
+ <menu>
+ <item name="Plan" href="plan.html"/>
+ <item name="Entry" href="entry.html"/>
+ </menu>
+
+ </body>
+
+</project>

Added: trunk/central/site/src/docs/station/plan/plan.xml
===================================================================
--- trunk/central/site/src/docs/station/plan/plan.xml 2007-03-20 17:35:28
UTC (rev 1927)
+++ trunk/central/site/src/docs/station/plan/plan.xml 2007-03-24 03:56:58
UTC (rev 1928)
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Station Application Profiles</title>
+ </properties>
+
+ <body>
+
+ <section name="Plan Directive">
+
+ <subsection name="Description">
+
+ <p>
+ Definition of a series of zero or deployment entries.
+ </p>
+
+ </subsection>
+
+ <subsection name="Attributes">
+ <table>
+ <tr>
+ <td><tt>name</tt></td>
+ <td>Short name identifying the plan.</td>
+ </tr>
+ <tr>
+ <td><tt>title</tt></td>
+ <td>Descriptive type of the plan.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ <subsection name="Nested Elements">
+
+ <table>
+ <tr>
+ <td><tt><a href="entry.html">entry</a></tt></td>
+ <td>
+ Declaration of a deployment entry. Zero or more entry elements
+ may be declared. Entries will be deployed sequentially.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
+

Modified: trunk/main/metro/appliance/etc/xsds/appliance.xsd
===================================================================
--- trunk/main/metro/appliance/etc/xsds/appliance.xsd 2007-03-20 17:35:28
UTC (rev 1927)
+++ trunk/main/metro/appliance/etc/xsds/appliance.xsd 2007-03-24 03:56:58
UTC (rev 1928)
@@ -5,7 +5,7 @@

Example:

- <application title="Sample Application" policy="automatic">
+ <appliance>

<process startup="60" shutdown="60">
<properties>
@@ -13,11 +13,9 @@
</properties>
</process>

- <codebase uri="link:part:acme/widget">
- <param class="java.awt.Color" method="RED"/>
- </codebase>
+ <codebase uri="link:part:acme/widget"/>

- </application>
+ </appliance>

-->

Modified: trunk/main/metro/station/etc/prefs/plans/default.plan
===================================================================
--- trunk/main/metro/station/etc/prefs/plans/default.plan 2007-03-20
17:35:28 UTC (rev 1927)
+++ trunk/main/metro/station/etc/prefs/plans/default.plan 2007-03-24
03:56:58 UTC (rev 1928)
@@ -1,5 +1,29 @@
<?xml version="1.0"?>

-<plan xmlns="dpml:plan" name="station" title="DPML Station Default
Deployment Plan">
+
+
+<plan xmlns="dpml:plan" name="station" title="DPML Station Deployment Plan">
+
+ 
+
</plan>

r1928 - in trunk: central/site/src/docs/station central/site/src/docs/station/appliance central/site/src/docs/station/appliance/process central/site/src/docs/station/cli central/site/src/docs/station/concepts central/site/src/docs/station/plan main/metro/appliance/etc/xsds main/metro/station/etc/prefs/plans, mcconnell at BerliOS, 03/23/2007