notify-dpml AT lists.ibiblio.org
Subject: DPML Notify
List archive
r1288 - in trunk/main/central/src/docs: metro/directives metro/directives/component metro/directives/component/context metro/directives/type metro/directives/type/categories metro/directives/type/context metro/directives/type/info metro/directives/type/parts metro/directives/type/services metro/directives/type/state metro/directives/type/state/trigger transit transit/parts/strategy
- From: mcconnell at BerliOS <mcconnell AT mail.berlios.de>
- To: notify-dpml AT lists.ibiblio.org
- Subject: r1288 - in trunk/main/central/src/docs: metro/directives metro/directives/component metro/directives/component/context metro/directives/type metro/directives/type/categories metro/directives/type/context metro/directives/type/info metro/directives/type/parts metro/directives/type/services metro/directives/type/state metro/directives/type/state/trigger transit transit/parts/strategy
- Date: Wed, 29 Mar 2006 07:05:26 +0200
Author: mcconnell
Date: 2006-03-29 07:05:20 +0200 (Wed, 29 Mar 2006)
New Revision: 1288
Added:
trunk/main/central/src/docs/transit/parts/strategy/plugin.xml
trunk/main/central/src/docs/transit/parts/strategy/resource.xml
Modified:
trunk/main/central/src/docs/metro/directives/component/categories.xml
trunk/main/central/src/docs/metro/directives/component/context/entries.xml
trunk/main/central/src/docs/metro/directives/component/context/index.xml
trunk/main/central/src/docs/metro/directives/component/context/navigation.xml
trunk/main/central/src/docs/metro/directives/component/context/values.xml
trunk/main/central/src/docs/metro/directives/component/index.xml
trunk/main/central/src/docs/metro/directives/component/parts.xml
trunk/main/central/src/docs/metro/directives/index.xml
trunk/main/central/src/docs/metro/directives/type/categories/category.xml
trunk/main/central/src/docs/metro/directives/type/categories/index.xml
trunk/main/central/src/docs/metro/directives/type/context/entry.xml
trunk/main/central/src/docs/metro/directives/type/context/index.xml
trunk/main/central/src/docs/metro/directives/type/index.xml
trunk/main/central/src/docs/metro/directives/type/info/index.xml
trunk/main/central/src/docs/metro/directives/type/parts/index.xml
trunk/main/central/src/docs/metro/directives/type/services/index.xml
trunk/main/central/src/docs/metro/directives/type/state/index.xml
trunk/main/central/src/docs/metro/directives/type/state/interface.xml
trunk/main/central/src/docs/metro/directives/type/state/operation.xml
trunk/main/central/src/docs/metro/directives/type/state/transition.xml
trunk/main/central/src/docs/metro/directives/type/state/trigger/index.xml
trunk/main/central/src/docs/transit/navigation.xml
trunk/main/central/src/docs/transit/parts/strategy/index.xml
trunk/main/central/src/docs/transit/parts/strategy/navigation.xml
Log:
more docs
Modified:
trunk/main/central/src/docs/metro/directives/component/categories.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/component/categories.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/component/categories.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -52,13 +52,16 @@
</p>
<source><![CDATA[
-<component xmlns="dpml:metro" dest="target/test/categories.part" test="true"
activation="true"
- type="net.dpml.test.categories.CategoriesComponent" collection="hard">
- <categories>
- <category name="alpha" priority="warn"/>
- <category name="beta" priority="error"/>
- </categories>
-<component>
+ <component xmlns="artifact:xsd:dpml/lang/dpml-component#1.0"
+ class="net.dpml.test.categories.CategoriesComponent"
+ name="categories"
+ collection="hard"
+ activation="startup">
+ <categories>
+ <category name="alpha" priority="warn"/>
+ <category name="beta" priority="error"/>
+ </categories>
+ </component>
]]></source>
</section>
Modified:
trunk/main/central/src/docs/metro/directives/component/context/entries.xml
===================================================================
---
trunk/main/central/src/docs/metro/directives/component/context/entries.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++
trunk/main/central/src/docs/metro/directives/component/context/entries.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -121,9 +121,9 @@
<pre><![CDATA[
<entry key="color">
- <value class="float" value="100"/>
- <value class="float" value="200"/>
- <value class="float" value="0"/>
+ <param class="float" value="100"/>
+ <param class="float" value="200"/>
+ <param class="float" value="0"/>
</entry>
]]></pre>
@@ -146,8 +146,8 @@
<pre><![CDATA[
<entry key="names">
- <value value="Hello"/>
- <value value="World"/>
+ <param value="Hello"/>
+ <param value="World"/>
</entry>
]]></pre>
Modified:
trunk/main/central/src/docs/metro/directives/component/context/index.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/component/context/index.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/component/context/index.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -54,19 +54,19 @@
<source><![CDATA[
<context>
- <entry key="name" value="$${user.name}"/>
+ <entry key="name" value="${user.name}"/>
<entry key="printer" lookup="org.acme.Printer"/>
<entry key="background" method="RED"/>
<entry key="foreground">
- <value class="float" value="100"/>
- <value class="float" value="200"/>
- <value class="float" value="0"/>
+ <param class="float" value="100"/>
+ <param class="float" value="200"/>
+ <param class="float" value="0"/>
</entry>
<entry key="widget" class="org.acme.DefaultWidget">
- <value class="org.acme.DefaultGizmo">
- <value class="float" value="0"/>
- <value class="int" value="1024"/>
- </value>
+ <param class="org.acme.DefaultGizmo">
+ <param class="float" value="0"/>
+ <param class="int" value="1024"/>
+ </param>
</entry>
</context>
]]></source>
Modified:
trunk/main/central/src/docs/metro/directives/component/context/navigation.xml
===================================================================
---
trunk/main/central/src/docs/metro/directives/component/context/navigation.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++
trunk/main/central/src/docs/metro/directives/component/context/navigation.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -26,7 +26,7 @@
<menu>
<item name="Entry" href="entries.html"/>
- <item name="Value" href="values.html"/>
+ <item name="Param" href="values.html"/>
</menu>
</body>
Modified:
trunk/main/central/src/docs/metro/directives/component/context/values.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/component/context/values.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/component/context/values.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -9,7 +9,7 @@
<body>
- <section name="Value">
+ <section name="Param Element">
<subsection name="Description">
@@ -23,7 +23,7 @@
</subsection>
- <subsection name="Entry Attributes">
+ <subsection name="Attributes">
<table>
<tr>
@@ -57,7 +57,7 @@
<table>
<tr>
- <td><tt><a href="values.html">value</a></tt></td>
+ <td><tt><a href="values.html">param</a></tt></td>
<td>The value element may contain 0..n nested <value>
directives.
If the value class is an array class the nested values are
interprited as array entries otherwise nested values are
interprited
@@ -79,7 +79,7 @@
</p>
<pre><![CDATA[
-<value value="Hello"/>
+<param value="Hello"/>
]]></pre>
</subsection>
@@ -93,7 +93,7 @@
</p>
<pre><![CDATA[
-<value class="java.awt.Color" method="RED"/>
+<param class="java.awt.Color" method="RED"/>
]]></pre>
</subsection>
@@ -106,11 +106,11 @@
</p>
<pre><![CDATA[
-<value class="java.awt.Color">
- <value class="float" value="100"/>
- <value class="float" value="200"/>
- <value class="float" value="0"/>
-</value>
+<param class="java.awt.Color">
+ <param class="float" value="100"/>
+ <param class="float" value="200"/>
+ <param class="float" value="0"/>
+</param>
]]></pre>
</subsection>
@@ -125,11 +125,11 @@
</p>
<pre><![CDATA[
-<value class="int[]">
- <value class="int" value="1"/>
- <value class="int" value="2"/>
- <value class="int" value="3"/>
-</value>
+<param class="int[]">
+ <param class="int" value="1"/>
+ <param class="int" value="2"/>
+ <param class="int" value="3"/>
+</param>
]]></pre>
</subsection>
Modified: trunk/main/central/src/docs/metro/directives/component/index.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/component/index.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/component/index.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -18,12 +18,12 @@
<subsection name="Standard Attributes">
<table>
<tr>
- <td><tt>class</tt></td>
+ <td><tt>type</tt></td>
<td>Set the component type classname (required).</td>
</tr>
<tr>
<td><tt>name</tt></td>
- <td>Optional overriding of the component profile name. If not
supplied
+ <td>Optional overriding of the component name. If not supplied
the component profile name will default to the name of the
underlying
component type.</td>
</tr>
@@ -64,6 +64,21 @@
</subsection>
+ <subsection name="Attributes Interited from Part Strategy">
+
+ <table>
+ <tr>
+ <td><tt>alias</tt></td>
+ <td>Used in conjunction with top-level components to declare that
+ a link uri is produced referencing an absolute artifact uri to
+ the component definition.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
+
<subsection name="Nested Elements">
<table>
Modified: trunk/main/central/src/docs/metro/directives/component/parts.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/component/parts.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/component/parts.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -41,89 +41,96 @@
</p>
<source><![CDATA[
+ <component xmlns="artifact:xsd:dpml/lang/dpml-component#1.0"
+ type="net.dpml.http.Server"
+ alias="true">
+
+ <parts>
+
+ <!--
+ Add a select channel connector to 8080.
+ -->
+ <component key="plain" type="net.dpml.http.SelectChannelConnector">
+ <context>
+ <entry key="port" value="8080"/>
+ <entry key="maxIdleTime" value="50000"/>
+ <entry key="acceptors" value="10"/>
+ </context>
+ </component>
+
+ <!--
+ Add a SSL connector to 8443.
+ -->
+ <component key="ssl" type="net.dpml.http.SslSocketConnector">
+ <context>
+ <entry key="port" value="8443"/>
+ <entry key="maxIdleTime" value="30000"/>
+ <entry key="keystore"
value="local:keystore:dpml/planet/http/jetty"/>
+ <entry key="password"
value="OBF:1vny1zlo1x8e1vnw1vn61x8g1zlu1vn4"/>
+ <entry key="keyPassword" value="OBF:1u2u1wml1z7s1z7a1wnl1u2g"/>
+ </context>
+ </component>
+
+ <!--
+ Add a user realm.
+ -->
+ <component key="realm" type="net.dpml.http.HashUserRealm">
+ <context>
+ <entry key="name" value="Test Realm"/>
+ <entry key="URI"
value="local:properties:dpml/planet/http/realm"/>
+ </context>
+ </component>
+
+ <!--
+ Add a web application.
+ -->
+ <component key="webapp" type="net.dpml.http.WebAppContextHandler">
+ <context>
+ <entry key="contextPath" value="/"/>
+ <entry key="war"
value="link:war:dpml/planet/http/dpml-http-app"/>
+ </context>
+ </component>
+
+ <!--
+ Creation of a HTTP server configured to present static content in
+ the ${dpml.share}/docs directory.
+ -->
+ <component key="context" type="net.dpml.http.ResourceContextHandler">
+ <context>
+ <entry key="resourceBase" value="${dpml.share}/docs"/>
+ <entry key="contextPath" value="/docs"/>
+ </context>
+ </component>
+
+ <!--
+ Add an experimental servlet context.
+ (Need to add context cloassloader configuration but this requires
+ per-component threads - currently limited to classes declared within
+ the part classloader).
+ -->
+ <component key="servlets" type="net.dpml.http.ServletContextHandler">
+ <context>
+ <entry key="resourceBase" value="${dpml.data}"/>
+ <entry key="contextPath" value="/data"/>
+ <entry key="servletHolders">
+ <param class="net.dpml.http.ServletHolder">
+ <param value="data"/>
+ <param value="org.mortbay.jetty.servlet.DefaultServlet"/>
+ </param>
+ </entry>
+ <entry key="servletEntries">
+ <param class="net.dpml.http.ServletEntry">
+ <param value="data"/>
+ <param value="/"/>
+ </param>
+ </entry>
+ </context>
+ </component>
+
+ </parts>
+
+ </component>]]></source>
-<component xmlns="metro" type="net.dpml.http.Server" lifestyle="singleton">
-
- <parts>
-
- <!--
- Add a select channel connector to 8080.
- -->
- <component key="plain" type="net.dpml.http.SelectChannelConnector">
- <context>
- <entry key="port" value="8080"/>
- <entry key="maxIdleTime" value="50000"/>
- <entry key="acceptors" value="10"/>
- </context>
- </component>
-
- <!--
- Add a SSL connector to 8443.
- -->
- <component key="ssl" type="net.dpml.http.SslSocketConnector">
- <context>
- <entry key="port" value="8443"/>
- <entry key="maxIdleTime" value="30000"/>
- <entry key="keystore" value="local:keystore:dpml/planet/http/jetty"/>
- <entry key="password" value="OBF:1vny1zlo1x8e1vnw1vn61x8g1zlu1vn4"/>
- <entry key="keyPassword" value="OBF:1u2u1wml1z7s1z7a1wnl1u2g"/>
- </context>
- </component>
-
- <!--
- Add a user realm.
- -->
- <component key="realm" type="net.dpml.http.HashUserRealm">
- <context>
- <entry key="name" value="Test Realm"/>
- <entry key="URI" value="local:properties:dpml/planet/http/realm"/>
- </context>
- </component>
-
- <!--
- Add a web application.
- -->
- <component key="webapp" type="net.dpml.http.WebAppContextHandler">
- <context>
- <entry key="contextPath" value="/"/>
- <entry key="war" value="link:war:dpml/planet/http/dpml-http-app"/>
- </context>
- </component>
-
- <!--
- Creation of a HTTP server configured to present static content in
- the ${dpml.share}/docs directory.
- -->
- <component key="context" type="net.dpml.http.ResourceContextHandler">
- <context>
- <entry key="resourceBase" value="$${dpml.share}/docs"/>
- <entry key="contextPath" value="/docs"/>
- </context>
- </component>
-
- <!--
- Add an experimental servlet context.
- -->
- <component key="servlets" type="net.dpml.http.ServletContextHandler">
- <context>
- <entry key="resourceBase" value="$${dpml.data}"/>
- <entry key="contextPath" value="/data"/>
- </context>
- <configuration>
- <servlets>
- <servlet name="data"
class="org.mortbay.jetty.servlet.DefaultServlet"/>
- </servlets>
- <mappings>
- <map servlet="data" path="/"/>
- </mappings>
- </configuration>
- </component>
-
- </parts>
-
-</component>
-]]></source>
-
</section>
</body>
Modified: trunk/main/central/src/docs/metro/directives/index.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/index.xml 2006-03-28
15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/index.xml 2006-03-29
05:05:20 UTC (rev 1288)
@@ -31,7 +31,7 @@
<info/>
- <component xmlns="artifact:xsd:dpml/lang/dpml-component#1.0"
class="org.acme.Widget"/>
+ <component xmlns="artifact:xsd:dpml/lang/dpml-component#1.0"
type="org.acme.Widget"/>
<classpath>
<private>
Modified:
trunk/main/central/src/docs/metro/directives/type/categories/category.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/type/categories/category.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/type/categories/category.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -9,7 +9,7 @@
<body>
- <section name="Category Descriptor">
+ <section name="Category Descriptor Element">
<subsection name="Description">
Modified:
trunk/main/central/src/docs/metro/directives/type/categories/index.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/type/categories/index.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/type/categories/index.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -9,7 +9,7 @@
<body>
- <section name="Categories Descriptor">
+ <section name="Categories Descriptor Element">
<subsection name="Description">
@@ -35,11 +35,7 @@
<![CDATA[
<?xml version="1.0"?>
-<type xmlns="artifact:xsd:dpml/lang/dpml-type#1.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- xmlns:part="artifact:xsd:dpml/lang/dpml-part#1.0"
- xmlns:type="artifact:xsd:dpml/lang/dpml-type#1.0"
- xmlns:component="artifact:xsd:dpml/lang/dpml-component#1.0">
+<type xmlns="artifact:xsd:dpml/lang/dpml-type#1.0">
<info name="categories"
class="net.dpml.test.categories.CategoriesComponent"
Modified: trunk/main/central/src/docs/metro/directives/type/context/entry.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/type/context/entry.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/type/context/entry.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -4,12 +4,12 @@
<properties>
<author email="mcconnell AT dpml.net">Stephen McConnell</author>
- <title>DPML Metro Component Type Parts Datatype</title>
+ <title>DPML Component Entry Descriptor Element</title>
</properties>
<body>
- <section name="Entry Descriptor">
+ <section name="Entry Descriptor Element">
<subsection name="Description">
Modified: trunk/main/central/src/docs/metro/directives/type/context/index.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/type/context/index.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/type/context/index.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -9,7 +9,7 @@
<body>
- <section name="Context Descriptor">
+ <section name="Context Element">
<subsection name="Description">
@@ -45,12 +45,7 @@
<section name="Examples">
<source>
-<![CDATA[
-<type xmlns="artifact:xsd:dpml/lang/dpml-type#1.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- xmlns:part="artifact:xsd:dpml/lang/dpml-part#1.0"
- xmlns:type="artifact:xsd:dpml/lang/dpml-type#1.0"
- xmlns:component="artifact:xsd:dpml/lang/dpml-component#1.0">
+<![CDATA[<type xmlns="artifact:xsd:dpml/lang/dpml-type#1.0">
<info name="context"
class="net.dpml.test.ContextTestComponent"
@@ -69,7 +64,6 @@
<entry key="name" class="java.lang.String" optional="false"/>
<entry key="integer" class="int" optional="false"/>
<entry key="path" class="java.lang.String" optional="false"/>
- <entry key="file" class="java.io.File" optional="false"/>
<entry key="file" class="java.io.File" optional="true"/>
<entry key="URI" class="java.net.URI" optional="false"/>
<entry key="color" class="java.awt.Color" optional="false"/>
@@ -87,8 +81,7 @@
<entry key="optionalURI" class="java.net.URI" optional="true"/>
</context>
-</type>
- </info>]]>
+</type>]]>
</source>
</section>
Modified: trunk/main/central/src/docs/metro/directives/type/index.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/type/index.xml 2006-03-28
15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/type/index.xml 2006-03-29
05:05:20 UTC (rev 1288)
@@ -14,13 +14,12 @@
<subsection name="Description">
<p>
- A component type directive is an XML document that describes
+ A component type descriptor is an XML document that describes
supplimentary information about a Java class. This information
includes details about the assumtions that the class makes concerning
- the supply of context information, it's capabilities with respect
- to thread safety, internal defaults declared as part of the
component,
- and other infromation including garbage collection policy,
lifestyle,
- and lifecycle.
+ context information, it's capabilities with respect to
thread-safety,
+ internal parts of the component, and other infromation including
+ garbage collection policy, lifestyle, and lifecycle.
</p>
<p>
@@ -78,77 +77,75 @@
<p>Example of a complex component type definition:</p>
<source><![CDATA[
-<?xml version="1.0"?>
-
-<type xmlns="artifact:xsd:dpml/lang/dpml-type#1.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- xmlns:part="artifact:xsd:dpml/lang/dpml-part#1.0"
- xmlns:type="artifact:xsd:dpml/lang/dpml-type#1.0"
- xmlns:component="artifact:xsd:dpml/lang/dpml-component#1.0">
-
- <info name="server"
- class="net.dpml.http.Server"
- version="0.0.0"
- lifestyle="singleton"
- collection="hard"
+<?xml version="1.0"?>
+
+<type xmlns="artifact:xsd:dpml/lang/dpml-type#1.0">
+
+ <info name="server"
+ class="net.dpml.http.Server"
+ version="0.0.0"
+ lifestyle="singleton"
+ collection="hard"
threadsafe="true"/>
-
- <services>
- <service class="net.dpml.http.Server" version="1.0.0"/>
+
+ <services>
+ <service class="net.dpml.http.Server" version="1.0.0"/>
</services>
-
- <context>
- <entry key="configuration" class="java.net.URI" optional="true"/>
- <entry key="threadPool" class="org.mortbay.thread.ThreadPool"
optional="true"/>
- <entry key="requestLog" class="org.mortbay.jetty.RequestLog"
optional="true"/>
+
+ <context>
+ <entry key="configuration" class="java.net.URI" optional="true"/>
+ <entry key="threadPool" class="org.mortbay.thread.ThreadPool"
optional="true"/>
+ <entry key="requestLog" class="org.mortbay.jetty.RequestLog"
optional="true"/>
</context>
-
- <state xmlns="artifact:xsd:dpml/lang/dpml-state#1.0">
- <trigger event="initialization">
- <transition name="init" target="started">
- <operation name="startup" method="start"/>
- </transition>
- </trigger>
- <state name="started">
- <trigger event="termination">
- <apply id="stop"/>
- </trigger>
- <transition name="stop" target="../stopped">
- <operation name="stop" method="stop"/>
- </transition>
- </state>
- <state name="stopped">
- <transition name="start" target="../started">
- <operation name="start" method="start"/>
- </transition>
- </state>
- </state>
-
- <parts>
- <component xmlns="artifact:xsd:dpml/lang/dpml-component#1.0"
key="requestLog"
- class="net.dpml.http.NCSARequestLog"
- name="requestLog"
- collection="hard"
- activation="demand">
- <context>
- <entry key="filename" class="java.lang.String"
value="${dpml.data}/logs/http/request.log"/>
- <entry key="append" class="boolean" value="true"/>
- <entry key="extended" class="boolean" value="true"/>
- </context>
- </component>
- <component xmlns="artifact:xsd:dpml/lang/dpml-component#1.0"
key="threadPool"
- class="net.dpml.http.BoundedThreadPool"
- name="threadPool"
- collection="hard"
- activation="demand">
- <context>
- <entry key="min" class="int" value="10"/>
- <entry key="max" class="int" value="100"/>
- </context>
- </component>
+
+ <state xmlns="artifact:xsd:dpml/lang/dpml-state#1.0">
+ <trigger event="initialization">
+ <transition name="init" target="started">
+ <operation name="startup" method="start"/>
+ </transition>
+ </trigger>
+ <state name="started">
+ <trigger event="termination">
+ <apply id="stop"/>
+ </trigger>
+ <transition name="stop" target="../stopped">
+ <operation name="stop" method="stop"/>
+ </transition>
+ </state>
+ <state name="stopped">
+ <transition name="start" target="../started">
+ <operation name="start" method="start"/>
+ </transition>
+ </state>
+ </state>
+
+ <parts>
+ <component xmlns="artifact:xsd:dpml/lang/dpml-component#1.0"
+ key="requestLog"
+ class="net.dpml.http.NCSARequestLog"
+ name="requestLog"
+ collection="hard"
+ activation="demand">
+ <context>
+ <entry key="filename" class="java.lang.String"
value="${dpml.data}/logs/http/request.log"/>
+ <entry key="append" class="boolean" value="true"/>
+ <entry key="extended" class="boolean" value="true"/>
+ </context>
+ </component>
+ <component xmlns="artifact:xsd:dpml/lang/dpml-component#1.0"
+ key="threadPool"
+ class="net.dpml.http.BoundedThreadPool"
+ name="threadPool"
+ collection="hard"
+ activation="demand">
+ <context>
+ <entry key="min" class="int" value="10"/>
+ <entry key="max" class="int" value="100"/>
+ </context>
+ </component>
</parts>
-
-</type>
+
+</type>
]]></source>
</section>
Modified: trunk/main/central/src/docs/metro/directives/type/info/index.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/type/info/index.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/type/info/index.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -14,6 +14,8 @@
<subsection name="Description">
<p>
+ The info element holds the component type name, details about a
component lifestyle policy,
+ garbage collection policy, and thread-safe capability.
</p>
</subsection>
Modified: trunk/main/central/src/docs/metro/directives/type/parts/index.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/type/parts/index.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/type/parts/index.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -4,12 +4,12 @@
<properties>
<author email="mcconnell AT dpml.net">Stephen McConnell</author>
- <title>DPML Metro Component Type Parts Datatype</title>
+ <title>DPML Metro Component Type Parts Element</title>
</properties>
<body>
- <section name="Parts">
+ <section name="Parts Element">
<subsection name="Description">
Modified: trunk/main/central/src/docs/metro/directives/type/services/index.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/type/services/index.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/type/services/index.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -9,7 +9,7 @@
<body>
- <section name="Services">
+ <section name="Services Element">
<subsection name="Description">
Modified: trunk/main/central/src/docs/metro/directives/type/state/index.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/type/state/index.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/type/state/index.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -9,7 +9,7 @@
<body>
- <section name="State Datatype">
+ <section name="State Descriptor Element">
<subsection name="Description">
@@ -32,7 +32,7 @@
<table>
<tr>
<td><tt>name</tt></td>
- <td>Set the state name (required on sub-states).</td>
+ <td>The name of the state (required on sub-states).</td>
</tr>
<tr>
<td><tt>terminal</tt></td>
@@ -70,30 +70,38 @@
<section name="Example">
<source><![CDATA[
-<c:type class="net.dpml.test.state.ManagedComponent" name="demo"
lifestyle="thread">
- <state>
- <operation name="ping" method="ping"/>
- <operation name="monitor"/>
- <trigger event="initialization">
- <transition name="startup" target="started">
- <operation method="start"/>
- </transition>
- </trigger>
- <state name="started">
- <trigger event="termination">
- <apply id="stop"/>
- </trigger>
- <transition name="stop" target="../stopped">
- <operation method="stop"/>
- </transition>
- </state>
- <state name="stopped">
- <transition name="start" target="../started">
- <operation method="start"/>
- </transition>
- </state>
- </state>
-</c:type>
+<?xml version="1.0"?>
+
+<type xmlns="artifact:xsd:dpml/lang/dpml-type#1.0">
+
+ <info name="example"
+ class="net.dpml.test.ExampleComponent"
+ version="0.0.0"
+ lifestyle="thread"
+ collection="system"
+ threadsafe="unknown"/>
+
+ <services>
+ <service class="net.dpml.test.ColorManager" version="1.0.0"/>
+ </services>
+
+ <context>
+ <entry key="color" class="java.awt.Color" optional="false"/>
+ </context>
+
+ <state xmlns="artifact:xsd:dpml/lang/dpml-state#1.0">
+ <trigger event="initialization">
+ <transition name="init" target="available"/>
+ </trigger>
+ <state name="available">
+ <trigger event="termination">
+ <transition name="terminate" target="../terminated"/>
+ </trigger>
+ </state>
+ <state name="terminated" terminal="true"/>
+ </state>
+
+</type>
]]></source>
</section>
Modified:
trunk/main/central/src/docs/metro/directives/type/state/interface.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/type/state/interface.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/type/state/interface.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -9,7 +9,7 @@
<body>
- <section name="Interface Datatype">
+ <section name="Interface Element">
<subsection name="Description">
Modified:
trunk/main/central/src/docs/metro/directives/type/state/operation.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/type/state/operation.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/type/state/operation.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -4,12 +4,12 @@
<properties>
<author email="mcconnell AT dpml.net">Stephen McConnell</author>
- <title>DPML Metro Management Operation Datatype</title>
+ <title>DPML Metro Management Operation Element</title>
</properties>
<body>
- <section name="Operation Datatype">
+ <section name="Operation Element">
<subsection name="Description">
Modified:
trunk/main/central/src/docs/metro/directives/type/state/transition.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/type/state/transition.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/type/state/transition.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -9,7 +9,7 @@
<body>
- <section name="Transition Datatype">
+ <section name="Transition Element">
<subsection name="Description">
Modified:
trunk/main/central/src/docs/metro/directives/type/state/trigger/index.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/type/state/trigger/index.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/metro/directives/type/state/trigger/index.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -4,12 +4,12 @@
<properties>
<author email="mcconnell AT dpml.net">Stephen McConnell</author>
- <title>DPML Metro Trigger Datatypes</title>
+ <title>DPML Metro Component Type - Trigger Element</title>
</properties>
<body>
- <section name="Trigger Datatype">
+ <section name="Trigger Element">
<subsection name="Description">
Modified: trunk/main/central/src/docs/transit/navigation.xml
===================================================================
--- trunk/main/central/src/docs/transit/navigation.xml 2006-03-28 15:56:03
UTC (rev 1287)
+++ trunk/main/central/src/docs/transit/navigation.xml 2006-03-29 05:05:20
UTC (rev 1288)
@@ -27,9 +27,9 @@
<menu>
<item name="Overview" href="concepts/index.html"/>
<item name="Protocols" href="technical/index.html"/>
- <item name="Configuration" href="setup/index.html"/>
<item name="Directives" href="parts/index.html"/>
<item name="Services" href="services/index.html"/>
+ <item name="Setup" href="setup/index.html"/>
<item name="Antlib" href="tasks/index.html"/>
<item name="CLI" href="cli/index.html"/>
</menu>
Modified: trunk/main/central/src/docs/transit/parts/strategy/index.xml
===================================================================
--- trunk/main/central/src/docs/transit/parts/strategy/index.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/transit/parts/strategy/index.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -14,25 +14,55 @@
<subsection name="Description">
<p>
- IN PROGRESS
+ Transit provides two strategy definitions - <a
href="plugin.html"><tt>plugin</tt></a>
+ and <a href="resource.html"><tt>resource</tt></a>.
</p>
- <p>Example:</p>
-
+ <p>
+ The plugin definition is the common form and used to establish
plugable services
+ within a software system. The resource definition is a special case
used to handle
+ the declaration of a antlib resource path and namespace - used in
conjunction with
+ plugable tasks and datatypes.
+ </p>
+
+ </subsection>
+
+ </section>
+
+ <section name="Example">
+
+ <p>
+ The <tt><strategy></tt> element represents an abstract schema
type as
+ such the <tt>xsi:type</tt> attribute is required in order to reference
a
+ concrete strategy. In the following example the <tt>xsi:type</tt>
attribute
+ is selecting the <tt>plugin</tt> schema type.
+ </p>
+
<source>
-<![CDATA[
-]]>
+<![CDATA[<strategy xsi:type="plugin"
class="net.dpml.tools.impl.StandardBuilder"/>]]>
</source>
- </subsection>
-
- <subsection name="Attributes">
+ <p>
+ The above strategy declaration is equivalent to the following:
+ </p>
- </subsection>
+<source>
+<![CDATA[<plugin class="net.dpml.tools.impl.StandardBuilder"/>]]>
+</source>
- <subsection name="Nested Elements">
+ <p>
+ The following example demonstrates the use of a foreign strategy
definition
+ (qualified by a namespace uri):
+ </p>
- </subsection>
+<source>
+<![CDATA[<component xmlns="artifact:xsd:dpml/lang/dpml-component#1.0"
+ type="net.dpml.http.Server"
+ collection="system"
+ activation="system">
+ ...
+</component>]]>
+</source>
</section>
Modified: trunk/main/central/src/docs/transit/parts/strategy/navigation.xml
===================================================================
--- trunk/main/central/src/docs/transit/parts/strategy/navigation.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/transit/parts/strategy/navigation.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -20,11 +20,13 @@
<project>
- <title>Component Strategy Directive Specification</title>
+ <title>Standard Strategies</title>
<body>
<menu>
+ <item name="Plugin" href="plugin.html"/>
+ <item name="Resource" href="resource.html"/>
</menu>
</body>
Added: trunk/main/central/src/docs/transit/parts/strategy/plugin.xml
===================================================================
--- trunk/main/central/src/docs/transit/parts/strategy/plugin.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/transit/parts/strategy/plugin.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Part Directive</title>
+ </properties>
+
+ <body>
+
+ <section name="Plugin Strategy">
+
+ <subsection name="Description">
+
+ <p>
+ </p>
+
+ </subsection>
+
+ <subsection name="Attributes">
+
+ <table>
+ <tr>
+ <td><tt>class</tt></td>
+ <td>The plugin class name.
+ </td>
+ </tr>
+ <tr>
+ <td><tt>alias</tt></td>
+ <td>Used in conjunction with part production declaration to
signal that
+ a link uri is produced referencing an absolute artifact uri to
+ the part definition. Alowable values are 'true' and 'false'.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ <subsection name="Nested Elements">
+
+ <table>
+ <tr>
+ <td><tt>param</tt></td>
+ <td>0..n parameter values.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ <section name="Examples">
+
+<source>
+<![CDATA[<plugin class="net.dpml.tools.impl.StandardBuilder"
alias="true"/>]]>
+</source>
+
+ </section>
+
+ </body>
+
+</document>
Added: trunk/main/central/src/docs/transit/parts/strategy/resource.xml
===================================================================
--- trunk/main/central/src/docs/transit/parts/strategy/resource.xml
2006-03-28 15:56:03 UTC (rev 1287)
+++ trunk/main/central/src/docs/transit/parts/strategy/resource.xml
2006-03-29 05:05:20 UTC (rev 1288)
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Part Directive</title>
+ </properties>
+
+ <body>
+
+ <section name="Resource Strategy">
+
+ <subsection name="Description">
+
+ <p>
+ </p>
+
+ </subsection>
+
+ <subsection name="Attributes">
+
+ <table>
+ <tr>
+ <td><tt>alias</tt></td>
+ <td>Used in conjunction with part production declaration to
signal that
+ a link uri is produced referencing an absolute artifact uri to
+ the part definition. Alowable values are 'true' and 'false'.
+ </td>
+ </tr>
+ <tr>
+ <td><tt>urn</tt></td>
+ <td>The urn to associated with the collection of tasks and types
+ referenced by the antlib resource declared under the path
attribute.
+ </td>
+ </tr>
+ <tr>
+ <td><tt>path</tt></td>
+ <td>The path to the bundled antlib.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ <section name="Examples">
+
+<source>
+<![CDATA[<resource alias="true" urn="dpml:checkstyle"
path="net/dpml/tools/checkstyle/antlib.xml"/>]]>
+</source>
+
+ </section>
+
+ </body>
+
+</document>
- r1288 - in trunk/main/central/src/docs: metro/directives metro/directives/component metro/directives/component/context metro/directives/type metro/directives/type/categories metro/directives/type/context metro/directives/type/info metro/directives/type/parts metro/directives/type/services metro/directives/type/state metro/directives/type/state/trigger transit transit/parts/strategy, mcconnell at BerliOS, 03/29/2006
Archive powered by MHonArc 2.6.24.