donaldp 2002/08/30 22:28:50
Added: containerkit/src/java/org/apache/avalon/framework/info/doc-files
entries.html
Log:
add some entry descriptions
Revision Changes Path
1.1
jakarta-avalon-excalibur/containerkit/src/java/org/apache/avalon/framework/info/doc-files/entries.html
Index: entries.html
===================================================================
<html>
<head>
<title>Context Entries</title>
</head>
<body>
<h3>Overview</h3>
<p>The Context interface gives the component writer an interface via
which to access resources that are provided by the container. Each
component declares the resources it requires (or will use if present)
under a specific key with a specific type.</p>
<p>The list of context keys that is supported by the container is
extensible and follows the namespacing conventions outlined in the
<a href="namespaces.html">Namespace</a> document. However there are
a set of standard key-value pairs. It is recomended that container
recognize these if they support the particular feature.</p>
<h3>Entry Definitions</h3>
<table border="1" cellpadding="2" cellspacing="0" width="100%">
<tr bgcolor="#CCCCCCS">
<td><b>Key</b></td>
<td><b>Type</b></td>
<td><b>Description</b></td>
</tr>
<tr>
<td>component:name</td>
<td><code>java.lang.String</code></td>
<td>This entry defines the name of the component.</td>
</tr>
<tr>
<td>component:home.dir</td>
<td><code>java.io.File</code></td>
<td>The location to store persistent data relevent to the
component. Often identical to the "application:home.dir"
and "partition:home.dir" entrys.</td>
</tr>
<tr>
<td>component:work.dir</td>
<td><code>java.io.File</code></td>
<td>This directory in which to store temporary or working
information. It may not persist over restarts of
the component. Often identical to the "application:work.dir"
and "partition:work.dir" entrys.</td>
</tr>
<tr>
<td>component:classloader</td>
<td><code>java.lang.ClassLoader</code></td>
<td>The classloader via which the component was loaded. May
differ from the ClassLoader returned by getClass().getClassLoader()
if the component was loaded from parent classloader.</td>
</tr>
<tr>
<td>partition:name</td>
<td><code>java.lang.String</code></td>
<td>This entry defines the name of the partition.</td>
</tr>
<tr>
<td>partition:home.dir</td>
<td><code>java.io.File</code></td>
<td>The location to store persistent data relevent to the
partition. Often identical to the "application:home.dir"
and "component:home.dir" entrys.</td>
</tr>
<tr>
<td>partition:work.dir</td>
<td><code>java.io.File</code></td>
<td>This directory in which to store temporary or working
information. It may not persist over restarts of
the partition. Often identical to the "application:work.dir"
and "component:work.dir" entrys.</td>
</tr>
<tr>
<td>partition:classloader</td>
<td><code>java.lang.ClassLoader</code></td>
<td>The classloader via which the partition was loaded. May
differ from the ClassLoader returned by getClass().getClassLoader()
from any component. Components may have been loaded parent
classloader. Often this classloader value is also set as
Thread.getContextClassLoader()</td>
</tr>
<tr>
<td>application:name</td>
<td><code>java.lang.String</code></td>
<td>This entry defines the name of the application.</td>
</tr>
<tr>
<td>application:home.dir</td>
<td><code>java.io.File</code></td>
<td>The location to store persistent data relevent to the
application. Often identical to the "partition:home.dir"
and "component:home.dir" entrys.</td>
</tr>
<tr>
<td>application:work.dir</td>
<td><code>java.io.File</code></td>
<td>This directory in which to store temporary or working
information. It may not persist over restarts of
the application. Often identical to the "partition:work.dir"
and "component:work.dir" entrys.</td>
</tr>
</table>
</body>
</html>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
