Tomcat 10.1.19 · org.apache.catalina.session.FileStore

Field Summary

Modifier and Type	Field and Description
private String	directory The pathname of the directory in which Sessions are stored.
private File	directoryFile A File representing the directory in which Sessions are stored.
private static final String	FILE_EXT The extension to use for serialized session filenames.
private static final Log	log Hides org.apache.catalina.util.LifecycleBase.log.
private static final StringManager	sm Hides org.apache.catalina.session.StoreBase.sm.
private static final String	storeName Hides org.apache.catalina.session.StoreBase.storeName. Name to register for this Store, used for logging.
private static final String	threadName Name to register for the background thread.

Inherited from org.apache.catalina.session.StoreBase:: manager support

Constructor Summary

Access	Constructor and Description
public	FileStore()

Method Summary

Modifier and Type	Method and Description
public void	clear() Implements org.apache.catalina.Store.clear. Remove all of the Sessions in this Store.
private File	directory() Return a File object representing the pathname to our session persistence directory, if any.
private File	file(String The ID of the Session to be retrieved. This is used in the file naming. id) Return a File object representing the pathname to our session persistence file, if any.
public String	Returns: The directory path for this Store. getDirectory()
public int	getSize() Implements org.apache.catalina.Store.getSize. Return the number of Sessions present in this Store.
public String	getStoreName() Overrides org.apache.catalina.session.StoreBase.getStoreName. Return the name for this Store, used for logging.
public String	Returns: The thread name for this Store. getThreadName()
public String[]	keys() Implements org.apache.catalina.Store.keys. Return an array containing the session identifiers of all Sessions currently saved in this Store.
public Session	load(String Session identifier of the session to load id) Implements org.apache.catalina.Store.load. Load and return the Session associated with the specified session identifier from this Store, without removing it.
public void	remove(String Session identifier of the Session to be removed id) Implements org.apache.catalina.Store.remove. Remove the Session with the specified session identifier from this Store, if present.
public void	save(Session Session to be saved session) Implements org.apache.catalina.Store.save. Save the specified Session into this Store.
public void	setDirectory(String The new directory path path) Set the directory path for this Store.

Inherited from org.apache.catalina.session.StoreBase:: addPropertyChangeListener destroyInternal expiredKeys getManager getObjectInputStream initInternal processExpires removePropertyChangeListener setManager startInternal stopInternal toString

Field Detail

directory	back to summary
private String directory The pathname of the directory in which Sessions are stored. This may be an absolute pathname, or a relative path that is resolved against the temporary work directory for this application.

directoryFile	back to summary
private File directoryFile A File representing the directory in which Sessions are stored.

FILE_EXT	back to summary
private static final String FILE_EXT The extension to use for serialized session filenames.

log	back to summary
private static final Log log Hides org.apache.catalina.util.LifecycleBase.log.

sm	back to summary
private static final StringManager sm Hides org.apache.catalina.session.StoreBase.sm.

storeName	back to summary
private static final String storeName Hides org.apache.catalina.session.StoreBase.storeName. Name to register for this Store, used for logging.

storeName

back to summary

private static final String storeName

Hides org.apache.catalina.session.StoreBase.storeName.

Name to register for this Store, used for logging.

threadName	back to summary
private static final String threadName Name to register for the background thread.

Constructor Detail

FileStore	back to summary
public FileStore()

Method Detail

clear	back to summary
public void clear() throws IOException Implements org.apache.catalina.Store.clear. Remove all of the Sessions in this Store. Annotations @Override Exceptions IOException: if an input/output error occurs

clear

back to summary

public void clear() throws IOException

Implements org.apache.catalina.Store.clear.

Remove all of the Sessions in this Store.

Annotations

@Override

Exceptions

IOException:: if an input/output error occurs

directory	back to summary
private File directory() throws IOException Return a File object representing the pathname to our session persistence directory, if any. The directory will be created if it does not already exist.

file	back to summary
private File file(String id) throws IOException Return a File object representing the pathname to our session persistence file, if any. Parameters id:String The ID of the Session to be retrieved. This is used in the file naming.

