public abstract class LifecycleWrapper extends Lifecycle implements FacesWrapper<Lifecycle>
Provides a simple implementation of
Lifecycle that can be subclassed by developers wishing to
provide specialized behavior to an existing Lifecycle
instance. The default implementation of all methods is to call
through to the wrapped Lifecycle.
Usage: extend this class and push the implementation being wrapped to the
constructor and use getWrapped() to access the instance being wrapped.
| Constructor and Description |
|---|
LifecycleWrapper()
Deprecated.
Use the other constructor taking the implementation being wrapped.
|
LifecycleWrapper(Lifecycle wrapped)
If this lifecycle has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. |
| 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. |
void |
attachWindow(FacesContext context)
Create or restore the |
void |
execute(FacesContext context)
Execute all of the phases of the request processing lifecycle,
up to but not including the Render Response phase,
as described in the Jakarta Server Faces Specification, in the specified
order.
|
PhaseListener[] |
getPhaseListeners()
Return the set of registered
PhaseListeners for this
Lifecycle instance. |
Lifecycle |
getWrapped()
A class that implements this interface uses this method to return an instance of the class being wrapped. |
void |
removePhaseListener(PhaseListener listener)
Deregister an existing
PhaseListener instance that is no
longer interested in being notified before and after the processing
for standard phases of the request processing lifecycle. |
void |
render(FacesContext context)
Execute the Render Response phase of the request
processing lifecycle, unless the
responseComplete()
method has been called on the FacesContext instance
associated with the current request. |
@Deprecated public LifecycleWrapper()
public LifecycleWrapper(Lifecycle wrapped)
If this lifecycle has been decorated,
the implementation doing the decorating should push the implementation being wrapped to this constructor.
The getWrapped() will then return the implementation being wrapped.
wrapped - The implementation being wrapped.public Lifecycle getWrapped()
FacesWrapperA class that implements this interface uses this method to return an instance of the class being wrapped.
getWrapped in interface FacesWrapper<Lifecycle>public void addPhaseListener(PhaseListener listener)
LifecycleRegister a new PhaseListener instance that is interested in
being notified before and after the processing for standard phases of
the request processing lifecycle.
addPhaseListener in class Lifecyclelistener - The PhaseListener to be registeredpublic void execute(FacesContext context) throws FacesException
LifecycleExecute all of the phases of the request processing lifecycle,
up to but not including the Render Response phase,
as described in the Jakarta Server Faces Specification, in the specified
order. The processing flow can be affected (by the application,
by components, or by event listeners) by calls to the
renderResponse() or responseComplete()
methods of the FacesContext instance associated with
the current request.
execute in class Lifecyclecontext - FacesContext for the request to be processedFacesException - if thrown during the execution of the
request processing lifecyclepublic PhaseListener[] getPhaseListeners()
LifecycleReturn the set of registered PhaseListeners for this
Lifecycle instance. If there are no registered listeners,
a zero-length array is returned.
getPhaseListeners in class LifecyclePhaseListenerspublic void removePhaseListener(PhaseListener listener)
LifecycleDeregister an existing PhaseListener instance that is no
longer interested in being notified before and after the processing
for standard phases of the request processing lifecycle. If no such
listener instance has been registered, no action is taken.
removePhaseListener in class Lifecyclelistener - The PhaseListener to be deregisteredpublic void render(FacesContext context) throws FacesException
LifecycleExecute the Render Response phase of the request
processing lifecycle, unless the responseComplete()
method has been called on the FacesContext instance
associated with the current request.
render in class Lifecyclecontext - FacesContext for the request being processedFacesException - if an exception is thrown during the execution
of the request processing lifecyclepublic void attachWindow(FacesContext context)
LifecycleCreate or restore the ClientWindow to be used to display the UIViewRoot for this run through the
lifecycle. See the class documentation for ClientWindow
for an overview of the feature.
If ExternalContext.getClientWindow() returns
null, create a new instance of ClientWindow using the
ClientWindowFactory. If the result is non-null, call
ClientWindow.decode(javax.faces.context.FacesContext) on it.
Store the new ClientWindow by calling
ExternalContext.setClientWindow(javax.faces.lifecycle.ClientWindow).
attachWindow in class Lifecyclecontext - the FacesContext for this request.