notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

r1930 - trunk/central/site/src/docs/station/cli

From: mcconnell at BerliOS <mcconnell AT mail.berlios.de>
To: notify-dpml AT lists.ibiblio.org
Subject: r1930 - trunk/central/site/src/docs/station/cli
Date: Sat, 24 Mar 2007 06:29:51 +0100

Author: mcconnell
Date: 2007-03-24 06:29:50 +0100 (Sat, 24 Mar 2007)
New Revision: 1930

Removed:
trunk/central/site/src/docs/station/cli/add.xml
trunk/central/site/src/docs/station/cli/control.xml
trunk/central/site/src/docs/station/cli/cstart.xml
trunk/central/site/src/docs/station/cli/remove.xml
trunk/central/site/src/docs/station/cli/restart.xml
trunk/central/site/src/docs/station/cli/set.xml
trunk/central/site/src/docs/station/cli/stop.xml
Log:
housekeeping

Deleted: trunk/central/site/src/docs/station/cli/add.xml
===================================================================
--- trunk/central/site/src/docs/station/cli/add.xml 2007-03-24 05:28:56
UTC (rev 1929)
+++ trunk/central/site/src/docs/station/cli/add.xml 2007-03-24 05:29:50
UTC (rev 1930)
@@ -1,107 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<document>
-
- <properties>
- <author email="mcconnell AT dpml.net">Stephen McConnell</author>
- <title>DPML Station Add Command</title>
- </properties>
-
- <body>
-
- <section name="Add Command">
-
- <subsection name="Description">
-
- <p>
- Create a new application profile associated with a supplied key and
- add the profile to the persistent registry storage. Default options
related
- to deployment directory, JVM process system properties, deployment
timeout
- conditions, application title and configuration can be supplied
- as optional arguments (or subsequently set using the set command).
- </p>
-
- </subsection>
-
- <subsection name="Commandline">
-
-<pre><![CDATA[$ station add <key>
- -uri <artifact>
- [-policy <policy>]
- [-D<name>=<value>]
- [-dir <path>]
- [-title <title>]
- [-registry <artifact>]
- [-startup <seconds>]
- [-shutdown <seconds>]
- [-config <uri>]]]>
-</pre>
-
- </subsection>
-
- <subsection name="Parameters">
-
- <table>
- <tr><td width="100"><tt><key></tt></td><td>The application
key.</td></tr>
- </table>
-
- </subsection>
-
- <subsection name="Options">
-
- <table>
- <tr>
- <td width="100"><tt>-uri</tt></td>
- <td>The application codebase uri (required).</td></tr>
- <tr>
- <td><tt>-policy</tt></td>
- <td>Startup policy (AUTOMATIC, MANUAL or DISABLED). The default
- value is MANUAL.</td></tr>
- <tr>
- <td><tt>-D</tt></td>
- <td>A system property to assigned to the JVM on application
process establishment.</td></tr>
- <tr>
- <td><tt>-dir</tt></td>
- <td>The application working directory.</td></tr>
- <tr>
- <td><tt>-title</tt></td>
- <td>The application title.</td></tr>
- <tr>
- <td><tt>-registry</tt></td>
- <td>Override the selection of the station registry store to use
when adding the profile.</td></tr>
- <tr>
- <td><tt>-startup</tt></td>
- <td>Set the startup timeout (seconds).</td></tr>
- <tr>
- <td><tt>-shutdown</tt></td>
- <td>Set the shutdown timeout (seconds).</td></tr>
- <tr>
- <td><tt>-config</tt></td>
- <td>Set a configuration uri.</td></tr>
- </table>
-
- </subsection>
-
- <subsection name="Example">
-
-<pre>$ station add demo -uri link:part:dpml/planet/http/dpml-http-demo -dir
${dpml.data}/work/http</pre>
-
-<source>
-Added new profile [demo]
-
- Codebase: link:part:dpml/planet/http/dpml-http-demo
- Working Directory Path: ${dpml.data}/work/http
- Startup Timeout: 6
- Shutdown Timeout: 6
- Startup Policy: MANUAL
- System Properties: 0
-</source>
-
- </subsection>
-
- </section>
-
- </body>
-
-</document>
-

