Skip to Content.
Sympa Menu

notify-dpml - svn commit: r1482 - in development/main/central/site: . src/docs/products/transit src/docs/products/transit/concepts src/docs/products/transit/overview src/docs/products/transit/technical/protocol

notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

Chronological Thread  
  • From: dleangen AT netcompartner.com
  • To: notify-dpml AT lists.ibiblio.org
  • Subject: svn commit: r1482 - in development/main/central/site: . src/docs/products/transit src/docs/products/transit/concepts src/docs/products/transit/overview src/docs/products/transit/technical/protocol
  • Date: Sun, 16 Jan 2005 06:33:54 +0100

Author: dleangen
Date: Sun Jan 16 06:33:53 2005
New Revision: 1482

Added:
development/main/central/site/src/docs/products/transit/concepts/
development/main/central/site/src/docs/products/transit/concepts/index.xml

development/main/central/site/src/docs/products/transit/concepts/navigation.xml

development/main/central/site/src/docs/products/transit/concepts/repository_enabled.xml
Modified:
development/main/central/site/build.xml
development/main/central/site/src/docs/products/transit/navigation.xml

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

development/main/central/site/src/docs/products/transit/technical/protocol/index.xml
Log:
Updated Transit docs.


Modified: development/main/central/site/build.xml
==============================================================================
--- development/main/central/site/build.xml (original)
+++ development/main/central/site/build.xml Sun Jan 16 06:33:53 2005
@@ -55,6 +55,7 @@
<x:filter key="dpml-magic" feature="api" token="MAGIC-DOCS-PATH"/>
<x:filter key="dpml-metro" feature="api" token="METRO-JAVADOC-PATH"/>
<filter token="CENTRAL-SITE-GLOSSARY-PATH"
value="products/transit/glossary/index.html"/>
+ <filter token="CENTRAL-SITE-CONCEPTS-PATH"
value="products/transit/concepts/index.html"/>
</target>

<target name="javadoc" depends="prepare"/>

Added:
development/main/central/site/src/docs/products/transit/concepts/index.xml
==============================================================================
--- (empty file)
+++
development/main/central/site/src/docs/products/transit/concepts/index.xml
Sun Jan 16 06:33:53 2005
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+ Copyright 2005 David Leangen
+ Copyright 2004 Stephen McConnell
+ 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
+
+ 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.
+-->
+
+<document>
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <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 verified="false">
+
+ <section name="Concepts">
+ </section>
+
+ </body>
+</document>

Added:
development/main/central/site/src/docs/products/transit/concepts/navigation.xml
==============================================================================
--- (empty file)
+++
development/main/central/site/src/docs/products/transit/concepts/navigation.xml
Sun Jan 16 06:33:53 2005
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2004 Stephen McConnell
+ 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
+
+ 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.
+-->
+
+<project>
+
+ <title>DPML Transit</title>
+
+ <body>
+
+ <menu>
+ </menu>
+
+ </body>
+
+</project>

Added:
development/main/central/site/src/docs/products/transit/concepts/repository_enabled.xml
==============================================================================
--- (empty file)
+++
development/main/central/site/src/docs/products/transit/concepts/repository_enabled.xml
Sun Jan 16 06:33:53 2005
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+ Copyright 2005 David Leangen
+ Copyright 2004 Stephen McConnell
+ 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
+
+ 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.
+-->
+
+<document>
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <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 verified="false">
+
+ <section name="Concepts">
+
+ <subsection name="Repository Enabled Application">
+
+ <p>
+ A <strong>repository enabled application</strong> is an
application
+ that leverages a <a href="">local cache</a> of <a
href="">artifacts</a>
+ backed by a formal repository model.
+ </p>
+
+<!--
+ <p>
+ Transit is the system infrastructure that provides support for
artifact
+ identification, <a href="artifact.html">retrieval</a>, and related
+ application functions including
+ <a href="classloading.html">classloader</a> construction and
+ <a href="plugins.html">plugin</a> management required by
repository
+ enabled solutions.
+ </p>
+-->
+ </subsection>
+ </section>
+
+ </body>
+</document>

Modified:
development/main/central/site/src/docs/products/transit/navigation.xml
==============================================================================
--- development/main/central/site/src/docs/products/transit/navigation.xml
(original)
+++ development/main/central/site/src/docs/products/transit/navigation.xml
Sun Jan 16 06:33:53 2005
@@ -29,6 +29,7 @@
<item name="Product Overview" href="overview/index.html"/>
<item name="Product Specifications" href="technical/index.html"/>
<item name="Glossary (to be moved...)"
href="../../@CENTRAL-SITE-GLOSSARY-PATH@"/>
+ <item name="Concepts (to be moved...)"
href="../../@CENTRAL-SITE-CONCEPTS-PATH@"/>
</menu>

</body>

Modified:
development/main/central/site/src/docs/products/transit/overview/artifact.xml
==============================================================================
---
development/main/central/site/src/docs/products/transit/overview/artifact.xml
(original)
+++
development/main/central/site/src/docs/products/transit/overview/artifact.xml
Sun Jan 16 06:33:53 2005
@@ -3,7 +3,7 @@
<document>
<properties>
<author email="mcconnell AT dpml.net">Stephen McConnell</author>
- <contributor email="dleangen AT dpml.net">David Leangen</contributor>
+ <author email="dleangen AT dpml.net">David Leangen</author>
<title>DPML Transit</title>
</properties>

