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.Modifier and Type | Field and Description |
---|---|
static String |
INIT_VIEW_PARAMETER |
static 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.
|
static String |
PORTLET_LIFECYCLE_ID |
static String |
PORTLET_SKIP_SAVE_WINDOW_STATE |
static String |
PORTLET_VIEW_ID |
static 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.
|
static String |
REQ_ATTR_FORCE_POSTBACK |
static String |
TARGET_VIEW_REQ_PARAM |
static 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
|
Constructor and Description |
---|
PortletLifecycle() |
Modifier and Type | Method and Description |
---|---|
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.
|
protected void |
copyDeferredMessages(FacesContext context,
boolean action,
javax.portlet.PortletRequest request,
com.webmethods.caf.faces.portlet.FacesPortletState state) |
void |
execute(FacesContext context)
Execute all of the phases of the request processing lifecycle, up to but
not including the Render Response phase in the specified order.
|
protected String |
findTargetViewRequestParamValue(FacesContext context) |
PhaseListener[] |
getPhaseListeners()
Return the set of PhaseListeners that have been registered.
|
void |
removePhaseListener(PhaseListener listener)
Remove a registered PhaseListener from the set of registered listeners
|
void |
render(FacesContext context)
Execute the Render Response phase.
|
attachWindow
public static final String REQ_ATTR_FORCE_POSTBACK
public static final String TARGET_VIEW_REQ_PARAM
public static final String PORTLET_LIFECYCLE_ID
public static final String PORTLET_VIEW_ID
public static final String PORTLET_SKIP_SAVE_WINDOW_STATE
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.
public static final String INIT_VIEW_PARAMETER
public static final String RENDER_WHEN_MINIMIZED
public static final String VIEW_CACHE_SESSION
public void addPhaseListener(PhaseListener listener)
addPhaseListener
in class Lifecycle
listener
- The PhaseListener
to be registeredNullPointerException
- if listener is nullpublic void execute(FacesContext context) throws FacesException
execute
in class Lifecycle
context
- FacesContext for the request to be processedFacesException
- if thrown during the execution of the request processing lifecycleNullPointerException
- if context is nullpublic PhaseListener[] getPhaseListeners()
getPhaseListeners
in class Lifecycle
public void render(FacesContext context) throws FacesException
render
in class Lifecycle
context
- FacesContext for the request being processedFacesException
- if an exception is thrown during the execution of the request
processing lifecycleNullPointerException
- if context is nullpublic void removePhaseListener(PhaseListener listener)
removePhaseListener
in class Lifecycle
protected void copyDeferredMessages(FacesContext context, boolean action, javax.portlet.PortletRequest request, com.webmethods.caf.faces.portlet.FacesPortletState state)
protected String findTargetViewRequestParamValue(FacesContext context)