freenet.clients.fcp

Class ClientRequest

java.lang.Object

freenet.clients.fcp.ClientRequest

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ClientGet, ClientPutBase

public abstract class ClientRequest
extends java.lang.Object
implements java.io.Serializable

A request process carried out by the node for an FCP client. Examples: ClientGet, ClientPut, MultiGet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientRequest.Persistence

Field Summary

Fields

Modifier and Type	Field and Description
protected PersistentRequestClient	client Client
protected java.lang.String	clientName If the request isn't on the global queue, what is the client's name?
protected java.lang.String	clientToken Client token (string to feed back to the client on a Persistent* when he does a ListPersistentRequests).
protected long	completionTime Timestamp : completion time
protected boolean	finished Has the request finished?
protected boolean	global Is the request on the global queue?
protected java.lang.String	identifier Unique request identifier
protected RequestClient	lowLevelClient
protected FCPConnectionHandler	origHandler Original FCPConnectionHandler.
protected ClientRequest.Persistence	persistence Persistence type
protected short	priorityClass Priority class
protected boolean	realTime Is the request scheduled as "real-time" (as opposed to bulk)?
protected boolean	started
protected long	startupTime Timestamp : startup time
protected FreenetURI	uri URI to fetch, or target URI to insert to
protected int	verbosity Verbosity level.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientRequest()
protected	ClientRequest(java.io.DataInputStream dis, RequestIdentifier reqID, ClientContext context)
	ClientRequest(FreenetURI uri2, java.lang.String identifier2, int verbosity2, java.lang.String charset, FCPConnectionHandler handler, PersistentRequestClient client, short priorityClass2, ClientRequest.Persistence persistenceType2, boolean realTime, java.lang.String clientToken2, boolean global)
	ClientRequest(FreenetURI uri2, java.lang.String identifier2, int verbosity2, java.lang.String charset, FCPConnectionHandler handler, short priorityClass2, ClientRequest.Persistence persistenceType2, boolean realTime, java.lang.String clientToken2, boolean global)

Method Summary

Modifier and Type	Method and Description
void	cancel(ClientContext context)
abstract boolean	canRestart()
void	dropped(ClientContext context) Completed request dropped off the end without being acknowledged
protected void	finish() Request completed.
protected abstract void	freeData() Free cached data bucket(s)
abstract 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).
PersistentRequestClient	getClient()
void	getClientDetail(java.io.DataOutputStream dos, ChecksumChecker checker)
protected abstract ClientRequester	getClientRequest()
abstract double	getFailedBlocks()
abstract java.lang.String	getFailureReason(boolean longDescription)
abstract double	getFatalyFailedBlocks()
abstract double	getFetchedBlocks()
java.lang.String	getIdentifier() Get identifier string for request
long	getLastActivity() Deprecated. Use ClientRequester.getLatestSuccess() instead. You can use getClientRequest() to obtain the ClientRequester.
abstract double	getMinBlocks()
short	getPriority() Return the priority class
RequestClient	getRequestClient()
RequestIdentifier	getRequestIdentifier() Get the RequestIdentifier.
abstract double	getSuccessFraction()
abstract double	getTotalBlocks()
boolean	hasFinished()
int	hashCode()
abstract boolean	hasSucceeded()
protected abstract void	innerResume(ClientContext context)
protected boolean	isGlobalQueue()
boolean	isPersistent() Is the request persistent? False = we can drop the request if we lose the connection
boolean	isPersistentForever()
boolean	isStarted()
abstract boolean	isTotalFinalized() Has the total number of blocks to insert been determined yet?
void	modifyRequest(java.lang.String newClientToken, short newPriorityClass, FCPServer server) Called after a ModifyPersistentRequest.
abstract void	onLostConnection(ClientContext context) Lost connection
void	onResume(ClientContext context) Called just after serializing in the request.
void	onShutdown(ClientContext context) Called just before the final write when the node is shutting down.
void	requestWasRemoved(ClientContext context) Called after a RemovePersistentRequest.
abstract boolean	restart(ClientContext context, boolean disableFilterData)
void	restartAsync(FCPServer server, boolean disableFilterData)
static ClientRequest	restartFrom(java.io.DataInputStream dis, RequestIdentifier reqID, ClientContext context, ChecksumChecker checker)
abstract void	sendPendingMessages(FCPConnectionOutputHandler handler, java.lang.String listRequestIdentifier, boolean includeData, boolean onlyData) Send any pending messages for a persistent request e.g.
abstract void	start(ClientContext context) Start the request, if it has not already been started.

Methods inherited from class java.lang.Object

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

Field Detail

uri

protected FreenetURI uri

URI to fetch, or target URI to insert to

identifier

protected final java.lang.String identifier

Unique request identifier

verbosity

protected final int verbosity

Verbosity level. Relevant to all ClientRequests, although they interpret it differently.

origHandler

protected final transient FCPConnectionHandler origHandler

Original FCPConnectionHandler. Null if persistence != connection

global

protected final boolean global

Is the request on the global queue?

clientName

protected final java.lang.String clientName

If the request isn't on the global queue, what is the client's name?

client

protected transient PersistentRequestClient client

Client

priorityClass

protected short priorityClass

Priority class

realTime

protected final boolean realTime

