org.jboss.portletbridge.bridge.scope

Interface BridgeRequestScopeManager

public interface BridgeRequestScopeManager

The RequestScopeManager manages a set of RequestScopes based on its desired policies. Clients interact with this manager to create and remove request scopes and to lookup (access) a request scope by its key.

Method Summary

Methods

Modifier and Type	Method and Description
BridgeRequestScope	createRequestScope(BridgeContext ctx, String viewId) Create a new empty RequestScope.
BridgeRequestScope	createRequestScope(BridgeContext ctx, String portletName, String sessionId, String viewId, String portletMode) Create a new empty RequestScope.
BridgeRequestScope	getRequestScope(BridgeContext ctx) Returns the BridgeRequestScope corresponding to the portletId, sessionId, viewId and portletMode.
BridgeRequestScope	getRequestScope(BridgeContext ctx, String viewId) Returns the BridgeRequestScope corresponding to the portletId, sessionId, viewId and portletMode.
BridgeRequestScope	getRequestScope(BridgeContext ctx, String viewId, String portletMode) Returns the BridgeRequestScope corresponding to the portletId, sessionId, viewId and portletMode.
BridgeRequestScope	getRequestScope(BridgeContext ctx, String portletName, String sessionId, String viewId, String portletMode) Returns the BridgeRequestScope corresponding to the portletId, sessionId, viewId and portletMode.
BridgeRequestScope	getRequestScopeById(BridgeContext ctx, String id) Returns the BridgeRequestScope corresponding to the supplied key (id)
BridgeRequestScope	removeRequestScope(BridgeContext ctx, BridgeRequestScope scope) Removes the supplied BridgeRequestScope from management.
BridgeRequestScope	removeRequestScope(BridgeContext ctx, String viewId) Removes the request scope pertaining to the portletId, sessionId, viewId and portletMode.
BridgeRequestScope	removeRequestScope(BridgeContext ctx, String viewId, String portletMode) Removes the request scope pertaining to the portletName, sessionId, viewId and portletMode.
BridgeRequestScope	removeRequestScope(BridgeContext ctx, String portletName, String sessionId, String viewId, String portletMode) Removes the request scope pertaining to the portletName, sessionId, viewId and portletMode.
BridgeRequestScope	removeRequestScopeById(BridgeContext ctx, String id) Removes the specific BridgeRequestScope (from management) that corresponds to the supplied key.
void	removeRequestScopesByPortlet(BridgeContext ctx) Removes all the BridgeRequestScope's currently being managed by this manager for the specific portlet that is identified in the PortletConfig object obtainable from the BridgeContext.
void	removeRequestScopesByPortlet(BridgeContext ctx, String portletName) Removes all the BridgeRequestScope's currently being managed by this manager for the specific portlet that is identified portletName.
void	removeRequestScopesBySession(BridgeContext ctx) Removes all the BridgeRequestScope's currently being managed by this manager for the current session.
void	removeRequestScopesBySession(BridgeContext ctx, String sessionId) Removes all the BridgeRequestScope's currently being managed by this manager for the session identified by sessionId.

Method Detail

createRequestScope

BridgeRequestScope createRequestScope(BridgeContext ctx,
                                    String portletName,
                                    String sessionId,
                                    String viewId,
                                    String portletMode)

Create a new empty RequestScope.

Parameters:

ctx -

portletName - name of the portlet to which this scope pertains

sessionId - a unique identifier for the user session in which this scope pertains

viewId - the faces viewId of this scope

portletMode - the mode this scope pertains to

Returns:

the new BridgeRequestScope

createRequestScope

BridgeRequestScope createRequestScope(BridgeContext ctx,
                                    String viewId)

Create a new empty RequestScope. Scope qualifiers portletId, sessionId, and portletMode are taken from the current request object in the BridgeContext.

Parameters:

ctx -

viewId - the faces viewId of this scope

Returns:

the new BridgeRequestScope

getRequestScopeById

BridgeRequestScope getRequestScopeById(BridgeContext ctx,
                                     String id)

Returns the BridgeRequestScope corresponding to the supplied key (id)

Parameters:

ctx -

id - BridgeRequestScope's id

Returns:

the BridgeRequestScope that corresponds to the supplied key or null if no match

getRequestScope

BridgeRequestScope getRequestScope(BridgeContext ctx,
                                 String portletName,
                                 String sessionId,
                                 String viewId,
                                 String portletMode)

Returns the BridgeRequestScope corresponding to the portletId, sessionId, viewId and portletMode.

Parameters:

ctx -

portletName - uniquely identifies this portlet.

