org.jboss.portletbridge.bridge.scope

Interface BridgeRequestScope

All Superinterfaces:

ConcurrentMap<String,Object>, Map<String,Object>

public interface BridgeRequestScope
extends ConcurrentMap<String,Object>

BridgeRequestScope is merely the holder of the bridge's request scope state. As such its a Map. Its main abstraction is to provide an id which a scope manager can use to identify this scope and as the gatekeeper of specific attributes that are excluded from the scope.
The BridgeRequestScope's main function is to prevent excluded attributes from being added to itself. The excluded attributes are comprised of those defined by the specification and those set by its client (typically its manager).

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Methods

Modifier and Type	Method and Description
void	addExcludedEntries(List<String> excludedNames) Adds a new List of excluded attribute names to the existing set.
List<String>	getExcludedEntries(List<String> excludedNames)
String	getId()
String	getPortletMode()
String	getPortletName()
String	getSessionId()
String	getViewId()
boolean	isExcluded(String key, Object value) Allows the caller to (pre-determine) if a given attribute name/value pair will be excluded or not.
void	setExcludedEntries(List<String> excludedNames) Sets a new List of excluded attribute names.

Methods inherited from interface java.util.concurrent.ConcurrentMap

putIfAbsent, remove, replace, replace

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

getId

String getId()

Returns:

unique string id representing this scope.

getPortletName

String getPortletName()

Returns:

unique string name representing the portlet to which this scope pertains.

getSessionId

String getSessionId()

Returns:

unique string id representing the session to which this scope pertains.

getViewId

String getViewId()

Returns:

unique string id representing the Faces viewId to which this scope pertains.

getPortletMode

String getPortletMode()

Returns:

unique string id representing the Portlet mode to which this scope pertains.

setExcludedEntries

void setExcludedEntries(List<String> excludedNames)

Sets a new List of excluded attribute names. The names follow the syntax described in the specification. Any currently set attribute names are lost.

Parameters:

excludedNames -

addExcludedEntries

void addExcludedEntries(List<String> excludedNames)

Adds a new List of excluded attribute names to the existing set. Duplicates are ignored. The names follow the syntax described in the specification.

Parameters:

excludedNames -

getExcludedEntries

List<String> getExcludedEntries(List<String> excludedNames)

Parameters:

excludedNames - returns the current list of excluded attribute names

isExcluded

boolean isExcluded(String key,
                 Object value)

Allows the caller to (pre-determine) if a given attribute name/value pair will be excluded or not.

Parameters:

key - name of the attribute

value - of the attribute

Returns:

true if the attribute will be excluded, false otherwise.