ClientRequester (fred API)

java.lang.Object
- freenet.client.async.ClientRequester

All Implemented Interfaces:

ClientRequestSchedulerGroup, java.io.Serializable

Direct Known Subclasses:

BaseClientGetter, BaseClientPutter
```
public abstract class ClientRequester
extends java.lang.Object
implements java.io.Serializable, ClientRequestSchedulerGroup
```
A high level request or insert. This may create any number of low-level requests of inserts, for example a request may follow redirects, download splitfiles and unpack containers, while an insert (for a file or a freesite) may also have to insert many blocks. A high-level request is created by a client, has a FetchContext or InsertContext for configuration. Compare to

See Also:

for a low-level request (which may still be multiple actual requests or inserts). WARNING: Changing non-transient members on classes that are Serializable can result in restarting downloads or losing uploads., Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`blockSetFinalized` Has totalBlocks stopped growing?
`protected boolean`	`cancelled` Has the request or insert been cancelled?
`protected RequestClient`	`client` The RequestClient, used to determine whether this request is persistent, and also we round-robin between different RequestClient's in scheduling within a given priority class and retry count.
`long`	`creationTime`
`protected int`	`failedBlocks` Number of blocks which have failed.
`protected int`	`fatallyFailedBlocks` Number of blocks which have failed fatally.
`protected java.util.Date`	`latestFailure`
`protected java.util.Date`	`latestSuccess` ATTENTION: This may be null for very old databases.
`protected int`	`minSuccessBlocks` Minimum number of blocks required to succeed for success.
`protected short`	`priorityClass` Priority class of the request or insert.
`protected boolean`	`realTimeFlag` Whether this is a real-time request
`protected boolean`	`sentToNetwork` Has at least one block been scheduled to be sent to the network? Requests can be satisfied entirely from the datastore sometimes.
`protected int`	`successfulBlocks` Number of blocks we have successfully completed a fetch/put for.
`protected int`	`totalBlocks` Total number of blocks this request has tried to fetch/put.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ClientRequester()` Required because we implement `Serializable`.
`protected`	`ClientRequester(short priorityClass, RequestClient requestClient)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBlock()` Add a block to our estimate of the total.
`void`	`addBlocks(int num)` Add several blocks to our estimate of the total.
`void`	`addMustSucceedBlocks(int blocks)` Add one or more blocks to the number of requires blocks, and don't notify the clients.
`void`	`addRedundantBlocksInsert(int blocks)` Insertors should override this.
`void`	`blockSetFinalized(ClientContext context)` The set of blocks has been finalised, total will not change any more.
`protected boolean`	`cancel()` Cancel the request.
`abstract void`	`cancel(ClientContext context)` Cancel the request.
`protected void`	`clearCountersOnRestart()`
`void`	`completedBlock(boolean dontNotify, ClientContext context)` We completed a block.
`void`	`failedBlock(boolean dontNotify, ClientContext context)` A block failed.
`void`	`failedBlock(ClientContext context)` A block failed.
`void`	`fatallyFailedBlock(ClientContext context)` A block failed fatally.
`static ClientRequester[]`	`getAll()`
`protected abstract ClientBaseCallback`	`getCallback()`
`RequestClient`	`getClient()` Get client context object
`byte[]`	`getClientDetail(ChecksumChecker checker)`
`protected static byte[]`	`getClientDetail(PersistentClientCallback callback, ChecksumChecker checker)`
`java.util.Date`	`getLatestFailure()` UTC Date of latest increase of `failedBlocks` or `fatallyFailedBlocks`. Null if there was no failure yet.
`java.util.Date`	`getLatestSuccess()` UTC Date of latest increase of `successfulBlocks`. Initialized to current time for usability purposes: This allows the user to sort downloads by last success in the user interface to determine which ones are stalling - those will be the ones with the oldest last success date.
`short`	`getPriorityClass()` What is our priority class?
`ClientRequestSchedulerGroup`	`getSchedulerGroup()` Get the group the request belongs to.
`int`	`getTotalBlocks()`
`abstract FreenetURI`	`getURI()` Get the URI for the request or insert.
`int`	`hashCode()` We need a hash code that persists across restarts.
`protected abstract void`	`innerNotifyClients(ClientContext context)` Notify clients, usually via a SplitfileProgressEvent, of the current progress.
`protected void`	`innerOnResume(ClientContext context)` Called by onResume() once and only once after restarting.
`protected abstract void`	`innerToNetwork(ClientContext context)` Notify clients that a request has gone to the network, for the first time, i.e.
`boolean`	`isCancelled()` Is the request or insert cancelled?
`boolean`	`isCurrentState(ClientGetState state)`
`abstract boolean`	`isFinished()` Is the request or insert completed (succeeded, failed, or cancelled, which is a kind of failure)?
`void`	`notifyClients(ClientContext context)` Notify clients by calling innerNotifyClients off-thread.
`void`	`onResume(ClientContext context)` Called for a persistent request after startup.
`void`	`onShutdown(ClientContext context)` Called just before the final write when shutting down the node.
`abstract void`	`onTransition(ClientGetState oldState, ClientGetState newState, ClientContext context)`
`boolean`	`persistent()` Is this request persistent?
`boolean`	`realTimeFlag()`
`protected void`	`resetBlocks()`
`void`	`setPriorityClass(short newPriorityClass, ClientContext ctx)` Change the priority class of the request (request includes inserts here).
`void`	`toNetwork(ClientContext context)` Called when we first send a request to the network.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - priorityClass
```
protected short priorityClass
```
    Priority class of the request or insert.
  - realTimeFlag
```
protected final boolean realTimeFlag
```
    Whether this is a real-time request
  - cancelled
```
protected boolean cancelled
```
    Has the request or insert been cancelled?
  - client
```
protected transient RequestClient client
```
    The RequestClient, used to determine whether this request is persistent, and also we round-robin between different RequestClient's in scheduling within a given priority class and retry count.
  - totalBlocks
```
protected int totalBlocks
```
    Total number of blocks this request has tried to fetch/put.
  - successfulBlocks
```
protected int successfulBlocks
```
    Number of blocks we have successfully completed a fetch/put for.
  - latestSuccess
```
protected java.util.Date latestSuccess
```
    ATTENTION: This may be null for very old databases.
    
    See Also:
    
    Explanation of the content and especially the default value.
  - failedBlocks
```
protected int failedBlocks
```
    Number of blocks which have failed.
  - fatallyFailedBlocks
```
protected int fatallyFailedBlocks
```
    Number of blocks which have failed fatally.
  - latestFailure
```
protected java.util.Date latestFailure
```
    See Also:
    
    getLatestFailure()
  - minSuccessBlocks
```
protected int minSuccessBlocks
```
    Minimum number of blocks required to succeed for success.
  - blockSetFinalized
```
protected boolean blockSetFinalized
```
    Has totalBlocks stopped growing?
  - sentToNetwork
```
protected boolean sentToNetwork
```
    Has at least one block been scheduled to be sent to the network? Requests can be satisfied entirely from the datastore sometimes.
  - creationTime
```
public final long creationTime
```
- Constructor Detail
  - ClientRequester
```
protected ClientRequester()
```
    Required because we implement Serializable.
  - ClientRequester
```
protected ClientRequester(short priorityClass,
                          RequestClient requestClient)
