freenet.client.async

Class USKRetriever

java.lang.Object

freenet.client.async.ClientRequester

freenet.client.async.BaseClientGetter

freenet.client.async.USKRetriever

All Implemented Interfaces:

ClientRequestSchedulerGroup, GetCompletionCallback, USKCallback, java.io.Serializable

public class USKRetriever
extends BaseClientGetter
implements USKCallback

Poll a USK, and when a new slot is found, fetch it.

See Also:

Serialized Form

Field Summary

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
USKRetriever(FetchContext fctx, short prio, RequestClient client, USKRetrieverCallback cb, USK origUSK)

Method Summary

Modifier and Type	Method and Description
void	cancel(ClientContext context) Cancel the request.
void	changeUSKPollParameters(long time, int tries, ClientContext context) Only works if setFetcher() has been called, i.e.
protected ClientBaseCallback	getCallback()
USK	getOriginalUSK() Get the original USK URI which was passed when creating the retriever - not the latest known URI!
short	getPollingPriorityNormal() Priority at which the polling should run normally.
short	getPollingPriorityProgress() Priority at which the polling should run when starting, or immediately after making some progress.
FreenetURI	getURI() Get the original USK URI which was passed when creating the retriever - not the latest known URI!
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 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)?
void	onBlockSetFinished(ClientGetState state, ClientContext context) Called when the ClientGetState knows that it knows about all the blocks it will need to fetch.
void	onExpectedMIME(ClientMetadata meta, ClientContext context) Called when we know the MIME type of the final data.
void	onExpectedSize(long size, ClientContext context) Called when we know the size of the final data.
void	onExpectedTopSize(long size, long compressed, int blocksReq, int blocksTotal, ClientContext context) Called when we know the size of the final file, and the number of blocks needed etc.
void	onFailure(FetchException e, ClientGetState state, ClientContext context)
void	onFinalizedMetadata()
void	onFoundEdition(long l, USK key, ClientContext context, boolean metadata, short codec, byte[] data, boolean newKnownGood, boolean newSlotToo) Found the latest edition.
void	onHashes(HashResult[] hashes, ClientContext context) Called when we know the HashResult of the final file.
void	onSplitfileCompatibilityMode(InsertContext.CompatibilityMode min, InsertContext.CompatibilityMode max, byte[] splitfileKey, boolean compressed, boolean bottomLayer, boolean definitiveAnyway, ClientContext context) Called when we know the settings for the splitfile.
void	onSuccess(StreamGenerator streamGenerator, ClientMetadata clientMetadata, java.util.List<? extends Compressor> decompressors, ClientGetState state, ClientContext context)
void	onTransition(ClientGetState oldState, ClientGetState newState, ClientContext context) Called when the ClientGetState handling the request yields control to another ClientGetState.
void	unsubscribe(USKManager manager)

Methods inherited from class freenet.client.async.ClientRequester

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

Methods inherited from class java.lang.Object

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

Constructor Detail

USKRetriever

public USKRetriever(FetchContext fctx,
                    short prio,
                    RequestClient client,
                    USKRetrieverCallback cb,
                    USK origUSK)

Method Detail

onFoundEdition

public void onFoundEdition(long l,
                           USK key,
                           ClientContext context,
                           boolean metadata,
                           short codec,
                           byte[] data,
                           boolean newKnownGood,
                           boolean newSlotToo)

Description copied from interface: USKCallback

Found the latest edition. Called when the USKFetcher has finished, it won't search for any later editions.

Specified by:

onFoundEdition in interface USKCallback

Parameters:

l - The edition number.

key - A copy of the key with new edition set

newKnownGood - If the highest known good edition (which has actually been fetched with what it pointed to) has increased. Otherwise, the highest known SSK slot has been increased, from which searches will start, but we do not know whether it can actually be fetched successfully.

newSlotToo - If newKnownGood is set, this indicates whether it is also a new highest known SSK slot. If newKnownGood is not set, there is always a new highest known SSK slot.

onSuccess

public void onSuccess(StreamGenerator streamGenerator,
                      ClientMetadata clientMetadata,
                      java.util.List<? extends Compressor> decompressors,
                      ClientGetState state,
                      ClientContext context)

Specified by:

onSuccess in interface GetCompletionCallback

onFailure

public void onFailure(FetchException e,
                      ClientGetState state,
                      ClientContext context)

Specified by:

onFailure in interface GetCompletionCallback

onBlockSetFinished

public void onBlockSetFinished(ClientGetState state,
                               ClientContext context)

Description copied from interface: GetCompletionCallback

Called when the ClientGetState knows that it knows about all the blocks it will need to fetch.

Specified by:

onBlockSetFinished in interface GetCompletionCallback

getOriginalUSK

public USK getOriginalUSK()

Get the original USK URI which was passed when creating the retriever - not the latest known URI!

getURI

public FreenetURI getURI()

Get the original USK URI which was passed when creating the retriever - not the latest known URI!

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

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

onTransition

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

Description copied from interface: GetCompletionCallback

Called when the ClientGetState handling the request yields control to another ClientGetState.

Specified by:

onTransition in interface GetCompletionCallback

