org.jivesoftware.smackx.entitycaps.cache
Class SimpleDirectoryPersistentCache

java.lang.Object
  org.jivesoftware.smackx.entitycaps.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.

Author:

Florian Schmaus

Constructor Summary

SimpleDirectoryPersistentCache(java.io.File cacheDir)
Creates a new SimpleDirectoryPersistentCache Object.

SimpleDirectoryPersistentCache(java.io.File cacheDir, StringEncoder filenameEncoder)
Creates a new SimpleDirectoryPersistentCache Object.

Method Summary

void	addDiscoverInfoByNodePersistent(java.lang.String node, DiscoverInfo info) Add an DiscoverInfo to the persistent Cache
void	emptyCache() Empty the Cache
void	replay() Replay the Caches data into EntityCapsManager

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 Base32Encoder, as this will work on all file systems, both case sensitive and case insensitive. It does however produce longer filenames.

Parameters:

cacheDir -

SimpleDirectoryPersistentCache

public SimpleDirectoryPersistentCache(java.io.File cacheDir,
                                      StringEncoder 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 Base32Encoder (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 node,
                                            DiscoverInfo info)

Description copied from interface: EntityCapsPersistentCache

Add an DiscoverInfo to the persistent Cache

Specified by:

addDiscoverInfoByNodePersistent in interface EntityCapsPersistentCache

replay

public void replay()
            throws java.io.IOException

Description copied from interface: EntityCapsPersistentCache

Replay the Caches data into EntityCapsManager

Specified by:

replay in interface EntityCapsPersistentCache

Throws:

java.io.IOException

emptyCache

public void emptyCache()

Description copied from interface: EntityCapsPersistentCache

Empty the Cache

Specified by:

emptyCache in interface EntityCapsPersistentCache