Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> lutris >> appserver >> server >> [ session overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.lutris.appserver.server.session
Interface StandardSessionHome  

All Known Implementing Classes:

BasicSessionHome, PagedSessionHome

---

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}

StandardSessionHome manages the state of a session. A session exists in either of two states: 'active' or 'passive'. An 'active' session is one that is actively being referenced by a thread of execution (request). A 'passive' session is one that is not currently associated with any request (thread). A session in the 'passive' state may be written to persistent store until it becomes 'active'. When a session becomes active, if it isn't in memory then it can be read from persistent store.

Version:

$Revision: 1.3.14.1 $

---

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

createSession

public StandardSession createSession(java.lang.String sessionKey)
                              throws CreateSessionException,
                                     DuplicateKeyException,
                                     SessionException

Creates and returns a new session instance. The session is bound to the specified session key. The session is also associated with the current thread and is considered in the 'active' state. The session remains in the 'active' state until the thread puts the session into the 'passive' state.. Only this thread will be able to put the session into the 'passive' state.

---

getSession

public StandardSession getSession(java.lang.String sessionKey)
                           throws SessionException

Returns the session bound to the session key. The session must already be in the 'active' state and associated with the current thread, otherwise null is returned.

---

getSession

public StandardSession getSession(java.lang.Thread thread,
                                  java.lang.String sessionKey)
                           throws SessionException

Returns the session bound to the specified session key. The session is put into the 'active' state. The session is also associated with the specified thread. Only this thread will be able to put the session back into the 'passive' state once it is done with the session.

---

removeSession

public void removeSession(java.lang.String sessionKey)
                   throws SessionException

Removes a session from the cache. If the session doesn't exist the opration is ignored.

---

passivateSession

public void passivateSession(java.lang.Thread thread,
                             java.lang.String sessionKey)
                      throws SessionException

Puts a session into the 'passive' state. A 'passive' session may be made persistent. Only the thread that put the session into the 'active' state may put the session into the 'passive' state.

---

containsKey

public boolean containsKey(java.lang.String sessionKey)
                    throws SessionException

Specifies if a key is currently bound to a session.

---

size

public int size()
         throws SessionException

Returns the current number of sessions.

---

pagedSize

public int pagedSize()
              throws SessionException

Returns the current number of sessions that are paged to persistent store.

---

keys

public java.util.Enumeration keys()
                           throws SessionException

Returns an enumeration of the keys for all the sessions.

---

shutdown

public void shutdown()

Shuts dows the session home.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> lutris >> appserver >> server >> [ session overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---