[jboss-cvs] JBossAS SVN: r106468 - projects/cluster/ha-server-cache-spi/branches/Session_Ownership/src/main/java/org/jboss/web/tomcat/service/session/distributedcache/spi.

[jboss-cvs-commits at lists.jboss.org]

Author: bstansberry at jboss.com
Date: 2010-07-06 15:11:24 -0400 (Tue, 06 Jul 2010)
New Revision: 106468

Modified:
   projects/cluster/ha-server-cache-spi/branches/Session_Ownership/src/main/java/org/jboss/web/tomcat/service/session/distributedcache/spi/DistributedCacheManager.java
Log:
[JBCLUSTER-260] Javadoc

Modified: projects/cluster/ha-server-cache-spi/branches/Session_Ownership/src/main/java/org/jboss/web/tomcat/service/session/distributedcache/spi/DistributedCacheManager.java
===================================================================
--- projects/cluster/ha-server-cache-spi/branches/Session_Ownership/src/main/java/org/jboss/web/tomcat/service/session/distributedcache/spi/DistributedCacheManager.java	2010-07-06 18:57:12 UTC (rev 106467)
+++ projects/cluster/ha-server-cache-spi/branches/Session_Ownership/src/main/java/org/jboss/web/tomcat/service/session/distributedcache/spi/DistributedCacheManager.java	2010-07-06 19:11:24 UTC (rev 106468)
@@ -257,10 +257,41 @@
     */
    Map<String, Object> getAttributes(String realId);
    
+   /**
+    * Indicates whether this manager supports taking ownership of a session
+    * across the cluster.
+    * 
+    * @return <code>true</code> if session ownership is supported; 
+    *         <code>false</code> if not
+    */
    boolean getSupportsSessionOwnership();
    
+   /**
+    * Attempt to take ownership of the session identified by the given id.
+    * 
+    * @param realId the session's id, excluding any jvmRoute
+    * @param newLock <code>true</code> if the caller knows this is a new session
+    *                that doesn't exist elsewhere in the cluster, and thus
+    *                acquiring ownership does not require any cluster-wide
+    *                call
+    *                
+    * @return the result of the attempt
+    * 
+    * @throws TimeoutException
+    * @throws InterruptedException
+    */
    LockResult acquireSessionOwnership(String realId, boolean newLock) throws TimeoutException, InterruptedException;
    
+   /**
+    * Releases ownership of a session, thus making it possible for other nodes
+    * to acquire it.
+    * 
+    * @param realId the session's id, excluding any jvmRoute
+    * @param remove <code>true</code> if this release is associated with a 
+    *               session removal, in which case the distributed cache manager
+    *               can stop tracking ownership
+    */
    void relinquishSessionOwnership(String realId, boolean remove);
+   
    void setForceSynchronous(boolean forceSynchronous);
 }
\ No newline at end of file