|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Generic interface for a portal session. In a component, you can get an EbiSession object from EbiContext.
A session holds cached data that persists between requests.
The session includes a
"whiteboard" that can hold values that a component needs to keep available.
You give each whiteboard value a key (either a one-part or two-part key),
which you use to retrieve the value.
EbiSession is also a cache holder for a session-lifetime managed cache. For information about
the managed cache, see EbiCacheManager
and EbiCacheHolder
.
The context does not persist between requests. When another request occurs, the session becomes part of the new context object and is passed back to the component.
In a portal application, the client session (EbiSession) can be associated with multiple HTTP sessions (EbiHttpSession). Each WAR in the portal application requires a separate HTTP session.
com.sssw.fw.api.EbiHttpSession
,
EbiContext
,
EbiPortalContext
Field Summary | |
static String |
LOCALE
A String specifying text to use for a locale key. |
Method Summary | |
Map |
getCachedValues()
Gets all the cached key/value pairs for the content stored by the cache manager. |
String |
getSessionID()
Gets the session's String identifier. |
Object |
getValue(String key)
Returns a value from the whiteboard. |
void |
removeValue(String key)
Removes a key/value pair from the whiteboard. |
void |
setValue(String key,
Object value)
Sets a value on the whiteboard, binding it to the specified key. |
Field Detail |
public static final String LOCALE
Method Detail |
public String getSessionID()
public Object getValue(String key)
If the value was added using a component key and a content key,
use #getValue(String, String)
instead.
For information about the whiteboard, see EbiContext
.
key
- The key for the object.EbiSession.setValue(String, Object)
public void setValue(String key, Object value)
The whiteboard provides persistent storage for key/value pairs.
For information about the whiteboard, see EbiContext
.
key
- A String specifying the key for the object.value
- The object to be stored in the session's whiteboard.
The object cannot be null.EbiSession.getValue(String)
public void removeValue(String key)
If the value was added using a component key and a content key,
use EbiSession.removeValue(String)
instead.
For information about the whiteboard, see EbiContext
.
key
- The key for the object.public Map getCachedValues()
|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |