File	Doc	Category	Size	Date	Package
BackingStore.java	API Doc	Glassfish v2 API	6499	Fri May 04 22:35:26 BST 2007	com.sun.appserv.ha.spi

BackingStore

• java.lang.Object

Fields Summary
private String	appId
private Properties	props

Constructors Summary

Methods Summary
public abstract void	destroy() Called when the store is no longer needed. Must clean up and close any opened resources.
protected java.lang.String	getAppId() return this.appId;
protected java.util.Properties	getProperties() return props;
protected void	initialize(java.lang.String appId, java.util.Properties props) this.appId = appId; this.props = props;
public abstract K	load(java.lang.String id) Load and return the daata for the given id. The store is expected to return the largest ever version that was saved in the stored using the save() method. Note that the return value could be null if Metadata was not accessed for {@link Metadata#getMaxInactiveInterval()} param id the id whose value must be returned return the value if this store contains it or null. The implementation must return the exact same type as that was passed to it in the save method. throws NullPointerException if the id is null throws BackingStoreException if the underlying store implementation encounters any exception
public abstract void	remove(java.lang.String id) Remove the association for the id. After this call, any call to load(id) must return null param id the id return true if the id was successfully removed false otherwise throws BackingStoreException if the underlying store implementation encounters any exception
public abstract int	removeExpired() Remove all instances that are idle. The implementation of this method must use {@link Metadata#getLastAccessTime()} and {@link Metadata#getMaxInactiveInterval()} to determine if a particular Metadata is idle or not. A Metadata is considered idle if (Metadata.getMaxInactiveInterval > 0) && ((System.currentTimeMillis() - Metadata.getLastAccessTime()) >= Metadata.getMaxInactiveInterval()) return The number of (idle) sessions removed. throws BackingStoreException if the underlying store implementation encounters any exception
public abstract void	save(java.lang.String id, K value) Save the value whose key is id. param id the id param value The Metadata to be stored throws BackingStoreException if the underlying store implementation encounters any exception
public abstract int	size() Get the current size of the store return the number of entries in the store throws BackingStoreException if the underlying store implementation encounters any exception
public abstract void	updateLastAccessTime(java.lang.String id, long time, long version) Update the last access time for this id. param id the id for the Metadata param time the time at which this data was last accessed param version the new version number for the data associated with this id. A newly created version will have version number zero. throws BackingStoreException if the underlying store implementation encounters any exception