```
- Method Detail
  - onTransition
```
public abstract void onTransition(ClientGetState oldState,
                                  ClientGetState newState,
                                  ClientContext context)
```
  - getPriorityClass
```
public short getPriorityClass()
```
    What is our priority class?
  - cancel
```
protected boolean cancel()
```
    Cancel the request. Inner method, subclasses should actually tell the ClientGetState or whatever to cancel itself: this does not do anything apart from set a flag!
    
    Returns:
    
    Whether we were already cancelled.
  - cancel
```
public abstract void cancel(ClientContext context)
```
    Cancel the request. Subclasses must implement to actually tell the ClientGetState's or ClientPutState's to cancel.
    
    Parameters:
    
    context - The ClientContext object including essential but non-persistent objects such as the schedulers.
  - isCancelled
```
public boolean isCancelled()
```
    Is the request or insert cancelled?
  - getURI
```
public abstract FreenetURI getURI()
```
    Get the URI for the request or insert. For a request this is set at creation, but for an insert, it is set when we know what the final URI will be.
  - isFinished
```
public abstract boolean isFinished()
```
    Is the request or insert completed (succeeded, failed, or cancelled, which is a kind of failure)?
  - hashCode
```
public int hashCode()
```
    We need a hash code that persists across restarts.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - getTotalBlocks
```
public int getTotalBlocks()
```
  - getLatestSuccess
```
public java.util.Date getLatestSuccess()
```
    UTC Date of latest increase of successfulBlocks.
    Initialized to current time for usability purposes: This allows the user to sort downloads by last success in the user interface to determine which ones are stalling - those will be the ones with the oldest last success date. If we initialized it to "null" only, that would not be possible: The user couldn't distinguish very old stalling downloads from downloads which merely had no success yet because they were added a short time ago.
  - getLatestFailure
```
public java.util.Date getLatestFailure()
```
    UTC Date of latest increase of failedBlocks or fatallyFailedBlocks.
    Null if there was no failure yet.
  - resetBlocks
```
protected void resetBlocks()
```
  - blockSetFinalized
```
public void blockSetFinalized(ClientContext context)
```
    The set of blocks has been finalised, total will not change any more. Notify clients.
    
    Parameters:
    
    context - The ClientContext object including essential but non-persistent objects such as the schedulers.
  - addBlock
```
public void addBlock()
```
    Add a block to our estimate of the total. Don't notify clients.
  - addBlocks
```
public void addBlocks(int num)
```
    Add several blocks to our estimate of the total. Don't notify clients.
  - completedBlock
```
public void completedBlock(boolean dontNotify,
                           ClientContext context)