Specified by:

onTransition in class ClientRequester

Parameters:

oldState - The old ClientGetState.

newState - The new ClientGetState.

context - The database handle. Must not be used by other threads.

onExpectedMIME

public void onExpectedMIME(ClientMetadata meta,
                           ClientContext context)

Description copied from interface: GetCompletionCallback

Called when we know the MIME type of the final data. Useful for e.g. determining whether it is safe to handle etc, although the client can ask for the client layer to handle filtering.

Specified by:

onExpectedMIME in interface GetCompletionCallback

Parameters:

meta - The MIME type, possibly including parameters, as a String. E.g. "text/html; charset=ISO-8859-1".

context - Utility object containing helpers, mostly not persistent, such as the Ticker, temporary storage factories etc.

onExpectedSize

public void onExpectedSize(long size,
                           ClientContext context)

Description copied from interface: GetCompletionCallback

Called when we know the size of the final data. Not the same as onExpectedTopSize(), which is called for new metadata and gives more information. This might be called much later on for older content.

Specified by:

onExpectedSize in interface GetCompletionCallback

Parameters:

size - The expected size of the final data.

context - Utility object containing helpers, mostly not persistent, such as the Ticker, temporary storage factories etc.

onFinalizedMetadata

public void onFinalizedMetadata()

Specified by:

onFinalizedMetadata in interface GetCompletionCallback

getPollingPriorityNormal

public short getPollingPriorityNormal()

Description copied from interface: USKCallback

Priority at which the polling should run normally. See RequestScheduler for constants.

Specified by:

getPollingPriorityNormal in interface USKCallback

getPollingPriorityProgress

public short getPollingPriorityProgress()

Description copied from interface: USKCallback

Priority at which the polling should run when starting, or immediately after making some progress. See RequestScheduler for constants.

Specified by:

getPollingPriorityProgress in interface USKCallback

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.

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

onExpectedTopSize

public void onExpectedTopSize(long size,
                              long compressed,
                              int blocksReq,
                              int blocksTotal,
                              ClientContext context)

Description copied from interface: GetCompletionCallback

Called when we know the size of the final file, and the number of blocks needed etc. For recent metadata, this is known at the time of handling the top block.

Specified by:

onExpectedTopSize in interface GetCompletionCallback

Parameters:

size - The final size of the data.

compressed - The size of the data after compression / before decompression.

blocksReq - The number of blocks needed to decode the file.

blocksTotal - The total number of blocks available.

context - Utility object containing helpers, mostly not persistent, such as the Ticker, temporary storage factories etc.

onSplitfileCompatibilityMode

public void onSplitfileCompatibilityMode(InsertContext.CompatibilityMode min,
                                         InsertContext.CompatibilityMode max,
                                         byte[] splitfileKey,
                                         boolean compressed,
                                         boolean bottomLayer,
                                         boolean definitiveAnyway,
                                         ClientContext context)

Description copied from interface: GetCompletionCallback

Called when we know the settings for the splitfile.

Specified by:

onSplitfileCompatibilityMode in interface GetCompletionCallback

Parameters:

min - The lowest CompatibilityMode that appears to be valid based on what we've fetched so far.

max - The highest CompatibilityMode that appears to be valid based on what we've fetched so far.

splitfileKey - The fixed byte[] encryption key used on insert. On anything recent, we generate a single key, randomly for an SSK, or based on the content for a CHK, and use it for everything. This saves metadata space and improves security for SSKs.

compressed - Whether the content is compressed. If false, the dontCompress option was used.

bottomLayer - Whether this report originates at the bottom layer of the splitfile pyramid. I.e. the actual file, not the file containing the metadata to fetch the file (this can recurse for several levels!)

definitiveAnyway - Whether this report is definitive even though it's not from the bottom layer. This is true of recent splitfiles, where we store all the data in the top key.

context - Utility object containing helpers, mostly not persistent, such as the Ticker, temporary storage factories etc.

onHashes

public void onHashes(HashResult[] hashes,
                     ClientContext context)

Description copied from interface: GetCompletionCallback

Called when we know the HashResult of the final file. This will be checked when we actually fetch it, so is guaranteed to be correct. For recent metadata this is known at the top layer/block.

Specified by:

onHashes in interface GetCompletionCallback

Parameters:

hashes - A set of hashes for the final file content.

context - Utility object containing helpers, mostly not persistent, such as the Ticker, temporary storage factories etc.

unsubscribe

public void unsubscribe(USKManager manager)

changeUSKPollParameters

public void changeUSKPollParameters(long time,
                                    int tries,
                                    ClientContext context)

Only works if setFetcher() has been called, i.e. if this was created through USKManager.subscribeContentCustom(). FIXME this is a special case hack, For a generic solution see https://bugs.freenetproject.org/view.php?id=4984

Parameters:

time - The new cooldown time. At least 30 minutes or we throw.

tries - The new number of tries after each cooldown. Greater than 0 and less than 3 or we throw.

innerOnResume

public void innerOnResume(ClientContext context)

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

getCallback

protected ClientBaseCallback getCallback()

Specified by:

getCallback in class ClientRequester