file

back to summary

private File file(String id) throws IOException

Return a File object representing the pathname to our session persistence file, if any.

Parameters

id:String: The ID of the Session to be retrieved. This is used in the file naming.

getDirectory	back to summary
public String getDirectory() Returns:String The directory path for this Store.

getSize	back to summary
public int getSize() throws IOException Implements org.apache.catalina.Store.getSize. Return the number of Sessions present in this Store. Returns:int Doc from org.apache.catalina.Store.getSize. the number of Sessions present in this Store. Annotations @Override Exceptions IOException: if an input/output error occurs

getSize

back to summary

public int getSize() throws IOException

Implements org.apache.catalina.Store.getSize.

Return the number of Sessions present in this Store.

Returns:int

Doc from org.apache.catalina.Store.getSize.

the number of Sessions present in this Store.

Annotations

@Override

Exceptions

IOException:: if an input/output error occurs

getStoreName	back to summary
public String getStoreName() Overrides org.apache.catalina.session.StoreBase.getStoreName. Return the name for this Store, used for logging. Returns:String Doc from org.apache.catalina.session.StoreBase.getStoreName. the name for this Store, used for logging. Annotations @Override

getStoreName

back to summary

public String getStoreName()

Overrides org.apache.catalina.session.StoreBase.getStoreName.

Return the name for this Store, used for logging.

Returns:String

Doc from org.apache.catalina.session.StoreBase.getStoreName.

the name for this Store, used for logging.

Annotations

@Override

getThreadName	back to summary
public String getThreadName() Returns:String The thread name for this Store.

keys	back to summary
public String[] keys() throws IOException Implements org.apache.catalina.Store.keys. 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. Returns:String[] Doc from org.apache.catalina.Store.keys. 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. Annotations @Override Exceptions IOException: if an input/output error occurred

keys

back to summary

public String[] keys() throws IOException

Implements org.apache.catalina.Store.keys.

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.

Returns:String[]

Doc from org.apache.catalina.Store.keys.

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.

Annotations

@Override

Exceptions

IOException:: if an input/output error occurred

load back to summary

load	back to summary
public Session load(String id) throws ClassNotFoundException, IOException Implements org.apache.catalina.Store.load. 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:String Session identifier of the session to load Returns:Session Doc from org.apache.catalina.Store.load. the loaded Session instance Annotations @Override Exceptions ClassNotFoundException: if a deserialization error occurs IOException: if an input/output error occurs

public Session load(String id) throws ClassNotFoundException, IOException

Implements org.apache.catalina.Store.load.

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:String: Session identifier of the session to load

Returns:Session

Doc from org.apache.catalina.Store.load.

the loaded Session instance

Annotations

@Override

Exceptions

ClassNotFoundException:: if a deserialization error occurs
IOException:: if an input/output error occurs

remove	back to summary
public void remove(String id) throws IOException Implements org.apache.catalina.Store.remove. 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:String Session identifier of the Session to be removed Annotations @Override Exceptions IOException: if an input/output error occurs

remove

back to summary

public void remove(String id) throws IOException

Implements org.apache.catalina.Store.remove.

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:String: Session identifier of the Session to be removed

Annotations

@Override

Exceptions

IOException:: if an input/output error occurs

save	back to summary
public void save(Session session) throws IOException Implements org.apache.catalina.Store.save. Save the specified Session into this Store. Any previously saved information for the associated session identifier is replaced. Parameters session:Session Session to be saved Annotations @Override Exceptions IOException: if an input/output error occurs

save

back to summary

public void save(Session session) throws IOException

Implements org.apache.catalina.Store.save.

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

Parameters

session:Session: Session to be saved

Annotations

@Override

Exceptions

IOException:: if an input/output error occurs

setDirectory	back to summary
public void setDirectory(String path) Set the directory path for this Store. Parameters path:String The new directory path

setDirectory

back to summary

public void setDirectory(String path)

Set the directory path for this Store.

Parameters

path:String: The new directory path

public final Class FileStore

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail