Author: markt
Date: Tue Oct 23 12:06:55 2012
New Revision: 1401258
URL: http://svn.apache.org/viewvc?rev=1401258&view=rev
Log:
Javadoc cleanup
Modified:
tomcat/sandbox/trunk-resources/java/org/apache/catalina/WebResource.java
tomcat/sandbox/trunk-resources/java/org/apache/catalina/WebResourceRoot.java
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/Cache.java
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/DirResourceSet.java
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/JarResourceSet.java
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/StandardRoot.java
Modified:
tomcat/sandbox/trunk-resources/java/org/apache/catalina/WebResource.java
URL:
http://svn.apache.org/viewvc/tomcat/sandbox/trunk-resources/java/org/apache/catalina/WebResource.java?rev=1401258&r1=1401257&r2=1401258&view=diff
==============================================================================
--- tomcat/sandbox/trunk-resources/java/org/apache/catalina/WebResource.java
(original)
+++ tomcat/sandbox/trunk-resources/java/org/apache/catalina/WebResource.java
Tue Oct 23 12:06:55 2012
@@ -91,13 +91,11 @@ public interface WebResource {
/**
* Set the MIME type for this Resource.
- * TODO: Previous implementation cached this
*/
void setMimeType(String mimeType);
/**
* Get the MIME type for this Resource.
- * TODO: Previous implementation cached this
*/
String getMimeType();
Modified:
tomcat/sandbox/trunk-resources/java/org/apache/catalina/WebResourceRoot.java
URL:
http://svn.apache.org/viewvc/tomcat/sandbox/trunk-resources/java/org/apache/catalina/WebResourceRoot.java?rev=1401258&r1=1401257&r2=1401258&view=diff
==============================================================================
---
tomcat/sandbox/trunk-resources/java/org/apache/catalina/WebResourceRoot.java
(original)
+++
tomcat/sandbox/trunk-resources/java/org/apache/catalina/WebResourceRoot.java
Tue Oct 23 12:06:55 2012
@@ -67,7 +67,7 @@ import java.util.Set;
* <li>Resource JARs - Same feature but implemented using the same
* mechanism as all the other additional
* resources.</li>
- * <li>TBD - More to list here</li>
+ * <li>TODO - More to list here</li>
* </ul>
*/
/*
@@ -126,7 +126,7 @@ public interface WebResourceRoot extends
/**
* Obtain the Set of the web applications pathnames of all of the files and
* directories located in the specified directory. Paths representing
- * directories will end with a "/" character.
+ * directories will end with a '/' character.
*
* @param path The path for the resource of interest relative to the root
* of the web application. It must start with '/'.
@@ -172,15 +172,6 @@ public interface WebResourceRoot extends
boolean write(String path, InputStream is);
/**
- *
- * @param url Identifies the root of the new {@link WebResourceSet}. It
- * must point to a JAR, directory or file.
- * @param initialPath Identifies any initial path (only in a JAR) that
- * must be skipped when matching web application paths
- * to paths in the new {@link WebResourceSet}
- */
-
- /**
* Creates a new {@link WebResourceSet} for this {@link WebResourceRoot}
* based on the provided parameters.
*
@@ -210,8 +201,22 @@ public interface WebResourceRoot extends
String webAppMount, String internalPath);
+ /**
+ * Adds the provided WebResourceSet to this web application as a 'Pre'
+ * resource.
+ */
void addPreResources(WebResourceSet webResourceSet);
+
+ /**
+ * Adds the provided WebResourceSet to this web application as a 'Jar'
+ * resource.
+ */
void addJarResources(WebResourceSet webResourceSet);
+
+ /**
+ * Adds the provided WebResourceSet to this web application as a 'Post'
+ * resource.
+ */
void addPostResources(WebResourceSet webResourceSet);
/**
@@ -238,7 +243,17 @@ public interface WebResourceRoot extends
*/
boolean getAllowLinking();
+ /**
+ * Set whether or not caching is permitted for this web application.
+ *
+ * @param cachingAllowed <code>true</code> to enable caching, else
+ * <code>false</code>
+ */
void setCachingAllowed(boolean cachingAllowed);
+
+ /**
+ * Get whether or not caching is permitted for this web application.
+ */
boolean isCachingAllowed();
/**
@@ -255,10 +270,33 @@ public interface WebResourceRoot extends
*/
long getCacheTtl();
+ /**
+ * Set the maximum permitted size for the cache.
+ *
+ * @param cacheMaxSize Maximum cache size in kilobytes
+ */
void setCacheMaxSize(long cacheMaxSize);
+
+ /**
+ * Get the maximum permitted size for the cache.
+ *
+ * @return Maximum cache size in kilobytes
+ */
long getCacheMaxSize();
+ /**
+ * Set the maximum permitted size for a single object in the cache.
+ *
+ * @param cacheMaxObjectSize Maximum size for a single cached object in
+ * kilobytes
+ */
void setCacheMaxObjectSize(long cacheMaxObjectSize);
+
+ /**
+ * Get the maximum permitted size for a single object in the cache.
+ *
+ * @return Maximum size for a single cached object in kilobytes
+ */
long getCacheMaxObjectSize();
/**
Modified:
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/Cache.java
URL:
http://svn.apache.org/viewvc/tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/Cache.java?rev=1401258&r1=1401257&r2=1401258&view=diff
==============================================================================
---
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/Cache.java
(original)
+++
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/Cache.java
Tue Oct 23 12:06:55 2012
@@ -179,11 +179,13 @@ public class Cache {
}
public long getMaxSize() {
- return maxSize;
+ // Internally bytes, externally kiobytes
+ return maxSize / 1024;
}
public void setMaxSize(long maxSize) {
- this.maxSize = maxSize;
+ // Internally bytes, externally kiobytes
+ this.maxSize = maxSize * 1024;
}
Modified:
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/DirResourceSet.java
URL:
http://svn.apache.org/viewvc/tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/DirResourceSet.java?rev=1401258&r1=1401257&r2=1401258&view=diff
==============================================================================
---
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/DirResourceSet.java
(original)
+++
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/DirResourceSet.java
Tue Oct 23 12:06:55 2012
@@ -31,7 +31,7 @@ import org.apache.catalina.util.Resource
import org.apache.tomcat.util.http.RequestUtil;
/**
- * Represents a {@link WebResourceSet} based on a directory.
+ * Represents a {@link org.apache.catalina.WebResourceSet} based on a
directory.
*/
public class DirResourceSet extends AbstractResourceSet {
@@ -50,19 +50,22 @@ public class DirResourceSet extends Abst
}
/**
- * Creates a new {@link WebResourceSet} based on a directory.
+ * Creates a new {@link org.apache.catalina.WebResourceSet} based on a
+ * directory.
*
* @param root The {@link WebResourceRoot} this new
- * {@link WebResourceSet} will be added to.
+ * {@link org.apache.catalina.WebResourceSet} will
+ * be added to.
* @param base The absolute path to the directory on the file
* system from which the resources will be served.
* @param webAppMount The path within the web application at which this
- * {@link WebResourceSet} will be mounted. For
- * example, to add a directory of JARs to a web
- * application, the directory would be mounted at
- * "WEB-INF/lib/"
- * @param internalPath The path within this new {@link WebResourceSet}
- * where resources will be served from.
+ * {@link org.apache.catalina.WebResourceSet} will
+ * be mounted. For example, to add a directory of
+ * JARs to a web application, the directory would
+ * be mounted at "WEB-INF/lib/"
+ * @param internalPath The path within this new {@link
+ * org.apache.catalina.WebResourceSet} where
+ * resources will be served from.
*/
public DirResourceSet(WebResourceRoot root, String base, String
webAppMount,
String internalPath) {
Modified:
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/JarResourceSet.java
URL:
http://svn.apache.org/viewvc/tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/JarResourceSet.java?rev=1401258&r1=1401257&r2=1401258&view=diff
==============================================================================
---
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/JarResourceSet.java
(original)
+++
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/JarResourceSet.java
Tue Oct 23 12:06:55 2012
@@ -32,7 +32,7 @@ import org.apache.catalina.WebResourceRo
import org.apache.catalina.util.ResourceSet;
/**
- * Represents a {@link WebResourceSet} based on a JAR file.
+ * Represents a {@link org.apache.catalina.WebResourceSet} based on a JAR file.
*/
public class JarResourceSet extends AbstractResourceSet {
@@ -41,16 +41,20 @@ public class JarResourceSet extends Abst
private final String internalPath;
/**
- * Creates a new {@link WebResourceSet} based on a JAR file.
+ * Creates a new {@link org.apache.catalina.WebResourceSet} based on a JAR
+ * file.
*
* @param root The {@link WebResourceRoot} this new
- * {@link WebResourceSet} will be added to.
+ * {@link org.apache.catalina.WebResourceSet} will
+ * be added to.
* @param base The absolute path to the JAR file on the file
system
* from which the resources will be served.
* @param webAppMount The path within the web application at which this
- * {@link WebResourceSet} will be mounted.
- * @param internalPath The path within this new {@link WebResourceSet}
- * where resources will be served from. E.g. for a
+ * {@link org.apache.catalina.WebResourceSet} will
+ * be mounted.
+ * @param internalPath The path within this new {@link
+ * org.apache.catalina.WebResourceSet} where
+ * resources will be served from. E.g. for a
* resource JAR, this would be
"META-INF/resources"
*/
public JarResourceSet(WebResourceRoot root, String base, String
webAppMount,
Modified:
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/StandardRoot.java
URL:
http://svn.apache.org/viewvc/tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/StandardRoot.java?rev=1401258&r1=1401257&r2=1401258&view=diff
==============================================================================
---
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/StandardRoot.java
(original)
+++
tomcat/sandbox/trunk-resources/java/org/apache/catalina/webresources/StandardRoot.java
Tue Oct 23 12:06:55 2012
@@ -44,7 +44,7 @@ import org.apache.tomcat.util.res.String
* </p><p>
* This implementation assumes that the base attribute supplied to {@link
* StandardRoot#createWebResourceSet(
- * org.apache.catalina.WebResourceRoot.ResourceSetType, String, String, String)
+ * org.apache.catalina.WebResourceRoot.ResourceSetType, String, String,
String)}
* represents the absolute path to a file.
* </p>
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
