Author: pete
Date: Sat Sep 11 18:01:06 2010
New Revision: 996189
URL: http://svn.apache.org/viewvc?rev=996189&view=rev
Log:
javadocs
Modified:
wicket/trunk/wicket-request/src/main/java/org/apache/wicket/request/http/WebResponse.java
wicket/trunk/wicket/src/main/java/org/apache/wicket/request/resource/AbstractResource.java
Modified:
wicket/trunk/wicket-request/src/main/java/org/apache/wicket/request/http/WebResponse.java
URL:
http://svn.apache.org/viewvc/wicket/trunk/wicket-request/src/main/java/org/apache/wicket/request/http/WebResponse.java?rev=996189&r1=996188&r2=996189&view=diff
==============================================================================
---
wicket/trunk/wicket-request/src/main/java/org/apache/wicket/request/http/WebResponse.java
(original)
+++
wicket/trunk/wicket-request/src/main/java/org/apache/wicket/request/http/WebResponse.java
Sat Sep 11 18:01:06 2010
@@ -210,9 +210,9 @@ public abstract class WebResponse extend
}
/**
- * scope for caching web responses
+ * caching scope for data
* <p/>
- * Unless the response is confidential or session-specific the general
advice is
+ * Unless the data is confidential, session-specific or user-specific
the general advice is
* to prefer value <code>PUBLIC</code> for best network performance.
* <p/>
* This value will basically affect the header [Cache-Control]. Details
can be found
@@ -222,16 +222,16 @@ public abstract class WebResponse extend
public static enum CacheScope
{
/**
- * all caches are allowed to cache the response
+ * use all caches (private + public)
* <p/>
- * Use this value for caching is your response is not
confidential or session-specific. In that
- * case public proxies and caches are allowed to cache the
response. In some versions of Firefox
- * it will enable caching of resources over SSL (details can be
found
+ * Use this value for caching if the data is not confidential
or session-specific. It will allow
+ * public caches to cache the data. In some versions of Firefox
this will enable caching
+ * of resources over SSL (details can be found
* <a
href="http://blog.pluron.com/2008/07/why-you-should.html";>here</a>).
*/
PUBLIC("public"),
/**
- * only the client may cache the response
+ * only use non-public caches
* <p/>
* Use this setting if the response is session-specific or
confidential and you don't
* want it to be cached on public caches or proxies. On some
versions of Firefox this
Modified:
wicket/trunk/wicket/src/main/java/org/apache/wicket/request/resource/AbstractResource.java
URL:
http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/request/resource/AbstractResource.java?rev=996189&r1=996188&r2=996189&view=diff
==============================================================================
---
wicket/trunk/wicket/src/main/java/org/apache/wicket/request/resource/AbstractResource.java
(original)
+++
wicket/trunk/wicket/src/main/java/org/apache/wicket/request/resource/AbstractResource.java
Sat Sep 11 18:01:06 2010
@@ -312,9 +312,8 @@ public abstract class AbstractResource i
}
/**
- * Sets the duration for which this resource should be cached
on client (in seconds). #see
- * {...@link
IResourceSettings#setDefaultCacheDuration(org.apache.wicket.util.time.Duration)}
- *
+ * Controls how long this response may be cached
+ *
* @param duration
* caching duration in seconds
*/
@@ -325,7 +324,14 @@ public abstract class AbstractResource i
}
/**
- * @return duration for which the resource shoudl be cached on
client (in seconds)
+ * returns how long this resource may be cached
+ * <p/>
+ * The special value Duration.NONE means caching is disabled.
+ *
+ * @return duration for caching
+ *
+ * @see
IResourceSettings#setDefaultCacheDuration(org.apache.wicket.util.time.Duration)
+ * @see IResourceSettings#getDefaultCacheDuration()
*/
public Duration getCacheDuration()
{