Deleted: trunk/central/site/src/docs/station/cli/control.xml
===================================================================
--- trunk/central/site/src/docs/station/cli/control.xml 2007-03-24 05:28:56
UTC (rev 1929)
+++ trunk/central/site/src/docs/station/cli/control.xml 2007-03-24 05:29:50
UTC (rev 1930)
@@ -1,106 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<document>
-
- <properties>
- <author email="mcconnell AT dpml.net">Stephen McConnell</author>
- <title>DPML Station Control Command</title>
- </properties>
-
- <body>
-
- <section name="Control Command">
-
- <subsection name="Description">
-
- <p>
- Start a console connected to a named application. The console
- provides a set of additional commands supporting the invocation
- of state transitions and management operations. Once connected
- with an application, management operations may be invoked using
- the nested <tt>exec</tt> command with the name of the operation
- as the first parameter. Subsequent parameters will be used as
- operation arguments. Transitions may be invoked using the
- nested <tt>apply</tt> command by supplying the name of the
- transition to be applied by the state machine.
- </p>
-
- </subsection>
-
- <subsection name="Commandline">
-
-<pre><![CDATA[$ station control <id>]]></pre>
-
- </subsection>
-
- <subsection name="Parameters">
-
- <table>
- <tr><td width="100"><tt><key></tt></td><td>The application
key.</td></tr>
- </table>
-
- </subsection>
-
- <subsection name="Console Commandline">
-
-<pre>
-<![CDATA[
-Usage:
- info | apply <id> | exec <id> [<arg> ...] | help | exit
-options
- info List state info.
- apply id Apply a state transition.
- exec id [arg ...] Execute a management operation.
- help List controller help info.
- exit Exit the console.
-]]>
-</pre>
-
- </subsection>
-
- <subsection name="Example">
-
- <p>
- The following example assumes that the demo application is up and
running. The
- initial command line establishes a console connected to the named
appplication.
- Within the console the user can query the status of the application
and review available
- state transitions and management operations published by the
component. The following
- example demonstrates the invocation of the management operation
<tt>'memory'</tt> on
- the component and the listing of the returned value.
- </p>
-
-<pre>$ station control demo</pre>
-
-<source>
-[3984]> Connected to application [demo]
-[3984]> <font color="darkred">info</font>
-
-Application: demo
-Current State:
-Transitions: 0
-Operations: 2
- [1] stats
- [2] memory
-
-[3984]> <font color="darkred">exec memory</font>
-
-applying operation: memory
-listing return value
-
-Memory Usage
- Timestamp: Fri Dec 23 08:07:16 CST 2005
- Free: 181024
- Total: 2523136
- Max: 66650112
-done
-[3984]>
-</source>
-
- </subsection>
-
- </section>
-
- </body>
-
-</document>
-

Deleted: trunk/central/site/src/docs/station/cli/cstart.xml
===================================================================
--- trunk/central/site/src/docs/station/cli/cstart.xml 2007-03-24 05:28:56
UTC (rev 1929)
+++ trunk/central/site/src/docs/station/cli/cstart.xml 2007-03-24 05:29:50
UTC (rev 1930)
@@ -1,67 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<document>
-
- <properties>
- <author email="mcconnell AT dpml.net">Stephen McConnell</author>
- <title>DPML Station Start Command</title>
- </properties>
-
- <body>
-
- <section name="Start Command">
-
- <subsection name="Description">
-
- <p>
- Start a named application. The station will create a new process
- with a Java virtual machine configured with system properties
declared
- in the selected profile. The codebase uri will be used to resolve
- the application unit (normally a <tt>part</tt> artifact). The
default
- logging configuration redirects application log message back to the
- station where log messages are consolidated in accordance with the
- station settings.
- </p>
-
- </subsection>
-
- <subsection name="Commandline">
-
-<pre><![CDATA[$ station start <key> [-port <port>]]]></pre>
-
- </subsection>
-
- <subsection name="Parameters">
-
- <table>
- <tr><td width="100"><tt><key></tt></td><td>The application
key.</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.</td></tr>
- </table>
-
- </subsection>
-
- <subsection name="Example">
-
-<pre>$ station start demo</pre>
-
-<source>
-[1132 ] [INFO ] (depot.station): starting application [demo]
-</source>
-
- </subsection>
-
- </section>
-
- </body>
-
-</document>
-

