Constructor Detail

SessionScope

Create a new SessionScope, storing attributes in a locally
isolated session (or default session, if there is no distinction
between a global session and a component-specific session).

SessionScope

public SessionScope(boolean globalSession)

Create a new SessionScope, specifying whether to store attributes
in the global session, provided that such a distinction is available.

This distinction is important for Portlet environments, where there
are two notions of a session: "portlet scope" and "application scope".
If this flag is on, objects will be put into the "application scope" session;
else they will end up in the "portlet scope" session (the typical default).

In a Servlet environment, this flag is effectively ignored.

Parameters:

globalSession - true in case of the global session as target;
false in case of a component-specific session as target

getConversationId

The exact meaning of the conversation ID depends on the underlying
storage mechanism. In the case of session-scoped objects, the
conversation ID would typically be equal to (or derived from) the
session ID; in the
case of a custom conversation that sits within the overall session,
the specific ID for the current conversation would be appropriate.

Note: This is an optional operation. It is perfectly valid to
return null in an implementation of this method if the
underlying storage mechanism has no obvious candidate for such an ID.

Returns:

the conversation ID, or null if there is no
conversation ID for the current scope

remove

Returns null if no object was found; otherwise
returns the removed Object.

Note that an implementation should also remove a registered destruction
callback for the specified object, if any. It does, however, not
need to execute a registered destruction callback in this case,
since the object will be destroyed by the caller (if appropriate).

Note: This is an optional operation. Implementations may throw
UnsupportedOperationException if they do not support explicitly
removing an object.