freenet.clients.fcp

Class ClientPutBase

java.lang.Object

freenet.clients.fcp.ClientRequest

freenet.clients.fcp.ClientPutBase

All Implemented Interfaces:

ClientBaseCallback, ClientPutCallback, ClientEventListener, java.io.Serializable

Direct Known Subclasses:

ClientPut, ClientPutDir

public abstract class ClientPutBase
extends ClientRequest
implements ClientPutCallback, ClientEventListener

Base class for ClientPut and ClientPutDir. Any code which can be shared between the two goes here.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientPutBase.UploadFrom

Nested classes/interfaces inherited from class freenet.clients.fcp.ClientRequest

ClientRequest.Persistence

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILE_HASH
protected FreenetURI	generatedURI URI generated for the insert.
protected FCPMessage	progressMessage
protected FreenetURI	publicURI
protected PutFailedMessage	putFailedMessage If the request failed, how did it fail? PutFailedMessage is the most convenient way to store this (InsertException has a stack trace!).
static java.lang.String	SALT
protected boolean	succeeded Has the request succeeded?

Fields inherited from class freenet.clients.fcp.ClientRequest

client, clientName, clientToken, completionTime, finished, global, identifier, lowLevelClient, origHandler, persistence, priorityClass, realTime, started, startupTime, uri, verbosity

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientPutBase()
	ClientPutBase(FreenetURI uri, java.lang.String identifier, int verbosity, java.lang.String charset, FCPConnectionHandler handler, PersistentRequestClient client, short priorityClass, ClientRequest.Persistence persistence, java.lang.String clientToken, boolean global, boolean getCHKOnly, boolean dontCompress, int maxRetries, boolean earlyEncode, boolean canWriteClientCache, boolean forkOnCacheable, boolean localRequestOnly, int extraInsertsSingleBlock, int extraInsertsSplitfileHeader, boolean realTimeFlag, java.lang.String compressorDescriptor, InsertContext.CompatibilityMode compatMode, boolean ignoreUSKDatehints, NodeClientCore core)
	ClientPutBase(FreenetURI uri, java.lang.String identifier, int verbosity, java.lang.String charset, FCPConnectionHandler handler, short priorityClass, ClientRequest.Persistence persistence, java.lang.String clientToken, boolean global, boolean getCHKOnly, boolean dontCompress, boolean localRequestOnly, int maxRetries, boolean earlyEncode, boolean canWriteClientCache, boolean forkOnCacheable, java.lang.String compressorDescriptor, int extraInsertsSingleBlock, int extraInsertsSplitfileHeader, boolean realTimeFlag, InsertContext.CompatibilityMode compatibilityMode, boolean ignoreUSKDatehints, FCPServer server)

Method Summary

