hlship 2004/08/08 06:16:26
Modified: library/src/documentation/content/xdocs/hivemind-lib
EJBProxyFactory.xml BeanFactoryBuilder.xml
PipelineFactory.xml SpringLookupFactory.xml
framework/src/documentation/content/xdocs/hivemind
BuilderFactory.xml
library/src/test/hivemind/test/lib EJBProxy.xml
src/documentation/content/xdocs services.xml descriptor.xml
library/src/descriptor/META-INF hivemodule.xml
Log:
More documentation updates re: removal of SDL.
Revision Changes Path
1.3 +2 -5
jakarta-hivemind/library/src/documentation/content/xdocs/hivemind-lib/EJBProxyFactory.xml
Index: EJBProxyFactory.xml
===================================================================
RCS file:
/home/cvs/jakarta-hivemind/library/src/documentation/content/xdocs/hivemind-lib/EJBProxyFactory.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- EJBProxyFactory.xml 17 Jun 2004 15:16:15 -0000 1.2
+++ EJBProxyFactory.xml 8 Aug 2004 13:16:26 -0000 1.3
@@ -33,12 +33,9 @@
href="site:hivemind.lib.NameLookup">NameLookup</link>
service), and
invokes <code>create()</code> on the returned home
interface.</p>
<p>The single service instance will be shared by all
threads.</p>
- <p>The general usage is as follows:</p>
+ <p>The service expects a single parameter element:</p>
<source><![CDATA[
- invoke-factory (service-id=hivemind.lib.EJBProxy)
- {
- parameters (home-interface=... jndi-name=... name-lookup-service=...)
- }]]> </source>
+<construct home-interface="..." jndi-name="..."
name-lookup-service="..."/>]]> </source>
<p>The <code>home-interface</code> attribute is the complete
class name for
the home interface, and is required.</p>
<p>The <code>jndi-name</code> attribute is the name of the
EJB's home
1.3 +4 -8
jakarta-hivemind/library/src/documentation/content/xdocs/hivemind-lib/BeanFactoryBuilder.xml
Index: BeanFactoryBuilder.xml
===================================================================
RCS file:
/home/cvs/jakarta-hivemind/library/src/documentation/content/xdocs/hivemind-lib/BeanFactoryBuilder.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- BeanFactoryBuilder.xml 15 Jun 2004 13:42:33 -0000 1.2
+++ BeanFactoryBuilder.xml 8 Aug 2004 13:16:26 -0000 1.3
@@ -39,12 +39,9 @@
bean class. </p>
<section>
<title>Usage</title>
- <p> The general usage is as follows: </p>
+ <p> The service takes a single parameter element:</p>
<source><![CDATA[
-invoke-factory (service-id=hivemind.lib.BeanFactoryBuilder)
-{
- factory (vend-class=... configuration-id=... default-cacheable=...)
-}
+<factory vend-class="..." configuration-id="..." default-cacheable="..."/>
]]></source>
<p> The <code>vend-class</code> attribute is the name of a class all
vended objects must be assignable to (as a class or interface). This
is
@@ -62,13 +59,12 @@
<p>Each BeanFactory service must have a configuration, into which
beans
are contributed:</p>
<source><![CDATA[
-configuration-point (id=...
schema-id=hivemind.lib.BeanFactoryContribution)]]>
+<configuration-point id="..."
schema-id="hivemind.lib.BeanFactoryContribution"/>]]>
</source>
<p>Contributions into the configuration are used to specify the bean
classes to instantiate, as:</p>
<source><![CDATA[
-bean (name=... class=... cacheable=...)
-]]> </source>
+<bean name="..." class="..." cacheable="..."/> ]]> </source>
<p> <code>name</code> is a unique name used to reference an instance
of
the class. </p>
<p><code>class</code> is the Java class to instantiate.</p>
1.4 +7 -14
jakarta-hivemind/library/src/documentation/content/xdocs/hivemind-lib/PipelineFactory.xml
Index: PipelineFactory.xml
===================================================================
RCS file:
/home/cvs/jakarta-hivemind/library/src/documentation/content/xdocs/hivemind-lib/PipelineFactory.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- PipelineFactory.xml 16 Jul 2004 23:15:40 -0000 1.3
+++ PipelineFactory.xml 8 Aug 2004 13:16:26 -0000 1.4
@@ -71,13 +71,9 @@
contribute filters into the service's pipeline. </p>
<section>
<title>Usage</title>
- <p> The general usage is as follows: </p>
+ <p> The factory expects a single parameter element: </p>
<source><![CDATA[
-invoke-factory (service-id=hivemind.lib.PipelineFactory)
-{
- create-pipeline (filter-interface=... configuration-id=...
terminator-service-id=...)
-}
-]]></source>
+<create-pipeline filter-interface="..." configuration-id="..."
terminator-service-id="..."/>]]></source>
<p> The <code>filter-interface</code> attribute is the complete class
name of the filter interface. </p>
<p>The <code>configuration-id</code> is the id of the companion
@@ -91,8 +87,7 @@
<p>Each pipeline service must have a configuration, into which filters
are contributed:</p>
<source><![CDATA[
-configuration-point (id=... schema-id=hivemind.lib.Pipeline)
- ]]></source>
+<configuration-point id="..." schema-id="hivemind.lib.Pipeline"/>]]></source>
</section>
<section>
<title>Contributions</title>
@@ -102,8 +97,7 @@
<section>
<title>filter</title>
<source><![CDATA[
-filter (service-id=... before=... after=...)
-]]> </source>
+<filter service-id="..." before="..." after="..."/>]]> </source>
<p>Contributes a filter as a service. The optional
<code>before</code>
and <code>after</code> attributes are lists of the ids of other
filters in the pipeline, used to set the ordering of the filters.
@@ -114,8 +108,7 @@
<section>
<title>filter-object</title>
<source><![CDATA[
-filter-object (name=... object=... before=... after=...)
-]]></source>
+<filter-object name="..." object="..." before="..." after="..."/>]]></source>
<p>Contributes a filter as an instance of the provided class. The
<code>name</code> attribute is required and will be qualified with
the contributing module id. The <code>object</code> attribute
@@ -125,7 +118,7 @@
</section>
<section>
<title>terminator</title>
- <source><![CDATA[terminator (service-id=...)]]></source>
+ <source><![CDATA[<terminator service-id="..."/>]]></source>
<p> Specifies the terminator service for the pipeline. Only a single
terminator may be specified, and the terminator service provided
in
the factory parameters takes precendence over a terminator in the
@@ -134,7 +127,7 @@
<section>
<title>terminator-object</title>
- <source><![CDATA[terminator-object (class=...)]]></source>
+ <source><![CDATA[<terminator-object class="..."/>]]></source>
<p> Specifies the termnator for the pipeline as an object (intead of
as
a service). </p>
</section>
1.4 +2 -3
jakarta-hivemind/library/src/documentation/content/xdocs/hivemind-lib/SpringLookupFactory.xml
Index: SpringLookupFactory.xml
===================================================================
RCS file:
/home/cvs/jakarta-hivemind/library/src/documentation/content/xdocs/hivemind-lib/SpringLookupFactory.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SpringLookupFactory.xml 25 Jun 2004 20:20:05 -0000 1.3
+++ SpringLookupFactory.xml 8 Aug 2004 13:16:26 -0000 1.4
@@ -39,12 +39,11 @@
>DefaultSpringBeanFactoryHolder</link> about it.</p>
<p>The SpringLookupFactory expects exactly <em>one</em>
parameter element:</p>
<source><![CDATA[
- lookup-bean (name=... source-service-id=...)
-]]> </source>
+<lookup-bean name="..." source-service-id="..."/>]]> </source>
<p>The <code>name</code> attribute is the name of the bean to
look for
inside the Spring BeanFactory.</p>
<p>The optional <code>source-service-id</code> attribute allows
an alternate
- service to be used to obtain the BeanFactory. The
identified service must
+ service to be used to obtain the Spring BeanFactory.
The identified service must
implement the <link
href="&apiroot-lib;/SpringBeanFactorySource.html">
SpringBeanFactorySource</link> interface.</p>
</body>
1.8 +3 -3
jakarta-hivemind/framework/src/documentation/content/xdocs/hivemind/BuilderFactory.xml
Index: BuilderFactory.xml
===================================================================
RCS file:
/home/cvs/jakarta-hivemind/framework/src/documentation/content/xdocs/hivemind/BuilderFactory.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- BuilderFactory.xml 3 Aug 2004 14:02:10 -0000 1.7
+++ BuilderFactory.xml 8 Aug 2004 13:16:26 -0000 1.8
@@ -28,9 +28,9 @@
<p>The <link
href="&hivedoc;/service/hivemind.BuilderFactory.html">
BuilderFactory</link> service is a service
implementation factory ... a
service that is used to construct other services.</p>
- <p>The general usage of the BuilderFactory is:</p>
+ <p>The builder factory takes a single parameter element
(usually with nested elements):</p>
<source><![CDATA[
-<invoke-factory service-id="hivemind.BuilderFactory"
+<construct
class="..." autowire-services="..." log-property="..."
messages-property="..."
service-id-property="..." initialize-method="..."
error-handler-property="..." class-resolver-property="...">
@@ -55,7 +55,7 @@
<set-resource property="..." path="..."/>
<set-service property="..." service-id="..."/>
<set-object property="..." value="..."/>
-</invoke-factory>]]> </source>
+</construct>]]> </source>
<p>The attributes of the <code>construct</code> element are
used to specify
the implementation class and set common service
properties. Nested
elements supply the constructor parameters and
configure other specific
1.5 +1 -1
jakarta-hivemind/library/src/test/hivemind/test/lib/EJBProxy.xml
Index: EJBProxy.xml
===================================================================
RCS file:
/home/cvs/jakarta-hivemind/library/src/test/hivemind/test/lib/EJBProxy.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- EJBProxy.xml 17 Jun 2004 15:16:14 -0000 1.4
+++ EJBProxy.xml 8 Aug 2004 13:16:26 -0000 1.5
@@ -22,7 +22,7 @@
interface="hivemind.test.lib.SimpleRemote">
<invoke-factory service-id="hivemind.lib.EJBProxyFactory">
- <parameters jndi-name="hivemind.test.lib.Simple"
+ <construct jndi-name="hivemind.test.lib.Simple"
home-interface="hivemind.test.lib.SimpleHome"
name-lookup-service-id="NameLookup"
/>
1.7 +12 -9
jakarta-hivemind/src/documentation/content/xdocs/services.xml
Index: services.xml
===================================================================
RCS file:
/home/cvs/jakarta-hivemind/src/documentation/content/xdocs/services.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- services.xml 3 Aug 2004 14:02:13 -0000 1.6
+++ services.xml 8 Aug 2004 13:16:26 -0000 1.7
@@ -167,16 +167,19 @@
arraingment of interceptors is possible
... even when different
modules contribute the interceptors.</p>
<p>Interceptors implement the
<code>toString()</code> method to provide
- a useful identification for the
interceptor, for example: <br/> <code><
- Interceptor:
hivemind.LoggingInterceptor for
-
com.myco.MyService(com.myco.MyServiceInterface)> </code> </p>
+ a useful identification for the
interceptor, for example: <br/>
+ <code><Iterceptor: hivemind.LoggingInterceptor for
+
com.myco.MyService(com.myco.MyServiceInterface)></code> </p>
<p>This string identifies the interceptor
service factory
(hivemind.LoggingInterceptor), the
service extension point
(com.myco.MyService) and the service
interface
(com.myco.MyServiceInterface).</p>
- <p>If <code>toString()</code> is part of the
service interface (really,
+
+ <warning>
+ If <code>toString()</code> is part of the service interface
(really,
a very rare case), then the interceptor
<em>does not</em> override the
- service implementation's method.</p>
+ service implementation's method.
However, this is not a recommended practice.
+ </warning>
</section>
</section>
<section>
@@ -198,10 +201,10 @@
hivemodule.xml, that must be included in the
module's META-INF
directory.</p>
<source><![CDATA[
-module (id=com.myco.mypackage version="1.0.0")
-{
- service-point (id=Adder interface=com.myco.mypackage.Adder)
-}]]></source>
+<?xml version="1.0"?>
+<module id="com.myco.mypackage" version="1.0.0">
+ <service-point id="Adder" interface="com.myco.mypackage.Adder"/>
+</module>]]></source>
<p>The complete id for this service is
<code>com.myco.mypackage.Adder</code>
, formed from the module id and the service id.
Commonly, the service id
will exactly match the complete name of the
service interface, but this
1.6 +1 -1
jakarta-hivemind/src/documentation/content/xdocs/descriptor.xml
Index: descriptor.xml
===================================================================
RCS file:
/home/cvs/jakarta-hivemind/src/documentation/content/xdocs/descriptor.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- descriptor.xml 3 Aug 2004 14:02:13 -0000 1.5
+++ descriptor.xml 8 Aug 2004 13:16:26 -0000 1.6
@@ -54,7 +54,7 @@
<tr>
<td>required</td>
<td>boolean</td>
- <td>boolean</td>
+ <td>no</td>
<td>If true, the attribute must be
provided in the contributed
configuration element. The
default is false.</td>
</tr>
1.9 +26 -13
jakarta-hivemind/library/src/descriptor/META-INF/hivemodule.xml
Index: hivemodule.xml
===================================================================
RCS file:
/home/cvs/jakarta-hivemind/library/src/descriptor/META-INF/hivemodule.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- hivemodule.xml 6 Aug 2004 17:03:31 -0000 1.8
+++ hivemodule.xml 8 Aug 2004 13:16:26 -0000 1.9
@@ -37,22 +37,35 @@
<default symbol="java.naming.factory.url.pkgs" value=""/>
<default symbol="java.naming.provider.url" value=""/>
</contribution>
- <service-point id="EJBProxyFactory"
interface="org.apache.hivemind.ServiceImplementationFactory">Core service
implementation factory that constructs dynamic proxies to EJB stateless session
beans. Factory parameters are used to specify the JNDI name of the EJB and the
name of its home interface.<parameters-schema>
- <element
- name="parameters">Specifies parameters needed to
construct the EJB Proxy.<attribute
- name="jndi-name" required="true">The JNDI Name of the
EJB's home interface.</attribute>
- <attribute name="home-interface" required="true">Complete
name of the EJB's home interface. The service interface must be the remote
interface.</attribute>
- <attribute name="name-lookup-service-id"
translator="service">Defines an alternate name lookup service to use when
resolving JNDI names to EJB home interfaces. If not specified, the default
service hivemind.NameLookup is used.</attribute>
- <conversion
class="org.apache.hivemind.lib.impl.EJBProxyParameters">
- <map attribute="jndi-name" property="jndiName"/>
- <map attribute="home-interface"
property="homeInterfaceClassName"/>
- <map attribute="name-lookup-service-id"
property="nameLookup"/>
- </conversion>
+ <service-point id="EJBProxyFactory"
interface="org.apache.hivemind.ServiceImplementationFactory">
+
+ Core service implementation factory that constructs dynamic proxies to
EJB stateless session beans. Factory parameters are used to specify the JNDI
name of the EJB and the name of its home interface.
+
+ <parameters-schema>
+ <element name="construct">
+
+ Specifies parameters needed to construct the EJB Proxy.
+
+ <attribute name="jndi-name" required="true">
+ The JNDI Name of the EJB's home interface.
+ </attribute>
+ <attribute name="home-interface" required="true">
+ Complete name of the EJB's home interface. The service
interface must be the remote interface.
+ </attribute>
+ <attribute name="name-lookup-service-id" translator="service">
+ Defines an alternate name lookup service to use when
resolving JNDI names to EJB home interfaces.
+ If not specified, the default service hivemind.NameLookup is
used.
+ </attribute>
+ <conversion
class="org.apache.hivemind.lib.impl.EJBProxyParameters">
+ <map attribute="jndi-name" property="jndiName"/>
+ <map attribute="home-interface"
property="homeInterfaceClassName"/>
+ <map attribute="name-lookup-service-id"
property="nameLookup"/>
+ </conversion>
</element>
</parameters-schema>
+
<invoke-factory service-id="hivemind.BuilderFactory">
- <construct
- class="org.apache.hivemind.lib.impl.EJBProxyFactory"
service-id-property="pointId">
+ <construct class="org.apache.hivemind.lib.impl.EJBProxyFactory"
service-id-property="pointId">
<set-service property="nameLookup" service-id="NameLookup"/>
<set-service property="classFactory"
service-id="hivemind.ClassFactory"/>
<set-service property="coordinator"
service-id="RemoteExceptionCoordinator"/>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
