freenet.client.async

Class ClientPutter

java.lang.Object

freenet.client.async.ClientRequester

freenet.client.async.BaseClientPutter

freenet.client.async.ClientPutter

All Implemented Interfaces:

ClientRequestSchedulerGroup, PutCompletionCallback, java.io.Serializable

public class ClientPutter
extends BaseClientPutter
implements PutCompletionCallback

A high level insert.

See Also:

Serialized Form

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, creationTime, failedBlocks, fatallyFailedBlocks, latestFailure, latestSuccess, minSuccessBlocks, priorityClass, realTimeFlag, sentToNetwork, successfulBlocks, totalBlocks

Constructor Summary

Constructors

Constructor and Description
ClientPutter(ClientPutCallback client, RandomAccessBucket data, FreenetURI targetURI, ClientMetadata cm, InsertContext ctx, short priorityClass, boolean isMetadata, java.lang.String targetFilename, boolean binaryBlob, ClientContext context, byte[] overrideSplitfileCrypto, long metadataThreshold)

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	cancel(ClientContext context) Cancel the insert.
boolean	canRestart() Can we restart the insert?
protected void	clearCountersOnRestart()
void	dump()
protected ClientBaseCallback	getCallback()
byte[]	getClientDetail(ChecksumChecker checker)
Bucket	getData()
int	getMinSuccessFetchBlocks()
byte[]	getSplitfileCryptoKey() Get used splitfile cryptokey.
FreenetURI	getTargetURI() Get the target URI with which this insert was started.
FreenetURI	getURI() Get the final URI to the inserted data
protected void	innerNotifyClients(ClientContext context) Notify clients, usually via a SplitfileProgressEvent, of the current progress.
void	innerOnResume(ClientContext context) Called by onResume() once and only once after restarting.
protected void	innerToNetwork(ClientContext context) Notify listening clients that an insert has been sent to the network.
boolean	isFinished() Has the insert completed already?
void	onBlockSetFinished(ClientPutState state, ClientContext context) Called when we know exactly how many blocks will be needed.
void	onEncode(BaseClientKey key, ClientPutState state, ClientContext context) Called when we know the final URI of the insert.
void	onFailure(InsertException e, ClientPutState state, ClientContext context) Called when the insert fails.
void	onFetchable(ClientPutState state) Called (sometimes) when enough of the data has been inserted that the file can now be fetched.
void	onMetadata(Bucket finalMetadata, ClientPutState state, ClientContext context) Called when metadataThreshold was specified and metadata is being returned instead of a URI.
void	onMetadata(Metadata m, ClientPutState state, ClientContext context) Called when we have generated metadata for the insert.
void	onShutdown(ClientContext context) Called just before the final write when shutting down the node.
void	onSuccess(ClientPutState state, ClientContext context) Called when the insert succeeds.
void	onTransition(ClientGetState oldState, ClientGetState newState, ClientContext context)
void	onTransition(ClientPutState oldState, ClientPutState newState, ClientContext context) Called when a ClientPutState transitions to a new state.
static boolean	randomiseSplitfileKeys(FreenetURI targetURI, InsertContext ctx, boolean persistent)
boolean	restart(ClientContext context) Restart the insert.
boolean	start(boolean restart, ClientContext context) Start the insert.
void	start(ClientContext context) Start the insert.

Methods inherited from class freenet.client.async.ClientRequester

blockSetFinalized, cancel, completedBlock, failedBlock, failedBlock, fatallyFailedBlock, getAll, getClient, 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

Methods inherited from interface freenet.client.async.PutCompletionCallback

onResume

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

ClientPutter

public ClientPutter(ClientPutCallback client,
                    RandomAccessBucket data,
                    FreenetURI targetURI,
                    ClientMetadata cm,
                    InsertContext ctx,
                    short priorityClass,
                    boolean isMetadata,
                    java.lang.String targetFilename,
                    boolean binaryBlob,
                    ClientContext context,
                    byte[] overrideSplitfileCrypto,
                    long metadataThreshold)

Parameters:

client - The object to call back when we complete, or don't.

data - The data to insert. This will be freed when the insert has completed, whether it succeeds or not, so wrap it in a @link freenet.support.io.NoFreeBucket if you don't want it to be freed.

targetURI -

cm -

ctx -

priorityClass -

isMetadata -

targetFilename - If set, create a one-file manifest containing this filename pointing to this file.

binaryBlob -

context - The client object for purposs of round-robin client balancing.

overrideSplitfileCrypto -

metadataThreshold -

Method Detail

start

public void start(ClientContext context)
           throws InsertException

Start the insert.

Parameters:

