freenet.client

Class ArchiveManager

java.lang.Object

freenet.client.ArchiveManager

public class ArchiveManager
extends java.lang.Object

Cache of recently decoded archives: - Keep up to N ArchiveHandler's in RAM (this can be large; we don't keep the files open due to the limitations of the java.util.zip API) - Keep up to Y bytes (after padding and overheads) of decoded data on disk (the OS is quite capable of determining what to keep in actual RAM) Always take the lock on ArchiveStoreContext before the lock on ArchiveManager, NOT the other way around.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArchiveManager.ARCHIVE_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	METADATA_NAME

Constructor Summary

Constructors

Constructor and Description
ArchiveManager(int maxHandlers, long maxCachedData, long maxArchivedFileSize, int maxCachedElements, BucketFactory tempBucketFactory) Create an ArchiveManager.

Method Summary

Modifier and Type	Method and Description
void	extractToCache(FreenetURI key, ArchiveManager.ARCHIVE_TYPE archiveType, Compressor.COMPRESSOR_TYPE ctype, Bucket data, ArchiveContext archiveContext, freenet.client.ArchiveStoreContext ctx, java.lang.String element, ArchiveExtractCallback callback, ClientContext context) Extract data to cache.
Bucket	getCached(FreenetURI key, java.lang.String filename) Get a cached, previously extracted, file from an archive.
ArchiveHandler	makeHandler(FreenetURI key, ArchiveManager.ARCHIVE_TYPE archiveType, Compressor.COMPRESSOR_TYPE ctype, boolean forceRefetch, boolean persistent) Create an archive handler.

Methods inherited from class java.lang.Object

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

Field Detail

METADATA_NAME

public static final java.lang.String METADATA_NAME

See Also:

Constant Field Values

Constructor Detail

ArchiveManager

public ArchiveManager(int maxHandlers,
                      long maxCachedData,
                      long maxArchivedFileSize,
                      int maxCachedElements,
                      BucketFactory tempBucketFactory)

Create an ArchiveManager.

Parameters:

maxHandlers - The maximum number of cached ArchiveHandler's i.e. the maximum number of containers to track.

maxCachedData - The maximum size of the cache directory, in bytes.

maxArchiveSize - The maximum size of an archive.

maxArchivedFileSize - The maximum extracted size of a single file in any archive.

maxCachedElements - The maximum number of cached elements (an element is a file extracted from an archive. It is stored, encrypted and padded, in a single file.

tempBucketFactory -

Method Detail

makeHandler

public ArchiveHandler makeHandler(FreenetURI key,
                                  ArchiveManager.ARCHIVE_TYPE archiveType,
                                  Compressor.COMPRESSOR_TYPE ctype,
                                  boolean forceRefetch,
                                  boolean persistent)

Create an archive handler. This does not need to know how to fetch the key, because the methods called later will ask. It will try to serve from cache, but if that fails, will re-fetch.

Parameters:

key - The key of the archive that we are extracting data from.

archiveType - The archive type, defined in Metadata.

Returns:

An archive handler.

getCached

public Bucket getCached(FreenetURI key,
                        java.lang.String filename)
                 throws ArchiveFailureException

Get a cached, previously extracted, file from an archive.

Parameters:

key - The key used to fetch the archive.

filename - The name of the file within the archive.

Returns:

A Bucket containing the data requested, or null.

Throws:

ArchiveFailureException

extractToCache

public void extractToCache(FreenetURI key,
                           ArchiveManager.ARCHIVE_TYPE archiveType,
                           Compressor.COMPRESSOR_TYPE ctype,
                           Bucket data,
                           ArchiveContext archiveContext,
                           freenet.client.ArchiveStoreContext ctx,
                           java.lang.String element,
                           ArchiveExtractCallback callback,
                           ClientContext context)
                    throws ArchiveFailureException,
                           ArchiveRestartException

Extract data to cache. Call synchronized on ctx.

Parameters:

key - The key the data was fetched from.

archiveType - The archive type. Must be Metadata.ARCHIVE_ZIP | Metadata.ARCHIVE_TAR.

data - The actual data fetched.

archiveContext - The context for the whole fetch process.

ctx - The ArchiveStoreContext for this key.

element - A particular element that the caller is especially interested in, or null.

callback - A callback to be called if we find that element, or if we don't.

Throws:

ArchiveFailureException - If we could not extract the data, or it was too big, etc.

ArchiveRestartException

ArchiveRestartException - If the request needs to be restarted because the archive changed.