freenet.client.async

Class USKInserter

java.lang.Object

freenet.client.async.USKInserter

All Implemented Interfaces:

ClientPutState, PutCompletionCallback, USKCallback, USKFetcherCallback, java.io.Serializable

public class USKInserter
extends java.lang.Object
implements ClientPutState, USKFetcherCallback, PutCompletionCallback, java.io.Serializable

Insert a USK. The algorithm is simply to do a thorough search for the latest edition, and insert at the following slot. Thereafter, if we get a collision, increment our slot; if we get more than 5 consecutive collisions, search for the latest slot again.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Object	tokenObject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	USKInserter()
	USKInserter(BaseClientPutter parent, Bucket data, short compressionCodec, FreenetURI uri, InsertContext ctx, PutCompletionCallback cb, boolean isMetadata, int sourceLength, int token, boolean addToParent, java.lang.Object tokenObject, ClientContext context, boolean freeData, boolean persistent, boolean realTimeFlag, int extraInserts, byte cryptoAlgorithm, byte[] forceCryptoKey)

Method Summary

Modifier and Type	Method and Description
void	cancel(ClientContext context) Cancel the request.
BaseClientPutter	getParent() Get the BaseClientPutter responsible for this request state.
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.
java.lang.Object	getToken() Get the token, an object which is passed around with the insert and may be used by callers.
int	hashCode()
void	onBlockSetFinished(ClientPutState state, ClientContext context) Called when the ClientPutState knows that it knows about all the blocks it will need to put.
void	onCancelled(ClientContext context)
void	onEncode(BaseClientKey key, ClientPutState state, ClientContext context) Called when we know the final URI of the state in question.
void	onFailure(ClientContext context) Failed to find any edition at all (later than or equal to the specified hint)
void	onFailure(InsertException e, ClientPutState state, ClientContext context)
void	onFetchable(ClientPutState state) Called when enough data has been inserted that the file can be retrieved, even if not all data has been inserted yet.
void	onFoundEdition(long l, USK key, ClientContext context, boolean lastContentWasMetadata, short codec, byte[] hisData, boolean newKnownGood, boolean newSlotToo) Found the latest edition.
void	onMetadata(Bucket meta, ClientPutState state, ClientContext context) Called as an alternative to onEncode, if a metadata length threshold was specified.
void	onMetadata(Metadata m, ClientPutState state, ClientContext context) Only called if explicitly asked for, in which case, generally the metadata won't be inserted.
void	onResume(ClientContext context) Called on restarting the node for a persistent request.
void	onShutdown(ClientContext context) Called just before the final write of client.dat before the node shuts down.
void	onSuccess(ClientPutState state, ClientContext context)
void	onTransition(ClientPutState oldState, ClientPutState newState, ClientContext context)
void	schedule(ClientContext context) Schedule the request.

Methods inherited from class java.lang.Object

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

Field Detail

tokenObject

public final java.lang.Object tokenObject

Constructor Detail

USKInserter

public USKInserter(BaseClientPutter parent,
                   Bucket data,
                   short compressionCodec,
                   FreenetURI uri,
                   InsertContext ctx,
                   PutCompletionCallback cb,
                   boolean isMetadata,
                   int sourceLength,
                   int token,
                   boolean addToParent,
                   java.lang.Object tokenObject,
                   ClientContext context,
                   boolean freeData,
                   boolean persistent,
                   boolean realTimeFlag,
                   int extraInserts,
                   byte cryptoAlgorithm,
                   byte[] forceCryptoKey)
            throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

USKInserter

protected USKInserter()

Method Detail

schedule

public void schedule(ClientContext context)
              throws InsertException

Description copied from interface: ClientPutState

Schedule the request.

Specified by:

schedule in interface ClientPutState

Throws:

InsertException

onFoundEdition

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

Description copied from interface: USKFetcherCallback

Found the latest edition. **This is terminal for a USKFetcherCallback**. It isn't for a USKCallback subscription.

Specified by:

onFoundEdition in interface USKCallback

Specified by:

onFoundEdition in interface USKFetcherCallback

Parameters:

l - The edition number.

key - The key.

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(ClientPutState state,
                      ClientContext context)

Specified by:

onSuccess in interface PutCompletionCallback

onFailure

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

Specified by:

onFailure in interface PutCompletionCallback

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getParent

public BaseClientPutter getParent()

Description copied from interface: ClientPutState

Get the BaseClientPutter responsible for this request state.

Specified by:

getParent in interface ClientPutState

cancel

public void cancel(ClientContext context)

Description copied from interface: ClientPutState

Cancel the request.

Specified by:

cancel in interface ClientPutState

onFailure

public void onFailure(ClientContext context)

Description copied from interface: USKFetcherCallback

Failed to find any edition at all (later than or equal to the specified hint)

Specified by:

onFailure in interface USKFetcherCallback

onCancelled

public void onCancelled(ClientContext context)

Specified by:

onCancelled in interface USKFetcherCallback

onEncode

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

Description copied from interface: PutCompletionCallback

Called when we know the final URI of the state in question. The currentState eventually calls this on the ClientPutter, which relays to the fcp layer, which sends a URIGenerated message.

Specified by:

onEncode in interface PutCompletionCallback

onTransition

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

Specified by:

onTransition in interface PutCompletionCallback

onMetadata

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

Description copied from interface: PutCompletionCallback

Only called if explicitly asked for, in which case, generally the metadata won't be inserted. Won't be called if there isn't any!

Specified by:

onMetadata in interface PutCompletionCallback

onBlockSetFinished

public void onBlockSetFinished(ClientPutState state,
                               ClientContext context)

Description copied from interface: PutCompletionCallback

Called when the ClientPutState knows that it knows about all the blocks it will need to put.

Specified by:

onBlockSetFinished in interface PutCompletionCallback

getToken

public java.lang.Object getToken()

Description copied from interface: ClientPutState

Get the token, an object which is passed around with the insert and may be used by callers.

Specified by:

getToken in interface ClientPutState

onFetchable

public void onFetchable(ClientPutState state)

Description copied from interface: PutCompletionCallback

Called when enough data has been inserted that the file can be retrieved, even if not all data has been inserted yet. Note that this is only supported for splitfiles; if you get onSuccess() first, assume that onFetchable() isn't coming.

Specified by:

onFetchable in interface PutCompletionCallback

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

onMetadata

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

Description copied from interface: PutCompletionCallback

Called as an alternative to onEncode, if a metadata length threshold was specified. Lower-level insert states, such as SplitFileInserter, will call onMetadata() instead. Higher level insert states will call this version or onEncode. Callee must free the Bucket. FIXME arguably we should split the interface, it might simplify e.g. SingleFileInserter.SplitHandler.

Specified by:

onMetadata in interface PutCompletionCallback

onResume

public void onResume(ClientContext context)
              throws InsertException,
                     ResumeFailedException

Description copied from interface: ClientPutState

Called on restarting the node for a persistent request. The request must re-schedule itself. Caller must ensure that it is safe to call this method more than once, as we recurse through the graph of dependencies.

Specified by:

onResume in interface ClientPutState

Specified by:

onResume in interface PutCompletionCallback

Throws:

InsertException

ResumeFailedException

onShutdown

public void onShutdown(ClientContext context)

Description copied from interface: ClientPutState

Called just before the final write of client.dat before the node shuts down. Should write any dirty data to disk etc.

Specified by:

onShutdown in interface ClientPutState