notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

r1929 - in trunk: central/site/src/docs/station/cli main/metro/station/src/main/dpml/station/console

From: mcconnell at BerliOS <mcconnell AT mail.berlios.de>
To: notify-dpml AT lists.ibiblio.org
Subject: r1929 - in trunk: central/site/src/docs/station/cli main/metro/station/src/main/dpml/station/console
Date: Sat, 24 Mar 2007 06:28:56 +0100

Author: mcconnell
Date: 2007-03-24 06:28:56 +0100 (Sat, 24 Mar 2007)
New Revision: 1929

Added:
trunk/central/site/src/docs/station/cli/server.xml
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/cli/startup.xml
trunk/main/metro/station/src/main/dpml/station/console/Main.java
Log:
more station docs

Modified: trunk/central/site/src/docs/station/cli/index.xml
===================================================================
--- trunk/central/site/src/docs/station/cli/index.xml 2007-03-24 03:56:58
UTC (rev 1928)
+++ trunk/central/site/src/docs/station/cli/index.xml 2007-03-24 05:28:56
UTC (rev 1929)
@@ -18,55 +18,61 @@
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.
+ NT service). Applications handled by the station are declared under
a station
+ <a href="../plan/index.html">deployment plan</a>.
</p>

</subsection>

<subsection name="Commandline">

