freenet.client.async

Class BaseManifestPutter

java.lang.Object

freenet.client.async.ClientRequester

freenet.client.async.BaseClientPutter

freenet.client.async.ManifestPutter

freenet.client.async.BaseManifestPutter

All Implemented Interfaces:

ClientRequestSchedulerGroup, java.io.Serializable

Direct Known Subclasses:

DefaultManifestPutter, PlainManifestPutter

public abstract class BaseManifestPutter
extends ManifestPutter

Base class for site insertion. This class contains all the insert logic, but not any 'pack logic'. The pack logic have to be implement in a subclass in makePutHandlers.

Internal container redirect URIs: The internal container URIs should be always redirects to CHKs, not just include the metadata into manifest only. The (assumed) default behavior is the reuse of containers between editions, also ArchiveManger want to have a URI given, not Metadata. This rule also makes site update code/logic much more easier.

container mode:

the metadata are inside the root container (the final URI points to an archive)

freeform mode:

the metadata are inserted separately.(the final URI points to a SimpleManifest)

WARNING: Changing non-transient members on classes that are Serializable can result in restarting downloads or losing uploads.

See Also:

PlainManifestPutter, freenet.client.async.DefaultManifestPutter DefaultManifestPutter, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BaseManifestPutter.ContainerBuilder
protected class	BaseManifestPutter.FreeFormBuilder
protected class	BaseManifestPutter.ManifestBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected int	minSuccessFetchBlocks The number of blocks that will be needed to fetch the data.

Fields inherited from class freenet.client.async.ClientRequester

blockSetFinalized, cancelled, client, creationTime, failedBlocks, fatallyFailedBlocks, latestFailure, latestSuccess, minSuccessBlocks, priorityClass, realTimeFlag, sentToNetwork, successfulBlocks, totalBlocks

Constructor Summary

Constructors

Constructor and Description
BaseManifestPutter(ClientPutCallback cb, java.util.HashMap<java.lang.String,java.lang.Object> manifestElements, short prioClass, FreenetURI target, java.lang.String defaultName, InsertContext ctx, boolean randomiseCryptoKeys, byte[] forceCryptoKey, ClientContext context)

Method Summary

Modifier and Type	Method and Description
void	addBlock() Add a block to our estimate of the total.
void	addBlocks(int num) Add several blocks to our estimate of the total.
void	addMustSucceedBlocks(int blocks) Add one or more blocks to the number of requires blocks, and don't notify the clients.
void	addRedundantBlocksInsert(int blocks) Add one or more blocks to the number of requires blocks, and don't notify the clients.
void	blockSetFinalized(ClientContext context) The set of blocks has been finalised, total will not change any more.
static java.util.HashMap<java.lang.String,java.lang.Object>	bucketsByNameToManifestEntries(java.util.HashMap<java.lang.String,java.lang.Object> bucketsByName)
void	cancel(ClientContext context) Cancel the request.
int	countFiles()
static ManifestElement[]	flatten(java.util.HashMap<java.lang.String,java.lang.Object> manifestElements)
static void	flatten(java.util.HashMap<java.lang.String,java.lang.Object> manifestElements, java.util.List<ManifestElement> v, java.lang.String prefix)
protected ClientBaseCallback	getCallback()
int	getMinSuccessFetchBlocks()
protected BaseManifestPutter.FreeFormBuilder	getRootBuilder()
protected BaseManifestPutter.ContainerBuilder	getRootContainer()
byte[]	getSplitfileCryptoKey()
FreenetURI	getURI() Get the URI for the request or insert.
protected ClientMetadata	guessMime(java.lang.String name, ManifestElement me)
protected ClientMetadata	guessMime(java.lang.String name, java.lang.String mimetype)
void	innerNotifyClients(ClientContext context) Notify clients, usually via a SplitfileProgressEvent, of the current progress.
protected void	innerOnResume(ClientContext context) Called by onResume() once and only once after restarting.
protected void	innerToNetwork(ClientContext context) Notify clients that a request has gone to the network, for the first time, i.e.
boolean	isFinished() Is the request or insert completed (succeeded, failed, or cancelled, which is a kind of failure)?
BaseManifestPutter.ContainerBuilder	makeArchive()
protected abstract void	makePutHandlers(java.util.HashMap<java.lang.String,java.lang.Object> manifestElements, java.lang.String defaultName) Implement the pack logic.
protected void	onFetchable(freenet.client.async.BaseManifestPutter.PutHandler handler)
void	onShutdown(ClientContext context) Called just before the final write when shutting down the node.
void	onTransition(ClientGetState oldState, ClientGetState newState, ClientContext context)
void	onTransition(ClientPutState from, ClientPutState to, ClientContext context)
void	start(ClientContext context)
long	totalSize()

Methods inherited from class freenet.client.async.BaseClientPutter

dump

Methods inherited from class freenet.client.async.ClientRequester

cancel, clearCountersOnRestart, completedBlock, failedBlock, failedBlock, fatallyFailedBlock, getAll, getClient, getClientDetail, getClientDetail, getLatestFailure, getLatestSuccess, getPriorityClass, getSchedulerGroup, getTotalBlocks, hashCode, isCancelled, isCurrentState, notifyClients, onResume, persistent, realTimeFlag, resetBlocks, setPriorityClass, toNetwork

Methods inherited from class java.lang.Object

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

Field Detail

minSuccessFetchBlocks

protected int minSuccessFetchBlocks

The number of blocks that will be needed to fetch the data. We put this in the top block metadata.

Constructor Detail

BaseManifestPutter

public BaseManifestPutter(ClientPutCallback cb,
                          java.util.HashMap<java.lang.String,java.lang.Object> manifestElements,
                          short prioClass,
                          FreenetURI target,
                          java.lang.String defaultName,
                          InsertContext ctx,
                          boolean randomiseCryptoKeys,
                          byte[] forceCryptoKey,
                          ClientContext context)
                   throws TooManyFilesInsertException

Throws:

TooManyFilesInsertException

Method Detail

start

public void start(ClientContext context)
           throws InsertException

Specified by:

start in class ManifestPutter

Throws:

InsertException

makePutHandlers

protected abstract void makePutHandlers(java.util.HashMap<java.lang.String,java.lang.Object> manifestElements,
                                        java.lang.String defaultName)
                                 throws TooManyFilesInsertException

Implement the pack logic.

Parameters:

manifestElements - A map from String to either ManifestElement or another String. This is the site structure, which will be split into containers and/or external inserts by the method.

Throws:

TooManyFilesInsertException

getURI

public FreenetURI getURI()

Description copied from class: ClientRequester

Get the URI for the request or insert. For a request this is set at creation, but for an insert, it is set when we know what the final URI will be.

Specified by:

getURI in class ClientRequester

isFinished

public boolean isFinished()

Description copied from class: ClientRequester

Is the request or insert completed (succeeded, failed, or cancelled, which is a kind of failure)?

Specified by:

isFinished in class ClientRequester

getSplitfileCryptoKey

public byte[] getSplitfileCryptoKey()

Overrides:

getSplitfileCryptoKey in class ManifestPutter

cancel

public void cancel(ClientContext context)

Description copied from class: ClientRequester

Cancel the request. Subclasses must implement to actually tell the ClientGetState's or ClientPutState's to cancel.

Specified by:

cancel in class ClientRequester

Parameters:

context - The ClientContext object including essential but non-persistent objects such as the schedulers.

addBlock

public void addBlock()

Description copied from class: ClientRequester

Add a block to our estimate of the total. Don't notify clients.

Overrides:

addBlock in class ClientRequester

addBlocks

public void addBlocks(int num)

Description copied from class: ClientRequester

Add several blocks to our estimate of the total. Don't notify clients.

Overrides:

