perfsonar development work

Author: michael.bischoff
Date: 2008-12-02 12:47:22 -0500 (Tue, 02 Dec 2008)
New Revision: 4730

Modified:
   
trunk/perfsonar_java-lsclient-api/src/main/java/org/perfsonar/lsclient/Level0LsClientInterface.java
   
trunk/perfsonar_java-lsclient-api/src/main/java/org/perfsonar/lsclient/Level1LsClientInterface.java
Log:
Updated comments with 

Modified: 
trunk/perfsonar_java-lsclient-api/src/main/java/org/perfsonar/lsclient/Level0LsClientInterface.java
===================================================================
--- 
trunk/perfsonar_java-lsclient-api/src/main/java/org/perfsonar/lsclient/Level0LsClientInterface.java
 2008-12-02 13:22:46 UTC (rev 4729)
+++ 
trunk/perfsonar_java-lsclient-api/src/main/java/org/perfsonar/lsclient/Level0LsClientInterface.java
 2008-12-02 17:47:22 UTC (rev 4730)
@@ -1,6 +1,7 @@
 package org.perfsonar.lsclient;
 
 import java.io.InputStream;
+import java.io.Reader;
 
 import org.perfsonar.lsclient.data.LookupService;
 
@@ -23,6 +24,9 @@
  */
 public interface Level0LsClientInterface {
        /**
+        * Takes an xquery to be send to the LS and returns a 
{@link
 InputStream} containing the message
+        * > NOTE: Perhaps in the future this method should be depreciated 
for a version with 
{@link
 Reader}.
+        * > but currently it is retained for max compatibility with old 
libraries.  
         * @param lookupService (should not be null.)
         * @param xquery A string that should contain a valid XQuery (should 
not be null.)
         * @return a InputStream of the XQuery result
@@ -33,12 +37,15 @@
        InputStream getRawQueryResult(LookupService lookupService, String 
xquery) throws LsQueryException;
        
        /**
-        * @param lookupService (should not be null.)
-        * @param summaryDescription (should not be null.)
-        * @return a InputStream of the response
+        * Takes an summary description(see the LS documentation)
+        * > NOTE: Perhaps in the future this method should be depreciated 
for a version with 
{@link
 Reader}.
+        * > but currently it is retained for max compatibility with old 
libraries.  
+        * @param lookupService (can't be null.)
+        * @param summaryDescription (can't be null.)
+        * @return a InputStream of the response containing UTF-8 characters
         * @throws LsQueryException when there are problems with querying the 
LookupService
         * @throws IllegalArgumentException is thrown if one or arguments are 
null or 
-        *                 (this is Optional) the string doesn't contain a 
valid XQuery 
+        *                 (this is Optional) the string doesn't contain a 
valid summary 
         */
        InputStream getRawDiscoveryResponse(LookupService lookupService, 
String summaryDescription) throws LsQueryException;
 }

Modified: 
trunk/perfsonar_java-lsclient-api/src/main/java/org/perfsonar/lsclient/Level1LsClientInterface.java
===================================================================
--- 
trunk/perfsonar_java-lsclient-api/src/main/java/org/perfsonar/lsclient/Level1LsClientInterface.java
 2008-12-02 13:22:46 UTC (rev 4729)
+++ 
trunk/perfsonar_java-lsclient-api/src/main/java/org/perfsonar/lsclient/Level1LsClientInterface.java
 2008-12-02 17:47:22 UTC (rev 4730)
@@ -5,8 +5,8 @@
 import org.perfsonar.lsclient.data.AuthorativeLookupservice;
 import org.perfsonar.lsclient.data.EventType;
 import org.perfsonar.lsclient.data.LookupService;
+import org.perfsonar.lsclient.data.Service;
 import org.perfsonar.lsclient.data.ServiceMeasurementMetadata;
-import org.perfsonar.lsclient.data.Service;
 import org.perfsonar.lsclient.data.ServiceType;
 import org.perfsonar.lsclient.data.TopologyElement;
 
@@ -43,7 +43,7 @@
         * @param elements a set of topologyElements of which one or more 
should match
         * @param eventTypes a set of eventTypes of which one or more should 
match
         * @param types a set of serviceTypes of which one or more should 
match
-        * @return a non-null Set of (home)LookupServices that know about any 
elements AND any eventTypes AND types
+        * @return a non-null Set of non-null (home)LookupServices that know 
about any elements AND any eventTypes AND types
         * 
         * @throw 
{@link
 UnsupportedOperationException} if a 
{@link
 ServiceType} is non-null this is because 
         * currently there isn't a way to determine the serviceType in the LS 
at this point. Also it's use 
@@ -54,10 +54,10 @@
         * starts a 
{@link
 DiscoveryProcess} allowing one to take more
         * fine-grained control over the discovery process.
         *  
-        * @param elements
-        * @param eventTypes
-        * @param types
-        * @return DiscoveryProcess
+        * @param elements a set of topologyElements of which one or more 
should match
+        * @param eventTypes a set of eventTypes of which one or more should 
match
+        * @param types a set of serviceTypes of which one or more should 
match
+        * @return DiscoveryProcess Object representing the discovery process 
see 
{@link
 DiscoveryProcess}
         */
        DiscoveryProcess startDiscovery(Set<TopologyElement> elements, 
Set<EventType> eventTypes, Set<ServiceType> types);
        /**