com.webmethods.caf.faces.portlet

Class PageFlowScopeStorage

java.lang.Object

com.webmethods.caf.faces.portlet.PageFlowScopeStorage

All Implemented Interfaces:

EventListener, HttpSessionBindingListener

public class PageFlowScopeStorage
extends Object
implements HttpSessionBindingListener

This class implements storage for Page Flow to preserve portlet state.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CHECKED_FLAG
protected Map	m_beans
protected Object	m_lastRequestID
static String	REQUEST_ID_ATTR
static String	REQUEST_KEEP_STATE
static String	REQUEST_RESET_STATE
static String	SESSION_ATTR

Constructor Summary

Constructors

Constructor and Description
PageFlowScopeStorage(FacesContext facesContext) Creates and touches a new storage container.

Method Summary

Modifier and Type	Method and Description
boolean	expire(FacesContext context) Checks if this has expired, and if so, releases this' beans.
Object	getBean(String beanName) Returns the Object stored with the given bean name.
boolean	isExpired(FacesContext facesContext) Determines if this storage container is expired, e.g.
void	release() Releases all beans managed by this storage object.
protected void	release(HttpSessionBindingEvent event)
void	setBean(String beanName, Object bean) Stores the Object with the given bean name.
void	touch(FacesContext facesContext) Touches this storage container.
void	valueBound(HttpSessionBindingEvent event)
void	valueUnbound(HttpSessionBindingEvent event)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SESSION_ATTR

public static final String SESSION_ATTR

REQUEST_ID_ATTR

public static final String REQUEST_ID_ATTR

See Also:

Constant Field Values

REQUEST_KEEP_STATE

public static final String REQUEST_KEEP_STATE

See Also:

Constant Field Values

REQUEST_RESET_STATE

public static final String REQUEST_RESET_STATE

See Also:

Constant Field Values

CHECKED_FLAG

protected static final String CHECKED_FLAG

See Also:

Constant Field Values

m_beans

protected Map m_beans

m_lastRequestID

protected Object m_lastRequestID

Constructor Detail

PageFlowScopeStorage

public PageFlowScopeStorage(FacesContext facesContext)

Creates and touches a new storage container.

Parameters:

facesContext -

Method Detail

getBean

public Object getBean(String beanName)

Returns the Object stored with the given bean name.

Parameters:

beanName - name of the bean

Returns:

the bean

setBean

public void setBean(String beanName,
                    Object bean)

Stores the Object with the given bean name. Replaces if already set.

Parameters:

beanName - name of the bean

bean - name of the bean

isExpired

public boolean isExpired(FacesContext facesContext)

Determines if this storage container is expired, e.g. it has not been used in the last request

Parameters:

facesContext -

Returns:

true if the storage container is expired

touch

public void touch(FacesContext facesContext)

Touches this storage container.

Parameters:

facesContext - Current context

release

public void release()

Releases all beans managed by this storage object.

release

protected void release(HttpSessionBindingEvent event)

expire

public boolean expire(FacesContext context)

Checks if this has expired, and if so, releases this' beans. Ensures that the beans are released only once per request.

Parameters:

context - Current context.

Returns:

true if this method released the beans, false if it didn't.

valueBound

public void valueBound(HttpSessionBindingEvent event)

Specified by:

valueBound in interface HttpSessionBindingListener

valueUnbound

public void valueUnbound(HttpSessionBindingEvent event)

Specified by:

valueUnbound in interface HttpSessionBindingListener