FileStore (Apache Tomcat 6.0.53 API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

Apache Tomcat 6.0.53

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.catalina.session
Class FileStore

java.lang.Object
  org.apache.catalina.session.StoreBase
      org.apache.catalina.session.FileStore

All Implemented Interfaces:: Lifecycle, Store

public final class FileStore
extends StoreBase
extends StoreBase

Concrete implementation of the Store interface that utilizes a file per saved Session in a configured directory. Sessions that are saved are still subject to being expired based on inactivity.

Author:: Craig R. McClanahan

Field Summary

Fields inherited from class org.apache.catalina.session.StoreBase
`lifecycle, manager, sm, started, support`

Fields inherited from interface org.apache.catalina.Lifecycle
`AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT`

Constructor Summary
`FileStore()`

Method Summary
`void`	`clear()` Remove all of the Sessions in this Store.
`java.lang.String`	`getDirectory()`
`java.lang.String`	`getInfo()` Return the info for this Store.
`int`	`getSize()` Return the number of Sessions present in this Store.
`java.lang.String`	`getStoreName()` Return the name for this Store, used for logging.
`java.lang.String`	`getThreadName()`
`java.lang.String[]`	`keys()` Return an array containing the session identifiers of all Sessions currently saved in this Store.
`Session`	`load(java.lang.String id)` Load and return the Session associated with the specified session identifier from this Store, without removing it.
`void`	`remove(java.lang.String id)` Remove the Session with the specified session identifier from this Store, if present.
`void`	`save(Session session)` Save the specified Session into this Store.
`void`	`setDirectory(java.lang.String path)` Set the directory path for this Store.

Methods inherited from class org.apache.catalina.session.StoreBase
`addLifecycleListener, addPropertyChangeListener, findLifecycleListeners, getManager, getObjectInputStream, processExpires, removeLifecycleListener, removePropertyChangeListener, setManager, start, stop`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

FileStore

public FileStore()

Method Detail

getDirectory

public java.lang.String getDirectory()

Returns:: The directory path for this Store.

setDirectory

public void setDirectory(java.lang.String path)

Set the directory path for this Store.

Parameters:: path - The new directory path

getInfo

public java.lang.String getInfo()

Description copied from class: StoreBase

Return the info for this Store.

Specified by:: getInfo in interface Store
Overrides:: getInfo in class StoreBase

getThreadName

public java.lang.String getThreadName()

Returns:: The thread name for this Store.

getStoreName

public java.lang.String getStoreName()

Return the name for this Store, used for logging.

Overrides:: getStoreName in class StoreBase

getSize

public int getSize()
            throws java.io.IOException

Return the number of Sessions present in this Store.

Throws:: java.io.IOException - if an input/output error occurs

clear

public void clear()
           throws java.io.IOException

Remove all of the Sessions in this Store.

Throws:: java.io.IOException - if an input/output error occurs

keys

public java.lang.String[] keys()
                        throws java.io.IOException

Return an array containing the session identifiers of all Sessions currently saved in this Store. If there are no such Sessions, a zero-length array is returned.

Throws:: java.io.IOException - if an input/output error occurred

load

public Session load(java.lang.String id)
             throws java.lang.ClassNotFoundException,
                    java.io.IOException

Load and return the Session associated with the specified session identifier from this Store, without removing it. If there is no such stored Session, return null.

Parameters:: id - Session identifier of the session to load
Throws:: java.lang.ClassNotFoundException - if a deserialization error occurs; java.io.IOException - if an input/output error occurs

remove

public void remove(java.lang.String id)
            throws java.io.IOException

Remove the Session with the specified session identifier from this Store, if present. If no such Session is present, this method takes no action.

Parameters:: id - Session identifier of the Session to be removed
Throws:: java.io.IOException - if an input/output error occurs

save

public void save(Session session)
          throws java.io.IOException

Save the specified Session into this Store. Any previously saved information for the associated session identifier is replaced.

Parameters:: session - Session to be saved
Throws:: java.io.IOException - if an input/output error occurs