avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mcconn...@apache.org
Subject cvs commit: avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/stages index.xml navigation.xml stage.xml
Date Fri, 25 Apr 2003 11:57:59 GMT
mcconnell    2003/04/25 04:57:59

  Modified:    merlin/merlin-smp/xdocs/merlin/kernel navigation.xml
               merlin/merlin-smp/xdocs/meta/info/type index.xml
                        navigation.xml
  Added:       merlin/merlin-smp/xdocs/meta/info/type info.xml
               merlin/merlin-smp/xdocs/meta/info/type/context entry.xml
                        index.xml navigation.xml
               merlin/merlin-smp/xdocs/meta/info/type/dependencies
                        dependency.xml index.xml navigation.xml
               merlin/merlin-smp/xdocs/meta/info/type/extensions
                        extension.xml index.xml navigation.xml
               merlin/merlin-smp/xdocs/meta/info/type/loggers index.xml
                        logger.xml navigation.xml
               merlin/merlin-smp/xdocs/meta/info/type/services index.xml
                        navigation.xml service.xml
               merlin/merlin-smp/xdocs/meta/info/type/stages index.xml
                        navigation.xml stage.xml
  Removed:     merlin/merlin-smp/xdocs/merlin/kernel jndi.xml
               merlin/merlin-smp/xdocs/meta/info/type context.xml
                        dependencies.xml extensions.xml loggers.xml
                        services.xml stages.xml
  Log:
  Documentation enhancements.
  
  Revision  Changes    Path
  1.5       +0 -1      avalon-sandbox/merlin/merlin-smp/xdocs/merlin/kernel/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/merlin/kernel/navigation.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- navigation.xml	17 Apr 2003 22:01:48 -0000	1.4
  +++ navigation.xml	25 Apr 2003 11:57:57 -0000	1.5
  @@ -19,7 +19,6 @@
         <item name="Merlin System" href="/merlin/index.html">
           <item name="Kernel" href="/merlin/kernel/index.html">
             <item name="CLI" href="/merlin/kernel/cli.html"/>
  -          <item name="JNDI" href="/merlin/kernel/jndi.html"/>
             <item name="NT" href="/merlin/kernel/nt.html"/>
           </item>
           <item name="Block" href="/merlin/block/index.html"/>
  
  
  
  1.2       +60 -19    avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/index.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- index.xml	2 Apr 2003 15:52:08 -0000	1.1
  +++ index.xml	25 Apr 2003 11:57:57 -0000	1.2
  @@ -19,7 +19,60 @@
   information about the component type.
   </p>
   
  -      <subsection name="XML Schema">
  +      <subsection name="Nested Elements">
  +        <table>
  +          <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
  +          <tr>
  +            <td><a href="info.html">info</a></td><td>1</td>
  +            <td>
  +             Declaration of the component type name, version, and optional 
  +             attributes.
  +            </td>
  +          </tr>
  +          <tr>
  +            <td><a href="loggers.html">loggers</a></td><td>0..1</td>
  +            <td>
  +             Declaration of the logging channels used by the component type.
  +            </td>
  +          </tr>
  +          <tr>
  +            <td><a href="loggers.html">context</a></td><td>0..1</td>
  +            <td>
  +             Declaration of the context criteria including the context entries
  +             and optional context interface.
  +            </td>
  +          </tr>
  +          <tr>
  +            <td><a href="dependencies.html">dependencies</a></td><td>0..1</td>
  +            <td>
  +             Declaration of the set of structural dependencies that the component
  +             type has towards other components.
  +            </td>
  +          </tr>
  +          <tr>
  +            <td><a href="services.html">services</a></td><td>0..1</td>
  +            <td>
  +             Declaration of the set of service that the component type provides.
  +            </td>
  +          </tr>
  +          <tr>
  +            <td><a href="stages.html">stages</a></td><td>0..1</td>
  +            <td>
  +             Declaration of the set of extended deployment stage dependencies that 
  +             the component type has.
  +            </td>
  +          </tr>
  +          <tr>
  +            <td><a href="extensions.html">extensions</a></td><td>0..1</td>
  +            <td>
  +             Declaration of the set of deployment stage handling abiliites that
  +             this component type can provide.
  +            </td>
  +          </tr>
  +        </table>
  +      </subsection>
  +
  +      <subsection name="Example XML">
   
   <p>Configuration instances supplied to the builder shall correspond to the <a href="http://avalon.apache.org/dtds/meta/type_1_1.dtd">type DTD</a>.  
   The structure of a Type XML document is is described below:</p>
  @@ -147,29 +200,17 @@
       &lt;dependencies&gt;
   
         <font color="gray"><i>&lt;!-- 
  -      A dependecy declaration. In the following example the optional 
  +      A dependency declaration. In the following example the optional 
         attribute is redundant as it is equivalent to the default value
         but is included here for completness.
         --&gt;</i></font>
     
  -      &lt;dependency optional="<font color="darkred">FALSE</font>"&gt;
  -  
  -        <font color="gray"><i>&lt;!-- 
  -        The role name that the component will use as the argument to 
  -        lookup. The default value is the value of the service type 
  -        attribute listed below.
  -        --&gt;</i></font>
  +      &lt;dependency optional="<font color="darkred">FALSE</font>"
     
  -        &lt;role&gt;<font color="darkred">my-transformer</font>&lt;/role&gt;
  -  
  -        <font color="gray"><i>&lt;!-- 
  -        service reference containing the classname of the service interface
  -        and the version value where version defaults to 1.0 
  -        --&gt;</i></font>
  -
  -        &lt;reference type="<font color="darkred">org.apache.cocoon.api.Transformer</font>" version="<font color="darkred">1.1</font>"/&gt;
  +        role="<font color="darkred">my-transformer</font>"
  +        type="<font color="darkred">org.apache.cocoon.api.Transformer:1.1</font>"&gt;
   
  -        <font color="gray"><i>&lt;!-- the set of attributes associated with the dependecy --&gt;</i></font>
  +        <font color="gray"><i>&lt;!-- the set of attributes associated with the dependency --&gt;</i></font>
   
           &lt;attributes&gt;
   
  
  
  
  1.6       +7 -6      avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/navigation.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- navigation.xml	17 Apr 2003 22:01:48 -0000	1.5
  +++ navigation.xml	25 Apr 2003 11:57:58 -0000	1.6
  @@ -20,12 +20,13 @@
         <item name="Meta Model" href="/meta/index.html">
           <item name="Meta Info" href="/meta/info/index.html">
             <item name="Type" href="/meta/info/type/index.html">
  -            <item name="Loggers" href="/meta/info/type/loggers.html"/>
  -            <item name="Context" href="/meta/info/type/context.html"/>
  -            <item name="Dependencies" href="/meta/info/type/dependencies.html"/>
  -            <item name="Services" href="/meta/info/type/services.html"/>
  -            <item name="Stages" href="/meta/info/type/stages.html"/>
  -            <item name="Extensions" href="/meta/info/type/extensions.html"/>
  +            <item name="Info" href="/meta/info/type/info.html"/>
  +            <item name="Loggers" href="/meta/info/type/loggers/index.html"/>
  +            <item name="Context" href="/meta/info/type/context/index.html"/>
  +            <item name="Dependencies" href="/meta/info/type/dependencies/index.html"/>
  +            <item name="Services" href="/meta/info/type/services/index.html"/>
  +            <item name="Stages" href="/meta/info/type/stages/index.html"/>
  +            <item name="Extensions" href="/meta/info/type/extensions/index.html"/>
             </item>
             <item name="Service" href="/meta/info/service.html"/>
           </item>
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/info.xml
  
  Index: info.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
    <properties>
      <author email="mcconnell@apache.org">Stephen McConnell</author>
      <title>Logging Descriptors</title>
    </properties>
  
    <body>
  
      <section name="Info Descriptor">
  
  <p>
  The org.apache.avalon.meta.info.infoDescriptor class describes the component type name, version, and optionally a set of attributes.
  </p>
        <subsection name="Nested Elements">
          <table>
            <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
            <tr>
              <td>name</td><td>1</td>
              <td>
               The name of the component type.
              </td>
            </tr>
            <tr>
              <td>version</td><td>0..1</td>
              <td>
               The component type implementation version.
              </td>
            </tr>
            <tr>
              <td>attributes</td><td>0..1</td>
              <td>
               Declaration of a set of attributes associated with the component type.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Example XML">
  
  <source><![CDATA[
    <info>
      <name>test</info>
      <version>1.0</version>
      <attributes>
        <attribute key="about" value="An example attribute."/>
        <attribute key="status" value="FINAL"/>
      </attributes>
    </info>
  ]]></source>
  
        </subsection>
  
      </section>
  
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2003/04/25 11:57:58 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/context/entry.xml
  
  Index: entry.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
    <properties>
      <author email="mcconnell@apache.org">Stephen McConnell</author>
      <title>Context Descriptors</title>
    </properties>
  
    <body>
  
      <section name="Entry Descriptor">
  
  <p>
  The entry element declares the criteria for the inclusion of a context entry within a context object.  The entry exposes a context key and the type that the context entry may be safely cast to.   
  </p>
        <subsection name="Attributes">
          <table>
            <tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
            <tr>
              <td>key</td><td>yes</td>
              <td>
               The key that the component implementation will use when 
               retrieving a value from the supplied context using the 
               context.get( key ) operation.
              </td>
            </tr>
            <tr>
              <td>type</td><td>no</td>
              <td>
               The classname of the context entry.  The default value 
               is java.lang.String.
              </td>
            </tr>
            <tr>
              <td>optional</td><td>no</td>
              <td>
               The optional status of the entry.  If optional is TRUE, a container
               is not required to supply the entry.  The default value is FALSE.
              </td>
            </tr>
          </table>
        </subsection>
        <subsection name="Example XML">
  <source><![CDATA[
  <context>
    <entry key="home" type="java.io.File"/>
    <entry key="test" type="MySpecialClass" optional="TRUE"/>
  </context>
  ]]></source>
        </subsection>
      </section>
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2003/04/25 11:57:58 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/context/index.xml
  
  Index: index.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
    <properties>
      <author email="mcconnell@apache.org">Stephen McConnell</author>
      <title>Context Descriptors</title>
    </properties>
  
    <body>
  
      <section name="Context Descriptor">
  
  <p>
  The org.apache.avalon.meta.info.ContextDescriptor class describes the set of context entries that a component may be depedent on.  Context entries declare a context key and the classname of the value that the component expects to receive.  A compliant container will ensure that a context object supplied to a component under the Contextualize phase can access required context entries with assurance that the value will be supplied under the correct key as as an instance of the required type.  The supply of optional context entries is a container concern with the single exception that a container must ensure that the an optional entry corresponds to the type requested by the component context entry.
  </p>
        <subsection name="Attributes">
          <table>
            <tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
            <tr>
              <td>type</td><td>no</td>
              <td>
               Declaration of an interface derived from org.apache.avalon.framework.context.Context 
               that the component requires.  Declaration of this value will enable the component 
               implementation to safely narrow the supplied context.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Nested Elements">
          <table>
            <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
            <tr>
              <td><a href="entry.html">entry</a></td><td>0..n</td>
              <td>
               Declaration of a context entry.
              </td>
            </tr>
            <tr>
              <td>attributes</td><td>0..1</td>
              <td>
               A set of optional attribute declarations.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Example XML">
  
  <source>
  
      <font color="gray"><i>&lt;!-- 
      Declaration of the context constraints for the compoent type. 
      The "type" attribute is the name of an interface derived from the default
      contenxt interface org.apache.avalon.framework.context.Context 
      --&gt;</i></font>
  
      &lt;context type="<font color="darkred">MyContextInterface</font>"&gt;
  
        <font color="gray"><i>&lt;!-- 
        Declaration of an entry in a context object, the "key" is
        the key used by a component to locate the context entry,
        the "type" is the classname of value (typically an interface)
        or primative type.  The default value is java.lang.String.
        The "optional" attribute is a boolean value derived from the 
        TRUE or FALSE that indicates if the context value must be 
        provided or not (default is FALSE). 
        --&gt;</i></font>
  
        &lt;entry key="<font color="darkred">base</font>" type="<font color="darkred">java.io.File</font>"/&gt;
        &lt;entry key="<font color="darkred">mode</font>" optional="<font color="darkred">TRUE</font>"/&gt;
  
      &lt;/context&gt;
  
  </source>
  
        </subsection>
  
      </section>
  
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2003/04/25 11:57:58 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/context/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <project>
  
   <title>Merlin</title>
  
   <body>
  
       <links>
         <item name="Home" href="http://avalon.apache.org/"/>
         <item name="Framework" href="http://avalon.apache.org/framework/"/>
         <item name="Components" href="http://avalon.apache.org/components"/>
         <item name="Containers" href="http://avalon.apache.org/containers/"/>
         <item name="Sandbox" href="http://avalon.apache.org/sandbox/"/>
       </links>
  
      <menu name="About Merlin">
        <item name="Overview" href="/about/index.html"/>
        <item name="Getting Started" href="/starting/index.html"/>
        <item name="Merlin System" href="/merlin/index.html"/>
        <item name="Meta Model" href="/meta/index.html">
          <item name="Meta Info" href="/meta/info/index.html">
            <item name="Type" href="/meta/info/type/index.html">
              <item name="Info" href="/meta/info/type/info.html"/>
              <item name="Loggers" href="/meta/info/type/loggers/index.html"/>
              <item name="Context" href="/meta/info/type/context/index.html">
                <item name="Entry" href="/meta/info/type/context/entry.html"/>
              </item>
              <item name="Dependencies" href="/meta/info/type/dependencies/index.html"/>
              <item name="Services" href="/meta/info/type/services/index.html"/>
              <item name="Stages" href="/meta/info/type/stages/index.html"/>
              <item name="Extensions" href="/meta/info/type/extensions/index.html"/>
            </item>
            <item name="Service" href="/meta/info/service.html"/>
          </item>
          <item name="Meta Data" href="/meta/model/index.html"/>
        </item>
        <item name="Tools" href="/tools/index.html"/>
      </menu>
  
      <menu name="Extensions">
        <item name="JNDI" href="/extensions/jndi/index.html"/>
        <item name="Servlet" href="/extensions/servlet/index.html"/>
      </menu>
  
   </body>
  
  </project>
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/dependencies/dependency.xml
  
  Index: dependency.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
    <properties>
      <author email="mcconnell@apache.org">Stephen McConnell</author>
      <title>Dependency Descriptors</title>
    </properties>
  
    <body>
  
      <section name="Dependency Descriptor">
  
  <p>
  A dependency declaration defines the key that the component will use to access a service via a service or component manager and the expected service type.     A dependecy may be declared as optional by setting the optional attribute value to TRUE.  The default value for optional is FALSE.
  </p>
  
        <subsection name="Attributes">
          <table>
            <tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
            <tr>
              <td>key</td><td>no</td>
              <td>
              The key that the component will use as the argument to 
              lookup on the supplied service or component manager. 
              The default value is the value is equal to the 
              service classname.
              </td>
            </tr>
            <tr>
              <td>type</td><td>yes</td>
              <td>
               Declaration of an interface and version seperated by the ":" character.
               If the ":" seperator is not included, a version of 1.0 is assumed.
              </td>
            </tr>
            <tr>
              <td>optional</td><td>no</td>
              <td>
               If TRUE, the dependency may not be fulfilled by a container.  If FALSE
               (the default) the container shall ensure that the depdendency is fulfilled
               before component deployment.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Nested Elements">
          <table>
            <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
            <tr>
              <td>attributes</td><td>0..1</td>
              <td>
               A set of attribute declarations.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Example XML">
  
  <source>
        &lt;dependency optional="<font color="darkred">FALSE</font>"
          key="<font color="darkred">my-transformer</font>"
          type="<font color="darkred">org.apache.cocoon.api.Transformer:1.1</font>"/&gt;
  </source>
  
        </subsection>
  
      </section>
  
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Avalon Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2003/04/25 11:57:58 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/dependencies/index.xml
  
  Index: index.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
    <properties>
      <author email="mcconnell@apache.org">Stephen McConnell</author>
      <title>Dependency Descriptors</title>
    </properties>
  
    <body>
  
      <section name="Service Dependencies">
  
  <p>
  Declaration of the set of dependecies that this component type has on component suppliers.  
  </p>
  <p>
  A container will typically provide services to resolve service providers with components declaring depedencies by matching provider and dependency declarations.
  </p>
  
        <subsection name="Nested Elements">
          <table>
            <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
            <tr>
              <td><a href="dependency.html">dependency</a></td><td>0..n</td>
              <td>
               A service dependency declaration.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Example XML">
  
  <p>Dependency descriptors are contained within a single &lt;dependencies&gt; element.  The &lt;dependencies&gt; element may contain 0..n &lt;dependency/&gt; declarations.</p>
  <source><![CDATA[
  <dependencies>
    <depedency key="test" type="MyService:1.2" optional="false"/>
  </dependencies>
  ]]></source>
  
        </subsection>
  
      </section>
  
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2003/04/25 11:57:58 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/dependencies/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <project>
  
   <title>Merlin</title>
  
   <body>
  
       <links>
         <item name="Home" href="http://avalon.apache.org/"/>
         <item name="Framework" href="http://avalon.apache.org/framework/"/>
         <item name="Components" href="http://avalon.apache.org/components"/>
         <item name="Containers" href="http://avalon.apache.org/containers/"/>
         <item name="Sandbox" href="http://avalon.apache.org/sandbox/"/>
       </links>
  
      <menu name="About Merlin">
        <item name="Overview" href="/about/index.html"/>
        <item name="Getting Started" href="/starting/index.html"/>
        <item name="Merlin System" href="/merlin/index.html"/>
        <item name="Meta Model" href="/meta/index.html">
          <item name="Meta Info" href="/meta/info/index.html">
            <item name="Type" href="/meta/info/type/index.html">
              <item name="Info" href="/meta/info/type/info.html"/>
              <item name="Loggers" href="/meta/info/type/loggers/index.html"/>
              <item name="Context" href="/meta/info/type/context/index.html"/>
              <item name="Dependencies" href="/meta/info/type/dependencies/index.html">
                <item name="Dependency" href="/meta/info/type/dependencies/dependency.html"/>
              </item>
              <item name="Services" href="/meta/info/type/services/index.html"/>
              <item name="Stages" href="/meta/info/type/stages/index.html"/>
              <item name="Extensions" href="/meta/info/type/extensions/index.html"/>
            </item>
            <item name="Service" href="/meta/info/service.html"/>
          </item>
          <item name="Meta Data" href="/meta/model/index.html"/>
        </item>
        <item name="Tools" href="/tools/index.html"/>
      </menu>
  
      <menu name="Extensions">
        <item name="JNDI" href="/extensions/jndi/index.html"/>
        <item name="Servlet" href="/extensions/servlet/index.html"/>
      </menu>
  
   </body>
  
  </project>
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/extensions/extension.xml
  
  Index: extension.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
    <properties>
      <author email="mcconnell@apache.org">Stephen McConnell</author>
      <title>Extension Descriptors</title>
    </properties>
  
    <body>
  
      <section name="Extension Descriptor">
  
  <p>
  The org.apache.avalon.meta.info.ExtensionDescriptor class declares tha ability of a component implementation to provide support for the handling of another component declararing a lifecycle stage dependency.  For example, component A may declare that it is capable of supporting lifecycle interface X and component B may declare that it requires a handler for lifecycle stage interface X.  A compliant container will handle the association of a component capable of handling the the lifecycle stage interface with the component declaring the stage dependency.
  </p>
        <subsection name="Attributes">
          <table>
            <tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
            <tr>
              <td>type</td><td>yes</td>
              <td>
               Declaration of an lifecycle stage interface this this component type 
               is capable of supporting.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Nested Elements">
          <table>
            <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
            <tr>
              <td>attributes</td><td>0..1</td>
              <td>
               A set of attribute declarations.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Example XML">
  
  <source><![CDATA[
    <extension type="org.apache.playground.Exploitable"/>
  ]]></source>
  
        </subsection>
  
      </section>
  
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2003/04/25 11:57:59 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/extensions/index.xml
  
  Index: index.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
    <properties>
      <author email="mcconnell@apache.org">Stephen McConnell</author>
      <title>Extension Descriptors</title>
    </properties>
  
    <body>
  
      <section name="Extensions">
  
  <p>
  Declaration of a set of lifecycle extension handling capabilities that the component type provides.
  </p>
        <subsection name="Nested Elements">
          <table>
            <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
            <tr>
              <td><a href="extension.html">extension</a></td><td>0..n</td>
              <td>
               An extension declaration.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Example XML">
  
  <source>
      &lt;extensions&gt;
        &lt;extension type="<font color="darkred">Securable</font>"/&gt;
      &lt;/extensions&gt;
  </source>
  
        </subsection>
  
      </section>
  
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Avalon Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2003/04/25 11:57:59 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/extensions/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <project>
  
   <title>Merlin</title>
  
   <body>
  
       <links>
         <item name="Home" href="http://avalon.apache.org/"/>
         <item name="Framework" href="http://avalon.apache.org/framework/"/>
         <item name="Components" href="http://avalon.apache.org/components"/>
         <item name="Containers" href="http://avalon.apache.org/containers/"/>
         <item name="Sandbox" href="http://avalon.apache.org/sandbox/"/>
       </links>
  
      <menu name="About Merlin">
        <item name="Overview" href="/about/index.html"/>
        <item name="Getting Started" href="/starting/index.html"/>
        <item name="Merlin System" href="/merlin/index.html"/>
        <item name="Meta Model" href="/meta/index.html">
          <item name="Meta Info" href="/meta/info/index.html">
            <item name="Type" href="/meta/info/type/index.html">
              <item name="Info" href="/meta/info/type/info.html"/>
              <item name="Loggers" href="/meta/info/type/loggers/index.html"/>
              <item name="Context" href="/meta/info/type/context/index.html"/>
              <item name="Dependencies" href="/meta/info/type/dependencies/index.html"/>
              <item name="Services" href="/meta/info/type/services/index.html"/>
              <item name="Stages" href="/meta/info/type/stages/index.html"/>
              <item name="Extensions" href="/meta/info/type/extensions/index.html">
                <item name="Extension" href="/meta/info/type/extensions/extension.html"/>
              </item>
            </item>
            <item name="Service" href="/meta/info/service.html"/>
          </item>
          <item name="Meta Data" href="/meta/model/index.html"/>
        </item>
        <item name="Tools" href="/tools/index.html"/>
      </menu>
  
      <menu name="Extensions">
        <item name="JNDI" href="/extensions/jndi/index.html"/>
        <item name="Servlet" href="/extensions/servlet/index.html"/>
      </menu>
  
   </body>
  
  </project>
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/loggers/index.xml
  
  Index: index.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
    <properties>
      <author email="mcconnell@apache.org">Stephen McConnell</author>
      <title>Logging Descriptors</title>
    </properties>
  
    <body>
  
      <section name="Logging Descriptor">
  
  <p>
  The org.apache.avalon.meta.info.LoggerDescriptor class describes the set of logging channels that the component requires. The name of each logging channel is relative to the logging channel passed to the component.  For example, a component hosted in a container names aaa/bbb/ccc will be supplied with a logging with a catagory of aaa.bbb.ccc.your-component and the logging categories defined in the meta-info model will be appended to that (using the period as a category delimiter).
  </p>
        <subsection name="Nested Elements">
          <table>
            <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
            <tr>
              <td><a href="logger.html">logger</a></td><td>0..n</td>
              <td>
               A logging category declaration.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Example XML">
  
  <p>Logger descriptors are contained within a single &lt;loggers&gt; element.</p>
  <source><![CDATA[
  <loggers>
    <logger name="test"/>
    <logger name="internal"/>
  </loggers>
  ]]></source>
  
        </subsection>
  
      </section>
  
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2003/04/25 11:57:59 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/loggers/logger.xml
  
  Index: logger.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
    <properties>
      <author email="mcconnell@apache.org">Stephen McConnell</author>
      <title>Logging Descriptors</title>
    </properties>
  
    <body>
  
      <section name="Logging Descriptor">
  
  <p>
  The org.apache.avalon.meta.info.LoggerDescriptor class describes the a logging channel that the component requires.
  </p>
        <subsection name="Attributes">
          <table>
            <tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
            <tr>
              <td>name</td><td>yes</td>
              <td>
              The logging category name.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Nested Elements">
          <table>
            <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
            <tr>
              <td>attributes</td><td>0..1</td>
              <td>
               A set of attribute declarations.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Example XML">
  <source><![CDATA[
  <logger name="store"/>
  <logger name="cache">
    <attributes>
      <attribute key="an-attribute" value="some value"/>
    </attributes>
  </logger>       
  ]]></source>
        </subsection>
      </section>
  
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Avalon Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2003/04/25 11:57:59 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/loggers/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <project>
  
   <title>Merlin</title>
  
   <body>
  
       <links>
         <item name="Home" href="http://avalon.apache.org/"/>
         <item name="Framework" href="http://avalon.apache.org/framework/"/>
         <item name="Components" href="http://avalon.apache.org/components"/>
         <item name="Containers" href="http://avalon.apache.org/containers/"/>
         <item name="Sandbox" href="http://avalon.apache.org/sandbox/"/>
       </links>
  
      <menu name="About Merlin">
        <item name="Overview" href="/about/index.html"/>
        <item name="Getting Started" href="/starting/index.html"/>
        <item name="Merlin System" href="/merlin/index.html"/>
        <item name="Meta Model" href="/meta/index.html">
          <item name="Meta Info" href="/meta/info/index.html">
            <item name="Type" href="/meta/info/type/index.html">
              <item name="Info" href="/meta/info/type/info.html"/>
              <item name="Loggers" href="/meta/info/type/loggers/index.html">
                <item name="Logger" href="/meta/info/type/loggers/logger.html"/>
              </item>
              <item name="Context" href="/meta/info/type/context/index.html"/>
              <item name="Dependencies" href="/meta/info/type/dependencies/index.html"/>
              <item name="Services" href="/meta/info/type/services/index.html"/>
              <item name="Stages" href="/meta/info/type/stages/index.html"/>
              <item name="Extensions" href="/meta/info/type/extensions/index.html"/>
            </item>
            <item name="Service" href="/meta/info/service.html"/>
          </item>
          <item name="Meta Data" href="/meta/model/index.html"/>
        </item>
        <item name="Tools" href="/tools/index.html"/>
      </menu>
  
      <menu name="Extensions">
        <item name="JNDI" href="/extensions/jndi/index.html"/>
        <item name="Servlet" href="/extensions/servlet/index.html"/>
      </menu>
  
   </body>
  
  </project>
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/services/index.xml
  
  Index: index.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
    <properties>
      <author email="mcconnell@apache.org">Stephen McConnell</author>
      <title>Service Descriptors</title>
    </properties>
  
    <body>
  
      <section name="Service Descriptor">
  
  <p>
  Declaration of the set of services published by this component type.
  </p>
        <subsection name="Nested Elements">
          <table>
            <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
            <tr>
              <td><a href="service.html">service</a></td><td>0..n</td>
              <td>
               A service declaration.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Example XML">
  
  <source>
  
      <font color="gray"><i>&lt;!--
      Declaration of the set of services that this component is capable 
      of supplying.  Each service declarared under the services element
      may be referenced by other component types as service dependecies
      or lifecycle stage depedencies.  A container is responsible for 
      the assembaly of component types based on the connection of 
      supply components to consumer components via a common service 
      description. 
      --&gt;</i></font>
  
      &lt;services&gt;
  
        <font color="gray"><i>&lt;!-- 
        The service type is the classname of an interface and the
        version identifier qualifes the interface version.  The 
        default version value is 1.0.
        --&gt;</i></font>
  
        &lt;service type="<font color="darkred">org.apache.SimpleService:3.2</font>"&gt;
          &lt;attributes&gt;
             <font color="gray"><i>&lt;!--
             Attribute declarations may be included to qualify the 
             characteristics of the service provided by the component
             implementation.
             --&gt;</i></font>
             &lt;attribute key="<font color="darkred">a-key</font>" value="<font color="darkred">a-value</font>"/&gt;
          &lt;/attributes&gt;
        &lt;/service&gt;
  
      &lt;/services&gt;
  
  </source>
  
        </subsection>
  
      </section>
  
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Avalon Apache Project. All rights reserved.
        $Revision: 1.1 $ $Date: 2003/04/25 11:57:59 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/services/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <project>
  
   <title>Merlin</title>
  
   <body>
  
       <links>
         <item name="Home" href="http://avalon.apache.org/"/>
         <item name="Framework" href="http://avalon.apache.org/framework/"/>
         <item name="Components" href="http://avalon.apache.org/components"/>
         <item name="Containers" href="http://avalon.apache.org/containers/"/>
         <item name="Sandbox" href="http://avalon.apache.org/sandbox/"/>
       </links>
  
      <menu name="About Merlin">
        <item name="Overview" href="/about/index.html"/>
        <item name="Getting Started" href="/starting/index.html"/>
        <item name="Merlin System" href="/merlin/index.html"/>
        <item name="Meta Model" href="/meta/index.html">
          <item name="Meta Info" href="/meta/info/index.html">
            <item name="Type" href="/meta/info/type/index.html">
              <item name="Info" href="/meta/info/type/info.html"/>
              <item name="Loggers" href="/meta/info/type/loggers/index.html"/>
              <item name="Context" href="/meta/info/type/context/index.html"/>
              <item name="Dependencies" href="/meta/info/type/dependencies/index.html"/>
              <item name="Services" href="/meta/info/type/services/index.html">
                <item name="Service" href="/meta/info/type/services/service.html"/>
              </item>
              <item name="Stages" href="/meta/info/type/stages/index.html"/>
              <item name="Extensions" href="/meta/info/type/extensions/index.html"/>
            </item>
            <item name="Service" href="/meta/info/service.html"/>
          </item>
          <item name="Meta Data" href="/meta/model/index.html"/>
        </item>
        <item name="Tools" href="/tools/index.html"/>
      </menu>
  
      <menu name="Extensions">
        <item name="JNDI" href="/extensions/jndi/index.html"/>
        <item name="Servlet" href="/extensions/servlet/index.html"/>
      </menu>
  
   </body>
  
  </project>
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/services/service.xml
  
  Index: service.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
    <properties>
      <author email="mcconnell@apache.org">Stephen McConnell</author>
      <title>Service Descriptors</title>
    </properties>
  
    <body>
  
      <section name="Service Descriptor">
  
  <p>
  The org.apache.avalon.meta.info.ServiceDescriptor class describes a service delivery capability. It contains a reference to ServiceDefinition. Service delivery capability represent the value-proposition that the component type offers to its clients. Client typically include other component that have declared dependencies on the type of service referenced by the ServiceDescriptor.  Services supporting dependency requirements are exposed to clients though a ServiceManager (or ComponentManager). For dependent services, the client will typically invoke the <code>lookup</code> operation against the supplied service manager, passing a lookup key to the supplied manager.  The object retured is the service (or a proxy that isolates the component from the offered service). 
  </p>
        <subsection name="Attributes">
          <table>
            <tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
            <tr>
              <td>type</td><td>yes</td>
              <td>
               Declaration of an interface and version seperated by the ":" character.
               If the ":" seperator is not included, a version of 1.0 is assumed.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Nested Elements">
          <table>
            <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
            <tr>
              <td>attributes</td><td>0..1</td>
              <td>
               A set of attribute declarations.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Example XML">
  
  <source>
  &lt;service type="<font color="darkred">org.apache.SimpleService:3.2</font>"/&gt;
  </source>
  
        </subsection>
  
      </section>
  
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Avalon Apache Project. All rights reserved.
        $Revision: 1.1 $ $Date: 2003/04/25 11:57:59 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/stages/index.xml
  
  Index: index.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
    <properties>
      <author email="mcconnell@apache.org">Stephen McConnell</author>
      <title>Stage Descriptors</title>
    </properties>
  
    <body>
      <section name="Lifecycle Stages">
  <p>
  Declaration of a set of lifecycle stage dependencies.  A container shall invoke lifecycle stages in the order corresponding to the order of the stage declarations.
  </p>
        <subsection name="Nested Elements">
          <table>
            <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
            <tr>
              <td><a href="stage.html">stage</a></td><td>0..n</td>
              <td>
               A stage dependency declaration.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Example XML">
  
  <source>
      &lt;stages&gt;
        &lt;stage type="<font color="darkred">Securable</font>"/&gt;
        &lt;stage type="<font color="darkred">Persistable</font>"/&gt;
      &lt;/stages&gt;
  </source>
  
        </subsection>
  
      </section>
  
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Avvalon Apache Project. All rights reserved.
        $Revision: 1.1 $ $Date: 2003/04/25 11:57:59 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/stages/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <project>
  
   <title>Merlin</title>
  
   <body>
  
       <links>
         <item name="Home" href="http://avalon.apache.org/"/>
         <item name="Framework" href="http://avalon.apache.org/framework/"/>
         <item name="Components" href="http://avalon.apache.org/components"/>
         <item name="Containers" href="http://avalon.apache.org/containers/"/>
         <item name="Sandbox" href="http://avalon.apache.org/sandbox/"/>
       </links>
  
      <menu name="About Merlin">
        <item name="Overview" href="/about/index.html"/>
        <item name="Getting Started" href="/starting/index.html"/>
        <item name="Merlin System" href="/merlin/index.html"/>
        <item name="Meta Model" href="/meta/index.html">
          <item name="Meta Info" href="/meta/info/index.html">
            <item name="Type" href="/meta/info/type/index.html">
              <item name="Info" href="/meta/info/type/info.html"/>
              <item name="Loggers" href="/meta/info/type/loggers/index.html"/>
              <item name="Context" href="/meta/info/type/context/index.html"/>
              <item name="Dependencies" href="/meta/info/type/dependencies/index.html"/>
              <item name="Services" href="/meta/info/type/services/index.html"/>
              <item name="Stages" href="/meta/info/type/stages/index.html">
                <item name="Stage" href="/meta/info/type/stages/stage.html"/>
              </item>
              <item name="Extensions" href="/meta/info/type/extensions/index.html"/>
            </item>
            <item name="Service" href="/meta/info/service.html"/>
          </item>
          <item name="Meta Data" href="/meta/model/index.html"/>
        </item>
        <item name="Tools" href="/tools/index.html"/>
      </menu>
  
      <menu name="Extensions">
        <item name="JNDI" href="/extensions/jndi/index.html"/>
        <item name="Servlet" href="/extensions/servlet/index.html"/>
      </menu>
  
   </body>
  
  </project>
  
  
  
  1.1                  avalon-sandbox/merlin/merlin-smp/xdocs/meta/info/type/stages/stage.xml
  
  Index: stage.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
    <properties>
      <author email="mcconnell@apache.org">Stephen McConnell</author>
      <title>Stage Descriptors</title>
    </properties>
  
    <body>
      <section name="Stage Descriptor">
  
  <p>
  The org.apache.avalon.meta.info.StageDescriptor class declares a depedency that
  a component has towards a stage interface handler (refer <a href="../extensions/extension.html">extension</a>).  A component 
  may declare multiple stage depedencies.  Each stage depedency references a version 
  interface.  A compliant container is responsible for handling the association of 
  extension handlers with components that are dependent on custom stages by matching
  extension candidates based on the interface type reference.
  </p>
        <subsection name="Attributes">
          <table>
            <tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
            <tr>
              <td>type</td><td>yes</td>
              <td>
               Declaration of an lifecycle stage interface this this component type 
               requires to be supplied during the component deployment phase.
              </td>
            </tr>
          </table>
        </subsection>
  
        <subsection name="Nested Elements">
          <table>
            <tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
            <tr>
              <td>attributes</td><td>0..1</td>
              <td>
               A set of attribute declarations.
              </td>
            </tr>
          </table>
        </subsection>
        <subsection name="Example XML">
  
  <source>
    &lt;stage type="<font color="darkred">Securable</font>"/&gt;
  </source>
  
        </subsection>
  
      </section>
  
    </body>
  
    <footer>
      <legal>
        Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
        $Revision: 1.1 $ $Date: 2003/04/25 11:57:59 $
      </legal>
    </footer>
  
  </document>
  
  
  
  
  

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


Mime
View raw message