ctubbsii commented on code in PR #68:
URL:
https://github.com/apache/accumulo-classloaders/pull/68#discussion_r2774936410
##########
modules/cargo-class-loader/README.md:
##########
@@ -18,43 +18,45 @@
under the License.
-->
-# Local Caching ClassLoader
+# Cargo ClassLoader Factory
-`LocalCachingContextClassLoaderFactory` implements Accumulo's
-`ContextClassLoaderFactory` SPI. Given a context parameter, supplied as a
-String containing a URL to a remote context definition file, it will produce
-and return `ClassLoader` instances to load classes and resources for a Java
-application, based on the list of resource URLs contained in the remote context
-definition. It will also monitor the URL to the context definition file for any
-changes, at the monitoring interval specified in the context definition file.
+`CargoClassLoaderFactory` implements Accumulo's `ContextClassLoaderFactory`
+SPI. For this implementation, "cargo" refers to a set of remote resources
+(typically, `.jar` files) listed in a JSON-formatted cargo manifest file.
+
+The URL to the cargo manifest file, as a String, is used for the context
+parameter. In return, this factory transports the cargo from the remote
+locations specified in the manifest to a local storage cache, where they will
+be used to produce a corresponding `ClassLoader` instance. The specified URL
+will then be monitored for any changes to the cargo manifest at that location,
+at the monitoring interval specified in the manifest.
## Introduction
This factory creates `ClassLoader` instances that point to locally cached
copies of remote resource files. In this way, this factory allows placing
common resources in a remote location for use across many hosts, but without
-many of the problems that can occur when loading resources from a remote
-location.
+many of the problems that can occur in alternate solutions.
Review Comment:
I think you're right that omission is best. I was trying to avoid the
open-ended "like what?" question that naturally followed from the previous
wording. I think it comes with the changed wording, too, though, so it's not
really any better. It's better to leave it unsaid, and people can ask more
specific questions if they want to.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
