NodeUpdater (fred API)

java.lang.Object
- freenet.node.updater.NodeUpdater

All Implemented Interfaces:

ClientBaseCallback, ClientGetCallback, USKCallback, RequestClient

Direct Known Subclasses:

MainJarUpdater, PluginJarUpdater
```
public abstract class NodeUpdater
extends java.lang.Object
implements ClientGetCallback, USKCallback, RequestClient
```

Field Summary

Fields
Modifier and Type	Field and Description
`NodeClientCore`	`core`
`protected int`	`fetchedVersion`
`NodeUpdateManager`	`manager`
`protected Node`	`node`
`protected java.io.File`	`tempBlobFile`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canUpdateNow()`
`int`	`fetchingVersion()`
`java.io.File`	`getBlobFile()`
`long`	`getBlobSize()`
`int`	`getFetchedVersion()`
`short`	`getPollingPriorityNormal()` Priority at which the polling should run normally.
`short`	`getPollingPriorityProgress()` Priority at which the polling should run when starting, or immediately after making some progress.
`RequestClient`	`getRequestClient()` Get the RequestClient context object used to indicate which requests are related to each other for scheduling purposes.
`FreenetURI`	`getUpdateKey()`
`boolean`	`isFetching()`
`abstract java.lang.String`	`jarName()`
`protected abstract void`	`maybeParseManifest(FetchResult result, int build)` Called with locks held
`protected void`	`maybeProcessOldBlob()`
`void`	`maybeUpdate()`
`void`	`onChangeURI(FreenetURI uri)` Called when the fetch URI has changed.
`void`	`onFailure(FetchException e, ClientGetter state)` Called on failed/canceled fetch.
`void`	`onFoundEdition(long l, USK key, ClientContext context, boolean wasMetadata, short codec, byte[] data, boolean newKnownGood, boolean newSlotToo)` Found the latest edition.
`void`	`onResume(ClientContext context)` Called for a persistent request when the node is restarted.
`protected abstract void`	`onStartFetching()`
`void`	`onSuccess(FetchResult result, ClientGetter state)` Called on successful fetch.
`protected void`	`parseDependencies(FetchResult result, int build)`
`protected void`	`parseDependencies(java.util.Properties props, int build)` Override if you want to deal with the file dependencies.properties
`protected void`	`parseManifest(FetchResult result)`
`protected void`	`parseManifestLine(java.lang.String line)`
`boolean`	`persistent()` Is this request persistent? Must not change!
`void`	`preKill()` Called before kill().
`protected abstract void`	`processSuccess(int fetched, FetchResult result, java.io.File blobFile)` We have fetched the jar! Do something after onSuccess().
`boolean`	`realTimeFlag()` Send the request with the real time flag enabled? Real-time requests are given a higher priority in data transfers, but fewer of them are accepted.
`void`	`setMinMax(int requiredExt, int recommendedExt)` Called by NodeUpdateManager to re-set the min/max versions for ext when a new freenet.jar has been downloaded.

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

- Field Detail
  - core
```
public final NodeClientCore core
```
  - node
```
protected final Node node
```
  - manager
```
public final NodeUpdateManager manager
```
  - fetchedVersion
```
protected int fetchedVersion
```
  - tempBlobFile
```
protected java.io.File tempBlobFile
```
- Method Detail
  - jarName
```
public abstract java.lang.String jarName()
```
  - maybeProcessOldBlob
```
protected void maybeProcessOldBlob()
```
  - getRequestClient
```
public RequestClient getRequestClient()
```
    Description copied from interface: ClientBaseCallback
    
    Get the RequestClient context object used to indicate which requests are related to each other for scheduling purposes.
    
    Specified by:
    
    getRequestClient in interface ClientBaseCallback
  - onFoundEdition
```
public void onFoundEdition(long l,
                           USK key,
                           ClientContext context,
                           boolean wasMetadata,
                           short codec,
                           byte[] data,
                           boolean newKnownGood,
                           boolean newSlotToo)
