notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

r1314 - in trunk/main/central/src/docs/transit: . concepts setup setup/config setup/config/hosts tasks technical

From: mcconnell at BerliOS <mcconnell AT mail.berlios.de>
To: notify-dpml AT lists.ibiblio.org
Subject: r1314 - in trunk/main/central/src/docs/transit: . concepts setup setup/config setup/config/hosts tasks technical
Date: Wed, 5 Apr 2006 18:30:23 +0200

Author: mcconnell
Date: 2006-04-05 18:30:21 +0200 (Wed, 05 Apr 2006)
New Revision: 1314

Added:
trunk/main/central/src/docs/transit/setup/config/hosts/
trunk/main/central/src/docs/transit/setup/config/hosts/index.xml
trunk/main/central/src/docs/transit/setup/config/hosts/layouts.xml
trunk/main/central/src/docs/transit/setup/config/hosts/navigation.xml
Removed:
trunk/main/central/src/docs/transit/services/
trunk/main/central/src/docs/transit/setup/config/hosts.xml
Modified:
trunk/main/central/src/docs/transit/concepts/plugins.xml
trunk/main/central/src/docs/transit/navigation.xml
trunk/main/central/src/docs/transit/setup/config/navigation.xml
trunk/main/central/src/docs/transit/setup/navigation.xml
trunk/main/central/src/docs/transit/tasks/import.xml
trunk/main/central/src/docs/transit/technical/local.xml
Log:
tighten-up transit docs

Modified: trunk/main/central/src/docs/transit/concepts/plugins.xml
===================================================================
--- trunk/main/central/src/docs/transit/concepts/plugins.xml 2006-04-05
15:51:16 UTC (rev 1313)
+++ trunk/main/central/src/docs/transit/concepts/plugins.xml 2006-04-05
16:30:21 UTC (rev 1314)
@@ -101,20 +101,10 @@
URI uri = new URI( "artifact:part:mycompany/thisproject/hello-impl#1.4.1"
);
Object[] args = new Object[] { "Hello, World!" };
Part part = Part.load( uri );
- Object plugin = part.instantiate( args );
- if( plugin instanceof Hello )
- {
- m_hello = (Hello) plugin;
- }
- else
- {
- throw Exception( "Loaded plugin is not of the right type." );
- }
- :
- :
- :
- m_hello.announce();
+ Hello plugin = (Hello) part.instantiate( args );
+ plugin.announce();
</source>
+
<p>
For this to work, you will need to create the plugin meta
descriptor. The easiest way is to use the DPML Depot build system,

Modified: trunk/main/central/src/docs/transit/navigation.xml
===================================================================
--- trunk/main/central/src/docs/transit/navigation.xml 2006-04-05 15:51:16
UTC (rev 1313)
+++ trunk/main/central/src/docs/transit/navigation.xml 2006-04-05 16:30:21
UTC (rev 1314)
@@ -28,7 +28,6 @@
<item name="Overview" href="concepts/index.html"/>
<item name="Protocols" href="technical/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"/>

