Menu
▾
▴
[Openutils-svn] SF.net SVN: openutils:[3013] trunk/openutils-mgnlcache/src/main/java/net/ sourceforge/openutils/mgnlsimplecache
|
From: <fg...@us...> - 2010-09-09 21:25:47
|
Revision: 3013
http://openutils.svn.sourceforge.net/openutils/?rev=3013&view=rev
Author: fgiust
Date: 2010-09-09 21:25:40 +0000 (Thu, 09 Sep 2010)
Log Message:
-----------
javadoc cleanup
Modified Paths:
--------------
trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/filesystem/FSCacheManager.java
trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/filesystem/FSCachedItem.java
trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/filters/CacheFilter.java
trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/managers/CacheResponseWrapper.java
trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/voters/AllInOneCacheVoter.java
Modified: trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/filesystem/FSCacheManager.java
===================================================================
--- trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/filesystem/FSCacheManager.java 2010-09-09 21:13:25 UTC (rev 3012)
+++ trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/filesystem/FSCacheManager.java 2010-09-09 21:25:40 UTC (rev 3013)
@@ -68,7 +68,7 @@
private String basePath = "fscache";
- private boolean flushOnStop = false;
+ private boolean flushOnStop;
private boolean reloadAtStartup;
@@ -283,7 +283,7 @@
{
uri += "root";
}
- String uriTokens[] = StringUtils.split(uri, "/");
+ String[] uriTokens = StringUtils.split(uri, "/");
for (int i = 0; i < uriTokens.length; i++)
{
try
Modified: trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/filesystem/FSCachedItem.java
===================================================================
--- trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/filesystem/FSCachedItem.java 2010-09-09 21:13:25 UTC (rev 3012)
+++ trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/filesystem/FSCachedItem.java 2010-09-09 21:25:40 UTC (rev 3013)
@@ -46,7 +46,7 @@
* @author Fabrizio Giustina
* @version $Id$
*/
-public class FSCachedItem extends LockableCacheContent
+public final class FSCachedItem extends LockableCacheContent
{
private String filename;
@@ -236,7 +236,8 @@
return true;
}
- size = sizeGzip = 0;
+ size = 0;
+ sizeGzip = 0;
lastModified = System.currentTimeMillis();
releaseLockToWrite();
@@ -286,15 +287,15 @@
}
}
- private static final int GZIP_MAGIC_NUMBER_BYTE_1 = 31;
-
- private static final int GZIP_MAGIC_NUMBER_BYTE_2 = -117;
-
/**
* Checks the first two bytes of the candidate byte array for the magic number 0x677a.
*/
private boolean isGZipped(byte[] candidate)
{
+
+ final int GZIP_MAGIC_NUMBER_BYTE_1 = 31;
+ final int GZIP_MAGIC_NUMBER_BYTE_2 = -117;
+
if (candidate == null || candidate.length < 2)
{
return false;
Modified: trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/filters/CacheFilter.java
===================================================================
--- trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/filters/CacheFilter.java 2010-09-09 21:13:25 UTC (rev 3012)
+++ trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/filters/CacheFilter.java 2010-09-09 21:25:40 UTC (rev 3013)
@@ -33,15 +33,16 @@
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
-import net.sourceforge.openutils.mgnlsimplecache.managers.CachedItem;
import net.sourceforge.openutils.mgnlsimplecache.managers.CacheHeaders;
import net.sourceforge.openutils.mgnlsimplecache.managers.CacheManager;
import net.sourceforge.openutils.mgnlsimplecache.managers.CacheResponseWrapper;
+import net.sourceforge.openutils.mgnlsimplecache.managers.CachedItem;
import org.apache.commons.io.IOUtils;
/**
+ * Main cache filter, to be configured in magnolia filter chain.
* @author Manuel Molaschi
* @author Fabrizio Giustina
* @version $Id$
Modified: trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/managers/CacheResponseWrapper.java
===================================================================
--- trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/managers/CacheResponseWrapper.java 2010-09-09 21:13:25 UTC (rev 3012)
+++ trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/managers/CacheResponseWrapper.java 2010-09-09 21:25:40 UTC (rev 3013)
@@ -44,9 +44,9 @@
private CachedItem content;
- boolean redirect;
+ private boolean redirect;
- boolean error;
+ private boolean error;
public CacheResponseWrapper(HttpServletResponse response, CachedItem content, OutputStream cachingStream)
{
@@ -215,30 +215,35 @@
this.stream2 = stream2;
}
+ @Override
public void write(int value) throws IOException
{
stream1.write(value);
stream2.write(value);
}
+ @Override
public void write(byte[] value) throws IOException
{
stream1.write(value);
stream2.write(value);
}
+ @Override
public void write(byte[] b, int off, int len) throws IOException
{
stream1.write(b, off, len);
stream2.write(b, off, len);
}
+ @Override
public void flush() throws IOException
{
stream1.flush();
stream2.flush();
}
+ @Override
public void close() throws IOException
{
try
Modified: trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/voters/AllInOneCacheVoter.java
===================================================================
--- trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/voters/AllInOneCacheVoter.java 2010-09-09 21:13:25 UTC (rev 3012)
+++ trunk/openutils-mgnlcache/src/main/java/net/sourceforge/openutils/mgnlsimplecache/voters/AllInOneCacheVoter.java 2010-09-09 21:25:40 UTC (rev 3013)
@@ -45,27 +45,54 @@
{
// just to make everything more explicit
- public static boolean CACHE = false;
+ public static final boolean CACHE = false;
// just to make everything more explicit
- public static boolean DONTCACHE = true;
+ public static final boolean DONTCACHE = true;
+ /**
+ * Comma separated list of allowed extensions.
+ */
protected String[] extensionsAllowed;
+ /**
+ * Comma separated list of denied extensions.
+ */
protected String[] extensionsDenied;
+ /**
+ * Comma separated list of allowed content types.
+ */
protected String[] contentTypesAllowed;
+ /**
+ * Comma separated list of denied content types.
+ */
protected String[] contentTypesDenied;
+ /**
+ * Cache requests with parameters?
+ */
protected boolean allowRequestWithParameters;
+ /**
+ * Cache content on admin instances?
+ */
protected boolean allowAdmin;
+ /**
+ * Cache content for authenticated users?
+ */
protected boolean allowAuthenticated;
+ /**
+ * Comma separated list of allowed start paths.
+ */
protected String[] pathsAllowed;
+ /**
+ * Comma separated list of denied start paths.
+ */
protected String[] pathsDenied;
/**
@@ -74,8 +101,8 @@
private Logger log = LoggerFactory.getLogger(AllInOneCacheVoter.class);
/**
- * Sets the extensionsAllowed.
- * @param extensionsAllowed the extensionsAllowed to set
+ * Sets a comma separated list of allowed extensions.
+ * @param extensionsAllowed comma separated list of allowed extensions
*/
public void setExtensionsAllowed(String extensionsAllowed)
{
@@ -83,8 +110,8 @@
}
/**
- * Sets the extensionsDenied.
- * @param extensionsDenied the extensionsDenied to set
+ * Sets a comma separated list of denied extensions.
+ * @param extensionsDenied comma separated list of denied extensions
*/
public void setExtensionsDenied(String extensionsDenied)
{
@@ -92,8 +119,8 @@
}
/**
- * Sets the contentTypesAllowed.
- * @param contentTypesAllowed the contentTypesAllowed to set
+ * Sets a comma separated list of allowed content types.
+ * @param contentTypesAllowed comma separated list of allowed content types
*/
public void setContentTypesAllowed(String contentTypesAllowed)
{
@@ -101,8 +128,8 @@
}
/**
- * Sets the contentTypesDenied.
- * @param contentTypesDenied the contentTypesDenied to set
+ * Sets a comma separated list of denied content types.
+ * @param contentTypesDenied comma separated list of denied content types.
*/
public void setContentTypesDenied(String contentTypesDenied)
{
@@ -110,7 +137,7 @@
}
/**
- * Sets the allowRequestWithParameters.
+ * Cache requests with parameters?
* @param allowRequestWithParameters the allowRequestWithParameters to set
*/
public void setAllowRequestWithParameters(boolean allowRequestWithParameters)
@@ -119,7 +146,7 @@
}
/**
- * Sets the allowAdmin.
+ * Cache content on admin instances?
* @param allowAdmin the allowAdmin to set
*/
public void setAllowAdmin(boolean allowAdmin)
@@ -128,7 +155,7 @@
}
/**
- * Sets the allowAuthenticated.
+ * Cache content for authenticated users?
* @param allowAuthenticated the allowAuthenticated to set
*/
public void setAllowAuthenticated(boolean allowAuthenticated)
@@ -137,8 +164,8 @@
}
/**
- * Sets the pathsAllowed.
- * @param pathsAllowed the pathsAllowed to set
+ * Sets a comma separated list of allowed start paths.
+ * @param pathsAllowed comma separated list of allowed start paths.
*/
public void setPathsAllowed(String pathsAllowed)
{
@@ -146,8 +173,8 @@
}
/**
- * Sets the pathsDenied.
- * @param pathsDenied the pathsDenied to set
+ * Sets a comma separated list of denied start paths.
+ * @param pathsDenied comma separated list of denied start paths.
*/
public void setPathsDenied(String pathsDenied)
{
@@ -198,12 +225,14 @@
{
if (log.isDebugEnabled())
{
- log.debug(logmessage, "extension ["
- + extension
- + "] doesn't match allowed:"
- + ArrayUtils.toString(extensionsAllowed)
- + " denied: "
- + ArrayUtils.toString(extensionsDenied));
+ log.debug(
+ logmessage,
+ "extension ["
+ + extension
+ + "] doesn't match allowed:"
+ + ArrayUtils.toString(extensionsAllowed)
+ + " denied: "
+ + ArrayUtils.toString(extensionsDenied));
}
return DONTCACHE;
}
@@ -216,12 +245,14 @@
{
if (log.isDebugEnabled())
{
- log.debug(logmessage, "content type ["
- + contentType
- + "] doesn't match allowed:"
- + ArrayUtils.toString(contentTypesAllowed)
- + " denied: "
- + ArrayUtils.toString(contentTypesDenied));
+ log.debug(
+ logmessage,
+ "content type ["
+ + contentType
+ + "] doesn't match allowed:"
+ + ArrayUtils.toString(contentTypesAllowed)
+ + " denied: "
+ + ArrayUtils.toString(contentTypesDenied));
}
return DONTCACHE;
}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
