You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by mc...@apache.org on 2004/06/01 05:58:05 UTC

svn commit: rev 20729 - in avalon/trunk/central/site/src: resources/images/discovery xdocs/products/discovery xdocs/products/discovery/model

Author: mcconnell
Date: Mon May 31 20:58:04 2004
New Revision: 20729

Added:
   avalon/trunk/central/site/src/resources/images/discovery/
   avalon/trunk/central/site/src/resources/images/discovery/p1.GIF   (contents, props changed)
   avalon/trunk/central/site/src/resources/images/discovery/p2.GIF   (contents, props changed)
   avalon/trunk/central/site/src/resources/images/discovery/p3.GIF   (contents, props changed)
   avalon/trunk/central/site/src/resources/images/discovery/p4.GIF   (contents, props changed)
   avalon/trunk/central/site/src/resources/images/discovery/p5.GIF   (contents, props changed)
   avalon/trunk/central/site/src/xdocs/products/discovery/glossary.xml
   avalon/trunk/central/site/src/xdocs/products/discovery/model/
   avalon/trunk/central/site/src/xdocs/products/discovery/model/disclosure.xml
   avalon/trunk/central/site/src/xdocs/products/discovery/model/federation.xml
   avalon/trunk/central/site/src/xdocs/products/discovery/model/index.xml
   avalon/trunk/central/site/src/xdocs/products/discovery/model/navigation.xml
   avalon/trunk/central/site/src/xdocs/products/discovery/model/selection.xml
Modified:
   avalon/trunk/central/site/src/xdocs/products/discovery/index.xml
   avalon/trunk/central/site/src/xdocs/products/discovery/navigation.xml
Log:
Add some preliminary information about Merlin Discovery (concept, principals, scope, etc).

Added: avalon/trunk/central/site/src/resources/images/discovery/p1.GIF
==============================================================================
Binary file. No diff available.

Added: avalon/trunk/central/site/src/resources/images/discovery/p2.GIF
==============================================================================
Binary file. No diff available.

Added: avalon/trunk/central/site/src/resources/images/discovery/p3.GIF
==============================================================================
Binary file. No diff available.

Added: avalon/trunk/central/site/src/resources/images/discovery/p4.GIF
==============================================================================
Binary file. No diff available.

Added: avalon/trunk/central/site/src/resources/images/discovery/p5.GIF
==============================================================================
Binary file. No diff available.

Added: avalon/trunk/central/site/src/xdocs/products/discovery/glossary.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/discovery/glossary.xml	Mon May 31 20:58:04 2004
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+  <properties>
+    <author email="dev@avalon.apache.org">Avalon Documentation Team</author>
+    <title>Merlin Discovery</title>
+  </properties> 
+
+  <body>
+    <section name="Discovery Terminology">
+      <subsection name="Glossary">
+        <table>
+          <tr><th>Term</th><th>Description</th></tr>
+          <tr>
+            <td>Identifiable</td>
+            <td>An object supporting URI based identification.</td>
+          </tr>
+          <tr>
+            <td>Artifact</td>
+            <td>A reference to a repository based resource.</td>
+          </tr>
+          <tr>
+            <td>ResourceDescription</td>
+            <td>A type describing an Internet based resource.</td>
+          </tr>
+          <tr>
+            <td>Disclosure</td>
+            <td>A type describing an act of disclosure of an Artifact.</td>
+          </tr>
+          <tr>
+            <td>Receipt</td>
+            <td>A type used to provide proof to a client of an act dealing with
+registration, modification, or retraction of an artifact from a Registry.</td>
+          </tr>
+          <tr>
+            <td>Registry</td>
+            <td>An service through which a client can register a resource
+description or existing disclosure instance.</td>
+          </tr>
+          <tr>
+            <td>Directory</td>
+            <td>An interface through which a client can invoke requests enabling
+the discovery of artifact descriptions based on supplied filters.</td>
+          </tr>
+        </table>
+      </subsection>
+    </section>
+  </body>
+</document>
+

Modified: avalon/trunk/central/site/src/xdocs/products/discovery/index.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/products/discovery/index.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/products/discovery/index.xml	Mon May 31 20:58:04 2004
@@ -6,9 +6,28 @@
   </properties> 
 
   <body>
