Save This Page
Home » apache-tomcat-6.0.16-src » org.apache » catalina » session » [javadoc | source]
org.apache.catalina.session
abstract public class: StoreBase [javadoc | source]
java.lang.Object
   org.apache.catalina.session.StoreBase

All Implemented Interfaces:
    Store, Lifecycle

Direct Known Subclasses:
    JDBCStore, FileStore

Abstract implementation of the Store interface to support most of the functionality required by a Store.
Field Summary
protected static  String info    The descriptive information about this implementation. 
protected static  String storeName    Name to register for this Store, used for logging. 
protected  boolean started    Has this component been started yet? 
protected  LifecycleSupport lifecycle    The lifecycle event support for this component. 
protected  PropertyChangeSupport support    The property change support for this component. 
protected  StringManager sm    The string manager for this package. 
protected  Manager manager    The Manager with which this JDBCStore is associated. 
Method from org.apache.catalina.session.StoreBase Summary:
addLifecycleListener,   addPropertyChangeListener,   findLifecycleListeners,   getInfo,   getManager,   getStoreName,   processExpires,   removeLifecycleListener,   removePropertyChangeListener,   setManager,   start,   stop
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.catalina.session.StoreBase Detail:
 public  void addLifecycleListener(LifecycleListener listener) 
    Add a lifecycle event listener to this component.
 public  void addPropertyChangeListener(PropertyChangeListener listener) 
    Add a property change listener to this component.
 public LifecycleListener[] findLifecycleListeners() 
    Get the lifecycle listeners associated with this lifecycle. If this Lifecycle has no listeners registered, a zero-length array is returned.
 public String getInfo() 
    Return the info for this Store.
 public Manager getManager() 
    Return the Manager with which the Store is associated.
 public String getStoreName() 
    Return the name for this Store, used for logging.
 public  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.
 public  void removeLifecycleListener(LifecycleListener listener) 
    Remove a lifecycle event listener from this component.
 public  void removePropertyChangeListener(PropertyChangeListener listener) 
    Remove a property change listener from this component.
 public  void setManager(Manager manager) 
    Set the Manager with which this Store is associated.
 public  void start() throws LifecycleException 
    Prepare for the beginning of active use of the public methods of this component. This method should be called after configure(), and before any of the public methods of the component are utilized.
 public  void stop() throws LifecycleException 
    Gracefully terminate the active use of the public methods of this component. This method should be the last one called on a given instance of this component.