Deleted: trunk/central/site/src/docs/station/cli/remove.xml
===================================================================
--- trunk/central/site/src/docs/station/cli/remove.xml 2007-03-24 05:28:56
UTC (rev 1929)
+++ trunk/central/site/src/docs/station/cli/remove.xml 2007-03-24 05:29:50
UTC (rev 1930)
@@ -1,66 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<document>
-
- <properties>
- <author email="mcconnell AT dpml.net">Stephen McConnell</author>
- <title>DPML Station Remove Command</title>
- </properties>
-
- <body>
-
- <section name="Remove">
-
- <subsection name="Description">
-
- <p>
- Stops the application (if running) and removes it for the station
storage.
- </p>
-
- </subsection>
-
- <subsection name="Commandline">
-
-<pre><![CDATA[$ station remove <key>]]></pre>
-
- </subsection>
-
- <subsection name="Parameters">
-
- <table>
- <tr><td width="100"><tt><key></tt></td><td>The application
key.</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>
- </table>
-
- </subsection>
-
- <subsection name="Example">
-
-<pre>$ station remove demo</pre>
-
-<source>
-[4072 ] [INFO ] (depot.station): removed application [demo]
-</source>
-
- </subsection>
-
- </section>
-
- </body>
-
-</document>
-

Deleted: trunk/central/site/src/docs/station/cli/restart.xml
===================================================================
--- trunk/central/site/src/docs/station/cli/restart.xml 2007-03-24 05:28:56
UTC (rev 1929)
+++ trunk/central/site/src/docs/station/cli/restart.xml 2007-03-24 05:29:50
UTC (rev 1930)
@@ -1,67 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<document>
-
- <properties>
- <author email="mcconnell AT dpml.net">Stephen McConnell</author>
- <title>DPML Station Restart Command</title>
- </properties>
-
- <body>
-
- <section name="Restart Command">
-
- <subsection name="Description">
-
- <p>
- Restart a named application. The station will initiate a clean
- shutdown of the application taking into account registered
- termination transitions and operations. On completion of
- the component decommissioning the JVM process will be
- terminated. Following termination a new process will be
- created and the normal application startup procedure will
- be applied.
- </p>
-
- </subsection>
-
- <subsection name="Commandline">
-
-<pre><![CDATA[$ station restart <id> [-port <port>]]]></pre>
-
- </subsection>
-
- <subsection name="Parameters">
-
- <table>
- <tr><td width="100"><tt><key></tt></td><td>The application
key.</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.</td></tr>
- </table>
-
- </subsection>
-
- <subsection name="Example">
-
-<pre>$ station restart demo</pre>
-
-<source>
-[404 ] [INFO ] (depot.station): restarting application [demo]
-</source>
-
- </subsection>
-
- </section>
-
- </body>
-
-</document>
-

