notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

r1285 - in trunk/main/central/src/docs: metro/directives/component metro/directives/component/context metro/directives/type/context metro/directives/type/parts transit/parts transit/parts/classpath transit/parts/info

From: mcconnell at BerliOS <mcconnell AT mail.berlios.de>
To: notify-dpml AT lists.ibiblio.org
Subject: r1285 - in trunk/main/central/src/docs: metro/directives/component metro/directives/component/context metro/directives/type/context metro/directives/type/parts transit/parts transit/parts/classpath transit/parts/info
Date: Tue, 28 Mar 2006 17:31:58 +0200

Author: mcconnell
Date: 2006-03-28 17:31:57 +0200 (Tue, 28 Mar 2006)
New Revision: 1285

Modified:
trunk/main/central/src/docs/metro/directives/component/context/index.xml
trunk/main/central/src/docs/metro/directives/component/parts.xml
trunk/main/central/src/docs/metro/directives/type/context/index.xml
trunk/main/central/src/docs/metro/directives/type/parts/index.xml
trunk/main/central/src/docs/transit/parts/classpath/index.xml
trunk/main/central/src/docs/transit/parts/index.xml
trunk/main/central/src/docs/transit/parts/info/index.xml
Log:
housekeeping

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 14:49:59 UTC (rev 1284)
+++ trunk/main/central/src/docs/metro/directives/component/context/index.xml
2006-03-28 15:31:57 UTC (rev 1285)
@@ -41,7 +41,7 @@

</section>

- <section name="Example">
+ <section name="Examples">

<subsection name="General Example">

@@ -52,7 +52,7 @@
creation, composite value creation, and service wiring.
</p>

-<pre><![CDATA[
+<source><![CDATA[
<context>
<entry key="name" value="$${user.name}"/>
<entry key="printer" lookup="org.acme.Printer"/>
@@ -69,7 +69,7 @@
</value>
</entry>
</context>
-]]></pre>
+]]></source>

</subsection>

Modified: trunk/main/central/src/docs/metro/directives/component/parts.xml
===================================================================
--- trunk/main/central/src/docs/metro/directives/component/parts.xml
2006-03-28 14:49:59 UTC (rev 1284)
+++ trunk/main/central/src/docs/metro/directives/component/parts.xml
2006-03-28 15:31:57 UTC (rev 1285)
@@ -40,83 +40,89 @@
profile made up of a collection in internal parts.
</p>

-<pre><![CDATA[
- <target name="build" depends="standard.build">
+<source><![CDATA[

- <depot:plugin uri="link:plugin:dpml/metro/dpml-metro-tools" urn="metro"/>
+<component xmlns="metro" type="net.dpml.http.Server" lifestyle="singleton">

- <component xmlns="metro" type="net.dpml.http.Server"
lifestyle="singleton">
- <parts>
- 
- <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>
- 
- <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>
- 
- <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>
- 
- <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>
- 
- <component key="context" type="net.dpml.http.ResourceContextHandler">
- <context>
- <entry key="resourceBase" value="$${dpml.share}/docs"/>
- <entry key="contextPath" value="/docs"/>
- </context>
- </component>
- 
- <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>
+ <parts>
+
+ 
+ <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>
-]]></pre>
+
+ 
+ <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>
+
+ 
+ <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>
+
+ 
+ <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>
+
+ 
+ <component key="context" type="net.dpml.http.ResourceContextHandler">
+ <context>
+ <entry key="resourceBase" value="$${dpml.share}/docs"/>
+ <entry key="contextPath" value="/docs"/>
+ </context>
+ </component>
+
+ 
+ <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>

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 14:49:59 UTC (rev 1284)
+++ trunk/main/central/src/docs/metro/directives/type/context/index.xml
2006-03-28 15:31:57 UTC (rev 1285)
@@ -14,8 +14,36 @@
<subsection name="Description">

<p>
+ A <tt><context></tt> describes a collection of context entry
+ descriptors. Each descriptor is represents the funtional assumptions
+ of the component implementation with resopect to a individual contect
+ entry. Each entry describes the class assignment presumptions and
+ optional versus required context entry assumptions.
</p>
+
+ </subsection>

+ <subsection name="Nested Elements">
+
+ <table>
+ <tr>
+ <td><tt><a href="entry.html">entry</a></tt></td>
+ <td>
+ Declaration of context entry directives. The context element
+ may contain multiple context entry directives. Each directive
+ declares a key identifying the component context entry name
+ using the Java-beans naming convention. The entry element
+ may also declare the context entry class expected the component
+ implementation and its optional or required status.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ <section name="Examples">
+
<source>
<![CDATA[
<type xmlns="artifact:xsd:dpml/lang/dpml-type#1.0"
@@ -63,26 +91,6 @@
</info>]]>
</source>

- </subsection>
-
- <subsection name="Nested Elements">
-
- <table>
- <tr>
- <td><tt><a href="entry.html">entry</a></tt></td>
- <td>
- Declaration of context entry. The context element
- may contain multiple context entry directives. Each directive
- declares a key identifying the component context entry name
- using the Java-beans naming convention. The entry element
- may also declare the context entry class expected the component
- implementation and its optional or required status.</td>
- </tr>
- </table>
-
- </subsection>
-
-
</section>

</body>

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 14:49:59 UTC (rev 1284)
+++ trunk/main/central/src/docs/metro/directives/type/parts/index.xml
2006-03-28 15:31:57 UTC (rev 1285)
@@ -34,10 +34,6 @@
<td><tt><a
href="../../component/index.html">component</a></tt></td>
<td>Declaration of a nested component using the Metro component
directive.</td>
</tr>
- <tr>
- <td><tt>part</tt></td>
- <td>Inclusion of a part by reference to a part uri</td>
- </tr>
</table>

</subsection>
@@ -46,40 +42,39 @@

<section name="Examples">

- <subsection name="Nested component example">
+<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">
+
+ <info name="parent"
+ class="net.dpml.test.composite.CompositeComponent"
+ 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>
+ <parts>
+ <component xmlns="artifact:xsd:dpml/lang/dpml-component#1.0" key="child"
+ class="net.dpml.test.composite.ChildComponent"
+ name="child"
+ collection="system"
+ activation="system">
+ <context>
+ <entry key="color" class="java.awt.Color" method="BLUE"/>
+ </context>
+ </component>
+ </parts>
+</type>
+]]></source>

