freenet.support.io

Class TempBucketFactory

java.lang.Object

freenet.support.io.TempBucketFactory

All Implemented Interfaces:

BucketFactory, LockableRandomAccessBufferFactory

public class TempBucketFactory
extends java.lang.Object
implements BucketFactory, LockableRandomAccessBufferFactory

Temporary Bucket Factory Buckets created by this factory can be either: - ArrayBuckets OR - FileBuckets ArrayBuckets are used if and only if: 1) there is enough room remaining on the pool (@see maxRamUsed and @see bytesInUse) 2) the initial size is smaller than (@maxRAMBucketSize) Depending on how they are used they might switch from one type to another transparently. Currently they are two factors considered for a migration: - if they are long-lived or not (@see RAMBUCKET_MAX_AGE) - if their size is over RAMBUCKET_CONVERSION_FACTOR*maxRAMBucketSize

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TempBucketFactory.TempBucket

Field Summary

Fields

Modifier and Type	Field and Description
static EncryptedRandomAccessBufferType	CRYPT_TYPE
static float	DEFAULT_FACTOR
static long	defaultIncrement

Constructor Summary

Constructors

Constructor and Description
TempBucketFactory(Executor executor, FilenameGenerator filenameGenerator, long maxBucketSizeKeptInRam, long maxRamUsed, java.util.Random weakPRNG, boolean reallyEncrypt, long minDiskSpace, MasterSecret masterSecret)

Method Summary

Modifier and Type	Method and Description
long	getMaxRAMBucketSize()
long	getMaxRamUsed()
long	getRamUsed()
DiskSpaceCheckingRandomAccessBufferFactory	getUnderlyingRAFFactory()
boolean	isEncrypting()
RandomAccessBucket	makeBucket(long size) Create a bucket.
RandomAccessBucket	makeBucket(long size, float factor)
TempBucketFactory.TempBucket	makeBucket(long size, float factor, long increment) Create a temp bucket
LockableRandomAccessBuffer	makeRAF(byte[] initialContents, int offset, int size, boolean readOnly) Create a bucket with specified initial contents.
LockableRandomAccessBuffer	makeRAF(long size) Create a bucket.
void	setEncryption(boolean value)
void	setMaxRAMBucketSize(long size)
void	setMaxRamUsed(long size)
void	setMinDiskSpace(long min)

Methods inherited from class java.lang.Object

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

Field Detail

defaultIncrement

public static final long defaultIncrement

See Also:

Constant Field Values

DEFAULT_FACTOR

public static final float DEFAULT_FACTOR

See Also:

Constant Field Values

CRYPT_TYPE

public static final EncryptedRandomAccessBufferType CRYPT_TYPE

Constructor Detail

TempBucketFactory

public TempBucketFactory(Executor executor,
                         FilenameGenerator filenameGenerator,
                         long maxBucketSizeKeptInRam,
                         long maxRamUsed,
                         java.util.Random weakPRNG,
                         boolean reallyEncrypt,
                         long minDiskSpace,
                         MasterSecret masterSecret)

Method Detail

makeBucket

public RandomAccessBucket makeBucket(long size)
                              throws java.io.IOException

Description copied from interface: BucketFactory

Create a bucket.

Specified by:

makeBucket in interface BucketFactory

Parameters:

size - The maximum size of the data, or -1 or Long.MAX_VALUE if we don't know. Some buckets will throw IOException if you go over this length.

Returns:

Throws:

java.io.IOException

makeBucket

public RandomAccessBucket makeBucket(long size,
                                     float factor)
                              throws java.io.IOException

Throws:

java.io.IOException

getRamUsed

public long getRamUsed()

setMaxRamUsed

public void setMaxRamUsed(long size)

getMaxRamUsed

public long getMaxRamUsed()

setMaxRAMBucketSize

public void setMaxRAMBucketSize(long size)

getMaxRAMBucketSize

public long getMaxRAMBucketSize()

setEncryption

public void setEncryption(boolean value)

setMinDiskSpace

public void setMinDiskSpace(long min)

isEncrypting

public boolean isEncrypting()

makeBucket

public TempBucketFactory.TempBucket makeBucket(long size,
                                               float factor,
                                               long increment)
                                        throws java.io.IOException

Create a temp bucket

Parameters:

size - Maximum size

factor - Factor to increase size by when need more space

Returns:

A temporary Bucket

Throws:

java.io.IOException - If it is not possible to create a temp bucket due to an I/O error

makeRAF

public LockableRandomAccessBuffer makeRAF(long size)
                                   throws java.io.IOException

Description copied from interface: LockableRandomAccessBufferFactory

Create a bucket.

Specified by:

makeRAF in interface LockableRandomAccessBufferFactory

Parameters:

size - The maximum size of the data. Most factories will pre-allocate this space, and it may not be exceeded. However we do not guarantee that any I/O operation will complete; even if we have pre-allocated the disk space, we may be unable to write to it because of e.g. a hardware error.

Returns:

A LockableRandomAccessBuffer of the requested size.

Throws:

java.io.IOException - If an I/O error prevented the operation.

makeRAF

public LockableRandomAccessBuffer makeRAF(byte[] initialContents,
                                          int offset,
                                          int size,
                                          boolean readOnly)
                                   throws java.io.IOException

Description copied from interface: LockableRandomAccessBufferFactory

Create a bucket with specified initial contents.

Specified by:

makeRAF in interface LockableRandomAccessBufferFactory

Parameters:

initialContents - Byte array from which to copy data. Data will be copied even if the underlying implementation is a byte array, for reasons of consistency.

offset - Offset within the array to start copying data from.

size - Number of bytes to copy i.e. length of the new RandomAccessBuffer.

Returns:

Throws:

java.io.IOException - If an I/O error prevented the operation.

getUnderlyingRAFFactory

public DiskSpaceCheckingRandomAccessBufferFactory getUnderlyingRAFFactory()