hlship 2003/10/14 12:14:43
Modified: hivemind/library/xdocs navigation.xml
Added: hivemind/library/xdocs RemoteExceptionCoordinator.xml
EJBProxyFactory.xml NameLookup.xml
Log:
Document the services provided in the HiveMind library.
Revision Changes Path
1.4 +7 -1 jakarta-commons-sandbox/hivemind/library/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/hivemind/library/xdocs/navigation.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- navigation.xml 9 Oct 2003 22:58:16 -0000 1.3
+++ navigation.xml 14 Oct 2003 19:14:43 -0000 1.4
@@ -14,6 +14,12 @@
<item name="HiveMind:Framework" href="../commons-hivemind/index.html"/>
</links>
+ <menu name="Services">
+ <item name="EJBProxyFactory" href="/EJBProxyFactory.html"/>
+ <item name="NameLookup" href="/NameLookup.html"/>
+ <item name="RemoteExceptionCoordinator"
href="/RemoteExceptionCoordinator.html"/>
+ </menu>
+
<menu name="Reference">
<item name="HiveDoc" href="/&hivemind-lib-hivedoc;"/>
</menu>
1.1
jakarta-commons-sandbox/hivemind/library/xdocs/RemoteExceptionCoordinator.xml
Index: RemoteExceptionCoordinator.xml
===================================================================
<?xml version="1.0"?>
<!-- $Id: RemoteExceptionCoordinator.xml,v 1.1 2003/10/14 19:14:43 hlship Exp $ -->
<!DOCTYPE document [
<!ENTITY projectroot '../'>
<!ENTITY apiroot 'apidocs/org/apache/commons/hivemind/lib'>
<!ENTITY % common-links SYSTEM "../../common/links.xml">
%common-links;
]>
<document>
<properties>
<title>hivemind.lib.RemoteExceptionCoordinator Service</title>
<author email="[EMAIL PROTECTED]">Howard M. Lewis Ship</author>
</properties>
<body>
<section name="hivemind.lib.RemoteExceptionCoordinator">
<p>
The <a
href="&hivemind-lib-hivedoc;#hivemind.lib.RemoteExceptionCoordinator">RemoteExceptionCoordinator</a>
is used to propogate notifications of remote exceptions throughout the HiveMind
repository. When any individual
service encounters a remote exception, it notifies all listeners, who release all
remote object proxies.
</p>
<p>
The service interface,
<a href="&apiroot;/RemoteExceptionCoordinator.html">RemoteExceptionCoordinator</a>,
allows objects
that implement the <a
href="&apiroot;/RemoteExceptionListener.html">RemoteExceptionListener</a>
interface to be registered for notification, and includes a method for firing
notifications.
</p>
</section>
</body>
</document>
1.1
jakarta-commons-sandbox/hivemind/library/xdocs/EJBProxyFactory.xml
Index: EJBProxyFactory.xml
===================================================================
<?xml version="1.0"?>
<!-- $Id: EJBProxyFactory.xml,v 1.1 2003/10/14 19:14:43 hlship Exp $ -->
<!DOCTYPE document [
<!ENTITY projectroot '../'>
<!ENTITY apiroot 'apidocs/org/apache/commons/hivemind/lib'>
<!ENTITY % common-links SYSTEM "../../common/links.xml">
%common-links;
]>
<document>
<properties>
<title>hivemind.lib.EJBProxyFactory Service</title>
<author email="[EMAIL PROTECTED]">Howard M. Lewis Ship</author>
</properties>
<body>
<section name="hivemind.lib.EJBProxyFactory">
<p>
The <a
href="&hivemind-lib-hivedoc;#hivemind.lib.EJBProxyFactory">EJBProxyFactory</a> service
is
used to construct a HiveMind service that delegates to an EJB stateless session
bean. The
EJB's remote interface is the service interface. When the first service method is
invoked, the fabricated proxy
will perform a JNDI lookup (using the <a href="NameLookup.html">NameLookup</a>
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:
<source><![CDATA[
<invoke-factory service-id="hivemind.lib.EJBProxyFactory">
<parameters
home-interface=". . ."
jndi-name=". . ."
name-lookup-service-id=". . ." />
</invoke-factory> ]]></source>
</p>
<p>
The <b>home-interface</b> attribute is the complete class name for the home
interface, and
is required.
</p>
<p> The <b>jndi-name</b> attribute is the name of the EJB's home interface, also
required.
</p>
<p>
The <b>name-lookup-service-id</b> attribute is optional and rarely used; it is an
alternate service
implementing the <a href="&apiroot;/NameLookup.html">NameLookup</a> interface to be
used for JNDI lookups.
</p>
</section>
</body>
</document>
1.1 jakarta-commons-sandbox/hivemind/library/xdocs/NameLookup.xml
Index: NameLookup.xml
===================================================================
<?xml version="1.0"?>
<!-- $Id: NameLookup.xml,v 1.1 2003/10/14 19:14:43 hlship Exp $ -->
<!DOCTYPE document [
<!ENTITY projectroot '../'>
<!ENTITY apiroot 'apidocs/org/apache/commons/hivemind/lib'>
<!ENTITY % common-links SYSTEM "../../common/links.xml">
%common-links;
]>
<document>
<properties>
<title>hivemind.lib.NameLookup Service</title>
<author email="[EMAIL PROTECTED]">Howard M. Lewis Ship</author>
</properties>
<body>
<section name="hivemind.lib.NameLookup">
<p>
The <a href="&hivemind-lib-hivedoc;#hivemind.lib.NameLookup">NameLookup</a>
service is a thin wrapper around JNDI lookup. It is used by
the <a href="EJBProxyFactory.html">EJBProxyFactory</a> service to locate
EJBs.
</p>
<p>
The implementation makes use of three symbols (all of whose values default to null):
<ul>
<li>java.naming.factory.initial</li>
<li>java.naming.factory.url</li>
<li>java.naming.provider.url</li>
</ul>
</p>
<p>
By supplying overrides of these values, it is possible to configure how the
NameLookup service
generated the InitialContext used for performing the JNDI lookup.
</p>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
