Package org.gatein.pc.federation

Interface PortletInvokerResolver

public interface PortletInvokerResolver
Encapsulates behavior to resolve FederatedPortletInvokers in the context of a FederatingPortletInvoker when the default resolution mechanism fails to retrieve an associated FederatedPortletInvoker.
Version:
$Revision$
Author:
Chris Laprun

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final PortletInvokerResolver
    DEFAULT_RESOLVER
    Default handling mechanism: if we haven't found an invoker for the portlet id in the first place, throw NoSuchPortletException if we specified a portlet id or null if we didn't.

  • Method Summary

    Modifier and Type
    Method
    Description
    Collection<String>
    getKnownInvokerIds()
     
    boolean
    knows(String invokerId)
     
    FederatedPortletInvoker
    resolvePortletInvokerFor(String invokerId, FederatingPortletInvoker callingInvoker, String compoundPortletId)
    Attempts to resolve a FederatedPortletInvoker with the specified identifier in the context of the specified calling FederatingPortletInvoker, optionally trying to perform resolution to invoke an action on the specified portlet identifier.

  • Field Details

    • DEFAULT_RESOLVER

      static final PortletInvokerResolver DEFAULT_RESOLVER
      Default handling mechanism: if we haven't found an invoker for the portlet id in the first place, throw NoSuchPortletException if we specified a portlet id or null if we didn't.

  • Method Details

    • resolvePortletInvokerFor

      FederatedPortletInvoker resolvePortletInvokerFor(String invokerId, FederatingPortletInvoker callingInvoker, String compoundPortletId) throws org.gatein.pc.api.NoSuchPortletException
      Attempts to resolve a FederatedPortletInvoker with the specified identifier in the context of the specified calling FederatingPortletInvoker, optionally trying to perform resolution to invoke an action on the specified portlet identifier.
      Parameters:
      invokerId - the identifier of the FederatedPortletInvoker to be retrieved. Should match the optional compound portlet identifier if one is specified.
      callingInvoker - the calling FederatingPortletInvoker which failed to resolve a FederatedPortletInvoker for the specified invoker identifier
      compoundPortletId - an optional portlet identifier for which we are trying to resolve an invoker, if no such portlet identifier is required for the resolution, this argument should be null and implementations should be prepared for that case.
      Returns:
      the resolved FederatedPortletInvoker or null if one couldn't be found
      Throws:
      org.gatein.pc.api.NoSuchPortletException - if a PortletInvoker couldn't be found and a compound portlet identifier was specified

    • knows

      boolean knows(String invokerId)

    • getKnownInvokerIds

      Collection<String> getKnownInvokerIds()