-<pre><![CDATA[$ station -help
+<pre>$ station startup | server | info | shutdown | -help | -version</pre>

- Description:
+ </subsection>

- Process management controller.
+ <subsection name="Options">

- Usage: $ station startup [<uri>] | info | shutdown | -help | -version
+ <table>
+ <tr>
+ <td width="100">-help</td>
+ <td>
+ List help information and exit.
+ </td>
+ </tr>
+ <tr>
+ <td width="100">-version</td>
+ <td>
+ List version information and exit.
+ </td>
+ </tr>
+ </table>

- 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>

<subsection name="Commands">

<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>info</td><td>List information about registered
applications.</td></tr>
- <tr><td>shutdown</td><td>Shutdown the station (implying shutdown
of all
- applications under the control of the station).</td></tr>
+ <tr>
+ <td width="100"><tt><a href="startup.html">startup</a></tt></td>
+ <td>
+ Start the station server as a background process.
+ </td>
+ </tr>
+ <tr>
+ <td width="100"><tt><a href="server.html">server</a></tt></td>
+ <td>
+ Start the station server as a foreground process.
+ </td>
+ </tr>
+ <tr>
+ <td><tt><a href="info.html">info</a></tt></td>
+ <td>List information about registered applications.</td>
+ </tr>
+ <tr>
+ <td><tt><a href="shutdown.html">shutdown</a></tt></td>
+ <td>Shutdown the station (implying shutdown of all
+ applications under the control of the station).</td>
+ </tr>
</table>

</subsection>

Modified: trunk/central/site/src/docs/station/cli/info.xml
===================================================================
--- trunk/central/site/src/docs/station/cli/info.xml 2007-03-24 03:56:58
UTC (rev 1928)
+++ trunk/central/site/src/docs/station/cli/info.xml 2007-03-24 05:28:56
UTC (rev 1929)
@@ -15,40 +15,23 @@

<p>
The info command provides support for listing information from
- the station registry, and if the server is active - information
- about the status of registered applications. If the
<tt><key></tt>
- argument is supplied then information about the process will be
- listed, otherwise a general listing of registered processes will
- included.
+ the station configuration.
</p>

</subsection>

<subsection name="Commandline">

-<pre><![CDATA[$ station info [<key>]]]></pre>
+<pre><![CDATA[$ station info]]></pre>

</subsection>

- <subsection name="Parameters">
-
- <table>
- <tr><td width="100"><tt><key></tt></td><td>The application
key (optional).</td></tr>
- </table>
-
- </subsection>
-
<subsection name="Options">

<table>
<tr>
<td width="100"><tt>-port</tt></td>
- <td>Override the RMI registry port to use when selecting the
station server
- (cannot be used in conjuction with the <tt>-registry</tt>
option).</td></tr>
- <tr>
- <td width="100"><tt>-registry</tt></td>
- <td>Override the application repository storage uri
- (cannot be used in conjuction with the <tt>-port</tt>
option).</td></tr>
+ <td>Override the RMI registry port to use when selecting the
station server.</td></tr>
</table>

</subsection>
@@ -70,31 +53,6 @@

</subsection>

- <subsection name="Example - Named Application Listing">
-
-<pre>$ station info demo
-
- <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
-
- Codebase: link:part:dpml/planet/http/dpml-http-demo
- Working Directory Path: ${dpml.data}/work
- Startup Timeout: 6
- Shutdown Timeout: 6
- Startup Policy: MANUAL
- System Properties: 1
-
- Process: [3452] (STARTED)
- State: [started]
- Transitions: (1)
- transition:stop (target=../stopped)</font>
-</pre>
-
- </subsection>
-
</section>

</body>

Modified: trunk/central/site/src/docs/station/cli/navigation.xml
===================================================================
--- trunk/central/site/src/docs/station/cli/navigation.xml 2007-03-24
03:56:58 UTC (rev 1928)
+++ trunk/central/site/src/docs/station/cli/navigation.xml 2007-03-24
05:28:56 UTC (rev 1929)
@@ -26,17 +26,9 @@

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

</body>

Added: trunk/central/site/src/docs/station/cli/server.xml
===================================================================
--- trunk/central/site/src/docs/station/cli/server.xml 2007-03-24 03:56:58
UTC (rev 1928)
+++ trunk/central/site/src/docs/station/cli/server.xml 2007-03-24 05:28:56
UTC (rev 1929)
@@ -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 Startup Command</title>
+ </properties>
+
+ <body>
+
+ <section name="Startup Command">
+
+ <subsection name="Description">
+
+ <p>
+ Initiates the startup of the station as a foreground process
(suitable for
+ debuging and other development related processes). The station will
register
+ itself with an RMI registry . An application plan is retrieved and
loaded.
+ Application entries declared withing the plan are used to construct
runtime
+ application instances.
+ </p>
+
+ </subsection>
+
+ <subsection name="Commandline">
+
+<pre>$ station server [-port <port>] [<uri>]</pre>
+
+ </subsection>
+
+ <subsection name="Options">
+
+ <table>
+ <tr><td width="100">-port</td><td>Optional override of the default
RMI registry port (1099).</td></tr>
+ </table>
+
+ </subsection>
+
+ <subsection name="Arguments">
+
+ <table>
+ <tr><td width="100"><uri></td><td>Overide the default plan
uri.</td></tr>
+ </table>
+
+ </subsection>
+
+ <subsection name="Example">
+
+<pre>$ station server</pre>
+
+<source>[5096 ] [INFO ] (depot.station): Station started on port:
1099</source>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
+

Modified: trunk/central/site/src/docs/station/cli/startup.xml
===================================================================
--- trunk/central/site/src/docs/station/cli/startup.xml 2007-03-24 03:56:58
UTC (rev 1928)
+++ trunk/central/site/src/docs/station/cli/startup.xml 2007-03-24 05:28:56
UTC (rev 1929)
@@ -25,7 +25,7 @@

<subsection name="Commandline">

-<pre><![CDATA[$ station startup [-port <port>] [-registry
<artifact>]]]></pre>
+<pre><![CDATA[$ station startup [-port <port>] [<uri>]]]></pre>

</subsection>

@@ -33,13 +33,19 @@

<table>
<tr><td width="100">-port</td><td>Optional override of the default
RMI registry port (1099).</td></tr>
- <tr><td>-registry</td><td>Optional overrride of the persistent
storage registry using
- to establish initial state process state and hold subsequent
modifications. The
- default registry storage is
<tt>local:xml:dpml/station/registry</tt>.</td></tr>
</table>

</subsection>

+ <subsection name="Arguments">
+
+ <table>
+ <tr><td width="100"><uri></td><td>Overide the default plan
uri.</td></tr>
+ </table>
+
+ </subsection>
+
+
<subsection name="Example">

<pre>$ station startup</pre>

Modified: trunk/main/metro/station/src/main/dpml/station/console/Main.java
===================================================================
--- trunk/main/metro/station/src/main/dpml/station/console/Main.java
2007-03-24 03:56:58 UTC (rev 1928)
+++ trunk/main/metro/station/src/main/dpml/station/console/Main.java
2007-03-24 05:28:56 UTC (rev 1929)
@@ -683,6 +683,7 @@
buffer.append( "\n" );
buffer.append( "\n DPML Station" );
buffer.append( "\n Version @PROJECT-VERSION@" );
+ buffer.append( "\n Codebase " +
getClass().getProtectionDomain().getCodeSource().getLocation() );
buffer.append( "\n Copyright 2005-2007 Stephen J. McConnell" );
buffer.append( "\n Digital Product Management Laboratory" );
String message = buffer.toString();
@@ -697,30 +698,38 @@
buffer.append( "\n" );
buffer.append( "\n Process management controller." );
buffer.append( "\n" );
- buffer.append( "\n Usage: $ station startup [<uri>] | info |
shutdown | -help | -version" );
+ buffer.append( "\n Usage: $ station startup | server | shutdown |
info | -help | -version" );
buffer.append( "\n" );
- buffer.append( "\n Common Options:" );
+ buffer.append( "\n Options:" );
buffer.append( "\n" );
buffer.append( "\n -help list command help and exit"
);
buffer.append( "\n -version list version info and exit"
);
- buffer.append( "\n -port override the RMI Registry
port value" );
buffer.append( "\n" );
buffer.append( "\n Commands:" );
buffer.append( "\n" );
- buffer.append( "\n startup [<uri>] startup the station" );
+ buffer.append( "\n startup [<uri>] startup the station as a
background process" );
buffer.append( "\n" );
buffer.append( "\n <uri> uri referencing a plan
datatype" );
buffer.append( "\n if not supplied the default
station deployment" );
buffer.append( "\n plan
(local:plan:dpml/station/default) will" );
buffer.append( "\n be selected" );
buffer.append( "\n" );
- buffer.append( "\n -server enables server execution
mode" );
+ buffer.append( "\n server [<uri>] startup the station as a
foreground process" );
buffer.append( "\n" );
+ buffer.append( "\n <uri> uri referencing a plan
datatype" );
+ buffer.append( "\n if not supplied the default
station deployment" );
+ buffer.append( "\n plan
(local:plan:dpml/station/default) will" );
+ buffer.append( "\n be selected" );
+ buffer.append( "\n" );
buffer.append( "\n info list station operational
status and exit" );
buffer.append( "\n" );
buffer.append( "\n shutdown shutdown the station" );
buffer.append( "\n" );
+ buffer.append( "\n Common Command Options:" );
buffer.append( "\n" );
+ buffer.append( "\n -port override the RMI Registry
port value" );
+ buffer.append( "\n" );
+ buffer.append( "\n" );
String message = buffer.toString();
m_logger.info( message );
}
@@ -781,21 +790,6 @@
.withValidator( new URIValidator() )
.create();

- private static final Group SERVER_GROUP =
- GROUP_BUILDER
- .withMinimum( 0 )
- .withMaximum( 2 )
- .withOption( PORT_OPTION )
- .withOption( CODEBASE )
- .create();
-
- private static final Option SERVER_COMMAND =
- COMMAND_BUILDER
- .withName( "server" )
- .withDescription( "Server mode." )
- .withChildren( SERVER_GROUP )
- .create();
-
private static final Group INFO_GROUP =
GROUP_BUILDER
.withMinimum( 0 )
@@ -815,7 +809,6 @@
.withMinimum( 0 )
.withMaximum( 2 )
.withOption( PORT_OPTION )
- //.withOption( SERVER_OPTION )
.withOption( CODEBASE )
.create();

@@ -826,6 +819,21 @@
.withChildren( STARTUP_GROUP )
.create();

+ private static final Group SERVER_GROUP =
+ GROUP_BUILDER
+ .withMinimum( 0 )
+ .withMaximum( 2 )
+ .withOption( PORT_OPTION )
+ .withOption( CODEBASE )
+ .create();
+
+ private static final Option SERVER_COMMAND =
+ COMMAND_BUILDER
+ .withName( "server" )
+ .withDescription( "Startup the station in forground server mode." )
+ .withChildren( SERVER_GROUP )
+ .create();
+
private static final Group SHUTDOWN_GROUP =
GROUP_BUILDER
.withMinimum( 0 )

r1929 - in trunk: central/site/src/docs/station/cli main/metro/station/src/main/dpml/station/console, mcconnell at BerliOS, 03/24/2007