earlyEncode - If true, try to find the final URI as quickly as possible, and insert the upper layers as soon as we can, rather than waiting for the lower layers. The default behaviour is safer, because an attacker can usually only identify the datastream once he has the top block, or once you have announced the key.

context - Contains some useful transient fields such as the schedulers.

Throws:

InsertException - If the insert cannot be started for some reason.

start

public boolean start(boolean restart,
                     ClientContext context)
              throws InsertException

Start the insert.

Parameters:

restart - If true, restart the insert even though it has completed before.

context - Contains some useful transient fields such as the schedulers.

Throws:

InsertException - If the insert cannot be started for some reason.

randomiseSplitfileKeys

public static boolean randomiseSplitfileKeys(FreenetURI targetURI,
                                             InsertContext ctx,
                                             boolean persistent)

onSuccess

public void onSuccess(ClientPutState state,
                      ClientContext context)

Called when the insert succeeds.

Specified by:

onSuccess in interface PutCompletionCallback

onFailure

public void onFailure(InsertException e,
                      ClientPutState state,
                      ClientContext context)

Called when the insert fails.

Specified by:

onFailure in interface PutCompletionCallback

onEncode

public void onEncode(BaseClientKey key,
                     ClientPutState state,
                     ClientContext context)

Called when we know the final URI of the insert.

Specified by:

onEncode in interface PutCompletionCallback

onMetadata

public void onMetadata(Bucket finalMetadata,
                       ClientPutState state,
                       ClientContext context)

Called when metadataThreshold was specified and metadata is being returned instead of a URI.

Specified by:

onMetadata in interface PutCompletionCallback

cancel

public void cancel(ClientContext context)

Cancel the insert. Will call onFailure() if it is not already cancelled, so the callback will normally be called.

Specified by:

cancel in class ClientRequester

Parameters:

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

isFinished

public boolean isFinished()

Has the insert completed already?

Specified by:

isFinished in class ClientRequester

getData

public Bucket getData()

Returns:

The data Bucket which is used by this ClientPutter.

getTargetURI

public FreenetURI getTargetURI()

Get the target URI with which this insert was started.

getURI

public FreenetURI getURI()

Get the final URI to the inserted data

Specified by:

getURI in class ClientRequester

getSplitfileCryptoKey

public byte[] getSplitfileCryptoKey()

Get used splitfile cryptokey. Valid only after start().

onTransition

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

Called when a ClientPutState transitions to a new state. If this is the current state, then we update it, but it might also be a subsidiary state, in which case we ignore it.

Specified by:

onTransition in interface PutCompletionCallback

Specified by:

onTransition in class BaseClientPutter

onMetadata

public void onMetadata(Metadata m,
                       ClientPutState state,
                       ClientContext context)

Called when we have generated metadata for the insert. This should not happen, because we should insert the metadata!

Specified by:

onMetadata in interface PutCompletionCallback

getMinSuccessFetchBlocks

public int getMinSuccessFetchBlocks()

Specified by:

getMinSuccessFetchBlocks in class BaseClientPutter

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

clearCountersOnRestart

protected void clearCountersOnRestart()

Overrides:

clearCountersOnRestart in class ClientRequester

innerNotifyClients

protected 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

innerToNetwork

protected void innerToNetwork(ClientContext context)

Notify listening clients that an insert has been sent to the network.

Specified by:

innerToNetwork in class ClientRequester

onBlockSetFinished

public void onBlockSetFinished(ClientPutState state,
                               ClientContext context)

Called when we know exactly how many blocks will be needed.

Specified by:

onBlockSetFinished in interface PutCompletionCallback

onFetchable

public void onFetchable(ClientPutState state)

Called (sometimes) when enough of the data has been inserted that the file can now be fetched. Not very useful unless earlyEncode was enabled.

Specified by:

onFetchable in interface PutCompletionCallback

canRestart

public boolean canRestart()

Can we restart the insert?

restart

public boolean restart(ClientContext context)
                throws InsertException

Restart the insert.

Returns:

True if the insert restarted successfully.

Throws:

InsertException - If the insert could not be restarted for some reason.

onTransition

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

Specified by:

onTransition in class ClientRequester

dump

public void dump()

Overrides:

dump in class BaseClientPutter

getClientDetail

public byte[] getClientDetail(ChecksumChecker checker)
                       throws java.io.IOException

Overrides:

getClientDetail in class ClientRequester

Parameters:

checker - Used to checksum and isolate large components where we can recover if they fail.

Returns:

A byte[] representing the original client, to be written to the file storing a persistent download. E.g. for FCP, this will include the Identifier, whether it is on the global queue and the client name.

Throws:

java.io.IOException

innerOnResume

public 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

getCallback

protected ClientBaseCallback getCallback()

Specified by:

getCallback in class ClientRequester

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