Is the request scheduled as "real-time" (as opposed to bulk)?

persistence

protected final ClientRequest.Persistence persistence

Persistence type

finished

protected boolean finished

Has the request finished?

clientToken

protected java.lang.String clientToken

Client token (string to feed back to the client on a Persistent* when he does a ListPersistentRequests).

startupTime

protected final long startupTime

Timestamp : startup time

completionTime

protected long completionTime

Timestamp : completion time

lowLevelClient

protected transient RequestClient lowLevelClient

started

protected boolean started

Constructor Detail

ClientRequest

public ClientRequest(FreenetURI uri2,
                     java.lang.String identifier2,
                     int verbosity2,
                     java.lang.String charset,
                     FCPConnectionHandler handler,
                     PersistentRequestClient client,
                     short priorityClass2,
                     ClientRequest.Persistence persistenceType2,
                     boolean realTime,
                     java.lang.String clientToken2,
                     boolean global)

ClientRequest

public ClientRequest(FreenetURI uri2,
                     java.lang.String identifier2,
                     int verbosity2,
                     java.lang.String charset,
                     FCPConnectionHandler handler,
                     short priorityClass2,
                     ClientRequest.Persistence persistenceType2,
                     boolean realTime,
                     java.lang.String clientToken2,
                     boolean global)

ClientRequest

protected ClientRequest()

ClientRequest

protected ClientRequest(java.io.DataInputStream dis,
                        RequestIdentifier reqID,
                        ClientContext context)
                 throws java.io.IOException,
                        StorageFormatException

Throws:

java.io.IOException

StorageFormatException

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

onLostConnection

public abstract void onLostConnection(ClientContext context)

Lost connection

sendPendingMessages

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

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

cancel

public void cancel(ClientContext context)

isPersistentForever

public boolean isPersistentForever()

isPersistent

public boolean isPersistent()

Is the request persistent? False = we can drop the request if we lose the connection

hasFinished

public boolean hasFinished()

getIdentifier

public java.lang.String getIdentifier()

Get identifier string for request

getClientRequest

protected abstract ClientRequester getClientRequest()

dropped

public void dropped(ClientContext context)

Completed request dropped off the end without being acknowledged

getPriority

public short getPriority()

Return the priority class

freeData

protected abstract void freeData()

Free cached data bucket(s)

finish

protected void finish()

Request completed. But we may have to stick around until we are acked.

getSuccessFraction

public abstract double getSuccessFraction()

getTotalBlocks

public abstract double getTotalBlocks()

getMinBlocks

public abstract double getMinBlocks()

getFetchedBlocks

public abstract double getFetchedBlocks()

getFailedBlocks

public abstract double getFailedBlocks()

getFatalyFailedBlocks

public abstract double getFatalyFailedBlocks()

getFailureReason

public abstract java.lang.String getFailureReason(boolean longDescription)

isTotalFinalized

public abstract boolean isTotalFinalized()

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

start

public abstract void start(ClientContext context)

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

isStarted

public boolean isStarted()

hasSucceeded

public abstract boolean hasSucceeded()

getLastActivity

@Deprecated
public long getLastActivity()

Deprecated. Use ClientRequester.getLatestSuccess() instead. You can use getClientRequest() to obtain the ClientRequester.

Returns the time of the request’s last activity, or 0 if there is no known last activity.

Returns:

The time of the request’s last activity, or 0

canRestart

public abstract boolean canRestart()

restart

public abstract boolean restart(ClientContext context,
                                boolean disableFilterData)
                         throws PersistenceDisabledException

Throws:

PersistenceDisabledException

modifyRequest

public void modifyRequest(java.lang.String newClientToken,
                          short newPriorityClass,
                          FCPServer server)

Called after a ModifyPersistentRequest. Sends a PersistentRequestModified message to clients if any value changed.

restartAsync

public void restartAsync(FCPServer server,
                         boolean disableFilterData)
                  throws PersistenceDisabledException

Throws:

PersistenceDisabledException

requestWasRemoved

public void requestWasRemoved(ClientContext context)

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

isGlobalQueue

protected boolean isGlobalQueue()

getClient

public PersistentRequestClient getClient()

getClientDetail

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

Throws:

java.io.IOException

onResume

public final void onResume(ClientContext context)
                    throws ResumeFailedException

Called just after serializing in the request. Called by the ClientRequester, i.e. the tree starts there, and we MUST NOT call back to it or we get an infinite recursion. The main purpose of this method is to give us an opportunity to connect to the various (transient) system utilities we get from ClientContext, e.g. bucket factories, the FCP persistent root etc. The base class implementation in ClientRequest will register the request with an PersistentRequestClient via the new PersistentRequestRoot.

Parameters:

context - Contains all the important system utilities.

Throws:

ResumeFailedException

innerResume

protected abstract void innerResume(ClientContext context)
                             throws ResumeFailedException

Throws:

ResumeFailedException

getRequestClient

public RequestClient getRequestClient()

getRequestIdentifier

public RequestIdentifier getRequestIdentifier()

Get the RequestIdentifier. This just includes the queue and the identifier.

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

fullyResumed

public abstract 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).

onShutdown

public void onShutdown(ClientContext context)

Called just before the final write when the node is shutting down. Should write any dirty data to disk etc.