|
EAF 7.4 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StandardSessionHome
StandardSessionManager uses StandardSessionHome to manage a collection of sessions. StandardSessionHome acts both as a session factory and as a session repository. The session manager gains access to instances of sessions via the home (StandardSessionHome) interface. The session manager dynamically loads the home interface. The implementation of the home interface that is loaded is specified in the applications configuration file:
SessionHome.Class: {class name}
StandardSession
,
StandardSessionManager
,
BasicSessionHome
,
PagedSessionHome
,
com.lutris.appserver.server.sessionEnhydra.persistent.PersistentSessionHome
Method Summary | |
---|---|
boolean |
containsKey(java.lang.String sessionKey)
Specifies if a key is currently bound to a session. |
StandardSession |
createSession(java.lang.String sessionKey)
Creates and returns a new session instance. |
StandardSession |
getSession(java.lang.String sessionKey)
Returns the session bound to the session key. |
StandardSession |
getSession(java.lang.Thread thread,
java.lang.String sessionKey)
Returns the session bound to the specified session key. |
java.util.Enumeration |
keys()
Returns an enumeration of the keys for all the sessions. |
int |
pagedSize()
Returns the current number of sessions that are paged to persistent store. |
void |
passivateSession(java.lang.Thread thread,
java.lang.String sessionKey)
Puts a session into the 'passive' state. |
void |
removeSession(java.lang.String sessionKey)
Removes a session from the cache. |
void |
shutdown()
Shuts dows the session home. |
int |
size()
Returns the current number of sessions. |
Method Detail |
---|
StandardSession createSession(java.lang.String sessionKey) throws CreateSessionException, DuplicateKeyException, SessionException
sessionKey
- the key to associate with the session.
CreateSessionException
- if the session cannot be
created.
DuplicateKeyException
- if the session cannot
be created because the key is already in use.
SessionException
- if the session cannot
be created for some other reason.passivateSession(java.lang.Thread, java.lang.String)
StandardSession getSession(java.lang.String sessionKey) throws SessionException
sessionKey
- the session key for the session. If the session
doesn't exist or is not is not bound to the current
thread then null is returned.
SessionException
- if the session cannot be retrieved.getSession(Thread, String)
StandardSession getSession(java.lang.Thread thread, java.lang.String sessionKey) throws SessionException
thread
- the thread that should be associated with
the session while it is in the active state. Only this
thread can put the session back into the passive state.sessionKey
- the session key for the session that will be made
'active' and returned. If the session doesn't exist
then null is returned.
SessionException
- if the session cannot be retrieved.passivateSession(java.lang.Thread, java.lang.String)
void removeSession(java.lang.String sessionKey) throws SessionException
sessionKey
- the session key associated with the session.
SessionException
- if the session cannot be retrieved.void passivateSession(java.lang.Thread thread, java.lang.String sessionKey) throws SessionException
thread
- the thread that is currently associated
with the session.sessionKey
- the session key for the session that will be made passive.
SessionException
- if the session cannot be retrieved.boolean containsKey(java.lang.String sessionKey) throws SessionException
sessionKey
- the session key to be tested.
SessionException
- if the existence of the key cannot be determined.int size() throws SessionException
SessionException
- if the size cannot be determinedint pagedSize() throws SessionException
SessionException
- if the size cannot be determinedjava.util.Enumeration keys() throws SessionException
SessionException
- if the session enumeration cannot be retrieved.void shutdown()
|
EAF 7.4 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |