org.portletfaces.bridge.scope
Interface BridgeRequestScopeManager

public interface BridgeRequestScopeManager

This interface defines a contract for managing a cache of BridgeRequestScope instances.

Author:

Neil Griffin

Method Summary

BridgeRequestScope	getBridgeRequestScope(BridgeContext bridgeContext) Either returns an existing BridgeRequestScope associated with the specified FacesContext from the underlying cache or returns a new one.
void	removeBridgeRequestScope(BridgeRequestScope bridgeRequestScope, BridgeContext bridgeContext) Removes the specified BridgeRequestScope associated with the specified FacesContext from the underlying cache.
void	removeBridgeRequestScopesByPortlet(BridgeContext bridgeContext) Removes all BridgeRequestScope instances that are associated with the specified FacesContext.
void	removeBridgeRequestScopesBySession(javax.servlet.http.HttpSession httpSession) Removes all of the BridgeRequestScope instances from the underlying cache that are associated with the specified HttpSession.

Method Detail

removeBridgeRequestScope

void removeBridgeRequestScope(BridgeRequestScope bridgeRequestScope,
                              BridgeContext bridgeContext)

Removes the specified BridgeRequestScope associated with the specified FacesContext from the underlying cache. This method should be called if an exception occurs that somehow invalidates the BridgeRequestScope.

Parameters:

bridgeRequestScope - The BridgeRequestScope that is to be removed.

bridgeContext - The current BridgeContext.

removeBridgeRequestScopesByPortlet

void removeBridgeRequestScopesByPortlet(BridgeContext bridgeContext)

Removes all BridgeRequestScope instances that are associated with the specified FacesContext. This should be called if the portlet container unloads an portlet individually.

Parameters:

bridgeContext - The current BridgeContext.

removeBridgeRequestScopesBySession

void removeBridgeRequestScopesBySession(javax.servlet.http.HttpSession httpSession)

Removes all of the BridgeRequestScope instances from the underlying cache that are associated with the specified HttpSession. This method is meant to be called from a HttpSessionListener when a session is invalidated or expires.

Parameters:

httpSession - The current HttpSession.

getBridgeRequestScope

BridgeRequestScope getBridgeRequestScope(BridgeContext bridgeContext)

Either returns an existing BridgeRequestScope associated with the specified FacesContext from the underlying cache or returns a new one.

Parameters:

bridgeContext - The current BridgeContext.