Package org.apache.catalina.session
Class StoreBase
- java.lang.Object
- 
- org.apache.catalina.util.LifecycleBase
- 
- org.apache.catalina.session.StoreBase
 
 
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from interface org.apache.catalina.LifecycleLifecycle.SingleUse
 
- 
 - 
Field SummaryFields Modifier and Type Field Description protected ManagermanagerThe Manager with which this Store is associated.protected static StringManagersmThe string manager for this package.protected static java.lang.StringstoreNameName to register for this Store, used for logging.protected java.beans.PropertyChangeSupportsupportThe property change support for this component.- 
Fields inherited from interface org.apache.catalina.LifecycleAFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
 
- 
 - 
Constructor SummaryConstructors Constructor Description StoreBase()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddPropertyChangeListener(java.beans.PropertyChangeListener listener)Add a property change listener to this component.protected voiddestroyInternal()Sub-classes implement this method to perform any instance destruction required.java.lang.String[]expiredKeys()Get only those keys of sessions, that are saved in the Store and are to be expired.ManagergetManager()protected java.io.ObjectInputStreamgetObjectInputStream(java.io.InputStream is)Create the object input stream to use to read a session from the store.java.lang.StringgetStoreName()protected voidinitInternal()Sub-classes implement this method to perform any instance initialisation required.voidprocessExpires()Called by our background reaper thread to check if Sessions saved in our store are subject of being expired.voidremovePropertyChangeListener(java.beans.PropertyChangeListener listener)Remove a property change listener from this component.voidsetManager(Manager manager)Set the Manager with which this Store is associated.protected voidstartInternal()Start this component and implement the requirements ofLifecycleBase.startInternal().protected voidstopInternal()Stop this component and implement the requirements ofLifecycleBase.stopInternal().java.lang.StringtoString()- 
Methods inherited from class org.apache.catalina.util.LifecycleBaseaddLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop
 
- 
 
- 
- 
- 
Field Detail- 
storeNameprotected static final java.lang.String storeName Name to register for this Store, used for logging.- See Also:
- Constant Field Values
 
 - 
supportprotected final java.beans.PropertyChangeSupport support The property change support for this component.
 - 
smprotected static final StringManager sm The string manager for this package.
 - 
managerprotected Manager manager The Manager with which this Store is associated.
 
- 
 - 
Method Detail- 
getStoreNamepublic java.lang.String getStoreName() - Returns:
- the name for this Store, used for logging.
 
 - 
setManagerpublic void setManager(Manager manager) Set the Manager with which this Store is associated.- Specified by:
- setManagerin interface- Store
- Parameters:
- manager- The newly associated Manager
 
 - 
getManagerpublic Manager getManager() - Specified by:
- getManagerin interface- Store
- Returns:
- the Manager with which the Store is associated.
 
 - 
addPropertyChangeListenerpublic void addPropertyChangeListener(java.beans.PropertyChangeListener listener) Add a property change listener to this component.- Specified by:
- addPropertyChangeListenerin interface- Store
- Parameters:
- listener- a value of type- PropertyChangeListener
 
 - 
removePropertyChangeListenerpublic void removePropertyChangeListener(java.beans.PropertyChangeListener listener) Remove a property change listener from this component.- Specified by:
- removePropertyChangeListenerin interface- Store
- Parameters:
- listener- The listener to remove
 
 - 
expiredKeyspublic java.lang.String[] expiredKeys() throws java.io.IOExceptionGet only those keys of sessions, that are saved in the Store and are to be expired.- Returns:
- list of session keys, that are to be expired
- Throws:
- java.io.IOException- if an input-/output error occurred
 
 - 
processExpirespublic void processExpires() Called by our background reaper thread to check if Sessions saved in our store are subject of being expired. If so expire the Session and remove it from the Store.
 - 
getObjectInputStreamprotected java.io.ObjectInputStream getObjectInputStream(java.io.InputStream is) throws java.io.IOExceptionCreate the object input stream to use to read a session from the store. Sub-classes must have set the thread context class loader before calling this method.- Parameters:
- is- The input stream provided by the sub-class that will provide the data for a session
- Returns:
- An appropriately configured ObjectInputStream from which the session can be read.
- Throws:
- java.io.IOException- if a problem occurs creating the ObjectInputStream
 
 - 
initInternalprotected void initInternal() Description copied from class:LifecycleBaseSub-classes implement this method to perform any instance initialisation required.- Specified by:
- initInternalin class- LifecycleBase
 
 - 
startInternalprotected void startInternal() throws LifecycleExceptionStart this component and implement the requirements ofLifecycleBase.startInternal().- Specified by:
- startInternalin class- LifecycleBase
- Throws:
- LifecycleException- if this component detects a fatal error that prevents this component from being used
 
 - 
stopInternalprotected void stopInternal() throws LifecycleExceptionStop this component and implement the requirements ofLifecycleBase.stopInternal().- Specified by:
- stopInternalin class- LifecycleBase
- Throws:
- LifecycleException- if this component detects a fatal error that prevents this component from being used
 
 - 
destroyInternalprotected void destroyInternal() Description copied from class:LifecycleBaseSub-classes implement this method to perform any instance destruction required.- Specified by:
- destroyInternalin class- LifecycleBase
 
 - 
toStringpublic java.lang.String toString() - Overrides:
- toStringin class- java.lang.Object
- Returns:
- a String rendering of this object.
 
 
- 
 
-