freenet.clients.fcp

Class ClientGet

java.lang.Object

freenet.clients.fcp.ClientRequest

freenet.clients.fcp.ClientGet

All Implemented Interfaces:

ClientBaseCallback, ClientGetCallback, PersistentClientCallback, ClientEventListener, java.io.Serializable

public class ClientGet
extends ClientRequest
implements ClientGetCallback, ClientEventListener, PersistentClientCallback

A simple client fetch. This can of course fetch arbitrarily large files, including splitfiles, redirects, etc.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientGet.ReturnType

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

ClientRequest.Persistence

Field Summary

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	ClientGet()
	ClientGet(FCPConnectionHandler handler, ClientGetMessage message, NodeClientCore core)
	ClientGet(PersistentRequestClient globalClient, FreenetURI uri, boolean dsOnly, boolean ignoreDS, boolean filterData, int maxSplitfileRetries, int maxNonSplitfileRetries, long maxOutputLength, ClientGet.ReturnType returnType, boolean persistRebootOnly, java.lang.String identifier, int verbosity, short prioClass, java.io.File returnFilename, java.lang.String charset, boolean writeToClientCache, boolean realTimeFlag, boolean binaryBlob, NodeClientCore core) Create one for a global-queued request not made by FCP.

Method Summary

Modifier and Type	Method and Description
boolean	canRestart()
boolean	filterData()
protected void	freeData() Free cached data bucket(s)
boolean	fullyResumed() Return true if we resumed the original fetch from stored data (usually a file for a splitfile download), rather than having to restart it (which happens in most other cases when we resume).
Bucket	getBucket() Returns the Bucket that contains the downloaded data.
void	getClientDetail(java.io.DataOutputStream dos, ChecksumChecker checker) Called to get a high level representation of the request.
protected ClientRequester	getClientRequest()
InsertContext.CompatibilityMode[]	getCompatibilityMode()
long	getDataSize()
java.io.File	getDestFilename()
boolean	getDontCompress()
double	getFailedBlocks()
java.lang.String	getFailureReason(boolean longDescription)
FetchException.FetchExceptionMode	getFailureReasonCode()
double	getFatalyFailedBlocks()
double	getFetchedBlocks()
java.lang.String	getMIMEType()
double	getMinBlocks()
byte[]	getOverriddenSplitfileCryptoKey()
double	getSuccessFraction()
double	getTotalBlocks()
FreenetURI	getURI()
boolean	hasPermRedirect()
boolean	hasSucceeded()
protected void	innerResume(ClientContext context)
boolean	isDirect()
boolean	isToDisk()
boolean	isTotalFinalized() Has the total number of blocks to insert been determined yet?
void	onFailure(FetchException e, ClientGetter state) Called on failed/canceled fetch.
void	onLostConnection(ClientContext context) Lost connection
void	onSuccess(FetchResult result, ClientGetter state) Called on successful fetch.
void	receive(ClientEvent ce, ClientContext context) Hears an event.
void	requestWasRemoved(ClientContext context) Called after a RemovePersistentRequest.
boolean	restart(ClientContext context, boolean disableFilterData)
static ClientRequest	restartFrom(java.io.DataInputStream dis, RequestIdentifier reqID, ClientContext context, ChecksumChecker checker)
void	sendPendingMessages(FCPConnectionOutputHandler handler, java.lang.String listRequestIdentifier, boolean includeData, boolean onlyData) Send any pending messages for a persistent request e.g.
void	setSuccessForMigration(ClientContext context, long completionTime, Bucket data)
void	start(ClientContext context) Start the request, if it has not already been started.

Methods inherited from class freenet.clients.fcp.ClientRequest

cancel, dropped, finish, getClient, getIdentifier, getLastActivity, getPriority, getRequestClient, getRequestIdentifier, hasFinished, hashCode, isGlobalQueue, isPersistent, isPersistentForever, isStarted, modifyRequest, onResume, onShutdown, restartAsync

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

Constructor Detail

ClientGet

public ClientGet(PersistentRequestClient globalClient,
                 FreenetURI uri,
                 boolean dsOnly,
                 boolean ignoreDS,
                 boolean filterData,
                 int maxSplitfileRetries,
                 int maxNonSplitfileRetries,
                 long maxOutputLength,
                 ClientGet.ReturnType returnType,
                 boolean persistRebootOnly,
                 java.lang.String identifier,
                 int verbosity,
                 short prioClass,
                 java.io.File returnFilename,
                 java.lang.String charset,
                 boolean writeToClientCache,
                 boolean realTimeFlag,
                 boolean binaryBlob,
                 NodeClientCore core)
          throws IdentifierCollisionException,
                 NotAllowedException,
                 java.io.IOException

Create one for a global-queued request not made by FCP.

Throws:

IdentifierCollisionException

NotAllowedException

java.io.IOException

ClientGet

