Documented the virtual webapp loader

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@568290 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/webapps/docs/config/loader.xml b/webapps/docs/config/loader.xml
index 1722b2f..981432b 100644 (file)
--- a/webapps/docs/config/loader.xml
+++ b/webapps/docs/config/loader.xml
@@ -116,6 +116,48 @@
   </subsection>
 
 
+  <subsection name="Virtual Webapp Loader">
+
+    <p>An extension of the standard webapp loader.
+    This extension, allows you to specify a classpath inside of your &lt;Loader&gt; element,
+    or even read it from the webapps MANIFEST.MF file.</p>
+    <p>The virtual webapp loader extends the <code>org.apache.catalina.loader.WebappLoader</code>
+    so all attributes are supported from the inherited implementation.</p>
+    <attributes>
+
+      <attribute name="className" required="true">
+        <p>Java class name of the <code>VirtualWebappLoader</code>
+        The value that must be specified is
+        <code>org.apache.catalina.loader.VirtualWebappLoader</code>.</p>
+      </attribute>
+      <attribute name="virtualClasspath" required="false">
+        <p>Class-Path string, separated by semi colon by default.
+        Format is the same as a classpath for the JVM.<br/>
+        Example: /dir/classes:/somedir/somejar.jar<br/>
+        You can chose what separator should be used by using the <code>separator</code> attribute.</p>
+      </attribute>
+      <attribute name="separator" required="false">
+        <p>The separator of class path elements in the <code>virtualClasspath</code> element.
+        Default value is semi colon <code>;</code>.</p>
+      </attribute>
+      <attribute name="makeLocalCopy" required="false">
+        <p>If set to true, all repositories will be copied over to the java.io.tmpdir directory
+        and used only by this webapp during runtime. During shutdown, the local copy will be removed.
+        The default value is <code>true</code> and Tomcat will copy the libraries to the temp directory.</p>
+      </attribute>
+      <attribute name="separateJars" required="false">
+        <p>If set to true, the JAR files will be added as WebappClassLoader.addJar to prevent them from being locked 
+        during runtime. The default value is set to 
+        <code>true</code>.</p>
+      </attribute>
+      <attribute name="readManifestCP" required="false">
+        <p>If set to true, Tomcat will extract the Class-Path variable from the webapp's META-INF/MANIFEST.MF
+        file and use that in addition to the virtualClasspath. The separator here is hardcoded to a space.
+        Default value is <code>true</code>.</p>
+      </attribute>
+    </attributes>
+  </subsection>  
+
 </section>