|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISessionManager
Interface defines the majority of the functionality outlined in the requirements. Code built against this interface can be jumped. An implementation will be written for both Java and C#. The implementation will be hidden from developers.
Method Summary | |
---|---|
void |
Abandon()
Abandon this session at the end of this request so that the Java/.NET session can be reclaimed by the server. |
void |
Clear()
Remove all the elements in this session manager. |
boolean |
ContainsSubSession(java.lang.String key)
Check if a subsession is already in the subsession table (i.e. |
java.lang.Object |
GetAttribute(java.lang.String key)
Get an Attribute from this SessionManager. |
IXPEnumerator |
GetKeys()
A String[] of all the keys contained in the session manager. |
int |
GetMaxCount()
Get the max number of objects that can be placed on this session. |
int |
GetMaxInactiveInterval()
Have this session manager timeout objects after x number of seconds. |
java.lang.Object |
GetMostRecentlyAccessedObject()
Get the most recently accessed Object (by set or get). |
ISessionManager |
GetSubSession(java.lang.String key)
Get a sub session. |
long |
GetTimeStamp(java.lang.String key)
Get the timestamp of an Attribute from this SessionManager. |
boolean |
IsAbandoned()
Check if the underlying Java/.NET session will be abandoned at the end of this request. |
boolean |
IsNewSession()
Check if the session is created from the factory. |
void |
RemoveAttribute(java.lang.String key)
Remove an attribute from the session manager. |
void |
RemoveSubSession(java.lang.String subSessionName)
Remove a sub session from this session manager. |
java.lang.String |
SetAttribute(java.lang.Object value)
Place an object on the session. |
void |
SetAttribute(java.lang.String key,
java.lang.Object value)
Place an object on the session based on a key. |
void |
SetAttribute(java.lang.String key,
java.lang.Object value,
ICacheUpdateListener callback,
int updateInterval)
Set an attribute with a callback. |
void |
SetMaxCount(int maxCount)
Set the max number of objects that can be placed into this session. |
void |
SetMaxInactiveInterval(int timeOut)
Have this session manager timeout objects after x number of seconds. |
Method Detail |
---|
void Clear()
boolean ContainsSubSession(java.lang.String key)
key
- The key which the subsession is under.
java.lang.Object GetAttribute(java.lang.String key)
key
- Key to look up the value to return.
SetAttribute
IXPEnumerator GetKeys()
int GetMaxCount()
SetMaxCount
int GetMaxInactiveInterval()
SetMaxInactiveInterval
java.lang.Object GetMostRecentlyAccessedObject()
ISessionManager GetSubSession(java.lang.String key)
key
- The key which the subsession is under.
long GetTimeStamp(java.lang.String key)
key
- Key to look up the value to return.
boolean IsNewSession()
void RemoveAttribute(java.lang.String key)
key
- The key to remove.void RemoveSubSession(java.lang.String subSessionName)
subSessionName
- java.lang.String SetAttribute(java.lang.Object value)
value
- The value interested in storing on the session.
void SetAttribute(java.lang.String key, java.lang.Object value)
key
- The key to place the value under.value
- The value interested in storing on the session.void SetAttribute(java.lang.String key, java.lang.Object value, ICacheUpdateListener callback, int updateInterval)
key
- Key on the sessionvalue
- The value to place on the session.callback
- Object to call back when time has elapsed.updateInterval
- Time in seconds before calling the callback.void SetMaxCount(int maxCount)
maxCount
- The max number of objects this session can hold.void SetMaxInactiveInterval(int timeOut)
timeOut
- Timeout in seconds.GetMaxInactiveInterval
void Abandon()
boolean IsAbandoned()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |