mcconnell 2002/11/11 03:58:47
Modified: meta/src/xdocs menu.xml
Added: meta/src/xdocs profile.xml
Log:
Update to the menu to include the profile documentation and initial commit
of the profile description, UML, and XML examples.
Revision Changes Path
1.3 +10 -6 jakarta-avalon-excalibur/meta/src/xdocs/menu.xml
Index: menu.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/meta/src/xdocs/menu.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- menu.xml 22 Sep 2002 07:55:15 -0000 1.2
+++ menu.xml 11 Nov 2002 11:58:47 -0000 1.3
@@ -11,18 +11,22 @@
<item name="Tools" href="tools.html"/>
</menu>
+ <menu name="Profile">
+ <item name="Profile Defintion" href="profile.html"/>
+ </menu>
+
+ <menu name="Service">
+ <item name="Service Definition" href="service.html"/>
+ </menu>
+
<menu name="Type">
<item name="Type Defintion" href="type.html"/>
- <item name="Logging" href="logging.html"/>
- <item name="Context" href="context.html"/>
+ <item name="Logging Crieria" href="logging.html"/>
+ <item name="Context Crieria" href="context.html"/>
<item name="Services" href="services.html"/>
<item name="Dependencies" href="dependencies.html"/>
<item name="Extensions" href="extensions.html"/>
<item name="Stages" href="stages.html"/>
- </menu>
-
- <menu name="Service">
- <item name="Service Definition" href="service.html"/>
</menu>
<menu name="Links">
1.1 jakarta-avalon-excalibur/meta/src/xdocs/profile.xml
Index: profile.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Profile Definition</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<s1 title="Introduction">
<p>A profile is the definition of the criteria for the establishment of a component.
A profile, when included within the scope of a container declaration, will be
instantiated in the model as an EXPLICIT profile resulting in the initiation of
dependency resolution relative to the component as the target deployment objective.
Multiple supplementary profiles may be packaged in a files <classname>.xprofile.
Profile declarations included within an .xprofile resource are refered to as packaged
profiles.</p>
<p>A profile represents an aggregation of the following information:</p>
<ul>
<li>the component Type that the profile is qualifying</li>
<li>a logging directive within which multiple logging categories declare the
priority and target to set for a logging channel</li>
<li>a context directive that contains:
<ul>
<li>import directives the declare to a container that the component expects the
host container to supply the context entry</li>
<li>context creation directives then enable the declarative specification of the
criteria for the creation of a context value usingh constructor parameters</li>
</ul>
</li>
<li>the configuration to be used</li>
<li>the parameters to be applied</li>
</ul>
<s2 title="UML">
<p>An overview of the Profile object model is presented in the following UML
diagram.</p>
<img src="images/Profile.gif" />
</s2>
<s2 title="XML">
<p>The Profile API includes factory services that support the creation of a profile
instance from an XML description. The following XML is an example of a profile
declaration.</p>
<source>
<font color="gray"><i><!--
Declaration of the services hosted by this container. Service container here
will be managed relative to other provider components at the same level and
may be serviced by components declared in parent container.
--></i></font>
<component name="<font color="darkred">complex</font>" class="<font
color="darkred">org.apache.excalibur.playground.ComplexComponent</font>"
activation="<font color="darkred">startup</font>">
<font color="gray"><i><!--
Priority and target assignments for component specific logging categrories.
--></i></font>
<categories priority="<font color="darkred">DEBUG</font>">
<category name="<font color="darkred">init</font>" priority="<font
color="darkred">DEBUG</font>" />
</categories>
<font color="gray"><i><!--
Include the following context value in the context supplied a component using this
profile. Context entries are normally only required in the case where the component
type declares a required context type and entry values. Generally speaking, a
component
will normally qualify it's instantiation criteria through a configuration
declaration.
Any context values defined at this level will override context values supplied by
the
container.
--></i></font>
<context>
<entry name="<font color="darkred">location</font>" value="<font
color="darkred">Paris</font>"/>
</context>
<font color="gray"><i><!--
Apply the following configuration when instantiating the component. This
configuration
will be applied as the primary configuration in a cascading configuration chain. A
type may declare a default configuration under a "classname".xconfig file that will
be
used to dereference any configuration requests not resolvable by the configuration
supplied here.
--></i></font>
<configuration>
<message value="<font color="darkred">Hello</font>"/>
</configuration>
<font color="gray"><i><!--
The parameterization criteria from this instance of the component type.
--></i></font>
<parameters/>
</component>
</source>
</s2>
</s1>
</body>
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
$Revision: 1.1 $ $Date: 2002/11/11 11:58:47 $
</legal>
</footer>
</document>
--
To unsubscribe, e-mail: <mailto:avalon-cvs-unsubscribe@;jakarta.apache.org>
For additional commands, e-mail: <mailto:avalon-cvs-help@;jakarta.apache.org>