-    <section name="Welcome to Avalon Discovery">
-      <p>
-      </p>
+    <section name="Introducing Merlin Discovery">
+      <p>
+Existing business requirements for services supporting the creation and maintenance of repositories capable of supporting the registration and discovery of XML based descriptions of services and implementation solution are required as part of the overall Avalon product development strategy.
+      </p>
+
+      <p>
+As an example, a logistics service provider may wish to describe the features, benefits, and the conditions of activation of a business capability concerning goods delivery. Such a description would be expressed as an instance of a Resource Description, possibly referencing marketing information under URLs to web pages, and potentially containing supplementary industry specific XML elements. During the process of service registration, the supplier would declare a formal Resource Description possibly detailing service activation constraints and service access points. As a result of the registration of a Resource Description, the provider receives a receipt of registration. 
+      </p>
+
+      <p>
+A client, using an implementation of the discovery interface can register transient or
+persistent queries. As an example, a client, using a discovery interface, could register a persistent query for Resource Descriptions specialized for the travel industry, for flight availability for a particular day. Over time, the query result would change as availability of flights fluctuated. In contrast, a transient query would be assessed against immediately available Resource Descriptions. 
+      </p>
+
+      <p>
+Service providers publishing computation or information artifacts under Resource Descriptions may choose to use a Resource Description as an input argument to a service activation operation. Such applications may require information identifying a chain of registration acts contributing to its discovery. Such a chain may be used by higher-level applications dealing with commercial referral (such as commercial trading systems, commercial brokerage applications, and advertising management systems).
+      </p>
+
+      <p>
+The Merlin Discovery project aims to to establish a product solution that leverages the Merlin Runtime Platform as the underlying service delivery infrastructure.
+      </p>
+
     </section>
   </body>
 </document>

Added: avalon/trunk/central/site/src/xdocs/products/discovery/model/disclosure.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/discovery/model/disclosure.xml	Mon May 31 20:58:04 2004
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+  <properties>
+    <author email="dev@avalon.apache.org">Avalon Documentation Team</author>
+    <title>Merlin Discovery</title>
+  </properties> 
+
+  <body>
+    <section name="Object Model">
+      <subsection name="Disclosure">
+<p>A disclosure instance is potentially a container of an arbitrarily long chain of registration events.  A resource description registered under registry R1 can be discovered under directory D2 as an instance of disclosure, subsequently registered again under another registry (possibly an registry supporting aggregated offers in a particular domain) and finally discovered by another consumer.  The resulting disclosure instance maintains an internal record of its passage of registration through R1 and R2.  This information is particularly relevant to supplier organizations in terms of tracking of advertising and channels management.  Supplier organizations can take advantage of this chain information by structuring server applications to take disclosure instances as input arguments.</p>
+
+<p><i>Conversion of a selection instance to a disclosure chain and resource description.</i></p>
+
+<p><img src="/images/discovery/p3.gif"/></p>
+
+      </subsection>
+    </section>
+  </body>
+</document>
+

Added: avalon/trunk/central/site/src/xdocs/products/discovery/model/federation.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/discovery/model/federation.xml	Mon May 31 20:58:04 2004
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+  <properties>
+    <author email="dev@avalon.apache.org">Avalon Documentation Team</author>
+    <title>Merlin Discovery</title>
+  </properties> 
+
+  <body>
+    <section name="Object Model">
+      <subsection name="Federation">
+<p>The following illustration depicts a possible business cycle of a resource description used as an argument to a server:</p>
+<ul>
+<li>Creation of the resource description, containing a description of the a supplier capability and URI reference to the server;</li>
+<li>registration of the resource description under a general marketplace registry;</li>
+<li>discovery of the capability under a general market directory in the form of a disclosure instance;</li>
+<li>subsequent referral of the description to vertical domain marketplace;</li>
+<li>discovery of the disclosure under the vertical marketplace;</li>
+<li>application of the resulting disclosure instance as an argument to a  server</li>
+</ul>
+<p>Server applications (processors) can take advantage of referral information in Disclosure chains as part of sophisticated applications supporting referral reward schemes and market site value assessment.</p>
+
+<p><i>Service referral across marketplace systems.</i></p>
+
+<p><img src="/images/discovery/p4.gif"/></p>
+
+      </subsection>
+    </section>
+  </body>
+</document>
+