-<pre><![CDATA[
- <type class="net.dpml.test.composite.CompositeComponent" name="parent">
- <parts>
- <component type="net.dpml.test.composite.ChildComponent" key="primary">
- <context>
- <entry key="color" method="RED"/>
- </context>
- </component>
- <component type="net.dpml.test.composite.ChildComponent"
key="secondary">
- <context>
- <entry key="color" method="BLUE"/>
- </context>
- </component>
- </parts>
- </type>
-]]></pre>
-
- </subsection>
-
- <subsection name="Part by reference example">
-
-<pre><![CDATA[
- <type class="org.acme.DefaultGizmo" name="gizmo">
- <parts>
- <part key="widget"
uri="artifact:part:acme/widget/standard-widget#3.1"/>
- </parts>
- </type>
-]]></pre>
-
- </subsection>
-
-
</section>

</body>

Modified: trunk/main/central/src/docs/transit/parts/classpath/index.xml
===================================================================
--- trunk/main/central/src/docs/transit/parts/classpath/index.xml
2006-03-28 14:49:59 UTC (rev 1284)
+++ trunk/main/central/src/docs/transit/parts/classpath/index.xml
2006-03-28 15:31:57 UTC (rev 1285)
@@ -14,38 +14,14 @@
<subsection name="Description">

<p>
+ A <tt><classpath></tt> element defines a classloader chain
based on
+ the three classloader categories - PUBLIC, PROTECTED and PRIVATE.
Typically
+ a classloader chain will be constructed relative to a supplied
anchor classloader.
+ The anchor will be used as the parent to a PUBLIC classloader which
in-turn is used
+ as the parent for the creatio of a protected (or SPI) classloader.
The protected
+ classloader is used as the parent to the PRIVATE implemention
classloader.
</p>

- <p>Example:</p>
-
-<source>
-<![CDATA[
- <classpath>
- <public>
- <uri>artifact:jar:dpml/util/dpml-logging-api#SNAPSHOT</uri>
- </public>
- <protected>
- <uri>artifact:jar:dpml/metro/dpml-state-api#SNAPSHOT</uri>
- <uri>artifact:jar:dpml/util/dpml-job-api#SNAPSHOT</uri>
- <uri>artifact:jar:dpml/transit/dpml-transit-main#SNAPSHOT</uri>
- <uri>artifact:jar:dpml/metro/dpml-metro-component#SNAPSHOT</uri>
- <uri>artifact:jar:dpml/util/dpml-parameters-api#SNAPSHOT</uri>
- <uri>artifact:jar:dpml/util/dpml-configuration-api#SNAPSHOT</uri>
- <uri>artifact:jar:dpml/metro/dpml-metro-model#SNAPSHOT</uri>
- </protected>
- <private>
- <uri>artifact:jar:dpml/util/dpml-parameters-impl#SNAPSHOT</uri>
- <uri>artifact:jar:dpml/util/dpml-configuration-impl#SNAPSHOT</uri>
- <uri>artifact:jar:dpml/util/dpml-job-impl#SNAPSHOT</uri>
- <uri>artifact:jar:dpml/metro/dpml-state-impl#SNAPSHOT</uri>
- <uri>artifact:jar:dpml/depot/dpml-library#SNAPSHOT</uri>
- <uri>artifact:jar:dpml/metro/dpml-metro-builder#SNAPSHOT</uri>
- <uri>artifact:jar:dpml/metro/dpml-metro-runtime#SNAPSHOT</uri>
- </private>
- </classpath>
-]]>
-</source>
-
</subsection>