Added: trunk/main/central/src/docs/transit/setup/config/hosts/index.xml
===================================================================
--- trunk/main/central/src/docs/transit/setup/config/hosts/index.xml
2006-04-05 15:51:16 UTC (rev 1313)
+++ trunk/main/central/src/docs/transit/setup/config/hosts/index.xml
2006-04-05 16:30:21 UTC (rev 1314)
@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Transit XML Specification</title>
+ </properties>
+
+ <body>
+
+ <section name="Transit XML Remote Hosts Declaration">
+
+ <subsection name="Description">
+
+ <p>
+ The transit <tt>hosts</tt> element may contain the declaration
+ of <tt>0..n</tt> remote host definitions. Remote hosts will be
+ used to resolve requests for resource via the artifact protocol.
+ Hosts will be evaluated relative the their priority settings.
+ </p>
+
+ </subsection>
+
+ <subsection name="Attributes">
+
+ <table>
+ <tr>
+ <td>id</td>
+ <td>required</td>
+ <td>The resource host identifier.</td>
+ </tr>
+ <tr>
+ <td>priority</td>
+ <td>required</td>
+ <td>An integer establishing the priority of the host. hosts
+ will be evaluated in accending order (lower number means
+ higher priority).</td>
+ </tr>
+ <tr>
+ <td>url</td>
+ <td>required</td>
+ <td>The URL referencing the remote repository root.</td>
+ </tr>
+ <tr>
+ <td><a href="layouts.html">layout</a></td>
+ <td>required</td>
+ <td>The name of the layout scheme employed by the remote host
+ (standard layout names include 'classic', 'modern' and
+ 'eclipse').</td>
+ </tr>
+ <tr>
+ <td>enabled</td>
+ <td>implied</td>
+ <td>The enabled status of the host definition. The default
+ value is true.</td>
+ </tr>
+ <tr>
+ <td>trusted</td>
+ <td>implied</td>
+ <td>The trusted status of the host definition. The default
+ value is false.</td>
+ </tr>
+ <tr>
+ <td>index</td>
+ <td>implied</td>
+ <td>Relative path to an remote index file containing group
+ names managed by the host. Default value is null.</td>
+ </tr>
+ <tr>
+ <td>scheme</td>
+ <td>implied</td>
+ <td>Authentication scheme. Default value is null.</td>
+ </tr>
+ <tr>
+ <td>prompt</td>
+ <td>implied</td>
+ <td>Authentication prompt. Default value is null.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ <subsection name="Nested Elements">
+
+ <table>
+ <tr>
+ <td><tt>credentials</tt></td>
+ <td>Optional declaration of a username and password.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ <subsection name="Example">
+
+<source><![CDATA[
+<transit cache="${dpml.data}/cache" layout="classic">
+
+ ...
+
+ <hosts>
+ <host id="dpml" priority="40" url="http://repository.dpml.net/classic";
layout="classic"/>
+ <host id="ibiblio" priority="70" url="http://www.ibiblio.org/maven";
layout="classic"/>
+ <host id="m2" priority="100" url="http://www.ibiblio.org/maven2";
layout="modern"/>
+ <host id="apache" priority="140"
url="http://www.apache.org/dist/java-repository"; layout="classic"/>
+ </hosts>
+
+</transit>
+
+]]></source>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
+

