com.webmethods.caf.faces.bean
Class BaseFacesSessionBean

java.lang.Object
  extended by com.webmethods.caf.faces.bean.BaseFacesBean
      extended by com.webmethods.caf.faces.bean.BaseFacesSessionBean
All Implemented Interfaces:
IPageFlowScopeAdapter
Direct Known Subclasses:
BaseFacesPreferencesBean, BaseViewBean, CommentsListProvider, CSPBaseProvider, CSPSessionManager, FunctionalPrivilegeProvider, ProcessDisplayProvider, RepositorySessionManager, TaskAuditDisplayProvider, TaskDisplayProvider

public abstract class BaseFacesSessionBean
extends BaseFacesBean
implements IPageFlowScopeAdapter

Base class for managed beans with session scope. Clients must implement BaseFacesSessionBean.release() method to cleanup all allocated resources when http session gets invalidated.


Field Summary
protected  Boolean fExpireWithPageFlow
          The value of 'expireWithPageFlow' flag from faces-config.
 
Fields inherited from class com.webmethods.caf.faces.bean.BaseFacesBean
DATA_BINDING_CLIENTS, OUTCOME_ERROR, OUTCOME_OK, resourcesProviders
 
Constructor Summary
BaseFacesSessionBean()
          Default constructor
 
Method Summary
 Boolean getExpireWithPageFlow()
          Returns the value of the expireWithPageFlow flag
protected abstract  void release()
          Override this method to release any resources associated with this session.
 void setExpireWithPageFlow(Boolean value)
          Sets the expireWithPageFlow flag.
 void valueBound(HttpSessionBindingEvent event)
          Implementation of the HttpSessionBindingListener.
 void valueUnbound(HttpSessionBindingEvent event)
          Implementation of the HttpSessionBindingListener.
 
Methods inherited from class com.webmethods.caf.faces.bean.BaseFacesBean
createMethodBinding, createValueBinding, error, error, error, error, error, getBean, getFacesContext, getLocale, getResourceInputStream, getResources, getResourcesProvider, getRootCause, getStackTrace, getTreeAttribute, isUserInRole, log, log, log, putTreeAttribute, resetDataBindingClients, resolveDataBinding, resolveDataBinding, resolveExpression, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fExpireWithPageFlow

protected Boolean fExpireWithPageFlow
The value of 'expireWithPageFlow' flag from faces-config.

NOTE: changing this value will have no effect after the managed bean has already been initialized and stored.

Constructor Detail

BaseFacesSessionBean

public BaseFacesSessionBean()
Default constructor

Method Detail

getExpireWithPageFlow

public Boolean getExpireWithPageFlow()
Description copied from interface: IPageFlowScopeAdapter
Returns the value of the expireWithPageFlow flag

Specified by:
getExpireWithPageFlow in interface IPageFlowScopeAdapter
Returns:

setExpireWithPageFlow

public void setExpireWithPageFlow(Boolean value)
Description copied from interface: IPageFlowScopeAdapter
Sets the expireWithPageFlow flag. NOTE: changing this value has no effect if the managed bean has already been initialized and stored.

Specified by:
setExpireWithPageFlow in interface IPageFlowScopeAdapter
Parameters:
value - true or false

release

protected abstract void release()
Override this method to release any resources associated with this session. Please note, the FacesContext is not valid for this function


valueBound

public void valueBound(HttpSessionBindingEvent event)
Implementation of the HttpSessionBindingListener. Does nothing by default.


valueUnbound

public void valueUnbound(HttpSessionBindingEvent event)
Implementation of the HttpSessionBindingListener. Calls BaseFacesSessionBean.release()