Anonymous avatar Anonymous committed e85414c

JavaDoc for CACHE-179

Comments (0)

Files changed (2)

src/java/com/opensymphony/oscache/web/filter/CacheFilter.java

      * The default value is auto detect.</li>
      * <li><b>nocache</b> - defines which objects shouldn't be cached. Acceptable values
      * are <code>off</code> (default) and <code>sessionIdInURL</code> if the session id is
-     * contained in the URL.
+     * contained in the URL.</li>
+     * <li><b>ICacheKeyProvider</b> - Class implementing the interface <code>ICacheKeyProvider</code>.
+     * A developer can implement a method which provides cache keys based on the request, 
+     * the servlect cache administrator and cache.</li>
      *
      * @param filterConfig The filter configuration
      */
         config = filterConfig;
         admin = ServletCacheAdministrator.getInstance(config.getServletContext());
 
-        //Will work this out later
+        // filter parameter time
         try {
             time = Integer.parseInt(config.getInitParameter("time"));
         } catch (Exception e) {

src/java/com/opensymphony/oscache/web/filter/ICacheKeyProvider.java

 import com.opensymphony.oscache.web.ServletCacheAdministrator;
 
 /**
- * Provider interface for cache key creation.
+ * Provider interface for cache key creation. A developer can implement a method which provides
+ * cache keys based on the request, the servlect cache administrator and cache.
  * 
  * JIRA issue: http://jira.opensymphony.com/browse/CACHE-179
  *
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.