Deleted: trunk/central/site/src/docs/station/cli/set.xml
===================================================================
--- trunk/central/site/src/docs/station/cli/set.xml 2007-03-24 05:28:56
UTC (rev 1929)
+++ trunk/central/site/src/docs/station/cli/set.xml 2007-03-24 05:29:50
UTC (rev 1930)
@@ -1,104 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<document>
-
- <properties>
- <author email="mcconnell AT dpml.net">Stephen McConnell</author>
- <title>DPML Station Set Command</title>
- </properties>
-
- <body>
-
- <section name="Set Command">
-
- <subsection name="Description">
-
- <p>
- Update a feature of an application profile. The set command
- supports modification of the stored codebase uri, startup policy,
- assigned system properties, working directory, title, statup
- and shutdown timeout values, and application configuration.
- </p>
-
- </subsection>
-
- <subsection name="Commandline">
-
-<pre><![CDATA[$ station set <key>
- [-uri <artifact>]
- [-policy <policy>]
- [-D<name>=<value>]
- [-dir <path>]
- [-title <title>]
- [-registry <artifact>]
- [-startup <seconds>]
- [-shutdown <seconds>]
- [-config <uri>]]]></pre>
-
- </subsection>
-
- <subsection name="Parameters">
-
- <table>
- <tr><td width="100"><tt><key></tt></td><td>The application
key.</td></tr>
- </table>
-
- </subsection>
-
- <subsection name="Options">
-
- <table>
- <tr>
- <td width="100"><tt>-uri</tt></td>
- <td>Set the application codebase uri.</td></tr>
- <tr>
- <td><tt>-policy</tt></td>
- <td>Startup policy (AUTOMATIC, MANUAL or DISABLED).</td></tr>
- <tr>
- <td><tt>-D</tt></td>
- <td>A system property to assigned to the JVM on application
process establishment.</td></tr>
- <tr>
- <td><tt>-dir</tt></td>
- <td>The application working directory.</td></tr>
- <tr>
- <td><tt>-title</tt></td>
- <td>The application title.</td></tr>
- <tr>
- <td><tt>-registry</tt></td>
- <td>Override the selection of the station registry store to use
when updating the profile.</td></tr>
- <tr>
- <td><tt>-startup</tt></td>
- <td>Set the startup timeout (seconds).</td></tr>
- <tr>
- <td><tt>-shutdown</tt></td>
- <td>Set the shutdown timeout (seconds).</td></tr>
- <tr>
- <td><tt>-config</tt></td>
- <td>Set the configuration uri.</td></tr>
- </table>
-
- </subsection>
-
- <subsection name="Example">
-
-<pre>$ station set demo -policy automatic</pre>
-
-<source>
-Updated profile [demo]
-
- Codebase: link:part:dpml/planet/http/dpml-http-demo
- Working Directory Path: ${dpml.data}/work/http
- Startup Timeout: 6
- Shutdown Timeout: 6
- Startup Policy: AUTOMATIC
- System Properties: 0
-</source>
-
- </subsection>
-
- </section>
-
- </body>
-
-</document>
-

Deleted: trunk/central/site/src/docs/station/cli/stop.xml
===================================================================
--- trunk/central/site/src/docs/station/cli/stop.xml 2007-03-24 05:28:56
UTC (rev 1929)
+++ trunk/central/site/src/docs/station/cli/stop.xml 2007-03-24 05:29:50
UTC (rev 1930)
@@ -1,64 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<document>
-
- <properties>
- <author email="mcconnell AT dpml.net">Stephen McConnell</author>
- <title>DPML Station Stop Command</title>
- </properties>
-
- <body>
-
- <section name="Stop Command">
-
- <subsection name="Description">
-
- <p>
- Stop a named application. The station will initiate a clean
- shutdown of the application taking into account registered
- termination transitions and operations. On completion of
- the component decommissioning the JVM process will be
- terminated.
- </p>
-
- </subsection>
-
- <subsection name="Commandline">
-
-<pre><![CDATA[$ station stop <id> [-port <port>]]]></pre>
-
- </subsection>
-
- <subsection name="Parameters">
-
- <table>
- <tr><td width="100"><tt><key></tt></td><td>The application
key.</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.</td></tr>
- </table>
-
- </subsection>
-
- <subsection name="Example">
-
-<pre>$ station stop demo</pre>
-
-<source>
-[4036 ] [INFO ] (depot.station): stopping application [demo]
-</source>
-
- </subsection>
-
- </section>
-
- </body>
-
-</document>

r1930 - trunk/central/site/src/docs/station/cli, mcconnell at BerliOS, 03/24/2007