hlship 2003/09/26 11:19:35
Modified: hivemind/xdocs bootstrap.xml
hivemind/framework/xdocs navigation.xml
hivemind/framework/src/xsl hivemind.xsl
hivemind maven.xml
Added: hivemind/framework/xdocs ThreadEventNotifier.xml
FactoryDefaults.xml ThreadLocalStorage.xml
ClassFactory.xml SymbolSource.xml
ApplicationDefaults.xml
Log:
Fill in the gaps in the framework documentation.
Revision Changes Path
1.7 +2 -2 jakarta-commons-sandbox/hivemind/xdocs/bootstrap.xml
Index: bootstrap.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/hivemind/xdocs/bootstrap.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- bootstrap.xml 23 Sep 2003 22:23:51 -0000 1.6
+++ bootstrap.xml 26 Sep 2003 18:19:35 -0000 1.7
@@ -85,7 +85,7 @@
</module>]]></source>
<p>
-Here we've chosen to have the module id, <code>hivemind.examples</code> match
the package name but
+Here we've chosen to have the module id, <code>hivemind.examples</code>, match
the package name but
that is not an absolute requirement.
</p>
1.3 +11 -2 jakarta-commons-sandbox/hivemind/framework/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/hivemind/framework/xdocs/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 24 Sep 2003 16:07:52 -0000 1.2
+++ navigation.xml 26 Sep 2003 18:19:35 -0000 1.3
@@ -11,8 +11,17 @@
<menu name="Services">
<item name="BuilderFactory" href="/BuilderFactory.html"/>
- <item name="LoggingInterceptor" href="/LoggingInterceptor.html"/>
+ <item name="ClassFactory" href="/ClassFactory.html"/>
+ <item name="LoggingInterceptor" href="/LoggingInterceptor.html"/>
+ <item name="ThreadEventNotifier" href="/ThreadEventNotifier.html"/>
+ <item name="ThreadLocalStorage" href="/ThreadLocalStorage.html"/>
</menu>
+
+ <menu name="Configurations">
+ <item name="ApplicationDefaults" href="/ApplicationDefaults.html"/>
+ <item name="FactoryDefaults" href="/FactoryDefaults.html"/>
+ <item name="SymbolSource" href="/SymbolSource.html"/>
+ </menu>
<menu name="Reference">
1.1
jakarta-commons-sandbox/hivemind/framework/xdocs/ThreadEventNotifier.xml
Index: ThreadEventNotifier.xml
===================================================================
<?xml version="1.0"?>
<!-- $Id: ThreadEventNotifier.xml,v 1.1 2003/09/26 18:19:35 hlship Exp $ -->
<!DOCTYPE document [
<!ENTITY projectroot '../'>
<!ENTITY % common-links SYSTEM "common/links.xml">
%common-links;
]>
<document>
<properties>
<title>hivemind.ThreadEventNotifier Service</title>
<author email="[EMAIL PROTECTED]">Howard M. Lewis Ship</author>
</properties>
<body>
<section name="hivemind.ThreadEventNotifier">
<p>
The <a
href="&hivemind-registry;#service:hivemind.ThreadEventNotifier">ThreadEventNotifier</a>
service implements
the
<a href="&apiroot;/service/ThreadEventNotifier.html">ThreadEventNotifier</a>
interface. It is used internally by HiveMind
to receive a notification when a thread should be cleaned up (at the end of a
request or transaction).
</p>
<p>
It is the application's responsibility to inform the service when the thread should
be cleaned up; typically
this is done from the top-level servlet (or, potentially, a servlet filter):
<source>
public void service(ServletRequest request, ServletResponse response)
throws ServletException, IOException
{
try
{
super.service(request, response);
}
finally
{
getThreadEventNotifier().fireThreadCleanup();
}
}
</source>
</p>
</section>
</body>
</document>
1.1
jakarta-commons-sandbox/hivemind/framework/xdocs/FactoryDefaults.xml
Index: FactoryDefaults.xml
===================================================================
<?xml version="1.0"?>
<!-- $Id: FactoryDefaults.xml,v 1.1 2003/09/26 18:19:35 hlship Exp $ -->
<!DOCTYPE document [
<!ENTITY projectroot '../'>
<!ENTITY % common-links SYSTEM "common/links.xml">
%common-links;
]>
<document>
<properties>
<title>hivemind.FactoryDefaults Configuration</title>
<author email="[EMAIL PROTECTED]">Howard M. Lewis Ship</author>
</properties>
<body>
<section name="hivemind.FactoryDefaults">
<p>
The <a
href="&hivemind-registry;#configuration:hivemind.FactoryDefaults">FactoryDefaults</a>
configuration
is used to set default values for substitution symbols. Contributions look like:
<source><![CDATA[
<default symbol=". . ." value=". . ."/>
]]>
</source>
</p>
<p>
Values defined here can be overriden by making a contribution to
<a href="ApplicationDefaults.html">hivemind.ApplicationDefaults</a>.
</p>
</section>
</body>
</document>
1.1
jakarta-commons-sandbox/hivemind/framework/xdocs/ThreadLocalStorage.xml
Index: ThreadLocalStorage.xml
===================================================================
<?xml version="1.0"?>
<!-- $Id: ThreadLocalStorage.xml,v 1.1 2003/09/26 18:19:35 hlship Exp $ -->
<!DOCTYPE document [
<!ENTITY projectroot '../'>
<!ENTITY % common-links SYSTEM "common/links.xml">
%common-links;
]>
<document>
<properties>
<title>hivemind.ThreadLocalStorage Service</title>
<author email="[EMAIL PROTECTED]">Howard M. Lewis Ship</author>
</properties>
<body>
<section name="hivemind.ThreadLocalStorage">
<p>
The <a
href="&hivemind-registry;#service:hivemind.ThreadLocalStorage">ThreadLocalStorage</a>
service implements
the
<a href="&apiroot;/service/ThreadLocalStorage.html">ThreadLocalStorage</a>
interface. This service
acts as a kind of Map for temporary data. The map is local to the current thread,
and is cleared
at the end of the transaction (see <a
href="ThreadEventNotifier.html">ThreadEventNotifier</a>).
</p>
</section>
</body>
</document>
1.1
jakarta-commons-sandbox/hivemind/framework/xdocs/ClassFactory.xml
Index: ClassFactory.xml
===================================================================
<?xml version="1.0"?>
<!-- $Id: ClassFactory.xml,v 1.1 2003/09/26 18:19:35 hlship Exp $ -->
<!DOCTYPE document [
<!ENTITY projectroot '../'>
<!ENTITY % common-links SYSTEM "common/links.xml">
%common-links;
]>
<document>
<properties>
<title>hivemind.ClassFactory Service</title>
<author email="[EMAIL PROTECTED]">Howard M. Lewis Ship</author>
</properties>
<body>
<section name="hivemind.ClassFactory">
<p>
The <a href="&hivemind-registry;#service:hivemind.ClassFactory">ClassFactory</a>
service implements
the
<a href="&apiroot;/service/ClassFactory.html">ClassFactory</a> interface. This
service is a wrapper
around the Javassist framework, as it utilized by the HiveMind framework to
construct proxies and
interceptors.
</p>
</section>
</body>
</document>
1.1
jakarta-commons-sandbox/hivemind/framework/xdocs/SymbolSource.xml
Index: SymbolSource.xml
===================================================================
<?xml version="1.0"?>
<!-- $Id: SymbolSource.xml,v 1.1 2003/09/26 18:19:35 hlship Exp $ -->
<!DOCTYPE document [
<!ENTITY projectroot '../'>
<!ENTITY % common-links SYSTEM "common/links.xml">
%common-links;
]>
<document>
<properties>
<title>hivemind.SymbolSource Configuration</title>
<author email="[EMAIL PROTECTED]">Howard M. Lewis Ship</author>
</properties>
<body>
<section name="hivemind.SymbolSource">
<p>
The <a
href="&hivemind-registry;#configuration:hivemind.SymbolSource">SymbolSource</a>
configuration
is used to define new
<a href="&apiroot;/SymbolSource.html">SymbolSource</a>s (providers of values for
substitution symbols).
</p>
<p>
Contributions are of the form:
<source><![CDATA[
<source order=". . ." class=". . ." service-id=". . ."/>
]]>
</source>
</p>
<p>
The <b>order</b> attribute is used to sort the sources into a search order;
lower values for order
will be searched first. The <a
href="ApplicationDefaults.html">ApplicationDefaults</a> have
an order of 900000. The <a href="FactoryDefaults.html">FactoryDefaults</a> have an
order of 1000000. Generally,
your contributions should have an order value less than 90000.
</p>
<p>
Only one of <b>class</b> and <b>service-id</b> should be specified. The former
is the complete name of a class
(implementing the SymbolSource interface). The second is used to contribute a
service (which must also implement the
interface).
</p>
</section>
</body>
</document>
1.1
jakarta-commons-sandbox/hivemind/framework/xdocs/ApplicationDefaults.xml
Index: ApplicationDefaults.xml
===================================================================
<?xml version="1.0"?>
<!-- $Id: ApplicationDefaults.xml,v 1.1 2003/09/26 18:19:35 hlship Exp $ -->
<!DOCTYPE document [
<!ENTITY projectroot '../'>
<!ENTITY % common-links SYSTEM "common/links.xml">
%common-links;
]>
<document>
<properties>
<title>hivemind.ApplicationDefaults Configuration</title>
<author email="[EMAIL PROTECTED]">Howard M. Lewis Ship</author>
</properties>
<body>
<section name="hivemind.ApplicationDefaults">
<p>
The <a
href="&hivemind-registry;#configuration:hivemind.ApplicationDefaults">ApplicationDefaults</a>
configuration
is used to set default values for substitution symbols.
Application defaults override contributions to <a
href="FactoryDefaults.html">hivemind.FactoryDefaults</a>.
The contribution format is the same FactoryDefaults:
<source><![CDATA[
<default symbol=". . ." value=". . ."/>
]]>
</source>
</p>
</section>
</body>
</document>
1.4 +2 -2 jakarta-commons-sandbox/hivemind/framework/src/xsl/hivemind.xsl
Index: hivemind.xsl
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/hivemind/framework/src/xsl/hivemind.xsl,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- hivemind.xsl 23 Sep 2003 22:23:52 -0000 1.3
+++ hivemind.xsl 26 Sep 2003 18:19:35 -0000 1.4
@@ -144,7 +144,7 @@
</xsl:template>
<xsl:template match="configuration-point">
- <a name="[EMAIL PROTECTED]"/>
+ <a name="configuration:[EMAIL PROTECTED]"/>
<h2 id="[EMAIL PROTECTED]">
Configuration Point <xsl:value-of select="@id"/> </h2>
<table class="summary">
1.9 +18 -5 jakarta-commons-sandbox/hivemind/maven.xml
Index: maven.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/hivemind/maven.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- maven.xml 16 Sep 2003 18:51:28 -0000 1.8
+++ maven.xml 26 Sep 2003 18:19:35 -0000 1.9
@@ -2,13 +2,20 @@
<!-- $Id$ -->
<project xmlns:j="jelly:core" xmlns:u="jelly:util" xmlns:ant="jelly:ant">
+ <goal name="build-fresh">
+ <attainGoal name="multiproject:clean"/>
+ <attainGoal name="multiproject:install"/>
+ </goal>
+
<goal name="install-latest" description="Build and install latest src and bin
distributions to temporary site.">
- <attainGoal name="clean"/>
- <attainGoal name="jar"/>
- <attainGoal name="xdoc"/>
+ <attainGoal name="multiproject:clean"/>
+ <attainGoal name="multiproject:install"/>
+ <attainGoal name="multiproject:site"/>
<attainGoal name="dist:build"/>
- <j:set var="copier" value='${context.getVariable("maven.scp.executable")}'/>
+ <!-- Rest probably broken since switchover to multiproject ... -->
+
+ <j:set var="copier" value='${context.getVariable("maven.scp.executable")}'/>
<echo>Copying from ${maven.dist.dir} to home page ...</echo>
@@ -22,4 +29,10 @@
<ant:arg value="[EMAIL PROTECTED]:~/public_html/hivemind"/>
</ant:exec>
</goal>
+
+
+ <goal name="multiproject:xdoc">
+ <j:set var="goal" value="xdoc"/>
+ <attainGoal name="multiproject:goal"/>
+ </goal>
</project>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
