notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

svn commit: r1406 - in development/main/central/site/src/docs: concepts products/transit/properties products/transit/properties/cache products/transit/properties/hosts

From: dleangen AT netcompartner.com
To: notify-dpml AT lists.ibiblio.org
Subject: svn commit: r1406 - in development/main/central/site/src/docs: concepts products/transit/properties products/transit/properties/cache products/transit/properties/hosts
Date: Sat, 08 Jan 2005 06:44:21 +0100

Author: dleangen
Date: Sat Jan 8 06:44:21 2005
New Revision: 1406

Added:
development/main/central/site/src/docs/concepts/dpml_home.xml

development/main/central/site/src/docs/products/transit/properties/cache.xml

development/main/central/site/src/docs/products/transit/properties/hosts.xml
Removed:
development/main/central/site/src/docs/products/transit/properties/cache/
development/main/central/site/src/docs/products/transit/properties/hosts/
Modified:
development/main/central/site/src/docs/concepts/index.xml

development/main/central/site/src/docs/products/transit/properties/index.xml

development/main/central/site/src/docs/products/transit/properties/navigation.xml
Log:
Updated information about Transit properties.

Added: development/main/central/site/src/docs/concepts/dpml_home.xml
==============================================================================
--- (empty file)
+++ development/main/central/site/src/docs/concepts/dpml_home.xml Sat
Jan 8 06:44:21 2005
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<document verified="false">
+ <properties>
+ <author email="dleangen AT dpml.net">David Leangen</author>
+ <title>DPML Concepts</title>
+ </properties>
+
+ <body>
+ <section name="${dpml.home}">
+
+ 
+ Environment variable that sets the home directory for your DPML
products.
+ 
+
+ 
+ This is the notation we use throughout this documentation to refer
to the
+ environment variable "DPML_HOME".
+ 
+
+ 
+ The location ${dpml.home} defines the location of your
+ <a href="index.html#local_cache">local cache</a>, as well as many of
the
+ configuration files required by the DPML systems.
+ 
+
+ 
+ See also:
+ <ul>
+ <li><a href="../guide/setup/dpml.html">DPML setup</a></li>
+ </ul>
+ 
+
+ </section>
+
+ </body>
+</document>

Modified: development/main/central/site/src/docs/concepts/index.xml
==============================================================================
--- development/main/central/site/src/docs/concepts/index.xml (original)
+++ development/main/central/site/src/docs/concepts/index.xml Sat Jan 8
06:44:21 2005
@@ -21,6 +21,12 @@
<th>Meaning</th>
</tr>
<tr>
+ <td><a name="dpml_home"
href="dpml_home.html">${dpml.home}</a></td>
+ <td>
+ Environment variable that sets the home directory for your
DPML products.
+ </td>
+ </tr>
+ <tr>
<td><a name="artifact" href="">artifact</a></td>
<td>
</td>
@@ -36,6 +42,11 @@
</td>
</tr>
<tr>
+ <td><a name="host" href="">host</a></td>
+ <td>
+ </td>
+ </tr>
+ <tr>
<td><a name="enabled_solution" href="">enabled
solution</a></td>
<td>
</td>