Modifier and Type	Method and Description
double	getFailedBlocks()
PutFailedMessage	getFailureMessage()
java.lang.String	getFailureReason(boolean longDescription)
double	getFatalyFailedBlocks()
double	getFetchedBlocks()
FreenetURI	getGeneratedURI()
double	getMinBlocks()
double	getSuccessFraction()
double	getTotalBlocks()
protected abstract java.lang.String	getTypeName()
boolean	isTotalFinalized() Has the total number of blocks to insert been determined yet?
void	onFailure(InsertException e, BaseClientPutter state) Called on failed/canceled insert.
void	onFetchable(BaseClientPutter putter) Called when the inserted data is fetchable (just a hint, don't rely on this).
void	onGeneratedMetadata(Bucket metadata, BaseClientPutter state) Called when we are returning metadata rather than a URI.
void	onGeneratedURI(FreenetURI uri, BaseClientPutter state) Called when URI is known (e.g.
void	onLostConnection(ClientContext context) Lost connection
protected abstract void	onStartCompressing()
protected abstract void	onStopCompressing()
void	onSuccess(BaseClientPutter state) Called on successful insert.
protected abstract FCPMessage	persistentTagMessage()
void	receive(ClientEvent ce, ClientContext context) Hears an event.
void	requestWasRemoved(ClientContext context) Called after a RemovePersistentRequest.
void	sendPendingMessages(FCPConnectionOutputHandler handler, java.lang.String listRequestIdentifier, boolean includeData, boolean onlyData) Send any pending messages for a persistent request e.g.
void	setVarsRestart()

Methods inherited from class freenet.clients.fcp.ClientRequest

cancel, canRestart, dropped, finish, freeData, fullyResumed, getClient, getClientDetail, getClientRequest, getIdentifier, getLastActivity, getPriority, getRequestClient, getRequestIdentifier, hasFinished, hashCode, hasSucceeded, innerResume, isGlobalQueue, isPersistent, isPersistentForever, isStarted, modifyRequest, onResume, onShutdown, restart, restartAsync, restartFrom, start

Methods inherited from class java.lang.Object

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

Methods inherited from interface freenet.client.async.ClientBaseCallback

getRequestClient, onResume

Field Detail

succeeded

protected boolean succeeded

Has the request succeeded?

putFailedMessage

protected PutFailedMessage putFailedMessage

If the request failed, how did it fail? PutFailedMessage is the most convenient way to store this (InsertException has a stack trace!).

generatedURI

protected FreenetURI generatedURI

URI generated for the insert.

progressMessage

protected transient FCPMessage progressMessage

publicURI

protected final FreenetURI publicURI

SALT

public static final java.lang.String SALT

See Also:

Constant Field Values

FILE_HASH

public static final java.lang.String FILE_HASH

See Also:

Constant Field Values

Constructor Detail

ClientPutBase

public ClientPutBase(FreenetURI uri,
                     java.lang.String identifier,
                     int verbosity,
                     java.lang.String charset,
                     FCPConnectionHandler handler,
                     short priorityClass,
                     ClientRequest.Persistence persistence,
                     java.lang.String clientToken,
                     boolean global,
                     boolean getCHKOnly,
                     boolean dontCompress,
                     boolean localRequestOnly,
                     int maxRetries,
                     boolean earlyEncode,
                     boolean canWriteClientCache,
                     boolean forkOnCacheable,
                     java.lang.String compressorDescriptor,
                     int extraInsertsSingleBlock,
                     int extraInsertsSplitfileHeader,
                     boolean realTimeFlag,
                     InsertContext.CompatibilityMode compatibilityMode,
                     boolean ignoreUSKDatehints,
                     FCPServer server)
              throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

ClientPutBase

protected ClientPutBase()

ClientPutBase

public ClientPutBase(FreenetURI uri,
                     java.lang.String identifier,
                     int verbosity,
                     java.lang.String charset,
                     FCPConnectionHandler handler,
                     PersistentRequestClient client,
                     short priorityClass,
                     ClientRequest.Persistence persistence,
                     java.lang.String clientToken,
                     boolean global,
                     boolean getCHKOnly,
                     boolean dontCompress,
                     int maxRetries,
                     boolean earlyEncode,
                     boolean canWriteClientCache,
                     boolean forkOnCacheable,
                     boolean localRequestOnly,
                     int extraInsertsSingleBlock,
                     int extraInsertsSplitfileHeader,
                     boolean realTimeFlag,
                     java.lang.String compressorDescriptor,
                     InsertContext.CompatibilityMode compatMode,
                     boolean ignoreUSKDatehints,
                     NodeClientCore core)
              throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

Method Detail

onLostConnection

public void onLostConnection(ClientContext context)

Description copied from class: ClientRequest

Lost connection

Specified by:

onLostConnection in class ClientRequest

onSuccess

public void onSuccess(BaseClientPutter state)

Description copied from interface: ClientPutCallback

Called on successful insert. In this callback you must free the Bucket which you specified for the insert!

Specified by:

onSuccess in interface ClientPutCallback

Parameters:

state - The original BaseClientPutter object which was returned by the .insert() method which started this insert. Can be casted to the return type of that .insert() (to obtain the Bucket).

onFailure

public void onFailure(InsertException e,
                      BaseClientPutter state)

Description copied from interface: ClientPutCallback

Called on failed/canceled insert. In this callback you must free the Bucket which you specified for the insert!

Specified by:

onFailure in interface ClientPutCallback

state - The original BaseClientPutter object which was returned by the .insert() method which started this insert. Can be casted to the return type of that .insert() (to obtain the Bucket).

onGeneratedURI

public void onGeneratedURI(FreenetURI uri,
                           BaseClientPutter state)

Description copied from interface: ClientPutCallback

Called when URI is known (e.g. after encode all CHK blocks). Won't be called if we are returning metadata instead.

Specified by:

onGeneratedURI in interface ClientPutCallback

state - The original BaseClientPutter object which was returned by the .insert() method which started this insert. Can be casted to the return type of that .insert().

getGeneratedURI

public FreenetURI getGeneratedURI()

onGeneratedMetadata

public void onGeneratedMetadata(Bucket metadata,
                                BaseClientPutter state)

Description copied from interface: ClientPutCallback

Called when we are returning metadata rather than a URI. This only happens if the originator specified a metadata threshold, and we can get the metadata below that threshold without inserting a single top block.

Specified by:

onGeneratedMetadata in interface ClientPutCallback

Parameters:

metadata - Bucket containing the metadata. Persistent if the insert is persistent. Recipient may keep it, but must eventually free it. The caller will not free it.

state - The original BaseClientPutter object which was returned by the .insert() method which started this insert. Can be casted to the return type of that .insert().

requestWasRemoved

public void requestWasRemoved(ClientContext context)

Description copied from class: ClientRequest

Called after a RemovePersistentRequest. Send a PersistentRequestRemoved to the clients. If the request is in the database, delete it.

Overrides:

requestWasRemoved in class ClientRequest

receive

public void receive(ClientEvent ce,
                    ClientContext context)

Description copied from interface: ClientEventListener

Hears an event.

Specified by:

receive in interface ClientEventListener

Parameters:

ce - ClientEvent

context - The database context the event was generated in. NOTE THAT IT MAY NOT HAVE BEEN GENERATED IN A DATABASE CONTEXT AT ALL: In this case, container will be null, and you should use context to schedule a DBJob.

onStopCompressing

protected abstract void onStopCompressing()

onStartCompressing

protected abstract void onStartCompressing()

onFetchable

public void onFetchable(BaseClientPutter putter)

Description copied from interface: ClientPutCallback

Called when the inserted data is fetchable (just a hint, don't rely on this).

Specified by:

onFetchable in interface ClientPutCallback

Parameters:

putter - The original BaseClientPutter object which was returned by the .insert() method which started this insert. Can be casted to the return type of that .insert().

persistentTagMessage

protected abstract FCPMessage persistentTagMessage()

sendPendingMessages

public void sendPendingMessages(FCPConnectionOutputHandler handler,
                                java.lang.String listRequestIdentifier,
                                boolean includeData,
                                boolean onlyData)

Description copied from class: ClientRequest

Send any pending messages for a persistent request e.g. after reconnecting

Specified by:

sendPendingMessages in class ClientRequest

getTypeName

protected abstract java.lang.String getTypeName()

getSuccessFraction

public double getSuccessFraction()

Specified by:

getSuccessFraction in class ClientRequest

getTotalBlocks

public double getTotalBlocks()

Specified by:

getTotalBlocks in class ClientRequest

getMinBlocks

public double getMinBlocks()

Specified by:

getMinBlocks in class ClientRequest

getFailedBlocks

public double getFailedBlocks()

Specified by:

getFailedBlocks in class ClientRequest

getFatalyFailedBlocks

public double getFatalyFailedBlocks()

Specified by:

getFatalyFailedBlocks in class ClientRequest

getFetchedBlocks

public double getFetchedBlocks()

Specified by:

getFetchedBlocks in class ClientRequest

isTotalFinalized

public boolean isTotalFinalized()

Description copied from class: ClientRequest

Has the total number of blocks to insert been determined yet?

Specified by:

isTotalFinalized in class ClientRequest

getFailureReason

public java.lang.String getFailureReason(boolean longDescription)

Specified by:

getFailureReason in class ClientRequest

getFailureMessage

public PutFailedMessage getFailureMessage()

setVarsRestart

public void setVarsRestart()