<subsection name="Nested Elements">
@@ -88,7 +64,39 @@
</subsection>

</section>
-
+
+ <section name="Examples">
+
+<source>
+<![CDATA[
+ <classpath>
+ <public>
+ <uri>artifact:jar:dpml/util/dpml-logging-api#SNAPSHOT</uri>
+ </public>
+ <protected>
+ <uri>artifact:jar:dpml/metro/dpml-state-api#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/util/dpml-job-api#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/transit/dpml-transit-main#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/metro/dpml-metro-component#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/util/dpml-parameters-api#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/util/dpml-configuration-api#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/metro/dpml-metro-model#SNAPSHOT</uri>
+ </protected>
+ <private>
+ <uri>artifact:jar:dpml/util/dpml-parameters-impl#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/util/dpml-configuration-impl#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/util/dpml-job-impl#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/metro/dpml-state-impl#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/depot/dpml-library#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/metro/dpml-metro-builder#SNAPSHOT</uri>
+ <uri>artifact:jar:dpml/metro/dpml-metro-runtime#SNAPSHOT</uri>
+ </private>
+ </classpath>
+]]>
+</source>
+
+ </section>
+
</body>

</document>

Modified: trunk/main/central/src/docs/transit/parts/index.xml
===================================================================
--- trunk/main/central/src/docs/transit/parts/index.xml 2006-03-28 14:49:59
UTC (rev 1284)
+++ trunk/main/central/src/docs/transit/parts/index.xml 2006-03-28 15:31:57
UTC (rev 1285)
@@ -23,6 +23,52 @@
definition.
</p>

+ </subsection>
+
+ <subsection name="Nested Elements">
+
+ <table>
+ <tr>
+ <td>
+ <tt><a href="info/index.html">info</a></tt>
+ </td>
+ <td>
+ The info defintion used to associate a title and
+ human readable description.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <tt><a href="strategy/index.html">strategy</a></tt>
+ </td>
+ <td>
+ Any XML element derived from StrategyType. The schema element
+ defines the deployment strategy. A part handler is resolved
+ through a element builder which is itself resolved relative to
+ the XML schema urn of the strategy element. The Transit system
+ provides two standard strategy elements -
<tt><plugin></tt>
+ and <tt><resource></tt>.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <tt><a href="classpath/index.html">classpath</a></tt>
+ </td>
+ <td>
+ Definition of the classpath for the part. The classpath
contains
+ the declaration of public, protected and private jar files
referenced
+ via uris that collectively enable the cionstruction of a
cloassloader
+ chain.
+ </td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ <section name="Examples">
+
<p>Example part definition:</p>

<source>
@@ -64,48 +110,6 @@
</part>]]>
</source>

- </subsection>
-
- <subsection name="Nested Elements">
-
- <table>
- <tr>
- <td>
- <tt><a href="info/index.html">info</a></tt>
- </td>
- <td>
- The info defintion used to associate a title and
- human readable description.
- </td>
- </tr>
- <tr>
- <td>
- <tt><a href="strategy/index.html">strategy</a></tt>
- </td>
- <td>
- Any XML element derived from StrategyType. The schema element
- defines the deployment strategy. A part handler is resolved
- through a element builder which is itself resolved relative to
- the XML schema urn of the strategy element. The Transit system
- provides two standard strategy elements -
<tt><plugin></tt>
- and <tt><resource></tt>.
- </td>
- </tr>
- <tr>
- <td>
- <tt><a href="classpath/index.html">classpath</a></tt>
- </td>
- <td>
- Definition of the classpath for the part. The classpath
contains
- the declaration of public, protected and private jar files
referenced
- via uris that collectively enable the cionstruction of a
cloassloader
- chain.
- </td>
- </tr>
- </table>
-
- </subsection>
-
</section>

</body>

Modified: trunk/main/central/src/docs/transit/parts/info/index.xml
===================================================================
--- trunk/main/central/src/docs/transit/parts/info/index.xml 2006-03-28
14:49:59 UTC (rev 1284)
+++ trunk/main/central/src/docs/transit/parts/info/index.xml 2006-03-28
15:31:57 UTC (rev 1285)
@@ -17,8 +17,14 @@
The <tt><info></tt> element associates a human-readable
title and description with a part definition.
</p>
+
+ </subsection>

- <p>Example:</p>
+ </section>
+
+ <section name="Example">
+
+ <p>Example of an ninfo element declaration:</p>

<source>
<![CDATA[
@@ -29,8 +35,6 @@
</description>
</info>]]>
</source>
-
- </subsection>

</section>

r1285 - in trunk/main/central/src/docs: metro/directives/component metro/directives/component/context metro/directives/type/context metro/directives/type/parts transit/parts transit/parts/classpath transit/parts/info, mcconnell at BerliOS, 03/28/2006