Changes between Version 2 and Version 3 of RemoteOutputFiles

Timestamp:

Feb 1, 2013, 10:58:24 PM (12 years ago)

Author:

davea

Comment:

--

RemoteOutputFiles

@@ -3 +3 @@
 == Web service interface ==
 
-Output files can be downloaded using web services of several forms:
+Output files of completed jobs can be downloaded using web services of several forms:
 {{{
 PROJECT_URL/get_output.php?cmd=result_file&auth_str=AUTH&result_name=NAME&file_num=N
@@ -19 +19 @@
   as a zip archive.
 
-In each case, '''auth_str''' is the authenticator of the requesting user,
-who must be the creator of the jobs involved.
+In each case, '''auth_str''' is the authenticator of the creator of the jobs involved.
 
 Notes:
 
  * These operations work only for jobs that are part of a batch.
+ * This interface is secure in sense that only the creator of a job can download its output files.
  * In case of error, the resulting file will have the work "error" in the first line.
 
 == C++ interface ==
+
+A C++ interface to the workunit_file variant is available in
+samples/condor/job_rpc.cpp:
 
 {{{
@@ -40 +43 @@
 
 == PHP interface ==
-=== boinc_get_output_file() ===
 
-Get a URL for a particular output file.
+The following PHP interfaces are available:
 
-Argument: a request object with elements
- * '''project''' and '''authenticator''': as above,
- * '''instance_name''': specifies a job instance,
- * '''file_num''': the ordinal number of one of the output files.
+{{{
+$req->project = "http://project.url";
+$req->authenticator = "...";
+$req->instance_name = "result name";
+$req->file_num = 0;
+$url = boinc_get_output_file($req);
 
-Result: a URL from which the output file can be downloaded.
+$x = file_get_contents($url);   // read output file into memory
+}}}
 
-=== boinc_get_output_files() ===
+'''boinc_get_output_file()''' returns the URL from which the output file can be downloaded.
 
-Argument: a request object with elements
- * '''project''' and '''authenticator''': as above,
- * '''batch_id''': specifies a batch.
+{{{
+$req->project = "http://project.url";
+$req->authenticator = "...";
+$req->batch_id = 55;
+$url = boinc_get_output_file($req);
+}}}
 
-Result: a URL from which a zipped archive of all
+'''boinc_get_output_files()''' returns a URL from which a zipped archive of all
 output files from the batch can be downloaded
 (only the outputs of "canonical" instances are included).