freenet.support.io

Class TempFileBucket

java.lang.Object

freenet.support.io.BaseFileBucket

freenet.support.io.TempFileBucket

All Implemented Interfaces:

Bucket, RandomAccessBucket, java.io.Serializable

Direct Known Subclasses:

PersistentTempFileBucket

public class TempFileBucket
extends BaseFileBucket
implements Bucket, java.io.Serializable

Temporary file handling. TempFileBuckets start empty.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected FilenameGenerator	generator

Fields inherited from class freenet.support.io.BaseFileBucket

fileRestartCounter, MAGIC, tempDir

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TempFileBucket()
protected	TempFileBucket(java.io.DataInputStream dis)
	TempFileBucket(long id, FilenameGenerator generator)
protected	TempFileBucket(long id, FilenameGenerator generator, boolean deleteOnFree) Constructor for the TempFileBucket object Subclasses can call this constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	createFileOnly() If true, we will fail if the file already exist.
RandomAccessBucket	createShadow() Create a shallow read-only copy of this bucket, using different objects but using the same external storage.
protected boolean	deleteOnExit()
protected boolean	deleteOnFree()
boolean	equals(java.lang.Object obj)
java.io.File	getFile() Returns the file object this buckets data is kept in.
int	hashCode()
protected void	innerResume(ClientContext context)
boolean	isReadOnly() Is the bucket read-only?
protected int	magic()
void	onResume(ClientContext context) Called after restarting.
protected boolean	persistent()
void	setReadOnly() Make the bucket read-only.
void	storeTo(java.io.DataOutputStream dos) Write enough data to reconstruct the Bucket, or throw UnsupportedOperationException.
protected boolean	tempFileAlreadyExists() If true, then the file is temporary and must already exist, so we will just open it.

Methods inherited from class freenet.support.io.BaseFileBucket

deleteFile, free, free, getInputStream, getInputStreamUnbuffered, getName, getOutputStream, getOutputStreamUnbuffered, getPersistentTempID, getTempDir, getTempfile, setDeleteOnExit, setTempDir, size, split, toRandomAccessBuffer, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface freenet.support.api.Bucket

free, getInputStream, getInputStreamUnbuffered, getName, getOutputStream, getOutputStreamUnbuffered, size

Field Detail

generator

protected transient FilenameGenerator generator

Constructor Detail

TempFileBucket

public TempFileBucket(long id,
                      FilenameGenerator generator)

TempFileBucket

protected TempFileBucket(long id,
                         FilenameGenerator generator,
                         boolean deleteOnFree)

Constructor for the TempFileBucket object Subclasses can call this constructor.

Parameters:

deleteOnExit - Set if you want the bucket deleted on shutdown. Passed to the parent BaseFileBucket. You must also override deleteOnExit() and implement your own createShadow()!

deleteOnFree - True for a normal temp bucket, false for a shadow.

TempFileBucket

protected TempFileBucket()

TempFileBucket

protected TempFileBucket(java.io.DataInputStream dis)
                  throws java.io.IOException,
                         StorageFormatException

Throws:

java.io.IOException

StorageFormatException

Method Detail

createFileOnly

protected boolean createFileOnly()

Description copied from class: BaseFileBucket

If true, we will fail if the file already exist. Incompatible with tempFileAlreadyExists()!

Specified by:

createFileOnly in class BaseFileBucket

deleteOnFree

protected boolean deleteOnFree()

Specified by:

deleteOnFree in class BaseFileBucket

getFile

public java.io.File getFile()

Description copied from class: BaseFileBucket

Returns the file object this buckets data is kept in.

Specified by:

getFile in class BaseFileBucket

isReadOnly

public boolean isReadOnly()

Description copied from interface: Bucket

Is the bucket read-only?

Specified by:

isReadOnly in interface Bucket

setReadOnly

public void setReadOnly()

Description copied from interface: Bucket

Make the bucket read-only. Irreversible.

Specified by:

setReadOnly in interface Bucket

deleteOnExit

protected boolean deleteOnExit()

Specified by:

deleteOnExit in class BaseFileBucket

createShadow

public RandomAccessBucket createShadow()

Description copied from interface: Bucket

Create a shallow read-only copy of this bucket, using different objects but using the same external storage. If this is not possible, return null. Note that if the underlying bucket is deleted, the copy will become invalid and probably throw an IOException on read, or possibly return too-short data etc. In some use cases e.g. on fproxy, this is acceptable.

Specified by:

createShadow in interface Bucket

Specified by:

createShadow in interface RandomAccessBucket

innerResume

protected void innerResume(ClientContext context)
                    throws ResumeFailedException

Throws:

ResumeFailedException

onResume

public final void onResume(ClientContext context)
                    throws ResumeFailedException

Description copied from interface: Bucket

Called after restarting. The Bucket should do any necessary housekeeping after resuming, e.g. registering itself with the appropriate persistent bucket tracker to avoid being garbage-collected. May be called twice, so the Bucket may need to track this internally.

Specified by:

onResume in interface Bucket

Overrides:

onResume in class BaseFileBucket

Parameters:

context - All the necessary runtime support will be on this object.

Throws:

ResumeFailedException

persistent

protected boolean persistent()

tempFileAlreadyExists

protected boolean tempFileAlreadyExists()

Description copied from class: BaseFileBucket

If true, then the file is temporary and must already exist, so we will just open it. Otherwise we will create a temporary file and then rename it over the target. Incompatible with createFileOnly()!

Specified by:

tempFileAlreadyExists in class BaseFileBucket

storeTo

public void storeTo(java.io.DataOutputStream dos)
             throws java.io.IOException

Description copied from interface: Bucket

Write enough data to reconstruct the Bucket, or throw UnsupportedOperationException. Used for recovering in emergencies, should be versioned if necessary.

Specified by:

storeTo in interface Bucket

Overrides:

storeTo in class BaseFileBucket

Throws:

java.io.IOException

magic

protected int magic()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object