You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by vi...@apache.org on 2002/09/05 05:45:23 UTC
cvs commit: jakarta-avalon-excalibur/altrmi/src/java/org/apache/excalibur/altrmi/client AltrmiInterfaceLookup.java AltrmiHostContext.java
vinayc 2002/09/04 20:45:23
Modified: altrmi/src/java/org/apache/excalibur/altrmi/client
AltrmiInterfaceLookup.java AltrmiHostContext.java
Log:
Living with a fatter javadoc-ed codebase
Revision Changes Path
1.3 +22 -21 jakarta-avalon-excalibur/altrmi/src/java/org/apache/excalibur/altrmi/client/AltrmiInterfaceLookup.java
Index: AltrmiInterfaceLookup.java
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/altrmi/src/java/org/apache/excalibur/altrmi/client/AltrmiInterfaceLookup.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AltrmiInterfaceLookup.java 24 Apr 2002 12:42:56 -0000 1.2
+++ AltrmiInterfaceLookup.java 5 Sep 2002 03:45:23 -0000 1.3
@@ -11,9 +11,9 @@
import org.apache.excalibur.altrmi.common.AltrmiConnectionException;
/**
- * Interface AltrmiFactory
- *
- *
+ * AltrmiInterfaceLookup describes the initial client's interaction with
+ * with the server (lookup/listing of remote services.)
+ *
* @author Paul Hammant <a href="mailto:Paul_Hammant@yahoo.com">Paul_Hammant@yahoo.com</a>
* @version $Revision$
*/
@@ -21,39 +21,40 @@
{
/**
- * Method lookup
- *
- *
+ * Lookup a name by which the remote service is
+ * published by the server.
+ * Usage:
+ * <code>
+ * AltrmiInterfaceLookup lookupService= . . . . ;
+ * RemoteInterface remoteInterface = lookupService.lookup("Published-Name-Of-The-Remote-Server");
+ * </code>
* @param publishedServiceName
- *
- * @return
- *
+ * @return proxy to the Remote service.
* @throws AltrmiConnectionException
- *
*/
- Object lookup( String publishedServiceName ) throws AltrmiConnectionException;
+ Object lookup(String publishedServiceName)
+ throws AltrmiConnectionException;
/**
- * Method lookup
- *
+ * Lookup a name by which the remote service is
+ * published by the server within the context of
+ * the Authentication credentials supplied.
*
* @param publishedServiceName
* @param altrmiAuthentication
- *
* @return
- *
* @throws AltrmiConnectionException
*
*/
- Object lookup( String publishedServiceName, AltrmiAuthentication altrmiAuthentication )
+ Object lookup(
+ String publishedServiceName,
+ AltrmiAuthentication altrmiAuthentication)
throws AltrmiConnectionException;
/**
- * Method list
- *
- *
+ * This method returns the list of names of the
+ * remote services.
* @return
- *
*/
String[] list();
1.4 +8 -8 jakarta-avalon-excalibur/altrmi/src/java/org/apache/excalibur/altrmi/client/AltrmiHostContext.java
Index: AltrmiHostContext.java
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/altrmi/src/java/org/apache/excalibur/altrmi/client/AltrmiHostContext.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AltrmiHostContext.java 6 May 2002 18:14:36 -0000 1.3
+++ AltrmiHostContext.java 5 Sep 2002 03:45:23 -0000 1.4
@@ -8,9 +8,10 @@
package org.apache.excalibur.altrmi.client;
/**
- * Interface AltrmiHostContext
- *
- *
+ * AltrmiHostContext, as the name suggests,describes the
+ * context of the calls made to the server which could be
+ * Over Piped Streams or Over Custom Transport or Direct calls etc ..
+ *
* @author Paul Hammant <a href="mailto:Paul_Hammant@yahoo.com">Paul_Hammant@yahoo.com</a>
* @version * $Revision$
*/
@@ -18,10 +19,9 @@
{
/**
- * Method getInvocationHandler
- *
- *
- * @return
+ * Return the Invocation Handler that can talk over
+ * the transport this particular context address.
+ * @return InvocationHandler
*
*/
AltrmiClientInvocationHandler getClientInvocationHandler();
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>