```
    Description copied from interface: USKCallback
    
    Found the latest edition. Called when the USKFetcher has finished, it won't search for any later editions.
    
    Specified by:
    
    onFoundEdition in interface USKCallback
    
    Parameters:
    
    l - The edition number.
    
    key - A copy of the key with new edition set
    
    newKnownGood - If the highest known good edition (which has actually been fetched with what it pointed to) has increased. Otherwise, the highest known SSK slot has been increased, from which searches will start, but we do not know whether it can actually be fetched successfully.
    
    newSlotToo - If newKnownGood is set, this indicates whether it is also a new highest known SSK slot. If newKnownGood is not set, there is always a new highest known SSK slot.
  - onStartFetching
```
protected abstract void onStartFetching()
```
  - maybeUpdate
```
public void maybeUpdate()
```
  - 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
  - processSuccess
```
protected abstract void processSuccess(int fetched,
                                       FetchResult result,
                                       java.io.File blobFile)
```
    We have fetched the jar! Do something after onSuccess(). Called unlocked.
  - maybeParseManifest
```
protected abstract void maybeParseManifest(FetchResult result,
                                           int build)
```
    Called with locks held
    
    Parameters:
    
    result -
  - parseManifest
```
protected void parseManifest(FetchResult result)
```
  - parseDependencies
```
protected void parseDependencies(FetchResult result,
                                 int build)
```
  - parseDependencies
```
protected void parseDependencies(java.util.Properties props,
                                 int build)
```
    Override if you want to deal with the file dependencies.properties
  - parseManifestLine
```
protected void parseManifestLine(java.lang.String line)
```
  - 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
  - preKill
```
public void preKill()
```
    Called before kill(). Don't do anything that will involve taking locks.
  - getUpdateKey
```
public FreenetURI getUpdateKey()
```
  - canUpdateNow
```
public boolean canUpdateNow()
```
  - onChangeURI
```
public void onChangeURI(FreenetURI uri)
```
    Called when the fetch URI has changed. No major locks are held by caller.
    
    Parameters:
    
    uri - The new URI.
  - getFetchedVersion
```
public int getFetchedVersion()
```
  - isFetching
```
public boolean isFetching()
```
  - fetchingVersion
```
public int fetchingVersion()
```
  - getBlobSize
```
public long getBlobSize()
```
  - getBlobFile
```
public java.io.File getBlobFile()
```
  - getPollingPriorityNormal
```
public short getPollingPriorityNormal()
```
    Description copied from interface: USKCallback
    
    Priority at which the polling should run normally. See RequestScheduler for constants.
    
    Specified by:
    
    getPollingPriorityNormal in interface USKCallback
  - getPollingPriorityProgress
```
public short getPollingPriorityProgress()
```
    Description copied from interface: USKCallback
    
    Priority at which the polling should run when starting, or immediately after making some progress. See RequestScheduler for constants.
    
    Specified by:
    
    getPollingPriorityProgress in interface USKCallback
  - persistent
```
public boolean persistent()
```
    Description copied from interface: RequestClient
    
    Is this request persistent? **Must not change!**
    
    Specified by:
    
    persistent in interface RequestClient
  - setMinMax
```
public void setMinMax(int requiredExt,
                      int recommendedExt)
```
    Called by NodeUpdateManager to re-set the min/max versions for ext when a new freenet.jar has been downloaded. This is to try to avoid the node installing incompatible versions of main and ext.
  - realTimeFlag
```
public boolean realTimeFlag()
```
    Description copied from interface: RequestClient
    
    Send the request with the real time flag enabled? Real-time requests are given a higher priority in data transfers, but fewer of them are accepted. They are optimised for latency rather than throughput, and are expected to be bursty rather than continual. **Must not change!**
    
    Specified by:
    
    realTimeFlag in interface RequestClient
  - onResume
```
public void onResume(ClientContext context)
```
    Description copied from interface: ClientBaseCallback
    
    Called for a persistent request when the node is restarted. Must re-register with whatever infrastructure the request is using, e.g. PersistentRequestRoot, persistent temp buckets etc.
    
    Specified by:
    
    onResume in interface ClientBaseCallback

Class NodeUpdater

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

core

node

manager

fetchedVersion

tempBlobFile

Method Detail

jarName

maybeProcessOldBlob

getRequestClient

onFoundEdition

onStartFetching

maybeUpdate

onSuccess

processSuccess

maybeParseManifest

parseManifest

parseDependencies

parseDependencies

parseManifestLine

onFailure

preKill

getUpdateKey

canUpdateNow

onChangeURI

getFetchedVersion

isFetching

fetchingVersion

getBlobSize

getBlobFile

getPollingPriorityNormal

getPollingPriorityProgress

persistent

setMinMax

realTimeFlag

onResume