Added:
development/main/central/site/src/docs/products/transit/properties/cache.xml
==============================================================================
--- (empty file)
+++
development/main/central/site/src/docs/products/transit/properties/cache.xml
Sat Jan 8 06:44:21 2005
@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+
+<document verified="false">
+ <properties>
+ <author email="niclas AT hedhman.org">Niclas Hedhman</author>
+ <author email="david.leangen AT konova.com">David Leangen</author>
+ <title>DPML Transit</title>
+ </properties>
+
+ <body>
+ <section name="Cache Properties">
+ 
+ The <a href="../../../concepts/index.html#local_cache_manager">local
cache manager</a>
+ stores the downloaded
+ <a href="../../../concepts/index.html#artifact">artifact</a>s on
your
+ local file system.
+ This allows your DPML-enabled applications to quickly retrieve
+ required resources.
+ 
+
+ 
+ When requested by your application, the cache manager will first
+ check the local cache for the required resource.
+ If the resource is not available in the local cache, the cache
manager
+ will then query each
+ <a href="../../../concepts/index.html#remote_repository">remote
repository</a>
+ defined as a
+ <a href="../../../concepts/index.html#host">host</a>
+ until the resource is found.
+ 
+
+ 
+ Requests to remote repositories are conducted sequentially in order
of
+ priority, with the highest priority value queried first.
+ 
+
+ << insert figure >>
+
+ <subsection name="Properties" >
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Default Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>dpml.transit.cache.location</td>
+ <td><a
href="../../../concepts/index.html#dpml_home">${dpml.home}</a>/main</td>
+ <td>The location of the cache system.</td>
+ </tr>
+ <tr>
+ <td>dpml.transit.cache.class</td>
+ <td><a
href="../../../../@TRANSIT-DOCS-PATH@/net/dpml/transit/artifact/FieldCacheHandler.html">net.dpml.transit.artifact.FileCacheHandler</a></td>
+ <td>
+ The class that implements the cache handler interface
+ <a
href="../../../../@TRANSIT-DOCS-PATH@/net/dpml/transit/artifact/CacheHandler.html">net.dpml.transit.artifact.CacheHandler</a>.
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ </section>
+ </body>
+</document>
+
+
+

Added:
development/main/central/site/src/docs/products/transit/properties/hosts.xml
==============================================================================
--- (empty file)
+++
development/main/central/site/src/docs/products/transit/properties/hosts.xml
Sat Jan 8 06:44:21 2005
@@ -0,0 +1,355 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+
+<document>
+ <properties>
+ <author email="niclas AT hedhman.org">Niclas Hedhman</author>
+ <title>DPML Transit</title>
+ </properties>
+
+ <body>
+ <section name="Hosts Configuration">
+
+ 
+ A Resource Host is a place where Artifacts can be downloaded. Transit
+ is capable of handling many types of resource hosts. Conceptually,
you
+ only need to implement the
+ <code>net.dpml.transit.artifact.ResourceHost</code> interface, and
+ specify the implementation class of the host handler.
+ host.
+ 
+
+ 
+ Resource hosts may be declared via XML (default) or property files.
+ 
+
+ <subsection name="XML Specification">
+
+ 
+ The hosts configuation files when full expanded contains multiple
<host>
+ element entries. The following example shows a host element with
all
+ elements declared:
+ 
+
+<source><![CDATA[
+<hosts>
+
+ <host href="http://www.dpml.net"; enabled="true">
+ <priority>20</priority>
+ <policy>fast</policy>
+ <trusted>false</trusted>
+ <class>net.dpml.transit.artifact.ClassicResourceHost</class>
+ <index href="index.idx">
+ <credentials>
+ <username>fred</username>
+ <password>blogs</password>
+ </credentials>
+ <scheme>basic</scheme>
+ <prompt>repository</prompt>
+ </host>
+
+</hosts>
+]]></source>
+
+ 
+ The default host configuration file is shown below, and find the
+ description of the elements in the properties
section
+ below.
+ 
+
+<source><![CDATA[
+<hosts>
+
+ <host dir="local/SNAPSHOT">
+ <priority>10</priority>
+ <trusted>true</trusted>
+ </host>
+
+ <host href="http://www.dpml.net/repository";>
+ <priority>20</priority>
+ </host>
+
+ <host href="http://www.ibiblio.org/maven";>
+ <priority>50</priority>
+ </host>
+
+ <host href="http://www.apache.org/dist/java-repository";>
+ <priority>70</priority>
+ </host>
+
+</hosts>]]></source>
+
+ </subsection>
+
+ <subsection name="Properties Specification">
+
+ 
+ If a host.xml file is not present, Transit will atempt to resolve
hosts using
+ a set of property based host descriptors. Property files describing
remote hosts
+ are based on the following property specification.
+ 
+
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Default Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>dpml.transit.resourcehost.enabled</td>
+ <td>true</td>
+ <td>
+ If true, the remote host repository will be used. If false, it
+ will be skipped completely.
+ </td>
+ </tr>
+ <tr>
+ <td>dpml.transit.resourcehost.base</td>
+ <td></td>
+ <td>This defines the base URL of the remote host repository.</td>

