| java.lang.Object
 org.apache.beehive.netui.pageflow.PageFlowManagedObject
org.apache.beehive.netui.pageflow.FacesBackingBean
| FacesBackingBean | | abstract public class FacesBackingBean extends PageFlowManagedObject (Code) | |
A JavaServer Faces backing bean. An instance of this class will be created whenever a corresponding JSF path is
requested (e.g., an instance of foo.MyPage will be created for the webapp-relative path "/foo/MyPage.faces"). The
instance will be released (removed from the user session) when a non-matching path is requested. A faces backing
bean can hold component references and event/command handlers, and it can raise actions with normal JSF command event
handlers that are annotated with
org.apache.beehive.netui.pageflow.annotations.Jpf.CommandHandler @Jpf.CommandHandler .
The bean instance can be bound to with a JSF-style expression like #{backing.myComponent}.
JSF backing beans are configured using the
org.apache.beehive.netui.pageflow.annotations.Jpf.FacesBacking @Jpf.FacesBacking annotation.
|
| Method Summary | |
| public void | ensureFailover(HttpServletRequest request)
Ensures that any changes to this object will be replicated in a cluster (for failover),
even if the replication scheme uses a change-detection algorithm that relies on
HttpSession.setAttribute to be aware of changes. | | public String | getDisplayName()
Get the display name for the bean. | | protected Object | getPageInput(String pageInputName)
Get a page input that was passed from a Page Flow action as an "action output".
Parameters:
pageInputName - the name of the page input. | | public Map | getPageInputMap()
Get the map of all page inputs that was passed from a Page Flow action as "action outputs". | | protected void | onRestore()
Callback that is invoked when this backing bean is restored as the page itself is restored through a
org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward or
org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction with
org.apache.beehive.netui.pageflow.annotations.Jpf.Forward.navigateTo navigateTo =
org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.currentPage Jpf.NavigateTo.currentPage or
org.apache.beehive.netui.pageflow.annotations.Jpf.Forward.navigateTo navigateTo =
org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.currentPage Jpf.NavigateTo.previousPage . | | public void | persistInSession(HttpServletRequest request, HttpServletResponse response)
Store this object in the user session, in the appropriate place. | | public void | reinitialize(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
Reinitialize the bean for a new request. | | public void | removeFromSession(HttpServletRequest request)
Remove this instance from the session. | | public void | restore(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
Restore this bean (set it as the current one from some dormant state). |
| ensureFailover | | public void ensureFailover(HttpServletRequest request)(Code) | | Ensures that any changes to this object will be replicated in a cluster (for failover),
even if the replication scheme uses a change-detection algorithm that relies on
HttpSession.setAttribute to be aware of changes. Note that this method is used by the framework
and does not need to be called explicitly in most cases.
Parameters:
request - the current HttpServletRequest |
| getDisplayName | | public String getDisplayName()(Code) | | Get the display name for the bean. For FacesBackingBeans, this is simply the class name.
|
| getPageInput | | protected Object getPageInput(String pageInputName)(Code) | | Get a page input that was passed from a Page Flow action as an "action output".
Parameters:
pageInputName - the name of the page input. This is the same as the name of the "action output". the value of the page input, or null if the given one does not exist. |
| getPageInputMap | | public Map getPageInputMap()(Code) | | Get the map of all page inputs that was passed from a Page Flow action as "action outputs".
a Map of page-input-name (String) to page-input-value (Object). |
| onRestore | | protected void onRestore()(Code) | | Callback that is invoked when this backing bean is restored as the page itself is restored through a
org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward or
org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction with
org.apache.beehive.netui.pageflow.annotations.Jpf.Forward.navigateTo navigateTo =
org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.currentPage Jpf.NavigateTo.currentPage or
org.apache.beehive.netui.pageflow.annotations.Jpf.Forward.navigateTo navigateTo =
org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.currentPage Jpf.NavigateTo.previousPage .
|
| persistInSession | | public void persistInSession(HttpServletRequest request, HttpServletResponse response)(Code) | | Store this object in the user session, in the appropriate place. Used by the framework; normally should not be
called directly.
|
| restore | | public void restore(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)(Code) | | Restore this bean (set it as the current one from some dormant state). This is a framework-invoked method that
should not normally be called directly.
Parameters:
request - the current HttpServletRequest.
Parameters:
response - the current HttpServletResponse.
Parameters:
servletContext - the current ServletContext. |
|
|