Skip to Content.
Sympa Menu

notify-dpml - svn commit: r1485 - in development/main/central/site/src/docs/products/transit/technical: cache protocol

notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

Chronological Thread  
  • From: niclas AT netcompartner.com
  • To: notify-dpml AT lists.ibiblio.org
  • Subject: svn commit: r1485 - in development/main/central/site/src/docs/products/transit/technical: cache protocol
  • Date: Sun, 16 Jan 2005 09:35:30 +0100

Author: niclas
Date: Sun Jan 16 09:35:30 2005
New Revision: 1485

Modified:

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

development/main/central/site/src/docs/products/transit/technical/protocol/index.xml
Log:
Touching up the Transit documentation.

Modified:
development/main/central/site/src/docs/products/transit/technical/cache/properties.xml
==============================================================================
---
development/main/central/site/src/docs/products/transit/technical/cache/properties.xml
(original)
+++
development/main/central/site/src/docs/products/transit/technical/cache/properties.xml
Sun Jan 16 09:35:30 2005
@@ -1,19 +1,19 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
-<!--
+<!--
Copyright 2004 Niclas Hedhman
Copyright 2005 David Leangen

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
+ You may obtain a copy of the License at
+
http://www.dpml.net/central/about/legal/
-
+
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
-
+
See the License for the specific language governing permissions and
limitations under the License.
-->
@@ -23,30 +23,30 @@
<author email="niclas AT hedhman.org">Niclas Hedhman</author>
<author email="david.leangen AT konova.com">David Leangen</author>
<title>DPML Transit</title>
- </properties>
+ </properties>

<body verified="false">
<section name="Cache Properties">
<p>
The transit system stores the downloaded resources
- on your local file system. The cache provides DPML-enabled
+ on your local file system. The cache provides DPML-enabled
applications with quickly retrieval of required resources.
</p>
-
+
<p>
- When requested by your application, a cache manager will first
+ When requested by your application, a 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 remote repository defined under the
- <a href="../hosts/index.html">host configuration</a> until the
+ will then query each remote repository defined under the
+ <a href="../hosts/index.html">host configuration</a> until the
resource is resolved.
</p>
-
+
<p>
Requests to remote repositories are conducted sequentially in order
of
priority, with the highest priority value queried first.
</p>
-
+
<subsection name="Properties" >
<table>
<tr>
@@ -62,12 +62,14 @@
<tr>
<td>dpml.transit.cache.class</td>
<td>
- <a
href="../../../../../@TRANSIT-DOCS-PATH@/net/dpml/transit/artifact/CacheHandler.html">
+ <a
href="../../../../../@TRANSIT-DOCS-PATH@/net/dpml/transit/artifact/FileCacheHandler.html">
<code>FileCacheHandler</code>
</a>
</td>
<td>
- The class that implements the cache handler interface.
+ The fully qualified class name of the class that implements the
+ <a
href="../../../../../@TRANSIT-DOCS-PATH@/net/dpml/transit/artifact/CacheHandler.html">
+ CacheHandler</a> interface.
</td>
</tr>
</table>
@@ -76,5 +78,5 @@
</body>
</document>

-
-
+
+

Modified:
development/main/central/site/src/docs/products/transit/technical/protocol/index.xml
==============================================================================
---
development/main/central/site/src/docs/products/transit/technical/protocol/index.xml
(original)
+++
development/main/central/site/src/docs/products/transit/technical/protocol/index.xml
Sun Jan 16 09:35:30 2005
@@ -1,18 +1,18 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
-<!--
+<!--
Copyright 2004 Niclas Hedhman

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
+ You may obtain a copy of the License at
+
http://www.dpml.net/central/about/legal/
-
+
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
-
+
See the License for the specific language governing permissions and
limitations under the License.
-->
@@ -21,18 +21,18 @@
<properties>
<author email="niclas AT hedhman.org">Niclas Hedhman</author>
<title>DPML Transit</title>
- </properties>
+ </properties>

<body verified="false">
<section name="Artifact Protocol">

<p>
- The key to the repository comes through the artifact protocol. It
+ The key to the repository comes through the artifact protocol. It
makes a separation of concern between the requested resource and the
location where such a resource can be found. The location is handled
by a the protocol handler, and is configured by the user. In reality,
once DPML Transit is in place, it is possible to request any type of
- resource via the familiar java.net.URL() and many existing
+ resource via the familiar java.net.URL() and many existing
applications can easily be made <strong>repository enabled</strong>
just by providing DPML Transit in the classpath and setting one or
two system properties.
@@ -45,6 +45,48 @@
<source> artifact:[type]:[group]/[name]#[version] </source>
</subsection>

+ <table>
+ <tr>
+ <td>
+ type
+ </td>
+ <td>
+ The type of the artifact. Typical example would be "jar", "png"
+ or "dtd".
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group
+ </td>
+ <td>
+ The group to which the artifact belong, so that naming conflicts
+ can be avoided.
+ It is recommended that the group is multi-leveled and slash
+ separated, where the top level denotes the distinguishable name
of
+ the organization.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ name
+ </td>
+ <td>
+ The name of the artifact.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ version
+ </td>
+ <td>
+ The version is an opaque identifier without any built-in semantic
+ contract. That means that Transit places no meaning into the
+ version itself, and 1.1.0 and 1.1.1 does not hint that the latter
+ can be used if the former is not present.
+ </td>
+ </tr>
+ </table>
<subsection name="Using an artifact URL" >
<p>
Using artifact URLs are no different from any http or ftp URLs. You
@@ -53,19 +95,19 @@
</p>
[[Look into where this should go]]
<p>
- The following example artifact URI identifies a resource named
- "dpml-http-server" associated with the "dpml/http" group, a
+ The following example artifact URI identifies a resource named
+ "dpml-http-server" associated with the "dpml/http" group, a
resource type called "block" and a version value of "1024".
</p>
-
+
<source>artifact:block:dpml/http/dpml-http-server#1024</source>


</subsection>
-
+
</section>
</body>
</document>

-
-
+
+



  • svn commit: r1485 - in development/main/central/site/src/docs/products/transit/technical: cache protocol, niclas, 01/16/2005

Archive powered by MHonArc 2.6.24.

Top of Page