org.apache.catalina.session
Class StoreBase
java.lang.Object
org.apache.catalina.session.StoreBase
- Lifecycle, Store
public abstract class StoreBase
extends java.lang.Object
Abstract implementation of the Store interface to
support most of the functionality required by a Store.
Version:
- Bip Thelin
protected int | debug - The debugging detail level for this component.
|
protected static String | info - The descriptive information about this implementation.
|
protected LifecycleSupport | lifecycle - The lifecycle event support for this component.
|
protected Manager | manager - The Manager with which this JDBCStore is associated.
|
protected StringManager | sm - The string manager for this package.
|
protected boolean | started - Has this component been started yet?
|
protected static String | storeName - Name to register for this Store, used for logging.
|
protected PropertyChangeSupport | support - The property change support for this component.
|
void | addLifecycleListener(LifecycleListener listener) - Add a lifecycle event listener to this component.
|
void | addPropertyChangeListener(PropertyChangeListener listener) - Add a property change listener to this component.
|
LifecycleListener[] | findLifecycleListeners() - Get the lifecycle listeners associated with this lifecycle.
|
int | getDebug() - Return the debugging detail level for this Store.
|
String | getInfo() - Return the info for this Store.
|
Manager | getManager() - Return the Manager with which the Store is associated.
|
String | getStoreName() - Return the name for this Store, used for logging.
|
protected void | log(String message) - Log a message on the Logger associated with our Container (if any).
|
void | processExpires() - Called by our background reaper thread to check if Sessions
saved in our store are subject of being expired.
|
void | removeLifecycleListener(LifecycleListener listener) - Remove a lifecycle event listener from this component.
|
void | removePropertyChangeListener(PropertyChangeListener listener) - Remove a property change listener from this component.
|
void | setDebug(int debug) - Set the debugging detail level for this Store.
|
void | setManager(Manager manager) - Set the Manager with which this Store is associated.
|
void | start() - Prepare for the beginning of active use of the public methods of this
component.
|
void | stop() - Gracefully terminate the active use of the public methods of this
component.
|
debug
protected int debug
The debugging detail level for this component.
info
protected static String info
The descriptive information about this implementation.
lifecycle
protected LifecycleSupport lifecycle
The lifecycle event support for this component.
manager
protected Manager manager
The Manager with which this JDBCStore is associated.
sm
protected StringManager sm
The string manager for this package.
started
protected boolean started
Has this component been started yet?
storeName
protected static String storeName
Name to register for this Store, used for logging.
support
protected PropertyChangeSupport support
The property change support for this component.
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)
Add a property change listener to this component.
- addPropertyChangeListener in interface Store
listener
- a value of type 'PropertyChangeListener'
findLifecycleListeners
public LifecycleListener[] findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle. If this
Lifecycle has no listeners registered, a zero-length array is returned.
- findLifecycleListeners in interface Lifecycle
getDebug
public int getDebug()
Return the debugging detail level for this Store.
getInfo
public String getInfo()
Return the info for this Store.
- getInfo in interface Store
getManager
public Manager getManager()
Return the Manager with which the Store is associated.
- getManager in interface Store
getStoreName
public String getStoreName()
Return the name for this Store, used for logging.
log
protected void log(String message)
Log a message on the Logger associated with our Container (if any).
message
- Message to be logged
processExpires
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.
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
Remove a property change listener from this component.
- removePropertyChangeListener in interface Store
listener
- The listener to remove
setDebug
public void setDebug(int debug)
Set the debugging detail level for this Store.
debug
- The new debugging detail level
setManager
public void setManager(Manager manager)
Set the Manager with which this Store is associated.
- setManager in interface Store
manager
- The newly associated Manager
start
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.
- start in interface Lifecycle
LifecycleException
- if this component detects a fatal error
that prevents this component from being used
stop
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.
- stop in interface Lifecycle
LifecycleException
- if this component detects a fatal error
that needs to be reported
Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.