Added: avalon/trunk/central/site/src/xdocs/products/discovery/model/index.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/discovery/model/index.xml	Mon May 31 20:58:04 2004
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+  <properties>
+    <author email="dev@avalon.apache.org">Avalon Documentation Team</author>
+    <title>Merlin Discovery</title>
+  </properties> 
+
+  <body>
+    <section name="Object Model">
+<p>The Merlin Discovery platform will provide two principal set of service interfaces and a number of immutable data types that will facilitate the publication and subsequent discovery of description of available services and componen types.  The two interfaces groups address the respective roles of registration and discovery.</p>
+
+<p>A registration interface provides operations supporting the registration of resource description, an object that describes an available resource or service. The resource description contains information about an artifact, its URI, a textual description, URI references to legal terms and conditions, its effective date and validity, and terms and conditions concerning the disclosure of the description by a registry operator, and last but not least - a reference to block defintion or remote service access point.</p>
+
+<p>The discovery interfaces provide a basic set of operations enabling simple lookup of a single resource description and operations supporting general queries based on supplied filter arguments that return a set of results in the form of selections.  The selection instances returned from a query are lightweight structures containing only a URI and a ranking value. A client presenting information to an end-user can expand the content of a particular selection by invoking operations on a directory to resolve the value of a selection to a resource description.  This approach allows the effective de-coupling of query resolution form presentation, enabling enhancement of the end-user experience.</p>
+
+<p>The following illustration depicts the cycle between the creation of a resource description and the subsequent generation of a selection set by a discovery service.  Firstly, a client acting in the role of a resource or capability provider, uses a application to constructs an instance of a ResourceDescription.  This value is used as an argument to a register operation on the Registry.  A client acting in the role of a resource or capability consumer invokes the find operation on a directory using a filter as the search criteria.  The result of the operation is a sequence of ranked selections.</p>
+
+<p><i>Resource Description registration, receipt creation, search and selection retrieval.</i></p>
+
+<p><img src="/images/discovery/p1.gif"/></p>
+
+    </section>
+  </body>
+</document>
+

Added: avalon/trunk/central/site/src/xdocs/products/discovery/model/navigation.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/discovery/model/navigation.xml	Mon May 31 20:58:04 2004
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- 
+ Copyright 2004 Apache Software Foundation
+ 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.apache.org/licenses/LICENSE-2.0
+ 
+ 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>Apache Avalon Central</title>
+
+ <body>
+    <menu>
+      <item name="Disclosure" href="disclosure.html"/>
+      <item name="Selection" href="selection.html"/>
+      <item name="Federation" href="federation.html"/>
+    </menu>
+  </body>
+
+</project>

Added: avalon/trunk/central/site/src/xdocs/products/discovery/model/selection.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/discovery/model/selection.xml	Mon May 31 20:58:04 2004
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+  <properties>
+    <author email="dev@avalon.apache.org">Avalon Documentation Team</author>
+    <title>Merlin Discovery</title>
+  </properties> 
+
+  <body>
+    <section name="Object Model">
+      <subsection name="Selection">
+<p>Selection instances contain a URI and a ranking of the resource description referenced by the URI.  In-fact, it is more correct to say that the URI references a type called Artifact which is the base type for the two types ResourceDescription and Disclosure. A Disclosure is simply a value type that contains a resource description together with information detailing a verifiable act of registration. The decision to reference a resource description as opposed to a disclosure instance is based on policy of the resource provider, together with the internal policy of the registration and directory services.</p>
+<p>Given a selection instance, the client invokes a resolve operation against the directory, enabling the conversation of the selection value to an associated resource description. The following illustration depicts the simple case of a selection directly referencing a resource description.  Once the client has the resource description it can present this information as part of a web page or other client application context.
+.</p>
+
+<p><i>Conversion of a selection instance to a resource description.</i></p>
+
+<p><img src="/images/discovery/p2.gif"/></p>
+
+      </subsection>
+    </section>
+  </body>
+</document>
+

Modified: avalon/trunk/central/site/src/xdocs/products/discovery/navigation.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/products/discovery/navigation.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/products/discovery/navigation.xml	Mon May 31 20:58:04 2004
@@ -1,29 +1,31 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<!-- 
- Copyright 2004 Apache Software Foundation
- 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.apache.org/licenses/LICENSE-2.0
- 
- 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>Apache Avalon Central</title>
-
- <body>
-    <menu>
-    </menu>
-  </body>
-
-</project>
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- 
+ Copyright 2004 Apache Software Foundation
+ 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.apache.org/licenses/LICENSE-2.0
+ 
+ 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>Apache Avalon Central</title>
+
+ <body>
+    <menu>
+      <item name="Glossary" href="glossary.html"/>
+      <item name="Object Model" href="model/index.html"/>
+    </menu>
+  </body>
+
+</project>

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org