```
    We completed a block. Count it and notify clients unless dontNotify.
  - failedBlock
```
public void failedBlock(boolean dontNotify,
                        ClientContext context)
```
    A block failed. Count it and notify our clients.
  - failedBlock
```
public void failedBlock(ClientContext context)
```
    A block failed. Count it and notify our clients.
  - fatallyFailedBlock
```
public void fatallyFailedBlock(ClientContext context)
```
    A block failed fatally. Count it and notify our clients.
  - addMustSucceedBlocks
```
public void addMustSucceedBlocks(int blocks)
```
    Add one or more blocks to the number of requires blocks, and don't notify the clients.
  - addRedundantBlocksInsert
```
public void addRedundantBlocksInsert(int blocks)
```
    Insertors should override this. The method is duplicated rather than calling addMustSucceedBlocks to avoid confusing consequences when addMustSucceedBlocks does other things.
  - notifyClients
```
public final void notifyClients(ClientContext context)
```
    Notify clients by calling innerNotifyClients off-thread.
  - innerNotifyClients
```
protected abstract void innerNotifyClients(ClientContext context)
```
    Notify clients, usually via a SplitfileProgressEvent, of the current progress. Called off-thread. Please do not change SimpleEventProducer to always produce events off-thread, it is better to deal with that here, because events could be re-ordered, which matters for some events notably SimpleProgressEvent.
  - toNetwork
```
public void toNetwork(ClientContext context)
```
    Called when we first send a request to the network. Ensures that it really is the first time and passes on to innerToNetwork().
  - innerToNetwork
```
protected abstract void innerToNetwork(ClientContext context)
```
    Notify clients that a request has gone to the network, for the first time, i.e. we have finished checking the datastore for at least one part of the request.
  - clearCountersOnRestart
```
protected void clearCountersOnRestart()
```
  - getClient
```
public RequestClient getClient()
```
    Get client context object
  - setPriorityClass
```
public void setPriorityClass(short newPriorityClass,
                             ClientContext ctx)
```
    Change the priority class of the request (request includes inserts here).
    
    Parameters:
    
    newPriorityClass - The new priority class for the request or insert.
    
    ctx - The ClientContext, contains essential transient objects such as the schedulers.
  - realTimeFlag
```
public boolean realTimeFlag()
```
  - persistent
```
public boolean persistent()
```
    Is this request persistent?
  - getAll
```
public static ClientRequester[] getAll()
```
  - getClientDetail
```
public byte[] getClientDetail(ChecksumChecker checker)
                       throws java.io.IOException
```
    Parameters:
    
    checker - Used to checksum and isolate large components where we can recover if they fail.
    
    Returns:
    
    A byte[] representing the original client, to be written to the file storing a persistent download. E.g. for FCP, this will include the Identifier, whether it is on the global queue and the client name.
    
    Throws:
    
    java.io.IOException
  - getClientDetail
```
protected static byte[] getClientDetail(PersistentClientCallback callback,
                                        ChecksumChecker checker)
                                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - onResume
```
public final void onResume(ClientContext context)
                    throws ResumeFailedException
```
    Called for a persistent request after startup. Should call notifyClients() at the end, after the callback has been registered etc.
    
    Throws:
    
    ResumeFailedException
  - innerOnResume
```
protected void innerOnResume(ClientContext context)
                      throws ResumeFailedException
```
    Called by onResume() once and only once after restarting. Must be overridden, and must call super.innerOnResume().
    
    Throws:
    
    ResumeFailedException
  - getCallback
```
protected abstract ClientBaseCallback getCallback()
```
  - onShutdown
```
public void onShutdown(ClientContext context)
```
    Called just before the final write when shutting down the node.
  - isCurrentState
```
public boolean isCurrentState(ClientGetState state)
```
  - getSchedulerGroup
```
public ClientRequestSchedulerGroup getSchedulerGroup()
```
    Get the group the request belongs to. For single requests (the default) this is the request itself; for those in a group, such as a site insert, it is a common value between them.

Class ClientRequester

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

priorityClass

realTimeFlag

cancelled

client

totalBlocks

successfulBlocks

latestSuccess

failedBlocks

fatallyFailedBlocks

latestFailure

minSuccessBlocks

blockSetFinalized

sentToNetwork

creationTime

Constructor Detail

ClientRequester

ClientRequester

Method Detail

onTransition

getPriorityClass

cancel

cancel

isCancelled

getURI

isFinished

hashCode

getTotalBlocks

getLatestSuccess

getLatestFailure

resetBlocks

blockSetFinalized

addBlock

addBlocks

completedBlock

failedBlock

failedBlock

fatallyFailedBlock

addMustSucceedBlocks

addRedundantBlocksInsert

notifyClients

innerNotifyClients

toNetwork

innerToNetwork

clearCountersOnRestart

getClient

setPriorityClass

realTimeFlag

persistent

getAll

getClientDetail

getClientDetail

onResume

innerOnResume

getCallback

onShutdown

isCurrentState

getSchedulerGroup