addBlocks in class ClientRequester

addMustSucceedBlocks

public void addMustSucceedBlocks(int blocks)

Add one or more blocks to the number of requires blocks, and don't notify the clients.

Overrides:

addMustSucceedBlocks in class ClientRequester

addRedundantBlocksInsert

public void addRedundantBlocksInsert(int blocks)

Add one or more blocks to the number of requires blocks, and don't notify the clients. These blocks are added to the minSuccessFetchBlocks for the insert, but not to the counter for what the requestor must fetch.

Overrides:

addRedundantBlocksInsert in class ClientRequester

innerNotifyClients

public void innerNotifyClients(ClientContext context)

Description copied from class: ClientRequester

Notify clients, usually via a SplitfileProgressEvent, of the current progress. Called off-thread. Please do not change SimpleEventProducer to always produce events off-thread, it is better to deal with that here, because events could be re-ordered, which matters for some events notably SimpleProgressEvent.

Specified by:

innerNotifyClients in class ClientRequester

getMinSuccessFetchBlocks

public int getMinSuccessFetchBlocks()

Specified by:

getMinSuccessFetchBlocks in class BaseClientPutter

blockSetFinalized

public void blockSetFinalized(ClientContext context)

Description copied from class: ClientRequester

The set of blocks has been finalised, total will not change any more. Notify clients.

Overrides:

blockSetFinalized in class ClientRequester

Parameters:

context - The ClientContext object including essential but non-persistent objects such as the schedulers.

countFiles

public int countFiles()

Specified by:

countFiles in class ManifestPutter

totalSize

public long totalSize()

Specified by:

totalSize in class ManifestPutter

onFetchable

protected void onFetchable(freenet.client.async.BaseManifestPutter.PutHandler handler)

onTransition

public void onTransition(ClientGetState oldState,
                         ClientGetState newState,
                         ClientContext context)

Specified by:

onTransition in class ClientRequester

onTransition

public void onTransition(ClientPutState from,
                         ClientPutState to,
                         ClientContext context)

Specified by:

onTransition in class BaseClientPutter

innerToNetwork

protected void innerToNetwork(ClientContext context)

Description copied from class: ClientRequester

Notify clients that a request has gone to the network, for the first time, i.e. we have finished checking the datastore for at least one part of the request.

Specified by:

innerToNetwork in class ClientRequester

guessMime

protected final ClientMetadata guessMime(java.lang.String name,
                                         ManifestElement me)

guessMime

protected final ClientMetadata guessMime(java.lang.String name,
                                         java.lang.String mimetype)

makeArchive

public BaseManifestPutter.ContainerBuilder makeArchive()

getRootContainer

protected BaseManifestPutter.ContainerBuilder getRootContainer()

getRootBuilder

protected BaseManifestPutter.FreeFormBuilder getRootBuilder()

getCallback

protected ClientBaseCallback getCallback()

Specified by:

getCallback in class ClientRequester

bucketsByNameToManifestEntries

public static java.util.HashMap<java.lang.String,java.lang.Object> bucketsByNameToManifestEntries(java.util.HashMap<java.lang.String,java.lang.Object> bucketsByName)

flatten

public static ManifestElement[] flatten(java.util.HashMap<java.lang.String,java.lang.Object> manifestElements)

flatten

public static void flatten(java.util.HashMap<java.lang.String,java.lang.Object> manifestElements,
                           java.util.List<ManifestElement> v,
                           java.lang.String prefix)

onShutdown

public void onShutdown(ClientContext context)

Description copied from class: ClientRequester

Called just before the final write when shutting down the node.

Overrides:

onShutdown in class ClientRequester

innerOnResume

protected void innerOnResume(ClientContext context)
                      throws ResumeFailedException

Description copied from class: ClientRequester

Called by onResume() once and only once after restarting. Must be overridden, and must call super.innerOnResume().

Overrides:

innerOnResume in class ClientRequester

Throws:

ResumeFailedException