notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

r1903 - in trunk/central/site/src/docs/metro: . component component/directive

From: mcconnell at BerliOS <mcconnell AT mail.berlios.de>
To: notify-dpml AT lists.ibiblio.org
Subject: r1903 - in trunk/central/site/src/docs/metro: . component component/directive
Date: Tue, 13 Mar 2007 05:24:57 +0100

Author: mcconnell
Date: 2007-03-13 05:24:56 +0100 (Tue, 13 Mar 2007)
New Revision: 1903

Added:
trunk/central/site/src/docs/metro/component/directive/categories.xml
trunk/central/site/src/docs/metro/component/directive/context/
trunk/central/site/src/docs/metro/component/directive/parts.xml
trunk/central/site/src/docs/metro/component/state/
Removed:
trunk/central/site/src/docs/metro/component/categories.xml
trunk/central/site/src/docs/metro/component/context/
trunk/central/site/src/docs/metro/component/parts.xml
trunk/central/site/src/docs/metro/state/
Modified:
trunk/central/site/src/docs/metro/component/index.xml
trunk/central/site/src/docs/metro/component/navigation.xml
trunk/central/site/src/docs/metro/navigation.xml
Log:
reshuffle strategy documentation

Deleted: trunk/central/site/src/docs/metro/component/categories.xml
===================================================================
--- trunk/central/site/src/docs/metro/component/categories.xml 2007-03-13
04:08:08 UTC (rev 1902)
+++ trunk/central/site/src/docs/metro/component/categories.xml 2007-03-13
04:24:56 UTC (rev 1903)
@@ -1,84 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<document>
-
- <properties>
- <author email="mcconnell AT dpml.net">Stephen McConnell</author>
- <title>DPML Metro Component Categories Datatype</title>
- </properties>
-
- <body>
-
- <section name="Categories">
-
- <subsection name="Description">
-
- <p>
- 0..n <tt><category></tt> elements may be declared within an
- enclosing <tt><categories></tt> element.
- </p>
-
- </subsection>
-
- <subsection name="Category Attributes">
-
- <table>
- <tr>
- <td><tt>name</tt></td>
- <td>The category name (required).</td>
- </tr>
- <tr>
- <td><tt>priority</tt></td>
- <td>An optional logging channel priority value. Allowable values
- include <tt>DEBUG</tt>, <tt>INFO</tt>, <tt>WARN</tt>, and
- <tt>ERROR</tt>.</td>
- </tr>
- <tr>
- <td><tt>target</tt></td>
- <td>An optional logging channel target.</td>
- </tr>
- </table>
-
- </subsection>
-
- </section>
-
- <section name="Example">
-
- <p>
- the following component directive is asserting that the two subsidiary
- logging channels (<tt>alpha</tt> and <tt>beta</tt>) shall be
established
- with the respective priorities of <tt>WARN</tt> and <tt>ERROR</tt>.
- </p>
-
-<source><![CDATA[
- <component xmlns="dpml:metro"
- 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>
-
- <section name="Technical Notes">
-
- <p>
- Overriding of category settings via metro comandline settings is not
- supported at this time. While the commandline handler does pass a
- categories configuration uri to the ComponentAdapter, the adapter
- does not currently support this feature. A second issue relates to
- non-assignment of logging category targets within the runtime
- DefaultComponentHandler.
- </p>
-
- </section>
-
- </body>
-
-</document>

Copied: trunk/central/site/src/docs/metro/component/directive/categories.xml
(from rev 1893, trunk/central/site/src/docs/metro/component/categories.xml)

Copied: trunk/central/site/src/docs/metro/component/directive/context (from
rev 1893, trunk/central/site/src/docs/metro/component/context)

Copied: trunk/central/site/src/docs/metro/component/directive/parts.xml (from
rev 1893, trunk/central/site/src/docs/metro/component/parts.xml)

Modified: trunk/central/site/src/docs/metro/component/index.xml
===================================================================
--- trunk/central/site/src/docs/metro/component/index.xml 2007-03-13
04:08:08 UTC (rev 1902)
+++ trunk/central/site/src/docs/metro/component/index.xml 2007-03-13
04:24:56 UTC (rev 1903)
@@ -11,100 +11,6 @@

<section name="Component Strategy">

- <subsection name="Namespace">
-
- <pre>dpml:metro</pre>
-
- </subsection>
-
- <subsection name="Description">
-
- <p>
- Definition of a part deployment strategy using the Metro component
model.
- </p>
-
- </subsection>
-
- <subsection name="Standard Attributes">
- <table>
- <tr>
- <td><tt>class</tt></td>
- <td>Declares the component classname.</td>
- </tr>
- <tr>
- <td><tt>name</tt></td>
- <td>Sets the component name.</td>
- </tr>
- <tr>
- <td><tt>activation</tt></td>
- <td>Set the activation policy (optional). The default value is
SYSTEM.
- Possible values include STARTUP (triggers activation on
startup), DEMAND
- (activation trigger on demand) and SYSTEM (activation decesions
are delagated
- to the container).</td>
- </tr>
- <tr>
- <td><tt>lifestyle</tt></td>
- <td>The lifestyle policy. Allowable values include
- <tt>singleton</tt>, <tt>thread</tt>, and <tt>transient</tt>.
- A component declaring the <tt>singleton</tt> lifestyle may be
- shared across all consumers within the JVM (i.e. the potential
- for concurrent access will exist). A component declaring
- the <tt>thread</tt> lifestyle policy may have a set of
instances
- corresponding to the number of threads requesting access. A
- component declaring the <tt>transient</tt> lifestyle will
- instantiated for each access request.</td>
- </tr>
- <tr>
- <td><tt>collection</tt></td>
- <td>The garbage collection policy. Allowable
- values include <tt>weak</tt>, <tt>soft</tt> and <tt>hard</tt>.
- A component type declaring a <tt>weak</tt> collection policy
will
- be garbage collected at the discretion of the JVM. A component
- declaring a <tt>soft</tt> collection policy will be garbage
- collected in the event of memory contention. A component
- declaring the <tt>hard</tt> collection policy will remain in
- memory for the lifetime of the JVM unless explicitly removed
- via a management system or controlling application.</td>
- </tr>
- </table>
-
- </subsection>
-
- <subsection name="Special Attributes">
-
- <table>
- <tr>
- <td><tt>key</tt></td>
- <td>Required only when declaring a nested component within a
type or
- parent component. The key corresponds to the internal key that
uniquely
- identifies the child component within the scope of the
enclosing entity.
- </td>
- </tr>
- </table>
-
- </subsection>
-
- <subsection name="Nested Elements">
-
- <table>
- <tr>
- <td><tt><a href="categories.html">categories</a></tt></td>
- <td>The categories element may contain 0..n logging
<category> directives.
- A category directive allows assignment of initial channel
priorities and
- targets.</td>
- </tr>
- <tr>
- <td><tt><a href="context/index.html">context</a></tt></td>
- <td>Declaration of the component initial context state.</td>
- </tr>
- <tr>
- <td><tt><a href="parts.html">parts</a></tt></td>
- <td>Declaration of the nested components.</td>
- </tr>
- </table>
-
- </subsection>
-
</section>

</body>

Modified: trunk/central/site/src/docs/metro/component/navigation.xml
===================================================================
--- trunk/central/site/src/docs/metro/component/navigation.xml 2007-03-13
04:08:08 UTC (rev 1902)
+++ trunk/central/site/src/docs/metro/component/navigation.xml 2007-03-13
04:24:56 UTC (rev 1903)
@@ -20,14 +20,15 @@

<project>

- <title>Component Strategy Directive Specification</title>
+ <title>Component Strategy</title>

<body>

<menu>
- <item name="Categories" href="categories.html"/>
- <item name="Context" href="context/index.html"/>
- <item name="Parts" href="parts.html"/>
+ <item name="Component Annotations" href="annotation/index.html"/>
+ <item name="Component Directives" href="directive/index.html"/>
+ <item name="Lifecycle Graph" href="state/index.html"/>
+ <item name="Packaged Profiles" href="profile/index.html"/>
</menu>

</body>

Deleted: trunk/central/site/src/docs/metro/component/parts.xml
===================================================================
--- trunk/central/site/src/docs/metro/component/parts.xml 2007-03-13
04:08:08 UTC (rev 1902)
+++ trunk/central/site/src/docs/metro/component/parts.xml 2007-03-13
04:24:56 UTC (rev 1903)
@@ -1,138 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<document>
-
- <properties>
- <author email="mcconnell AT dpml.net">Stephen McConnell</author>
- <title>DPML Metro Component Categories Datatype</title>
- </properties>
-
- <body>
-
- <section name="Parts">
-
- <subsection name="Description">
-
- <p>
- A <tt><parts></tt> elements enables the declaration of
- 0..n nested components.
- </p>
-
- </subsection>
-
- <subsection name="Part Nested Elements">
-
- <table>
- <tr>
- <td><a href="index.html"><tt>component</tt></a></td>
- <td><tt>0..n</tt> nested components.</td>
- </tr>
- </table>
-
- </subsection>
-
- </section>
-
- <section name="Example">
-
- <p>
- The following component defines an HHTP server deployment
- profile made up of a collection in internal parts.
- </p>
-
-<source><![CDATA[
-<component xmlns="dpml:metro"
- type="net.dpml.http.Server"
- alias="true">
-
- <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"/>
- <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>
-
- </section>
-
- </body>
-
-</document>

Copied: trunk/central/site/src/docs/metro/component/state (from rev 1893,
trunk/central/site/src/docs/metro/state)

Modified: trunk/central/site/src/docs/metro/navigation.xml
===================================================================
--- trunk/central/site/src/docs/metro/navigation.xml 2007-03-13 04:08:08
UTC (rev 1902)
+++ trunk/central/site/src/docs/metro/navigation.xml 2007-03-13 04:24:56
UTC (rev 1903)
@@ -29,7 +29,6 @@
<item name="Metro CLI" href="cli/index.html"/>
<item name="Part Definitions" href="parts/index.html"/>
<item name="Component Strategy" href="component/index.html"/>
- <item name="Lifecycle Model" href="state/index.html"/>
<item name="Runtime" href="runtime/index.html"/>
<item name="Tutorials" href="tutorials/index.html"/>
</menu>

r1903 - in trunk/central/site/src/docs/metro: . component component/directive, mcconnell at BerliOS, 03/13/2007