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

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

Author: bstansberry at jboss.com
Date: 2009-04-13 21:29:35 -0400 (Mon, 13 Apr 2009)
New Revision: 87221

Modified:
   projects/cluster/ha-server-cache-spi/trunk/src/main/java/org/jboss/web/tomcat/service/session/distributedcache/spi/OutgoingAttributeGranularitySessionData.java
   projects/cluster/ha-server-cache-spi/trunk/src/main/java/org/jboss/web/tomcat/service/session/distributedcache/spi/OutgoingSessionGranularitySessionData.java
Log:
Javadoc

Modified: projects/cluster/ha-server-cache-spi/trunk/src/main/java/org/jboss/web/tomcat/service/session/distributedcache/spi/OutgoingAttributeGranularitySessionData.java
===================================================================
--- projects/cluster/ha-server-cache-spi/trunk/src/main/java/org/jboss/web/tomcat/service/session/distributedcache/spi/OutgoingAttributeGranularitySessionData.java	2009-04-14 01:22:28 UTC (rev 87220)
+++ projects/cluster/ha-server-cache-spi/trunk/src/main/java/org/jboss/web/tomcat/service/session/distributedcache/spi/OutgoingAttributeGranularitySessionData.java	2009-04-14 01:29:35 UTC (rev 87221)
@@ -26,13 +26,30 @@
 import java.util.Set;
 
 /**
+ * Expands on {@link OutgoingDistributableSessionData} to expose information 
+ * about changes in the session's attribute map.
+ * 
  * @author Brian Stansberry
- *
  */
 public interface OutgoingAttributeGranularitySessionData 
    extends OutgoingDistributableSessionData
 {   
+   /**
+    * Gets those key/value pairs in the session's attribute map that have been
+    * modified versus what is already present in the distributed cache, 
+    * including newly added key/value pairs.
+    * 
+    * @return map containing the modified attributes map or <code>null</code>
+    *         if there are no modified attributes.
+    */
    Map<String, Object> getModifiedSessionAttributes();
    
+   /**
+    * Gets the names of session attributes that have been removed locally
+    * and thus need to be removed from the distributed cache.
+    * 
+    * @return a set of attribute keys that need to be removed from the
+    *         distributed cache, or <code>null</code> if there are no such keys
+    */
    Set<String> getRemovedSessionAttributes();
 }

Modified: projects/cluster/ha-server-cache-spi/trunk/src/main/java/org/jboss/web/tomcat/service/session/distributedcache/spi/OutgoingSessionGranularitySessionData.java
===================================================================
--- projects/cluster/ha-server-cache-spi/trunk/src/main/java/org/jboss/web/tomcat/service/session/distributedcache/spi/OutgoingSessionGranularitySessionData.java	2009-04-14 01:22:28 UTC (rev 87220)
+++ projects/cluster/ha-server-cache-spi/trunk/src/main/java/org/jboss/web/tomcat/service/session/distributedcache/spi/OutgoingSessionGranularitySessionData.java	2009-04-14 01:29:35 UTC (rev 87221)
@@ -25,12 +25,22 @@
 import java.util.Map;
 
 /**
+ * Expands on {@link OutgoingDistributableSessionData} to expose the session's
+ * attribute map.
+ * 
  * @author Brian Stansberry
- *
  */
 public interface OutgoingSessionGranularitySessionData 
    extends OutgoingDistributableSessionData
 {
-   
+   /**
+    * Gets the attribute map for the session, or <code>null</code> if
+    * the attribute map is unmodified from what is already present
+    * in the distributed cache.
+    * 
+    * @return the attribute map or <code>null</code>. If not <code>null</code>,
+    *         all replicatable attributes managed by the session will be
+    *         included in the map, not just those that have been modified
+    */
    Map<String, Object> getSessionAttributes();
 }