@@ -11,23 +11,67 @@
<section name="Dynamic Artifact Retrieval">

<p>
- An artifact is a resource identified by an
- artifact uri. The Artifact
- <a href="../technical/protocol/index.html">protocol
specification</a>
- describe a resource type, group, name, and resource version. These
- identifiers dissassociate the definition of an application from
- the source of the resources needed to build and deploy the
- application.
+ An <strong>artifact</strong> is simply a resource used by a Java
+ application. Basically, an artifact can be any type of file:
+ JAR, image, text...
+ Based on its protocol specification, Transit provides for dynamic
+ retrieval of such artifacts.
</p>
-
- <p>
- 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 name="Artifact URI">
+ <p>
+ Each artifact has a unique identifier conforming to the Transit
+ <a href="../technical/protocol/index.html">protocol
specification</a>.
+ Using an extension to the xxxxxxx class in the Java API, Transit
+ accesses an artifact through an <strong>artifact URI</strong>.
+ The artifact URI thus serves the dual purpose of identifying the
+ artifact and providing a means for Transit to retrieve the file.
+ </p>
+
+ <p>
+ The artifact URI describes the:
+ <ul>
+ <li>type of resource (JAR, meta, template...)</li>
+ <li>group to which the artifact belongs</li>
+ <li>name of the artifact</li>
+ <li>version</li>
+ </ul>
+ </p>
+
+ <p>
+ Typically, an artifact is a JAR file, a <a href="">meta</a> file,
+ or a <a href="">block</a> descriptor file.
+ However, there is no limitation to the type of resource that an
artifact
+ can be. Essentially, you can use the Transit system to manage
virtually
+ any type of resource.
+ </p>
+
+ <p>
+ The group is an arbitrary grouping of resources that is decided by
+ the developer. [[need a better way of saying this]]
+ </p>
+
+ <p>
+ [[Need some explanation of version]]
+ </p>
+
+ <p>
+ [[Point to best practices for naming and managing projects]]
+ </p>
+
+ <p>
+ These identifiers dissassociate the definition of an application
+ from the source of the resources needed to build and deploy the
+ application.
+
+ [[Not sure what you're trying to say here...]]
+ </p>
+
+ </subsection>
+
+ <subsection name="Artifact Retrieval">
+ </subsection>
+
</section>
</body>
</document>

Modified:
development/main/central/site/src/docs/products/transit/overview/index.xml
==============================================================================
---
development/main/central/site/src/docs/products/transit/overview/index.xml
(original)
+++
development/main/central/site/src/docs/products/transit/overview/index.xml
Sun Jan 16 06:33:53 2005
@@ -32,31 +32,37 @@

<section name="Product Overview">

-<!--
- <subsection name="Repository Enabled Application">
-
- <p>
- A repository enabled application is an application the leverages a
local
- cache of artifacts backed by a formal repository model.
- Transit is the system infrastructure that provides support for
artifact
- identification, <a href="artifact.html">retrieval</a>, and related
- application functions including
- <a href="classloading.html">classloader</a> construction and
- <a href="plugins.html">plugin</a> management required by
repository
- enabled solutions.
- </p>
+ <p>
+ One of the more difficult tasks when building Java applications
+ is managing <a href="">classloaders</a>. Oftentimes, when combining
+ various projects together into an enterprise application, because
+ of Java's classloading mechanism, the application is not able to
+ load the right classes at the right time, causing the application
+ to fail. Although a fundamental issue, classloading has remained
+ a rather obscure topic. Not surprisingly, many Java projects fail
+ to manage classloaders effectively.
+ </p>
+
+ <p>
+ Transit provides a solution to this problem.
+ </p>

- </subsection>
--->
<p>
- The core of the Transit product is a URL protocol handler which
serves as
- the basic construct on which classloader management in provided.
The classloader
- creation services provide the framework with a simple plugin
framework.
+ At core of Transit is a URL protocol handler.
+ Based on the protocol handler, Transit is able to manage classloaders
+ effectively. This allows an application to provide more advanced
services
+ such as a plugin framework.
+ </p>
+
+ <p>
+ In other words, Transit helps to realize the full potential of a
+ Java application.
</p>

<subsection name="Features and Benefits">
<a name="features"/>

+<!--
<p>
Key features of the Transit system include:
</p>
@@ -79,7 +85,7 @@
<li>improved security through repository management</li>
<li>low maintenance though centralized configuration</li>
</ol>
-
+-->
</subsection>

</section>

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 06:33:53 2005
@@ -51,6 +51,16 @@
create them by instantiating the <code>java.net.URL</code> class,
and setting the protocol to "artifact" (no quotes).
</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
+ resource type called "block" and a version value of "1024".
+ </p>
+
+ <source>artifact:block:dpml/http/dpml-http-server#1024</source>
+
+
</subsection>

</section>



  • svn commit: r1482 - in development/main/central/site: . src/docs/products/transit src/docs/products/transit/concepts src/docs/products/transit/overview src/docs/products/transit/technical/protocol, dleangen, 01/16/2005

Archive powered by MHonArc 2.6.24.

Top of Page