[gatein-commits] gatein SVN: r5394 - components/wsrp/trunk/producer/src/main/java/org/gatein/registration.

[do-not-reply at jboss.org]

Author: mwringe
Date: 2010-11-30 22:22:48 -0500 (Tue, 30 Nov 2010)
New Revision: 5394

Modified:
   components/wsrp/trunk/producer/src/main/java/org/gatein/registration/RegistrationPolicy.java
   components/wsrp/trunk/producer/src/main/java/org/gatein/registration/RegistrationPortletContextChangeListener.java
Log:
Add some javadocs.

Modified: components/wsrp/trunk/producer/src/main/java/org/gatein/registration/RegistrationPolicy.java
===================================================================
--- components/wsrp/trunk/producer/src/main/java/org/gatein/registration/RegistrationPolicy.java	2010-12-01 02:40:31 UTC (rev 5393)
+++ components/wsrp/trunk/producer/src/main/java/org/gatein/registration/RegistrationPolicy.java	2010-12-01 03:22:48 UTC (rev 5394)
@@ -123,11 +123,47 @@
     */
    void validateConsumerGroupName(String groupName, RegistrationManager manager) throws IllegalArgumentException, RegistrationException;
    
-   //TODO: add javadocs here
+   /**
+    * Checks if a portlet handle belongs to a specific registration.
+    * 
+    * @param registration The registration to check
+    * @param portletHandle The portlet handle to use
+    * @return True if the registration contains this portlet handle
+    */
    boolean checkPortletHandle(Registration registration, String portletHandle);
+   
+   /**
+    * Adds a Portlet Handle to a Registration
+    * 
+    * @param registration The registration to use
+    * @param portletHandle The portletHandle to add
+    */
    void addPortletHandle(Registration registration, String portletHandle);
+   
+   /**
+    * Removes a portlet handle from a specific registration
+    * 
+    * @param registration The registration to use
+    * @param portletHandle The portlet handle to remove
+    */
    void removePortletHandle(Registration registration, String portletHandle);
+   
+   /**
+    * Updates the list of currently available portlet handles.
+    * 
+    * Note: this is not registration specific. This method deals with the situation where
+    * the producer has a change in the available portlets. The RegistrationPolicy needs to either handle
+    * the globally available portlets separately or update each registration when this type of change occurs.
+    * 
+    * @param portlets
+    */
    void updatePortletHandles(List<String> portlets);
    
+   /**
+    * Adds a PortletContextChangeListener to the RegistrationPolicy. The PortletContextChangeListener
+    * will be called whenever the portlet contexts within a registration changes.
+    * 
+    * @param listener The listener to add
+    */
    void addPortletContextChangeListener(RegistrationPortletContextChangeListener listener);
 }

Modified: components/wsrp/trunk/producer/src/main/java/org/gatein/registration/RegistrationPortletContextChangeListener.java
===================================================================
--- components/wsrp/trunk/producer/src/main/java/org/gatein/registration/RegistrationPortletContextChangeListener.java	2010-12-01 02:40:31 UTC (rev 5393)
+++ components/wsrp/trunk/producer/src/main/java/org/gatein/registration/RegistrationPortletContextChangeListener.java	2010-12-01 03:22:48 UTC (rev 5394)
@@ -23,6 +23,8 @@
 package org.gatein.registration;
 
 /**
+ * Listeners for when the portlet contexts of a registration change.
+ * 
  * @author <a href="mailto:mwringe at redhat.com">Matt Wringe</a>
  * @version $Revision$
  */