sessionId - uniquely identifies a user context (session)

viewId - Faces view to which this scope pertains

portletMode - portlet mode that this scope represents

Returns:

the BridgeRequestScope that corresponds to the supplied key or null if no match

getRequestScope

BridgeRequestScope getRequestScope(BridgeContext ctx,
                                 String viewId,
                                 String portletMode)

Returns the BridgeRequestScope corresponding to the portletId, sessionId, viewId and portletMode. PortletName and sessionId are taken from the current request/portlet config

Parameters:

ctx -

viewId - Faces view to which this scope pertains

portletMode - portlet mode that this scope represents

Returns:

the BridgeRequestScope that corresponds to the supplied key or null if no match

getRequestScope

BridgeRequestScope getRequestScope(BridgeContext ctx,
                                 String viewId)

Returns the BridgeRequestScope corresponding to the portletId, sessionId, viewId and portletMode. PortletName, sessionId, and portletMode are taken from the current request/portlet config

Parameters:

ctx -

viewId - Faces view to which this scope pertains

Returns:

the BridgeRequestScope that corresponds to the supplied key or null if no match

getRequestScope

BridgeRequestScope getRequestScope(BridgeContext ctx)

Returns the BridgeRequestScope corresponding to the portletId, sessionId, viewId and portletMode. PortletName, sessionId, and portletMode and viewId are taken from the current bridge context

Parameters:

ctx -

Returns:

the BridgeRequestScope that corresponds to the supplied key or null if no match

removeRequestScopeById

BridgeRequestScope removeRequestScopeById(BridgeContext ctx,
                                        String id)

Removes the specific BridgeRequestScope (from management) that corresponds to the supplied key.

Parameters:

ctx -

id -

Returns:

the BridgeRequestScope that corresponds to the supplied key.

removeRequestScope

BridgeRequestScope removeRequestScope(BridgeContext ctx,
                                    BridgeRequestScope scope)

Removes the supplied BridgeRequestScope from management.

Parameters:

ctx -

scope -

Returns:

scope that was removed or null -- if scope not in the repository. (Note: scope is cleared before being returned)

removeRequestScope

BridgeRequestScope removeRequestScope(BridgeContext ctx,
                                    String portletName,
                                    String sessionId,
                                    String viewId,
                                    String portletMode)

Removes the request scope pertaining to the portletName, sessionId, viewId and portletMode. This operation is a noop if a match is not found.

Parameters:

ctx -

portletName - uniquely identifies this portlet.

sessionId - uniquely identifies a user context (session)

viewId - Faces view to which this scope pertains

portletMode - portlet mode that this scope represents

Returns:

scope that was removed or null. (Note: scope is cleared before being returned)

removeRequestScope

BridgeRequestScope removeRequestScope(BridgeContext ctx,
                                    String viewId,
                                    String portletMode)

Removes the request scope pertaining to the portletName, sessionId, viewId and portletMode. Portletname and sessionId are taken from the current request/portlet config This operation is a noop if a match is not found.

Parameters:

ctx -

viewId - Faces view to which this scope pertains

portletMode - portlet mode that this scope represents

Returns:

scope that was removed or null. (Note: scope is cleared before being returned)

removeRequestScope

BridgeRequestScope removeRequestScope(BridgeContext ctx,
                                    String viewId)

Removes the request scope pertaining to the portletId, sessionId, viewId and portletMode. PortletName, sessionId, and portletMode are taken from the current request/portlet config This operation is a noop if a match is not found.

Parameters:

ctx -

viewId - Faces view to which this scope pertains

Returns:

scope that was removed or null. (Note: scope is cleared before being returned)

removeRequestScopesByPortlet

void removeRequestScopesByPortlet(BridgeContext ctx,
                                String portletName)

Removes all the BridgeRequestScope's currently being managed by this manager for the specific portlet that is identified portletName.

Parameters:

ctx -

removeRequestScopesByPortlet

void removeRequestScopesByPortlet(BridgeContext ctx)

Removes all the BridgeRequestScope's currently being managed by this manager for the specific portlet that is identified in the PortletConfig object obtainable from the BridgeContext.

Parameters:

ctx -

removeRequestScopesBySession

void removeRequestScopesBySession(BridgeContext ctx,
                                String sessionId)

Removes all the BridgeRequestScope's currently being managed by this manager for the session identified by sessionId.

Parameters:

ctx -

removeRequestScopesBySession

void removeRequestScopesBySession(BridgeContext ctx)

Removes all the BridgeRequestScope's currently being managed by this manager for the current session.

Parameters:

ctx -