Anonymous avatar Anonymous committed b75cff6

javadoc updated for developers to avoid a potential deadlock situation

Comments (0)

Files changed (1)

src/java/com/opensymphony/oscache/web/ServletCacheAdministrator.java

     }
 
     /**
-    * Put an object in the cache
+    * Put an object in the cache. This should only be called by a thread
+    * that received a {@link NeedsRefreshException}. Using session scope
+    * the thread has to insure that the session wasn't invalidated in
+    * the meantime. CacheTag and CacheFilter guarantee that the same
+    * cache is used in cancelUpdate and getFromCache.
     *
     * @param scope The cache scope
     * @param request The servlet request
     }
 
     /**
-    * Put an object in the cache
+    * Put an object in the cache. This should only be called by a thread
+    * that received a {@link NeedsRefreshException}. Using session scope
+    * the thread has to insure that the session wasn't invalidated in
+    * the meantime. CacheTag and CacheFilter guarantee that the same
+    * cache is used in cancelUpdate and getFromCache.
     *
     * @param scope The cache scope
     * @param request The servlet request
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.