UpdateRunner (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- java.lang.Thread
- - net.i2p.util.I2PThread
  - - net.i2p.util.I2PAppThread
    - - net.i2p.router.update.UpdateRunner

All Implemented Interfaces:
Runnable, UpdateTask, EepGet.StatusListener
Direct Known Subclasses:
DevSU3UpdateChecker, DevSU3UpdateRunner, NewsFetcher, PluginUpdateChecker, PluginUpdateRunner, UnsignedUpdateChecker, UnsignedUpdateRunner
```
class UpdateRunner
extends I2PAppThread
implements UpdateTask, EepGet.StatusListener
```
The downloader for router signed updates, and the base class for all the other Checkers and Runners.

Nested Class Summary
- Nested classes/interfaces inherited from class net.i2p.util.I2PThread
  I2PThread.OOMEventListener
- Nested classes/interfaces inherited from class java.lang.Thread
  Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields
Modifier and Type	Field and Description
`protected ByteArrayOutputStream`	`_baos` 56 byte header, only used for suds
`protected RouterContext`	`_context` router context
`protected URI`	`_currentURI` current URI being fetched
`protected EepGet`	`_get` the current EepGet instance
`protected boolean`	`_isPartial` tells the listeners what mode we are in - set to true in extending classes for checks
`protected boolean`	`_isRunning` whether the runner is currently running
`protected Log`	`_log` Class logger.
`protected UpdateMethod`	`_method` update method
`protected ConsoleUpdateManager`	`_mgr` update manager
`protected String`	`_newVersion` set by the listeners on completion
`protected UpdateType`	`_type` update type
`protected String`	`_updateFile` temporary file for the update download
`protected List<URI>`	`_urls` list of update URIs
`protected static long`	`CONNECT_TIMEOUT` connect timeout in ms
`protected boolean`	`done` whether the update completed
`protected static long`	`INACTIVITY_TIMEOUT` inactivity timeout with proxy in ms
`protected static long`	`NOPROXY_INACTIVITY_TIMEOUT` inactivity timeout without proxy in ms

Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors
Constructor and Description
`UpdateRunner(RouterContext ctx, ConsoleUpdateManager mgr, UpdateType type, List<URI> uris)` Uses router version for partial checks
`UpdateRunner(RouterContext ctx, ConsoleUpdateManager mgr, UpdateType type, List<URI> uris, String currentVersion)` Constructor with explicit current version.
`UpdateRunner(RouterContext ctx, ConsoleUpdateManager mgr, UpdateType type, UpdateMethod method, List<URI> uris)` Uses router version for partial checks
`UpdateRunner(RouterContext ctx, ConsoleUpdateManager mgr, UpdateType type, UpdateMethod method, List<URI> uris, String currentVersion)` Full constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`_t(String s)` translate a string
`protected String`	`_t(String s, Object o)` translate a string with a parameter
`void`	`attemptFailed(String url, long bytesTransferred, long bytesRemaining, int currentAttempt, int numRetries, Exception cause)` attemptFailed.
`void`	`attempting(String url)` attempting.
`void`	`bytesTransferred(long alreadyTransferred, int currentWrite, long bytesTransferred, long bytesRemaining, String url)` subclasses should override
`String`	`getID()` I d.
`UpdateMethod`	`getMethod()` Method.
`UpdateType`	`getType()` Type.
`URI`	`getURI()` U r i.
`void`	`headerReceived(String url, int attemptNum, String key, String val)` headerReceived.
`boolean`	`isRunning()` Whether running.
`protected static String`	`linkify(String url)` linkify.
`void`	`run()` run.
`void`	`shutdown()` shutdown.
`String`	`toString()` toString.
`void`	`transferComplete(long alreadyTransferred, long bytesTransferred, long bytesRemaining, String url, String outputFile, boolean notModified)` subclasses should override
`void`	`transferFailed(String url, long bytesTransferred, long bytesRemaining, int currentAttempt)` subclasses should override
`protected void`	`update()` Loop through the entire list of update URLs.
`protected void`	`updateStatus(String s)` updateStatus.

Methods inherited from class net.i2p.util.I2PAppThread
addOOMEventThreadListener, fireOOM, removeOOMEventThreadListener

Methods inherited from class net.i2p.util.I2PThread
addOOMEventListener, removeOOMEventListener, start

Methods inherited from class java.lang.Thread
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, stop, stop, suspend, yield

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

Methods inherited from interface net.i2p.update.UpdateTask
start

- Field Detail
  - _baos
```
protected final ByteArrayOutputStream _baos
```
    56 byte header, only used for suds
  - _context
```
protected final RouterContext _context
```
    router context
  - _currentURI
```
protected URI _currentURI
```
    current URI being fetched
  - _get
```
protected EepGet _get
```
    the current EepGet instance
  - _isPartial
```
protected boolean _isPartial
```
    tells the listeners what mode we are in - set to true in extending classes for checks
  - _isRunning
```
protected volatile boolean _isRunning
```
    whether the runner is currently running
  - _log
```
protected final Log _log
```
    Class logger.
  - _method
```
protected final UpdateMethod _method
```
    update method
  - _mgr
```
protected final ConsoleUpdateManager _mgr
```
    update manager
  - _newVersion
```
protected String _newVersion
```
    set by the listeners on completion
  - _type
```
protected final UpdateType _type
```
    update type
  - _updateFile
```
protected final String _updateFile
```
    temporary file for the update download
  - _urls
```
protected final List<URI> _urls
```
    list of update URIs
  - CONNECT_TIMEOUT
```
protected static final long CONNECT_TIMEOUT
```
    connect timeout in ms
    See Also:
    Constant Field Values
  - done
```
protected boolean done
```
    whether the update completed
  - INACTIVITY_TIMEOUT
```
protected static final long INACTIVITY_TIMEOUT
```
    inactivity timeout with proxy in ms
    See Also:
    Constant Field Values
  - NOPROXY_INACTIVITY_TIMEOUT
```
protected static final long NOPROXY_INACTIVITY_TIMEOUT
```
    inactivity timeout without proxy in ms
    See Also:
    Constant Field Values
- Constructor Detail
  - UpdateRunner
```
public UpdateRunner(RouterContext ctx,
                    ConsoleUpdateManager mgr,
                    UpdateType type,
                    List<URI> uris)
```
    Uses router version for partial checks
    Parameters:
    ctx - router context
    mgr - update manager
    type - update type
    uris - list of update URIs
  - UpdateRunner
```
public UpdateRunner(RouterContext ctx,
                    ConsoleUpdateManager mgr,
                    UpdateType type,
                    List<URI> uris,
                    String currentVersion)
```
    Constructor with explicit current version.
    Parameters:
    ctx - router context
    mgr - update manager
    type - update type
    uris - list of update URIs
    currentVersion - used for partial checks
  - UpdateRunner
```
public UpdateRunner(RouterContext ctx,
                    ConsoleUpdateManager mgr,
                    UpdateType type,
                    UpdateMethod method,
                    List<URI> uris)
```
    Uses router version for partial checks
    Parameters:
    ctx - router context
    mgr - update manager
    type - update type
    method - update method
    uris - list of update URIs
  - UpdateRunner
```
public UpdateRunner(RouterContext ctx,
                    ConsoleUpdateManager mgr,
                    UpdateType type,
                    UpdateMethod method,
                    List<URI> uris,
                    String currentVersion)
```
    Full constructor.
    Parameters:
    ctx - router context
    mgr - update manager
    type - update type
    method - HTTP, HTTP_CLEARNET, or HTTPS_CLEARNET
    uris - list of update URIs
    currentVersion - used for partial checks
- Method Detail
  - _t
```
protected String _t(String s)
```
    translate a string
  - _t
```
protected String _t(String s,
                    Object o)
```
    translate a string with a parameter
  - attemptFailed
```
public void attemptFailed(String url,
                          long bytesTransferred,
                          long bytesRemaining,
                          int currentAttempt,
                          int numRetries,
                          Exception cause)
```
    attemptFailed.
    Specified by:
    attemptFailed in interface EepGet.StatusListener
    Parameters:
    url - the URL
    bytesTransferred - total transferred
    bytesRemaining - remaining
    currentAttempt - attempt index
    numRetries - retry limit
    cause - failure cause
    See Also:
    EepGet.StatusListener.bytesTransferred(long, int, long, long, java.lang.String)
  - attempting
```
public void attempting(String url)
```
    attempting.
    Specified by:
    attempting in interface EepGet.StatusListener
    Parameters:
    url - the URL being attempted
  - bytesTransferred
```
public void bytesTransferred(long alreadyTransferred,
                             int currentWrite,
                             long bytesTransferred,
                             long bytesRemaining,
                             String url)
```
    subclasses should override
    Specified by:
    bytesTransferred in interface EepGet.StatusListener
    Parameters:
    alreadyTransferred - total of all attempts, not including currentWrite If nonzero on the first call, a partial file of that length was found, _and_ the server supports resume. If zero on a subsequent call after some bytes are transferred (and presumably after an attemptFailed), the server does _not_ support resume and we had to start over. To track _actual_ transfer if the output file could already exist, the listener should keep its own counter, or subtract the initial alreadyTransferred value. And watch out for alreadyTransferred resetting if a resume failed...
    currentWrite - since last call to the listener
    bytesTransferred - includes headers, retries, redirects, discarded partial downloads, ...
    bytesRemaining - on this attempt only, currentWrite already subtracted - or -1 if chunked encoding or server does not return a length
    url - the URL being fetched
  - getID
```
public String getID()
```
    I d.
    Specified by:
    getID in interface UpdateTask
    Returns:
    the i d
  - getMethod
```
public UpdateMethod getMethod()
```
    Method.
    Specified by:
    getMethod in interface UpdateTask
    Returns:
    the method
  - getType
```
public UpdateType getType()
```
    Type.
    Specified by:
    getType in interface UpdateTask
    Returns:
    the type
  - getURI
```
public URI getURI()
```
    U r i.
    Specified by:
    getURI in interface UpdateTask
    Returns:
    the u r i
  - headerReceived
```
public void headerReceived(String url,
                           int attemptNum,
                           String key,
                           String val)
```
    headerReceived.
    Specified by:
    headerReceived in interface EepGet.StatusListener
    Parameters:
    url - the URL
    attemptNum - attempt index
    key - header key
    val - header value
  - isRunning
```
public boolean isRunning()
```
    Whether running.
    Specified by:
    isRunning in interface UpdateTask
    Returns:
    whether running
  - linkify
```
protected static String linkify(String url)
```
    linkify.
  - run
```
public void run()
```
    run.
    Specified by:
    run in interface Runnable
    Overrides:
    run in class I2PThread
  - shutdown
```
public void shutdown()
```
    shutdown.
    Specified by:
    shutdown in interface UpdateTask
  - toString
```
public String toString()
```
    toString.
    Overrides:
    toString in class Thread
  - transferComplete
```
public void transferComplete(long alreadyTransferred,
                             long bytesTransferred,
                             long bytesRemaining,
                             String url,
                             String outputFile,
                             boolean notModified)
```
    subclasses should override
    Specified by:
    transferComplete in interface EepGet.StatusListener
    Parameters:
    alreadyTransferred - total bytes transferred
    bytesTransferred - total incl headers
    bytesRemaining - remaining bytes
    url - the URL
    outputFile - null if unknown (output stream constructor)
    notModified - whether 304
    See Also:
    EepGet.StatusListener.bytesTransferred(long, int, long, long, java.lang.String)
  - transferFailed
```
public void transferFailed(String url,
                           long bytesTransferred,
                           long bytesRemaining,
                           int currentAttempt)
```
    subclasses should override
    Specified by:
    transferFailed in interface EepGet.StatusListener
    Parameters:
    url - the URL
    bytesTransferred - total transferred
    bytesRemaining - remaining
    currentAttempt - attempt index
    See Also:
    EepGet.StatusListener.bytesTransferred(long, int, long, long, java.lang.String)
  - update
```
protected void update()
```
    Loop through the entire list of update URLs. For each one, first get the version from the first 56 bytes and see if it is newer than what we are running now. If it is, get the whole thing.
  - updateStatus
```
protected void updateStatus(String s)
```
    updateStatus.

Class UpdateRunner

Nested Class Summary

Nested classes/interfaces inherited from class net.i2p.util.I2PThread

Nested classes/interfaces inherited from class java.lang.Thread

Field Summary

Fields inherited from class java.lang.Thread

Constructor Summary

Method Summary

Methods inherited from class net.i2p.util.I2PAppThread

Methods inherited from class net.i2p.util.I2PThread

Methods inherited from class java.lang.Thread

Methods inherited from class java.lang.Object

Methods inherited from interface net.i2p.update.UpdateTask

Field Detail

_baos

_context

_currentURI

_get

_isPartial

_isRunning

_log

_method

_mgr

_newVersion

_type

_updateFile

_urls

CONNECT_TIMEOUT

done

INACTIVITY_TIMEOUT

NOPROXY_INACTIVITY_TIMEOUT

Constructor Detail

UpdateRunner

UpdateRunner

UpdateRunner

UpdateRunner

Method Detail

_t

_t

attemptFailed

attempting

bytesTransferred

getID

getMethod

getType

getURI

headerReceived

isRunning

linkify

run

shutdown

toString

transferComplete

transferFailed

update

updateStatus