freenet.client.async

Class MultiPutCompletionCallback

java.lang.Object

freenet.client.async.MultiPutCompletionCallback

All Implemented Interfaces:

ClientPutState, PutCompletionCallback, java.io.Serializable

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

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MultiPutCompletionCallback(PutCompletionCallback cb, BaseClientPutter parent, java.lang.Object token, boolean persistent)
MultiPutCompletionCallback(PutCompletionCallback cb, BaseClientPutter parent, java.lang.Object token, boolean persistent, boolean collisionIsOK)
MultiPutCompletionCallback(PutCompletionCallback cb, BaseClientPutter parent, java.lang.Object token, boolean persistent, boolean collisionIsOK, boolean finishOnFailure)

Method Summary

Modifier and Type	Method and Description
void	add(ClientPutState ps)
void	addURIGenerator(ClientPutState ps)
void	arm(ClientContext context)
void	cancel(ClientContext context) Cancel the request.
BaseClientPutter	getParent() Get the BaseClientPutter responsible for this request state.
java.lang.Object	getToken() Get the token, an object which is passed around with the insert and may be used by callers.
void	onBlockSetFinished(ClientPutState state, ClientContext context) Called when the ClientPutState knows that it knows about all the blocks it will need to put.
void	onEncode(BaseClientKey key, ClientPutState state, ClientContext context) Called when we know the final URI of the state in question.
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	onMetadata(Bucket metadata, 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, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

token

public final java.lang.Object token

Constructor Detail

MultiPutCompletionCallback

public MultiPutCompletionCallback(PutCompletionCallback cb,
                                  BaseClientPutter parent,
                                  java.lang.Object token,
                                  boolean persistent)

MultiPutCompletionCallback

public MultiPutCompletionCallback(PutCompletionCallback cb,
                                  BaseClientPutter parent,
                                  java.lang.Object token,
                                  boolean persistent,
                                  boolean collisionIsOK)

MultiPutCompletionCallback

public MultiPutCompletionCallback(PutCompletionCallback cb,
                                  BaseClientPutter parent,
                                  java.lang.Object token,
                                  boolean persistent,
                                  boolean collisionIsOK,
                                  boolean finishOnFailure)

Method Detail

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

addURIGenerator

public void addURIGenerator(ClientPutState ps)

add

public void add(ClientPutState ps)

arm

public void arm(ClientContext context)

getParent

public BaseClientPutter getParent()

Description copied from interface: ClientPutState

Get the BaseClientPutter responsible for this request state.

Specified by:

getParent in interface ClientPutState

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

cancel

public void cancel(ClientContext context)

Description copied from interface: ClientPutState

Cancel the request.

Specified by:

cancel in interface ClientPutState

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

onMetadata

public void onMetadata(Bucket metadata,
                       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

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

schedule

public void schedule(ClientContext context)
              throws InsertException

Description copied from interface: ClientPutState

Schedule the request.

Specified by:

schedule in interface ClientPutState

Throws:

InsertException

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

onResume

public void onResume(ClientContext context)
              throws InsertException,
                     ResumeFailedException

Description copied from interface: PutCompletionCallback

Called on restarting the node for a persistent request. The request must re-schedule itself.

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