mcconnell 2003/08/27 21:08:10
Added: merlin/merlin-platform/xdocs/meta/kernel index.xml
navigation.xml
merlin/merlin-platform/xdocs/meta/kernel/logging
category.xml index.xml navigation.xml target.xml
merlin/merlin-platform/xdocs/meta/kernel/repository
cache.xml hosts.xml index.xml navigation.xml
proxy.xml
Log:
Updated kernel meta-data spec.
Revision Changes Path
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/kernel/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Kernel Reference</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Kernel">
<subsection name="Nested Elements">
<table>
<tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
<tr>
<td><a href="logging/index.html">logging</a></td><td>0..1</td>
<td>Defintion of the root logging system.</td>
</tr>
<tr>
<td><a href="repository/index.html">repository</a></td><td>0..1</td>
<td>Defintion of the repository sub-system including proxy settings,
cache directory and remote host list.</td>
</tr>
</table>
</subsection>
<subsection name="Description">
<p>
The kernel element declares a root Merlin kernel that is used
to establish core services.
</p>
</subsection>
<subsection name="Sample XML">
<source><![CDATA[
<!-- kernel declaration -->
<kernel>
<logging target="default" priority="INFO">
<category name="/logger" priority="WARN"/>
</logging>
<repository>
<hosts>
<host>http://www.ibiblio.org/merlin/</host>
<host>http://www.ibiblio.org/maven/</host>
</hosts>
</repository>
</kernel>
]]></source>
</subsection>
</section>
</body>
</document>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/kernel/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="kernel.xml" href="/meta/kernel/index.html">
<item name="logging" href="/meta/kernel/logging/index.html"/>
<item name="repository" href="/meta/kernel/repository/index.html"/>
</item>
<item name="block.xml" href="/meta/block/index.html"/>
<item name="config.xml" href="/meta/config/index.html"/>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Resources" href="/resources/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-platform/xdocs/meta/kernel/logging/category.xml
Index: category.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Category Directive</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Category Directive">
<subsection name="Attributes">
<table>
<tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
<tr>
<td>name</td><td>yes</td>
<td>
Logging category name. The category name refers to
a logging sub-category within the enclosing category.
</td>
</tr>
<tr>
<td>priority</td><td>no</td>
<td>
The logging priority (one of INFO, WARN, ERROR, FATAL, DEBUG).
</td>
</tr>
<tr>
<td>target</td><td>no</td>
<td>
Named logging target.
</td>
</tr>
</table>
</subsection>
<subsection name="Description">
<p>The logging channel category directive.</p>
</subsection>
<subsection name="Sample XML">
<source><![CDATA[
<category name="/sys" priority="INFO"/>
]]></source>
</subsection>
</section>
</body>
</document>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/kernel/logging/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Kernel Logging System</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Logging Directive">
<subsection name="Attributes">
<table>
<tr><th>Attribute</th><th>Required</th><th>Description</th></tr>
<tr>
<td>priority</td><td>no</td>
<td>The default logging priority level. Allowable values include
INFO, WARN, ERROR, and DEBUG.</td>
</tr>
<tr>
<td>target</td><td>no</td>
<td>The name of the default logging target.</td>
</tr>
</table>
</subsection>
<subsection name="Nested Elements">
<table>
<tr><th>Element</th><th>Cardinality</th><th>Description</th></tr>
<tr>
<td><a href="target.html">target</a></td><td>n</td>
<td>Logging target declartation.</td>
</tr>
<tr>
<td><a href="category.html">category</a></td><td>n</td>
<td>Internal kernel logging category directive.</td>
</tr>
</table>
</subsection>
<subsection name="Description">
<p>Logging services build above the Avalon framework abstract logging
infrastructure. Merlin provides the mechanisms through which logging hierarchies can
be created, logging priorities assigned, and definition of log event output targets.
Logging directives may be includes at the kernel, container and component levels.</p>
<p>A kernel may be configured with an optional logging system creation directive.
The logging element declares the application wide default logging priority. A target
element enables definition of a logging file to which log entries will be directed.
The target name attribute is the name referenced by category elements defined within
the loggers element. Child category declarations must include a name (the logging
category), and may optionally include a target and a priority attribute. The target
defaults of "default" which corresponds to a internal default logging target that
issue messages to System.out (unless overridden by a target named default). If the
target is declared inside a category element, it must refer to a named target element.
The priority attribute may container one of the values <code>DEBUG</code>,
<code>INFO</code>, <code>WARN</code> or <code>ERROR</code>. The target must contain a
single file element with the attribute <code>location</code> the corresponds to the
name of the logging file.</p>
</subsection>
<subsection name="Sample XML">
<source><![CDATA[
<logging priority="INFO" target="kernel">
<target name="kernel">
<file location="kernel.log" />;
</target>
</logging>
]]></source>
</subsection>
</section>
</body>
</document>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/kernel/logging/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="kernel.xml" href="/meta/kernel/index.html">
<item name="logging" href="/meta/kernel/logging/index.html">
<item name="target" href="/meta/kernel/logging/target.html"/>
<item name="category" href="/meta/kernel/logging/category.html"/>
</item>
<item name="repository" href="/meta/kernel/repository/index.html"/>
</item>
<item name="block.xml" href="/meta/block/index.html"/>
<item name="config.xml" href="/meta/config/index.html"/>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Resources" href="/resources/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-platform/xdocs/meta/kernel/logging/target.xml
Index: target.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Logging Target Directive</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Logging Target Directive">
<subsection name="Description">
<p>
Logging targets defines a named logging target for the kernel. The
name of the target can be used within category directives. At this
time logging targets types are limitewd to a file sink.
</p>
</subsection>
<subsection name="Sample XML">
<source><![CDATA[
<!--
Example of a kernel that creates a named logging target that
logs to a file.
-->
<logging target="kernel" priority="INFO" name="kernel">
<category name="/logger" priority="WARN"/>
<target name="kernel">
<file location="logs/kernel.log" />
</target>
</logging>
]]></source>
</subsection>
</section>
</body>
</document>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/kernel/repository/cache.xml
Index: cache.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Repository Proxy</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Proxy">
<subsection name="Description">
<p>A local directory to be used as the cache. If not
declared, the value defaults to '[MERLIN-HOME]/repository'.</p>
</subsection>
<subsection name="Sample XML">
<source><![CDATA[
<repository>
<cache>C:/maven/repository</cache>
</repository>
]]></source>
</subsection>
</section>
</body>
</document>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/kernel/repository/hosts.xml
Index: hosts.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Repository Hosts</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Hosts">
<subsection name="Nested Elements">
<table>
<tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
<tr>
<td>host</td><td>0..1</td>
<td>
<p>Declaration of a remote host. The value of the element
is an http address of a server the implements the Maven
style repository model.</p>
<p>I.e.
[root]/[group-id]/[type-id]s/[artifact-name][-[version]].[type]</p>
<source><![CDATA[
<host>http://www.ibiblio.org/maven/</host>
]]></source>
</td>
</tr>
</table>
</subsection>
<subsection name="Description">
<p>If a resource is unknown within the local cache, the
repository implementation will attempt to resolve the
resource relative to one or more an external hosts.
Hosts are checked relative to the order listed under
this element.</p>
</subsection>
<subsection name="Sample XML">
<source><![CDATA[
<repository>
<hosts>
<host>http://www.osm.net/repository/</host>
<host>http://www.ibiblio.org/merlin/repository/</host>
<host>http://www.ibiblio.org/maven/</host>
</hosts>
</repository>
]]></source>
</subsection>
</section>
</body>
</document>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/kernel/repository/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Kernel Logging Categories</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Repository">
<subsection name="Nested Elements">
<table>
<tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
<tr>
<td><a href="cache.html">cache</a></td><td>0..1</td>
<td>
A local directory to be used as the cache. If not
declared, the value defaults to '[MERLIN-HOME]/repository'.
</td>
</tr>
<tr>
<td><a href="proxy.html">proxy</a></td><td>0..1</td>
<td>
Declaration of proxy host, port and credentials.
</td>
</tr>
<tr>
<td><a href="hosts.html">hosts</a></td><td>n</td>
<td>
A list of remote repositories.
</td>
</tr>
</table>
</subsection>
<subsection name="Description">
<p>Merlin provides a resouces repository against which jar files may be resolved
relative to group, artifact and version. Aspects of the repository may be qualified
using the <repository> element.</p>
</subsection>
<subsection name="Sample XML">
<source><![CDATA[
<kernel>
<!-- declaration of the local repository -->
<repository>
<!--
The default local cache is the [MERLIN-HOME]/repository.
In the following example the local cache is changed
to use the Maven repository.
-->
<cache>C:/maven/repository</cache>
<!--
If a resource cannot be located in the local repository
cache, Merlin will attempt to locate the resource in one
or more remote repositories. If you have a proxy server
you will need to declare it under the proxy element. If
you declare a proxy, the host and port elements must be
declared. You can also declare a 'credentials' element if
your proxy requires password authentication.
-->
<proxy>
<host>proxy.somethere.com</host>
<port>999</port>
<credentials>
<username>test</username>
<password>test</password>
</credentials>
</proxy>
<!--
Merlin will attempt to locate resource from the local cache.
If a resource is unavailable, Merlin willl attempt to
download the resource from one or more remote hosts. The
hosts element contains the list of hosts that Merlin should
attempt to connect to when resolving unsatisfied resource
requests.
-->
<hosts>
<host>http://www.osm.net/repository/</host>
<host>http://www.ibiblio.org/merlin/repository</host>
</hosts>
</repository>
</kernel>
]]></source>
</subsection>
</section>
</body>
</document>
1.1
avalon-sandbox/merlin/merlin-platform/xdocs/meta/kernel/repository/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="kernel.xml" href="/meta/kernel/index.html">
<item name="logging" href="/meta/kernel/logging.html"/>
<item name="repository" href="/meta/kernel/repository/index.html">
<item name="cache" href="/meta/kernel/repository/cache.html"/>
<item name="proxy" href="/meta/kernel/repository/proxy.html"/>
<item name="hosts" href="/meta/kernel/repository/hosts.html"/>
</item>
</item>
<item name="block.xml" href="/meta/block/index.html"/>
<item name="config.xml" href="/meta/config/index.html"/>
</item>
<item name="Tools" href="/tools/index.html"/>
<item name="Resources" href="/resources/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-platform/xdocs/meta/kernel/repository/proxy.xml
Index: proxy.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Repository Proxy</title>
<authors>
<person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<section name="Proxy">
<subsection name="Nested Elements">
<table>
<tr><th>Element</th><th>Occurance</th><th>Description</th></tr>
<tr>
<td>host</td><td>1</td>
<td>
<p>The host name of the proxy server.</p>
</td>
</tr>
<tr>
<td>port</td><td>1</td>
<td>
<p>The proxy server port number.</p>
</td>
</tr>
<tr>
<td>credentials</td><td>0..1</td>
<td>
<p>If a resource is unknown within the local cache, the
repository implementation will attempt to resolve the
resource relative to one or more an external hosts.
Hosts are checked relative to the order listed under
this element.</p>
</td>
</tr>
</table>
</subsection>
<subsection name="Description">
<p>Declaration of a proxy server to use when resolving remotely located jar
files.</p>
</subsection>
<subsection name="Sample XML">
<source><![CDATA[
<proxy>
<host>proxy.somewhere.com</host>
<port>9090</port>
<credentials>
<username>test</username>
<password>test</password>
</credentials>
</proxy>
]]></source>
</subsection>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
