Package org.jivesoftware.smackx.caps.cache

Class SimpleDirectoryPersistentCache

java.lang.Object

org.jivesoftware.smackx.caps.cache.SimpleDirectoryPersistentCache

All Implemented Interfaces:

EntityCapsPersistentCache

public class SimpleDirectoryPersistentCache
extends java.lang.Object
implements EntityCapsPersistentCache

Simple implementation of an EntityCapsPersistentCache that uses a directory to store the Caps information for every known node. Every node is represented by a file.

Constructor Summary

Constructors

Constructor	Description
SimpleDirectoryPersistentCache(java.io.File cacheDir)	Creates a new SimpleDirectoryPersistentCache Object.
SimpleDirectoryPersistentCache(java.io.File cacheDir, StringEncoder<java.lang.String> filenameEncoder)	Creates a new SimpleDirectoryPersistentCache Object.

Method Summary

Modifier and Type	Method	Description
void	addDiscoverInfoByNodePersistent(java.lang.String nodeVer, DiscoverInfo info)	Add an DiscoverInfo to the persistent Cache.
void	emptyCache()	Empty the Cache.
DiscoverInfo	lookup(java.lang.String nodeVer)	Lookup DiscoverInfo by a Node string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleDirectoryPersistentCache

public SimpleDirectoryPersistentCache(java.io.File cacheDir)

Creates a new SimpleDirectoryPersistentCache Object. Make sure that the cacheDir exists and that it's an directory.

Default filename encoder Base32, as this will work on all file systems, both case sensitive and case insensitive. It does however produce longer filenames.

Parameters:

cacheDir - TODO javadoc me please

SimpleDirectoryPersistentCache

public SimpleDirectoryPersistentCache(java.io.File cacheDir,
                                      StringEncoder<java.lang.String> filenameEncoder)

Creates a new SimpleDirectoryPersistentCache Object. Make sure that the cacheDir exists and that it's an directory. If your cacheDir is case insensitive then make sure to set the StringEncoder to Base32 (which is the default).

Parameters:

cacheDir - The directory where the cache will be stored.

filenameEncoder - Encodes the node string into a filename.

Method Detail

addDiscoverInfoByNodePersistent

public void addDiscoverInfoByNodePersistent(java.lang.String nodeVer,
                                            DiscoverInfo info)

Description copied from interface: EntityCapsPersistentCache

Add an DiscoverInfo to the persistent Cache.

Specified by:

addDiscoverInfoByNodePersistent in interface EntityCapsPersistentCache

Parameters:

nodeVer - TODO javadoc me please

info - TODO javadoc me please

lookup

public DiscoverInfo lookup(java.lang.String nodeVer)

Description copied from interface: EntityCapsPersistentCache

Lookup DiscoverInfo by a Node string.

Specified by:

lookup in interface EntityCapsPersistentCache

Parameters:

nodeVer - TODO javadoc me please

Returns:

DiscoverInfo.

emptyCache

public void emptyCache()

Description copied from interface: EntityCapsPersistentCache

Empty the Cache.

Specified by:

emptyCache in interface EntityCapsPersistentCache