+ </tr>
+ <tr>
+ <td>dpml.transit.resourcehost.class</td>
+ <td>net.dpml.transit.artifact.ClassicResourceHost</td>
+ <td>
+ Defines the class to use for the management of the remote host.
+ </td>
+ </tr>
+ <tr>
+ <td>dpml.transit.resourcehost.knowngroups</td>
+ <td></td>
+ <td>
+ A URL pointing to a file containing a line-separated list of
+ groups that are known to be installed on the remote host
+ repository. (named <index> in the hosts.xml file.)
+ </td>
+ </tr>
+ <tr>
+ <td>dpml.transit.resourcehost.username</td>
+ <td></td>
+ <td>The username required for the remote host.</td>
+ </tr>
+ <tr>
+ <td>dpml.transit.resourcehost.password</td>
+ <td></td>
+ <td>The password for the user required to access the remote
host.</td>
+ </tr>
+ <tr>
+ <td>dpml.transit.resourcehost.scheme</td>
+ <td></td>
+ <td>The authentication scheme used for the connection.</td>
+ </tr>
+ <tr>
+ <td>dpml.transit.resourcehost.prompt</td>
+ <td></td>
+ <td>
+ The authentication prompt or
+ realm sent by the server.
+ </td>
+ </tr>
+ <tr>
+ <td>dpml.transit.resourcehost.policy</td>
+ <td>fast</td>
+ <td>
+ Download policy. "fast"=if the artifact exist in the cache, use
+ it.
+ </td>
+ </tr>
+ <tr>
+ <td>dpml.transit.resourcehost.priority</td>
+ <td>80</td>
+ <td>
+ The priority defines which host should take precedence over
+ another host for obtaining the artifact. A lower number indicates
+ a higher priority.
+ </td>
+ </tr>
+ <tr>
+ <td>dpml.transit.resourcehost.trusted</td>
+ <td>false</td>
+ <td>
+ If true Transit shall assume that the host connection is trusted.
+ When set to "true" in conjunction with an https:// conection,
the
+ certificate chain of the host will be accepted unconditionally.
+ </td>
+ </tr>
+ 
+ </table>
+
+ </subsection>
+
+ <subsection name="Authorative Host">
+
+ 
+ The Transit system may be configured locally or remotely depending on
+ the value of the "dpml.transit.authority" property. The property
identifies
+ a remote or local path to the authorative configuration and is held
within a
+ file of the same name.
+ 
+
+ Search sequence:
+
+ <ol>
+ <li><code>${java.ext.dirs}/dpml.transit.authority</code></li>
+ <li><code>${dpml.home}/transit/dpml.transit.authority</code></li>
+ </ol>
+
+ 
+ In the "dpml.transit.authority" file, a single property
+ "dpml.transit.authority" is resolved to a URL of the
+ Authorative Host. If no protocol is given, it is assumed to be a
+ directory in the local file system relative to
+ ${dpml.home}/transit.
+ 
+
+ Default contents of dpml.transit.authority file:
+
+<source>
+dpml.transit.authority=authority/
+</source>
+
+ The default value of the above is equivalent to:
+
+<pre>
+ ${dpml.home}/transit/authority/
+</pre>
+
+ 
+ The configuration of available hosts is contained in the file:
+ 
+<pre>
+ ${dpml.transit.authority}/hosts.xml
+</pre>
+
+ 
+ Transit will also look for property based host descriptors. If the
+ value of ${dpml.transit.authority} is a file url host properties
files
+ will be resolved relative to the following path:
+ 
+
+<pre>
+ ${dpml.transit.authority}/hosts/*.*
+</pre>
+ 
+ All files found in the hosts/ directory will be read one by one.
+ The priority property will determine in which order the hosts are
+ queried for artifacts.
+ 
+ 
+ If the location is a remote URL, it will read the file
+ "index.lst" at that location. "index.lst" must contain a line
+ separated list of files that can be read at the location,
containing
+ the resource host defintions.
+ 
+
+ </subsection>
+
+ 
+
+ </section>
+ </body>
+</document>
+
+
+

Modified:
development/main/central/site/src/docs/products/transit/properties/index.xml
==============================================================================
---
development/main/central/site/src/docs/products/transit/properties/index.xml
(original)
+++
development/main/central/site/src/docs/products/transit/properties/index.xml
Sat Jan 8 06:44:21 2005
@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="ISO-8859-1"?>


-<document>
+<document verified="false">
<properties>
<author email="niclas AT hedhman.org">Niclas Hedhman</author>
+ <author email="david.leangen AT konova.com">David Leangen</author>
<title>DPML Transit</title>
</properties>

<body>

<section name="Transit Properties">
-
- <subsection name="Authorative Host">
-
- 
- The Transit system may be configured locally or remotely depending on
- the value of the "dpml.transit.authority" property. The property
identifies
- a remote or local path to the authorative configuration and is held
within a
- file of the same name.
- 
-
- Search sequence:
-
- <ol>
- <li><code>${java.ext.dirs}/dpml.transit.authority</code></li>
- <li><code>${dpml.home}/transit/dpml.transit.authority</code></li>
- </ol>
-
- 
- In the "dpml.transit.authority" file, a single property
- "dpml.transit.authority" is resolved to a URL of the
- Authorative Host. If no protocol is given, it is assumed to be a
- directory in the local file system relative to
- ${dpml.home}/transit.
- 
-
- Default contents of dpml.transit.authority file:
-
-<source>
-dpml.transit.authority=authority/
-</source>
-
- The default value of the above is equivalent to:
-
-<pre>
- ${dpml.home}/transit/authority/
-</pre>
-
- 
- The configuration of available hosts is contained in the file:
- 
-<pre>
- ${dpml.transit.authority}/hosts.xml
-</pre>
-
- 
- Transit will also look for property based host descriptors. If the
- value of ${dpml.transit.authority} is a file url host properties
files
- will be resolved relative to the following path:
- 
-
-<pre>
- ${dpml.transit.authority}/hosts/*.*
-</pre>
- 
- All files found in the hosts/ directory will be read one by one.
- The priority property will determine in which order the hosts are
- queried for artifacts.
- 
- 
- If the location is a remote URL, it will read the file
- "index.lst" at that location. "index.lst" must contain a line
- separated list of files that can be read at the location,
containing
- the resource host defintions.
- 
-
- </subsection>
+
+ 
+ Transit provides several configuration properties.
+ 
+
+ 
+ You can define your own configuration for:
+ <ul>
+ <li><a href="cache.html">your local cache</a></li>
+ <li><a href="hosts.html">remote hosts</a></li>
+ <li><a href="runtime.html">runtime properties</a></li>
+ </ul>
+ 

- 
-
</section>
</body>
</document>

Modified:
development/main/central/site/src/docs/products/transit/properties/navigation.xml
==============================================================================
---
development/main/central/site/src/docs/products/transit/properties/navigation.xml
(original)
+++
development/main/central/site/src/docs/products/transit/properties/navigation.xml
Sat Jan 8 06:44:21 2005
@@ -25,8 +25,8 @@
<body>

<menu>
- <item name="Cache Properties" href="cache/index.html"/>
- <item name="Host Config Properties" href="hosts/index.html"/>
+ <item name="Cache Properties" href="cache.html"/>
+ <item name="Host Config Properties" href="hosts.html"/>
<item name="Runtime Properties" href="runtime.html"/>
</menu>

svn commit: r1406 - in development/main/central/site/src/docs: concepts products/transit/properties products/transit/properties/cache products/transit/properties/hosts, dleangen, 01/08/2005