Package com.webmethods.caf.faces.portlet

Class PortletLifecycle

java.lang.Object
javax.faces.lifecycle.Lifecycle
com.webmethods.caf.faces.portlet.PortletLifecycle
public class PortletLifecycle extends Lifecycle
PortletLifecycle manages the processing of the entire lifecycle of a particular PortletRequest. An instance of PortletLifecycle is created by calling the PortletLifecycleFactory.getLifecycle(String) method, for a specified lifecycle identifier.

  • Field Details

    • REQ_ATTR_FORCE_POSTBACK

      public static final String REQ_ATTR_FORCE_POSTBACK
      See Also:

    • TARGET_VIEW_REQ_PARAM

      public static final String TARGET_VIEW_REQ_PARAM
      See Also:

    • PORTLET_LIFECYCLE_ID

      public static final String PORTLET_LIFECYCLE_ID
      See Also:

    • PORTLET_VIEW_ID

      public static final String PORTLET_VIEW_ID
      See Also:

    • PORTLET_SKIP_SAVE_WINDOW_STATE

      public static final String PORTLET_SKIP_SAVE_WINDOW_STATE
      See Also:

    • INITIAL_VIEW_FOR_PORTLET_MODE_INIT_PARAM_PREFIX

      public static final String INITIAL_VIEW_FOR_PORTLET_MODE_INIT_PARAM_PREFIX

      Context initialization parameter under which the application may specify an initial view identifier to be displayed.

      See Also:

    • INIT_VIEW_PARAMETER

      public static final String INIT_VIEW_PARAMETER

    • RENDER_WHEN_MINIMIZED

      public static final String RENDER_WHEN_MINIMIZED
      Init param name which nees to be set to true if portlet is completely rendered in the minimized state but just not getting displayed. By default portlet is not rendered in the minimized state. The primary reason to override this is when portlet includes some other portlets which state is important to keep if the parent portlet is minimized
      See Also:

    • VIEW_CACHE_SESSION

      public static final String VIEW_CACHE_SESSION
      Init param name which nees to be set to true if view state caching should be done in the session as opposed to default pageflow storage
      See Also:

  • Constructor Details

    • PortletLifecycle

      public PortletLifecycle()

  • Method Details

    • addPhaseListener

      public void addPhaseListener(PhaseListener listener)
      Register a new PhaseListener instance that is interested in being notified before and after the processing for standard phases of the request processing lifecycle.
      Specified by:
      addPhaseListener in class Lifecycle
      Parameters:
      listener - The PhaseListener to be registered
      Throws:
      NullPointerException - if listener is null

    • execute

      public void execute(FacesContext context) throws FacesException
      Execute all of the phases of the request processing lifecycle, up to but not including the Render Response phase in the specified order.
      Specified by:
      execute in class Lifecycle
      Parameters:
      context - FacesContext for the request to be processed
      Throws:
      FacesException - if thrown during the execution of the request processing lifecycle
      NullPointerException - if context is null

    • getPhaseListeners

      public PhaseListener[] getPhaseListeners()
      Return the set of PhaseListeners that have been registered.
      Specified by:
      getPhaseListeners in class Lifecycle

    • render

      public void render(FacesContext context) throws FacesException
      Execute the Render Response phase.
      Specified by:
      render in class Lifecycle
      Parameters:
      context - FacesContext for the request being processed
      Throws:
      FacesException - if an exception is thrown during the execution of the request processing lifecycle
      NullPointerException - if context is null

    • removePhaseListener

      public void removePhaseListener(PhaseListener listener)
      Remove a registered PhaseListener from the set of registered listeners
      Specified by:
      removePhaseListener in class Lifecycle

    • copyDeferredMessages

      protected void copyDeferredMessages(FacesContext context, boolean action, javax.portlet.PortletRequest request, com.webmethods.caf.faces.portlet.FacesPortletState state)

    • findTargetViewRequestParamValue

      protected String findTargetViewRequestParamValue(FacesContext context)