public ClientGet(FCPConnectionHandler handler,
                 ClientGetMessage message,
                 NodeClientCore core)
          throws IdentifierCollisionException,
                 MessageInvalidException

Throws:

IdentifierCollisionException

MessageInvalidException

ClientGet

protected ClientGet()

Method Detail

start

public void start(ClientContext context)

Description copied from class: ClientRequest

Start the request, if it has not already been started.

Specified by:

start in class ClientRequest

onLostConnection

public void onLostConnection(ClientContext context)

Description copied from class: ClientRequest

Lost connection

Specified by:

onLostConnection in class ClientRequest

onSuccess

public void onSuccess(FetchResult result,
                      ClientGetter state)

Description copied from interface: ClientGetCallback

Called on successful fetch. Caller should schedule a job on the Ticker or Executor (on the ClientContext) if it needs to do much work.

Specified by:

onSuccess in interface ClientGetCallback

setSuccessForMigration

public void setSuccessForMigration(ClientContext context,
                                   long completionTime,
                                   Bucket data)
                            throws ResumeFailedException

Throws:

ResumeFailedException

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

onFailure

public void onFailure(FetchException e,
                      ClientGetter state)

Description copied from interface: ClientGetCallback

Called on failed/canceled fetch. Caller should schedule a job on the Ticker or Executor (on the ClientContext) if it needs to do much work.

Specified by:

onFailure in interface ClientGetCallback

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.

getClientRequest

protected ClientRequester getClientRequest()

Specified by:

getClientRequest in class ClientRequest

freeData

protected void freeData()

Description copied from class: ClientRequest

Free cached data bucket(s)

Specified by:

freeData in class ClientRequest

hasSucceeded

public boolean hasSucceeded()

Specified by:

hasSucceeded in class ClientRequest

isDirect

public boolean isDirect()

isToDisk

public boolean isToDisk()

getURI

public FreenetURI getURI()

getDataSize

public long getDataSize()

getMIMEType

public java.lang.String getMIMEType()

getDestFilename

public java.io.File getDestFilename()

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

getCompatibilityMode

public InsertContext.CompatibilityMode[] getCompatibilityMode()

getDontCompress

public boolean getDontCompress()

getOverriddenSplitfileCryptoKey

public byte[] getOverriddenSplitfileCryptoKey()

getFailureReason

public java.lang.String getFailureReason(boolean longDescription)

Specified by:

getFailureReason in class ClientRequest

getFailureReasonCode

public FetchException.FetchExceptionMode getFailureReasonCode()

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

getBucket

public Bucket getBucket()

Returns the Bucket that contains the downloaded data.

Returns:

The data in a Bucket, or null if this isn’t applicable

canRestart

public boolean canRestart()

Specified by:

canRestart in class ClientRequest

restart

public boolean restart(ClientContext context,
                       boolean disableFilterData)

Specified by:

restart in class ClientRequest

hasPermRedirect

public boolean hasPermRedirect()

filterData

public boolean filterData()

getClientDetail

public void getClientDetail(java.io.DataOutputStream dos,
                            ChecksumChecker checker)
                     throws java.io.IOException

Description copied from interface: PersistentClientCallback

Called to get a high level representation of the request. This will include: - Enough information to restart the request from scratch, including fields that can be changed manually after starting it (priority and client token). - If the request has completed, full data on its completion, i.e. the MIME type, where it was eventually stored etc. - If the request has reached a *simple* final state, i.e. a splitfile download, enough information to resume the request. This does NOT apply to single block fetches, multi-level metadata fetches, container fetches etc; it's basically the filename of the splitfile download plus the metadata that the splitfile may not have (MIME type etc). This is called in two cases: 1) When checkpointing, we write this data so that a request can be recovered even if serialization fails. 2) When creating a splitfile, we store it, so that a request can be recovered just from the splitfile. We do not update this data later on, so when it is restored it may have an out of date priority or client token.

Specified by:

getClientDetail in interface PersistentClientCallback

Overrides:

getClientDetail in class ClientRequest

Throws:

java.io.IOException

restartFrom

public static ClientRequest restartFrom(java.io.DataInputStream dis,
                                        RequestIdentifier reqID,
                                        ClientContext context,
                                        ChecksumChecker checker)
                                 throws StorageFormatException,
                                        java.io.IOException,
                                        ResumeFailedException

Throws:

StorageFormatException

java.io.IOException

ResumeFailedException

innerResume

protected void innerResume(ClientContext context)
                    throws ResumeFailedException

Specified by:

innerResume in class ClientRequest

Throws:

ResumeFailedException

fullyResumed

public boolean fullyResumed()

Description copied from class: ClientRequest

Return true if we resumed the original fetch from stored data (usually a file for a splitfile download), rather than having to restart it (which happens in most other cases when we resume).

Specified by:

fullyResumed in class ClientRequest