[gatein-commits] gatein SVN: r1744 - components/pc/trunk/federation/src/main/java/org/gatein/pc/federation.

[do-not-reply at jboss.org]

Author: chris.laprun at jboss.com
Date: 2010-02-16 08:04:51 -0500 (Tue, 16 Feb 2010)
New Revision: 1744

Modified:
   components/pc/trunk/federation/src/main/java/org/gatein/pc/federation/NullInvokerHandler.java
Log:
- Added some documentation.

Modified: components/pc/trunk/federation/src/main/java/org/gatein/pc/federation/NullInvokerHandler.java
===================================================================
--- components/pc/trunk/federation/src/main/java/org/gatein/pc/federation/NullInvokerHandler.java	2010-02-16 12:56:26 UTC (rev 1743)
+++ components/pc/trunk/federation/src/main/java/org/gatein/pc/federation/NullInvokerHandler.java	2010-02-16 13:04:51 UTC (rev 1744)
@@ -34,6 +34,10 @@
  */
 public interface NullInvokerHandler
 {
+   /**
+    * Default handling mechanism: if we haven't found an invoker for the portlet id in the first place, throw
+    * NoSuchPortletException.
+    */
    NullInvokerHandler DEFAULT_HANDLER = new NullInvokerHandler()
    {
       public FederatedPortletInvoker resolvePortletInvokerFor(String compoundPortletId, String invokerId,
@@ -43,6 +47,18 @@
       }
    };
 
+   /**
+    * Attempts to resolve a FederatedPortletInvoker for the specified compound portlet id in the context of the
+    * specified calling FederatingPortletInvoker.
+    *
+    * @param compoundPortletId the portlet identifier for which we're trying to resolve a FederatedPortletInvoker
+    * @param invokerId         the identifier of the FederatedPortletInvoker to be retrieved as parsed from the compound
+    *                          portlet id by the calling FederatingPortletInvoker
+    * @param callingInvoker    the calling FederatingPortletInvoker which failed to resolve a FederatedPortletInvoker
+    *                          for the specified portlet id
+    * @return
+    * @throws NoSuchPortletException
+    */
    FederatedPortletInvoker resolvePortletInvokerFor(String compoundPortletId, String invokerId,
                                                     FederatingPortletInvoker callingInvoker) throws NoSuchPortletException;
 }