Added: trunk/main/central/src/docs/transit/setup/config/hosts/layouts.xml
===================================================================
--- trunk/main/central/src/docs/transit/setup/config/hosts/layouts.xml
2006-04-05 15:51:16 UTC (rev 1313)
+++ trunk/main/central/src/docs/transit/setup/config/hosts/layouts.xml
2006-04-05 16:30:21 UTC (rev 1314)
@@ -0,0 +1,109 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+
+
+<document>
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Transit Host Layouts</title>
+ </properties>
+
+ <body>
+
+ <section name="Host Layouts">
+
+ <p>
+ Transit resource hosts configuration allows the declaration
+ of a host layout scheme. Layout schemes deal with the mapping
+ of a resource identifier to a resource location. Three layout
+ schemes are provides as a part of the core Transit system
+ together with support for the installation of custom layout
+ handlers. The standard layout schemes supported within the
+ Transit core system are described below.
+ </p>
+
+ <subsection name="Modern">
+
+ <p>
+ The ModernLayout decodes artifacts into a layout scheme that follows
the
+ <tt>[group[/[subgroup[/...]]]/[version]/name[-[version]].[type]</tt>
convention.
+ </p>
+
+ <table>
+ <tr>
+ <td>artifact:</td>
+ <td><tt>artifact:jar:metro/cache/dpml-cache-main#1.0.0</tt></td>
+ </tr>
+ <tr>
+ <td>path:</td>
+
<td><tt>[host]/metro/cache/1.0.0/dpml-cache-main-1.0.0.jar</tt></td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ <subsection name="Classic">
+
+ <p>
+ The ClassicLayout decodes artifacts into the Classic/Maven layout
+ of artifacts on a file system or http server. This format says that
+ for an artifact <tt>artifact:[type]:[group]/[name]#[version]</tt>
+ the location of such artifact shall be:
<tt>[group]/[type]s/[name]-[version].[type]</tt>.
+ </p>
+
+ <table>
+ <tr>
+ <td>artifact:</td>
+ <td><tt>artifact:jar:metro/cache/dpml-cache-main#1.0.0</tt></td>
+ </tr>
+ <tr>
+ <td>path:</td>
+
<td><tt>[host]/metro/cache/jars/dpml-cache-main-1.0.0.jar</tt></td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ <subsection name="Eclipse">
+
+ <p>
+ The EclipseLayout maps artifacts into the Eclipse specified layout
+ of artifacts on a file system or http server. This format says that
for
+ an artifact <tt>artifact:[type]:[group]/[name]#[version]</tt>
+ the location of such artifact shall be:
<tt>[group]-[version]/[name].[type]</tt>.
+ </p>
+
+ <table>
+ <tr>
+ <td>artifact:</td>
+ <td><tt>artifact:jar:metro/cache/dpml-cache-main#1.0.0</tt></td>
+ </tr>
+ <tr>
+ <td>path:</td>
+ <td><tt>[host]/metro/cache-1.0.0/dpml-cache-main.jar</tt></td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>

Added: trunk/main/central/src/docs/transit/setup/config/hosts/navigation.xml
===================================================================
--- trunk/main/central/src/docs/transit/setup/config/hosts/navigation.xml
2006-04-05 15:51:16 UTC (rev 1313)
+++ trunk/main/central/src/docs/transit/setup/config/hosts/navigation.xml
2006-04-05 16:30:21 UTC (rev 1314)
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+
+
+<project>
+
+ <title>DPML Central</title>
+
+ <body>
+
+ <menu>
+ <item name="Layout" href="layouts.html"/>
+ </menu>
+
+ </body>
+
+</project>

Deleted: trunk/main/central/src/docs/transit/setup/config/hosts.xml
===================================================================
--- trunk/main/central/src/docs/transit/setup/config/hosts.xml 2006-04-05
15:51:16 UTC (rev 1313)
+++ trunk/main/central/src/docs/transit/setup/config/hosts.xml 2006-04-05
16:30:21 UTC (rev 1314)
@@ -1,120 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<document>
-
- <properties>
- <author email="mcconnell AT dpml.net">Stephen McConnell</author>
- <title>DPML Transit XML Specification</title>
- </properties>
-
- <body>
-
- <section name="Transit XML Remote Hosts Declaration">
-
- <subsection name="Description">
-
- <p>
- The transit <tt>hosts</tt> element may contain the declaration
- of <tt>0..n</tt> remote host definitions. Remote hosts will be
- used to resolve requests for resource via the artifact protocol.
- Hosts will be evaluated relative the their priority settings.
- </p>
-
- </subsection>
-
- <subsection name="Attributes">
-
- <table>
- <tr>
- <td>id</td>
- <td>required</td>
- <td>The resource host identifier.</td>
- </tr>
- <tr>
- <td>priority</td>
- <td>required</td>
- <td>An integer establishing the priority of the host. hosts
- will be evaluated in accending order (lower number means
- higher priority).</td>
- </tr>
- <tr>
- <td>url</td>
- <td>required</td>
- <td>The URL referencing the remote repository root.</td>
- </tr>
- <tr>
- <td>layout</td>
- <td>required</td>
- <td>The name of the layout scheme employed by the remote host
- (standard layout names include 'classic', 'modern' and
- 'eclipse').</td>
- </tr>
- <tr>
- <td>enabled</td>
- <td>implied</td>
- <td>The enabled status of the host defintion. The default
- value is true.</td>
- </tr>
- <tr>
- <td>trusted</td>
- <td>implied</td>
- <td>The trusted status of the host defintion. The default
- value is false.</td>
- </tr>
- <tr>
- <td>index</td>
- <td>implied</td>
- <td>Relative path to an remote index file containing group
- names managed by the host. Default value is null.</td>
- </tr>
- <tr>
- <td>scheme</td>
- <td>implied</td>
- <td>Authentication scheme. Default value is null.</td>
- </tr>
- <tr>
- <td>prompt</td>
- <td>implied</td>
- <td>Authentication prompt. Default value is null.</td>
- </tr>
- </table>
-
- </subsection>
-
- <subsection name="Nested Elements">
-
- <table>
- <tr>
- <td><tt>credentials</tt></td>
- <td>Optional declaration of a username and password.</td>
- </tr>
- </table>
-
- </subsection>
-
- <subsection name="Example">
-
-<source><![CDATA[
-<transit cache="${dpml.data}/cache" layout="classic">
-
- ...
-
- <hosts>
- <host id="dpml" priority="40" url="http://repository.dpml.net/classic";
layout="classic"/>
- <host id="ibiblio" priority="70" url="http://www.ibiblio.org/maven";
layout="classic"/>
- <host id="m2" priority="100" url="http://www.ibiblio.org/maven2";
layout="modern"/>
- <host id="apache" priority="140"
url="http://www.apache.org/dist/java-repository"; layout="classic"/>
- </hosts>
-
-</transit>
-
-]]></source>
-
- </subsection>
-
- </section>
-
- </body>
-
-</document>
-

Modified: trunk/main/central/src/docs/transit/setup/config/navigation.xml
===================================================================
--- trunk/main/central/src/docs/transit/setup/config/navigation.xml
2006-04-05 15:51:16 UTC (rev 1313)
+++ trunk/main/central/src/docs/transit/setup/config/navigation.xml
2006-04-05 16:30:21 UTC (rev 1314)
@@ -27,7 +27,7 @@
<menu>
<item name="Local" href="local.html"/>
<item name="Proxy" href="proxy.html"/>
- <item name="Hosts" href="hosts.html"/>
+ <item name="Hosts" href="hosts/index.html"/>
</menu>

</body>

Modified: trunk/main/central/src/docs/transit/setup/navigation.xml
===================================================================
--- trunk/main/central/src/docs/transit/setup/navigation.xml 2006-04-05
15:51:16 UTC (rev 1313)
+++ trunk/main/central/src/docs/transit/setup/navigation.xml 2006-04-05
16:30:21 UTC (rev 1314)
@@ -25,8 +25,8 @@
<body>

<menu>
- <item name="System Properties" href="properties.html"/>
- <item name="XML Configuration" href="config/index.html"/>
+ <item name="Properties" href="properties.html"/>
+ <item name="XML" href="config/index.html"/>
</menu>

</body>

Modified: trunk/main/central/src/docs/transit/tasks/import.xml
===================================================================
--- trunk/main/central/src/docs/transit/tasks/import.xml 2006-04-05
15:51:16 UTC (rev 1313)
+++ trunk/main/central/src/docs/transit/tasks/import.xml 2006-04-05
16:30:21 UTC (rev 1314)
@@ -34,7 +34,6 @@
</p>

<table>
- <tr><th>Attribute</th><th>Description</th></tr>
<tr>
<td>uri</td>
<td>A URI resolvable to a template resource.</td>

Modified: trunk/main/central/src/docs/transit/technical/local.xml
===================================================================
--- trunk/main/central/src/docs/transit/technical/local.xml 2006-04-05
15:51:16 UTC (rev 1313)
+++ trunk/main/central/src/docs/transit/technical/local.xml 2006-04-05
16:30:21 UTC (rev 1314)
@@ -48,7 +48,7 @@
type
</td>
<td>
- The type of the artifact - e.g. "template".
+ The type of the artifact - e.g. "properties".
</td>
</tr>
<tr>
@@ -89,17 +89,17 @@
</p>
<p>
The following example local URI identifies a resource named
- "standard" associated with the "dpml/tools" group, using a
- resource type called "template".
+ "standard" associated with the "org/acme" group, using a
+ resource type "properties".
</p>

- <source>local:dpml/tools/standard</source>
+ <source>local:properties:org/acme/standard</source>

<p>
The above uri is equivalent to the following logical file path:
</p>

- <pre>${dpml.prefs}/dpml/tools/templates/standard.template</pre>
+ <pre>${dpml.prefs}/org/acme/properties/standard.properties</pre>

</subsection>

r1314 - in trunk/main/central/src/docs/transit: . concepts setup setup/config setup/config/hosts tasks technical, mcconnell at BerliOS, 04/05/2006