com.sun.jsfcl.app
Class FacesBean

java.lang.Object
  extended by com.sun.jsfcl.app.FacesBean
All Implemented Interfaces:
java.io.Serializable, java.util.EventListener, javax.faces.event.PhaseListener
Direct Known Subclasses:
AbstractApplicationBean, AbstractPageBean, AbstractRequestBean, AbstractSessionBean

public abstract class FacesBean
extends java.lang.Object
implements javax.faces.event.PhaseListener

FacesBean is the abstract base class for all page beans, session scope data beans, and application scope data beans that wish to participate in the request processing lifecycle. Concrete subclasses of this class will typically be registered as managed beans, so that they get created on demand (and added to the relevant scope's attributes).

See Also:
Serialized Form

Constructor Summary
FacesBean()
           
 
Method Summary
protected  void afterApplyRequestValues()
           
protected  void afterInvokeApplication()
           
 void afterPhase(javax.faces.event.PhaseEvent phaseEvent)
          Call through to the "after" lifecycle callback method for the current phase.
protected  void afterProcessValidations()
           
protected  void afterRenderResponse()
           
protected  void afterRestoreView()
           
protected  void afterUpdateModelValues()
           
protected  void beforeApplyRequestValues()
           
protected  void beforeInvokeApplication()
           
 void beforePhase(javax.faces.event.PhaseEvent phaseEvent)
          Call through to the "before" lifecycle callback method for the current phase.
protected  void beforeProcessValidations()
           
protected  void beforeRenderResponse()
           
protected  void beforeRestoreView()
           
protected  void beforeUpdateModelValues()
           
protected  void erase()
          Erase previously submitted values for all input components on this page.
protected  void error(java.lang.String summary)
          Enqueue a global FacesMessage (not associated with any particular componen) containing the specified summary text and a message severity level of FacesMessage.SEVERITY_ERROR.
protected  void error(javax.faces.component.UIComponent component, java.lang.String summary)
          Enqueue a FacesMessage associated with the specified component, containing the specified summary text and a message severity level of FacesMessage.SEVERITY_ERROR.
protected  void fatal(java.lang.String summary)
          Enqueue a global FacesMessage (not associated with any particular componen) containing the specified summary text and a message severity level of FacesMessage.SEVERITY_FATAL.
protected  void fatal(javax.faces.component.UIComponent component, java.lang.String summary)
          Enqueue a FacesMessage associated with the specified component, containing the specified summary text and a message severity level of FacesMessage.SEVERITY_FATAL.
protected  javax.faces.application.Application getApplication()
          Return the Application instance for the current web application.
protected  java.util.Map getApplicationMap()
          Return a Map of the application scope attributes for this web application.
protected  java.lang.Object getBean(java.lang.String name)
          Return any attribute stored in request scope, session scope, or application scope under the specified name.
protected  javax.faces.context.FacesContext getContext()
          Return the FacesContext instance for the current request.
protected  javax.faces.context.ExternalContext getExternalContext()
          Return the ExternalContext instance for the current request.
protected  javax.faces.context.FacesContext getFacesContext()
          Return the FacesContext instance for the current request.
protected  javax.faces.lifecycle.Lifecycle getLifecycle()
          Return the configured Lifecycle instance for the current web application.
 javax.faces.event.PhaseId getPhaseId()
          Return PhaseId.ANY_PHASE to indicate that we are interested in all phases.
protected  java.util.Map getRequestMap()
          Return a Map of the request scope attributes for the current request.
protected  java.util.Map getSessionMap()
          Return a Map of the session scope attributes for the current user's session.
protected  java.lang.Object getValue(java.lang.String expr)
          Evaluate the specified value binding expression, and return the value that it points at.
protected  void info(java.lang.String summary)
          Enqueue a global FacesMessage (not associated with any particular componen) containing the specified summary text and a message severity level of FacesMessage.SEVERITY_INFO.
protected  void info(javax.faces.component.UIComponent component, java.lang.String summary)
          Enqueue a FacesMessage associated with the specified component, containing the specified summary text and a message severity level of FacesMessage.SEVERITY_INFO.
protected  boolean isPostBack()
          Return true if the current request was a post back for an existing view, rather than the creation of a new view.
protected  void log(java.lang.String message)
          Log the specified message to the container's log file.
protected  void log(java.lang.String message, java.lang.Throwable throwable)
          Log the specified message and exception to the container's log file.
protected  void renderResponse()
          Skip any remaining request processing lifecycle phases for the current request, and go immediately to Render Response phase.
protected  void setBean(java.lang.String name, java.lang.Object value)
          Replace the value of any attribute stored in request scope, session scope, or application scope under the specified name.
protected  void setValue(java.lang.String expr, java.lang.Object value)
          Evaluate the specified value binding expression, and update the value that it points at.
protected  void warn(java.lang.String summary)
          Enqueue a global FacesMessage (not associated with any particular componen) containing the specified summary text and a message severity level of FacesMessage.SEVERITY_WARN.
protected  void warn(javax.faces.component.UIComponent component, java.lang.String summary)
          Enqueue a FacesMessage associated with the specified component, containing the specified summary text and a message severity level of FacesMessage.SEVERITY_WARN.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FacesBean

public FacesBean()
Method Detail

getApplication

protected javax.faces.application.Application getApplication()

Return the Application instance for the current web application.


getApplicationMap

protected java.util.Map getApplicationMap()

Return a Map of the application scope attributes for this web application.


getContext

protected javax.faces.context.FacesContext getContext()

Return the FacesContext instance for the current request. This method has been restored for backwards compatibilty.


getExternalContext

protected javax.faces.context.ExternalContext getExternalContext()

Return the ExternalContext instance for the current request.


getFacesContext

protected javax.faces.context.FacesContext getFacesContext()

Return the FacesContext instance for the current request.


getLifecycle

protected javax.faces.lifecycle.Lifecycle getLifecycle()

Return the configured Lifecycle instance for the current web application.


getRequestMap

protected java.util.Map getRequestMap()

Return a Map of the request scope attributes for the current request.


getSessionMap

protected java.util.Map getSessionMap()

Return a Map of the session scope attributes for the current user's session. Note that calling this method will cause a session to be created if there is not already one associated with this request.


getBean

protected java.lang.Object getBean(java.lang.String name)

Return any attribute stored in request scope, session scope, or application scope under the specified name. If no such attribute is found, and if this name is the registered name of a managed bean, cause a new instance of this managed bean to be created (and stored in an appropriate scope, if necessary) and returned. If no attribute exists, and no managed bean was created, return null.

Parameters:
name - Name of the attribute to be retrieved

setBean

protected void setBean(java.lang.String name,
                       java.lang.Object value)

Replace the value of any attribute stored in request scope, session scope, or application scope under the specified name. If there is no such attribute, create a new request scope attribute under this name, and store the value there.


getValue

protected java.lang.Object getValue(java.lang.String expr)

Evaluate the specified value binding expression, and return the value that it points at.

Parameters:
expr - Value binding expression (including delimiters)

setValue

protected void setValue(java.lang.String expr,
                        java.lang.Object value)

Evaluate the specified value binding expression, and update the value that it points at.

Parameters:
expr - Value binding expression (including delimiters) that must point at a writeable property
value - New value for the property pointed at by expr

beforePhase

public void beforePhase(javax.faces.event.PhaseEvent phaseEvent)

Call through to the "before" lifecycle callback method for the current phase.

Specified by:
beforePhase in interface javax.faces.event.PhaseListener
Parameters:
phaseEvent - PhaseEvent to be processed

afterPhase

public void afterPhase(javax.faces.event.PhaseEvent phaseEvent)

Call through to the "after" lifecycle callback method for the current phase.

Specified by:
afterPhase in interface javax.faces.event.PhaseListener
Parameters:
phaseEvent - PhaseEvent to be processed

getPhaseId

public javax.faces.event.PhaseId getPhaseId()

Return PhaseId.ANY_PHASE to indicate that we are interested in all phases.

Specified by:
getPhaseId in interface javax.faces.event.PhaseListener

beforeRestoreView

protected void beforeRestoreView()

afterRestoreView

protected void afterRestoreView()

beforeApplyRequestValues

protected void beforeApplyRequestValues()

afterApplyRequestValues

protected void afterApplyRequestValues()

beforeProcessValidations

protected void beforeProcessValidations()

afterProcessValidations

protected void afterProcessValidations()

beforeUpdateModelValues

protected void beforeUpdateModelValues()

afterUpdateModelValues

protected void afterUpdateModelValues()

beforeInvokeApplication

protected void beforeInvokeApplication()

afterInvokeApplication

protected void afterInvokeApplication()

beforeRenderResponse

protected void beforeRenderResponse()

afterRenderResponse

protected void afterRenderResponse()

isPostBack

protected boolean isPostBack()

Return true if the current request was a post back for an existing view, rather than the creation of a new view. The result of this method may be used to conditionally execute one time setup that is only required when a page is first displayed.


renderResponse

protected void renderResponse()

Skip any remaining request processing lifecycle phases for the current request, and go immediately to Render Response phase. This method is typically invoked when you want to throw away input values provided by the user, instead of processing them.


erase

protected void erase()

Erase previously submitted values for all input components on this page. This method MUST be called if you have bound input components to database columns, and then arbitrarily navigate the underlying RowSet to a different row in an event handler method.


log

protected void log(java.lang.String message)

Log the specified message to the container's log file.

Parameters:
message - Message to be logged

log

protected void log(java.lang.String message,
                   java.lang.Throwable throwable)

Log the specified message and exception to the container's log file.

Parameters:
message - Message to be logged
throwable - Exception to be logged

info

protected void info(java.lang.String summary)

Enqueue a global FacesMessage (not associated with any particular componen) containing the specified summary text and a message severity level of FacesMessage.SEVERITY_INFO.

Parameters:
summary - Summary text for this message

info

protected void info(javax.faces.component.UIComponent component,
                    java.lang.String summary)

Enqueue a FacesMessage associated with the specified component, containing the specified summary text and a message severity level of FacesMessage.SEVERITY_INFO.

Parameters:
component - Component with which this message is associated
summary - Summary text for this message

warn

protected void warn(java.lang.String summary)

Enqueue a global FacesMessage (not associated with any particular componen) containing the specified summary text and a message severity level of FacesMessage.SEVERITY_WARN.

Parameters:
summary - Summary text for this message

warn

protected void warn(javax.faces.component.UIComponent component,
                    java.lang.String summary)

Enqueue a FacesMessage associated with the specified component, containing the specified summary text and a message severity level of FacesMessage.SEVERITY_WARN.

Parameters:
component - Component with which this message is associated
summary - Summary text for this message

error

protected void error(java.lang.String summary)

Enqueue a global FacesMessage (not associated with any particular componen) containing the specified summary text and a message severity level of FacesMessage.SEVERITY_ERROR.

Parameters:
summary - Summary text for this message

error

protected void error(javax.faces.component.UIComponent component,
                     java.lang.String summary)

Enqueue a FacesMessage associated with the specified component, containing the specified summary text and a message severity level of FacesMessage.SEVERITY_ERROR.

Parameters:
component - Component with which this message is associated
summary - Summary text for this message

fatal

protected void fatal(java.lang.String summary)

Enqueue a global FacesMessage (not associated with any particular componen) containing the specified summary text and a message severity level of FacesMessage.SEVERITY_FATAL.

Parameters:
summary - Summary text for this message

fatal

protected void fatal(javax.faces.component.UIComponent component,
                     java.lang.String summary)

Enqueue a FacesMessage associated with the specified component, containing the specified summary text and a message severity level of FacesMessage.SEVERITY_FATAL.

Parameters:
component - Component with which this message is associated
summary - Summary text for this message