Download

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.gudy.azureus2.plugins.download
Interface Download

All Superinterfaces:: DownloadEventNotifier, DownloadStub, Taggable

All Known Implementing Classes:: DownloadImpl, LWSDownload, RPDownload

public interface Download
extends DownloadEventNotifier, DownloadStub, Taggable
extends DownloadEventNotifier, DownloadStub, Taggable

Management of a Torrent's activity. Note: All listener based methods are now located in DownloadEventNotifier.

 A download's lifecycle:
 torrent gets added
    state -> QUEUED
 slot becomes available, queued torrent is picked, "restart" executed
    state -> WAITING
 state moves through PREPARING to READY
    state -> PREPARING
    state -> READY
 execute "start" method
    state -> SEEDING -or- DOWNLOADING
 if torrent is DOWNLOADING, and completes, state changes to SEEDING

 Path 1                   | Path 2
 -------------------------+------------------------------------------------
 execute "stop" method    | startstop rules are met, execute "stopandQueue"
    state -> STOPPING     |     state -> STOPPING
    state -> STOPPED      |     state -> STOPPED
                          |     state -> QUEUED
 execute "remove" method -> deletes the download
 a "stop" method call can be made when the download is in all states except STOPPED

Author:: parg

Nested Class Summary

Nested classes/interfaces inherited from interface org.gudy.azureus2.plugins.download.DownloadStub
`DownloadStub.DownloadStubEx, DownloadStub.DownloadStubFile`

Field Summary
`static long`	`FLAG_ALLOW_PERMITTED_PEER_SOURCE_CHANGES` Flag value - normally the permitted peer sources for a download are fixed and can't be changed this flag allows the permitted peer source set to be increased/decreased (but not beyond the enforced values required to honour a torrent's 'private' flag
`static long`	`FLAG_DISABLE_AUTO_FILE_MOVE` Flag value - if set, it prevents any of the "move on completion" or "move on removal" rules taking place.
`static long`	`FLAG_DISABLE_IP_FILTER` Used to disable IP filter rules for a download when ip-filtering is enabled
`static long`	`FLAG_DO_NOT_DELETE_DATA_ON_REMOVE` Flag value - if set the data will not be delete when the download is "deleted" from the v3 interface.
`static long`	`FLAG_ERROR_REPORTED`
`static long`	`FLAG_FORCE_DIRECT_DELETE` Force direct delete of download data when delete requested, rather than recoverable delete, and no user prompt
`static long`	`FLAG_INITIAL_NETWORKS_SET`
`static long`	`FLAG_LIGHT_WEIGHT`
`static long`	`FLAG_LOW_NOISE` Flag value - if set the user won't be bothered with popups/completion events during the download's life.
`static long`	`FLAG_METADATA_DOWNLOAD`
`static long`	`FLAG_MOVE_ON_COMPLETION_DONE` Flag value - if set, then it means this download has been considered for "move on completion", and it should not be considered again for it.
`static long`	`FLAG_ONLY_EVER_SEEDED` Flags values
`static long`	`FLAG_SCAN_INCOMPLETE_PIECES`
`static int`	`PR_HIGH_PRIORITY` Use more of the upload bandwidth than low priority downloads don't change these as they are used by remote clients
`static int`	`PR_LOW_PRIORITY` Use less of the upload bandwidth than high priority downloads
`static int`	`ST_DOWNLOADING` downloading
`static int`	`ST_ERROR` failed
`static java.lang.String[]`	`ST_NAMES`
`static int`	`ST_PREPARING` getting files ready (allocating/checking)
`static int`	`ST_QUEUED` stopped, but ready for auto-starting
`static int`	`ST_READY` ready to be started if required
`static int`	`ST_SEEDING` seeding
`static int`	`ST_STOPPED` stopped, do not auto-start!
`static int`	`ST_STOPPING` stopping
`static int`	`ST_WAITING` waiting to be told to start preparing

Method Summary
`void`	`addRateLimiter(RateLimiter limiter, boolean is_upload)`
`SaveLocationChange`	`calculateDefaultDownloadLocation()` Returns a `SaveLocationChange` object describing the appropriate location for the download (and torrent file) to exist in, based on the download's completion state, the `for-completion` rules in place, and the `SaveLocationManager` object in use.
`java.io.File[]`	`calculateDefaultPaths(boolean for_moving)` Deprecated. Use `calculateDefaultDownloadLocation()` instead.
`boolean`	`canBeRemoved()` Tests whether or not a download can be removed.
`boolean`	`canMoveDataFiles()` Returns `true` if Azureus will allow the data files for the torrent to be moved.
`boolean`	`canStubbify()`
`void`	`changeLocation(SaveLocationChange slc)` Apply the changes in the given `SaveLocationChange` object - this includes moving torrent and data file data.
`DownloadActivationEvent`	`getActivationState()` Gives access to the current activation state.
`DownloadScrapeResult`	`getAggregatedScrapeResult()` Returns an aggregated scrape result of all good results, or if none the same as getLastScrapeResult
`java.lang.String`	`getAttribute(TorrentAttribute attribute)` Gets an attribute of this download.
`boolean`	`getBooleanAttribute(TorrentAttribute attribute)` Gets the value of the given attribute from the download.
`java.lang.String`	`getCategoryName()` Deprecated. Use TorrentAttribute.TA_CATEGORY (2.2.0.3)
`long`	`getCreationTime()` returns the time this download was created in milliseconds
`DiskManager`	`getDiskManager()` Return the disk manager, null if its not running
`int`	`getDiskManagerFileCount()` Return the number of DiskManagerFile objects
`DiskManagerFileInfo[]`	`getDiskManagerFileInfo()` Returns info about the torrent's files.
`DiskManagerFileInfo`	`getDiskManagerFileInfo(int index)` Returns file info for the given index.
`java.util.List<DistributedDatabase>`	`getDistributedDatabases()`
`byte[]`	`getDownloadPeerId()` Get the local peerID advertised to the download swarm.
`int`	`getDownloadRateLimitBytesPerSecond()` Get the max download rate allowed for this download.
`java.lang.String`	`getErrorStateDetails()` When the download state is ERROR this method returns the error details
`boolean`	`getFlag(long flag)` Get the flag value
`long`	`getFlags()` get all the flags as a bitmap
`int`	`getIndex()` Index of download.
`int`	`getIntAttribute(TorrentAttribute attribute)` Gets the value of the given attribute from the download.
`DownloadAnnounceResult`	`getLastAnnounceResult()` Gives access to the last announce result received from the tracker for the download
`DownloadScrapeResult`	`getLastScrapeResult()` Gives access to the last scrape result received from the tracker for the download
`java.lang.String[]`	`getListAttribute(TorrentAttribute attribute)`
`long`	`getLongAttribute(TorrentAttribute attribute)` Gets the value of the given attribute from the download.
`java.util.Map`	`getMapAttribute(TorrentAttribute attribute)`
`int`	`getMaximumDownloadKBPerSecond()` Get the max download rate allowed for this download
`java.lang.String`	`getName()` Returns the name of the torrent.
`PeerManager`	`getPeerManager()` return the current peer manager for the download.
`int`	`getPosition()` Returns the current position in the queue Completed and Incompleted downloads have seperate position sets.
`DiskManagerFileInfo`	`getPrimaryFile()` Returns the "Primary" file in the download.
`int`	`getPriority()` Deprecated. >= 2.1.0.6 does nothing
`java.lang.String`	`getSavePath()` This returns the full save path for the download.
`int`	`getSeedingRank()` The torrents with the highest rankings will be seeded first.
`int`	`getState()` get state from above ST_ set
`DownloadStats`	`getStats()` Gives access to the download's statistics
`int`	`getSubState()` For the STOPPING state this method gives the state that is being transited too (STOPPED, QUEUED or ERROR)
`java.util.List<Tag>`	`getTags()`
`Torrent`	`getTorrent()` Each download has a corresponding torrent
`java.lang.String`	`getTorrentFileName()` Returns the full file path and name of the .torrent file
`int`	`getUploadRateLimitBytesPerSecond()` Get the max upload rate allowed for this download.
`java.lang.Object`	`getUserData(java.lang.Object key)` get user-defined key/value
`boolean`	`hasAttribute(TorrentAttribute attribute)` Returns `true` if the download has an explicit value stored for the given attribute.
`void`	`initialize()` See lifecycle description above
`boolean`	`isChecking()` When a download is completed it is rechecked (if the option is enabled).
`boolean`	`isComplete()` Indicates if the download has completed or not, exluding any files marked as Do No Download
`boolean`	`isComplete(boolean bIncludeDND)` Indicates if the download has completed or not
`boolean`	`isForceStart()` Retrieves whether the download is force started
`boolean`	`isInDefaultSaveDir()` Deprecated. Use `DefaultSaveLocationManager.isInDefaultSaveDir(Download)` instead.
`boolean`	`isMessagingEnabled()` Is advanced AZ messaging enabled for this download.
`boolean`	`isMoving()` Returns true if the download is currently in the process of having its datafiles moved
`boolean`	`isPaused()`
`boolean`	`isPersistent()` Downloads can be persistent (be remembered across Azureus sessions), or non-persistent.
`boolean`	`isPriorityLocked()` Deprecated. >= 2.0.8.0 does nothing
`boolean`	`isRemoved()`
`boolean`	`isStartStopLocked()` When a download is "start-stop locked" it means that seeding rules shouldn't start or stop the download as it is under manual control
`void`	`moveDataFiles(java.io.File new_parent_dir)` Move a download's data files to a new location.
`void`	`moveDataFiles(java.io.File new_parent_dir, java.lang.String new_name)` Move a download's data files to a new location, and rename the download at the same time.
`void`	`moveDown()` Moves the download down one position
`void`	`moveTo(int position)` Moves a download and re-orders the others appropriately.
`void`	`moveTorrentFile(java.io.File new_parent_dir)` Move a download's torrent file to a new location.
`void`	`moveUp()` Moves the download position up one
`void`	`pause()` Pause the download
`void`	`recheckData()` Performs a complete recheck of the downloaded data Download must be in stopped, queued or error state Action is performed asynchronously and will progress the download through states PREPARING back to the relevant state
`void`	`remove()` Removes a download.
`void`	`remove(boolean delete_torrent, boolean delete_data)` Same as "remove" but, if successful, deletes the torrent and/or data
`void`	`removeRateLimiter(RateLimiter limiter, boolean is_upload)`
`void`	`renameDownload(java.lang.String name)` Renames the file (for a single file torrent) or directory (for a multi file torrent) where the download is being saved to.
`void`	`requestTrackerAnnounce()` request a tracker announce
`void`	`requestTrackerAnnounce(boolean immediate)` request a tracker announce
`void`	`requestTrackerScrape(boolean immediate)` request a tracker announce
`void`	`restart()` See lifecycle description above
`void`	`resume()` Resume the download if paused
`void`	`setAnnounceResult(DownloadAnnounceResult result)`
`void`	`setAttribute(TorrentAttribute attribute, java.lang.String value)` Sets an attribute of this download.
`void`	`setBooleanAttribute(TorrentAttribute attribute, boolean value)` Sets a boolean attribute on this download.
`void`	`setCategory(java.lang.String sName)` Deprecated. Use TorrentAttribute.TA_CATEGORY (2.2.0.3)
`void`	`setDownloadRateLimitBytesPerSecond(int max_rate_bps)` Set the max download rate allowed for this download.
`void`	`setFlag(long flag, boolean set)` Set the flag value.
`void`	`setForceStart(boolean forceStart)` Set the forcestart state of the download
`void`	`setIntAttribute(TorrentAttribute attribute, int value)` Sets an integer attribute on this download.
`void`	`setListAttribute(TorrentAttribute attribute, java.lang.String[] value)`
`void`	`setLongAttribute(TorrentAttribute attribute, long value)` Sets a long attribute on this download.
`void`	`setMapAttribute(TorrentAttribute attribute, java.util.Map value)`
`void`	`setMaximumDownloadKBPerSecond(int kb)` Sets the maximum download speed in bytes per second.
`void`	`setMessagingEnabled(boolean enabled)` Enable or disable advanced AZ messaging for this download.
`void`	`setPosition(int newPosition)` Sets the position in the queue Completed and Incompleted downloads have seperate position sets
`void`	`setPriority(int priority)` Deprecated. >= 2.1.0.6 does nothing
`void`	`setScrapeResult(DownloadScrapeResult result)`
`void`	`setSeedingRank(int rank)` The torrents with the highest rankings will be seeded first.
`void`	`setUploadRateLimitBytesPerSecond(int max_rate_bps)` Set the max upload rate allowed for this download.
`void`	`setUserData(java.lang.Object key, java.lang.Object data)` set user defined value.
`void`	`start()` See lifecycle description above
`void`	`startDownload(boolean force)` Simple method to start the download.
`void`	`stop()` See lifecycle description above
`void`	`stopAndQueue()` See lifecycle description above
`void`	`stopDownload()` Simple method to stop the download.
`DownloadStub`	`stubbify()`

Methods inherited from interface org.gudy.azureus2.plugins.download.DownloadEventNotifier
`addActivationListener, addAttributeListener, addCompletionListener, addDownloadWillBeRemovedListener, addListener, addPeerListener, addPropertyListener, addTrackerListener, addTrackerListener, removeActivationListener, removeAttributeListener, removeCompletionListener, removeDownloadWillBeRemovedListener, removeListener, removePeerListener, removePropertyListener, removeTrackerListener`

Methods inherited from interface org.gudy.azureus2.plugins.download.DownloadStub
`destubbify, getStubFiles, getTorrentHash, getTorrentSize, isStub`

Field Detail

ST_WAITING

static final int ST_WAITING

waiting to be told to start preparing

See Also:: Constant Field Values

ST_PREPARING

static final int ST_PREPARING

getting files ready (allocating/checking)

See Also:: Constant Field Values

ST_READY

static final int ST_READY

ready to be started if required

See Also:: Constant Field Values

ST_DOWNLOADING

static final int ST_DOWNLOADING

downloading

See Also:: Constant Field Values

ST_SEEDING

static final int ST_SEEDING

seeding

See Also:: Constant Field Values

ST_STOPPING

static final int ST_STOPPING

stopping

See Also:: Constant Field Values

ST_STOPPED

static final int ST_STOPPED

stopped, do not auto-start!

See Also:: Constant Field Values

ST_ERROR

static final int ST_ERROR

failed

See Also:: Constant Field Values

ST_QUEUED

static final int ST_QUEUED

stopped, but ready for auto-starting

See Also:: Constant Field Values

ST_NAMES

static final java.lang.String[] ST_NAMES

PR_HIGH_PRIORITY

static final int PR_HIGH_PRIORITY

Use more of the upload bandwidth than low priority downloads don't change these as they are used by remote clients

See Also:: Constant Field Values

PR_LOW_PRIORITY

static final int PR_LOW_PRIORITY

Use less of the upload bandwidth than high priority downloads

See Also:: Constant Field Values

FLAG_ONLY_EVER_SEEDED

static final long FLAG_ONLY_EVER_SEEDED

Flags values

Since:: 2.3.0.5
See Also:: Constant Field Values

FLAG_SCAN_INCOMPLETE_PIECES

static final long FLAG_SCAN_INCOMPLETE_PIECES

See Also:: Constant Field Values

FLAG_DISABLE_AUTO_FILE_MOVE

static final long FLAG_DISABLE_AUTO_FILE_MOVE

Flag value - if set, it prevents any of the "move on completion" or "move on removal" rules taking place.

Since:: 2.5.0.1
See Also:: Constant Field Values

FLAG_MOVE_ON_COMPLETION_DONE

static final long FLAG_MOVE_ON_COMPLETION_DONE

Flag value - if set, then it means this download has been considered for "move on completion", and it should not be considered again for it. This value is more for internal use rather than plugin use.

Since:: 2.5.0.1
See Also:: Constant Field Values

FLAG_LOW_NOISE

static final long FLAG_LOW_NOISE

Flag value - if set the user won't be bothered with popups/completion events during the download's life. This is used, for example, for downloads used to run speed-tests

Since:: 3.0.1.3
See Also:: Constant Field Values

FLAG_ALLOW_PERMITTED_PEER_SOURCE_CHANGES

static final long FLAG_ALLOW_PERMITTED_PEER_SOURCE_CHANGES

Flag value - normally the permitted peer sources for a download are fixed and can't be changed this flag allows the permitted peer source set to be increased/decreased (but not beyond the enforced values required to honour a torrent's 'private' flag

See Also:: Constant Field Values

FLAG_DO_NOT_DELETE_DATA_ON_REMOVE

static final long FLAG_DO_NOT_DELETE_DATA_ON_REMOVE

Flag value - if set the data will not be delete when the download is "deleted" from the v3 interface.

Since:: 3.1.0.0
See Also:: Constant Field Values

FLAG_FORCE_DIRECT_DELETE

static final long FLAG_FORCE_DIRECT_DELETE

Force direct delete of download data when delete requested, rather than recoverable delete, and no user prompt

Since:: 4.3.1.5
See Also:: Constant Field Values

FLAG_DISABLE_IP_FILTER

static final long FLAG_DISABLE_IP_FILTER

Used to disable IP filter rules for a download when ip-filtering is enabled

Since:: 4.7.0.3
See Also:: Constant Field Values

FLAG_METADATA_DOWNLOAD

static final long FLAG_METADATA_DOWNLOAD

Since:: 4.7.0.4 indicates that the download is just a metadata downloader and not a 'real' one (yet)
See Also:: Constant Field Values

FLAG_LIGHT_WEIGHT

static final long FLAG_LIGHT_WEIGHT

See Also:: Constant Field Values

FLAG_ERROR_REPORTED

static final long FLAG_ERROR_REPORTED

Since:: 5701
See Also:: Constant Field Values

FLAG_INITIAL_NETWORKS_SET

static final long FLAG_INITIAL_NETWORKS_SET

Since:: 5721
See Also:: Constant Field Values

Method Detail

getState

int getState()

get state from above ST_ set

Returns:: ST_ constant
Since:: 2.0.7.0

getSubState

int getSubState()

For the STOPPING state this method gives the state that is being transited too (STOPPED, QUEUED or ERROR)

Returns:
Since:: 2.3.0.5

getErrorStateDetails

java.lang.String getErrorStateDetails()

When the download state is ERROR this method returns the error details

Returns:
Since:: 2.0.7.0

getFlag

boolean getFlag(long flag)

Get the flag value

Parameters:: flag - FLAG value from above
Returns:
Since:: 2.3.0.5

setFlag

void setFlag(long flag,
             boolean set)

Set the flag value.

Parameters:: flag - FLAG value from above; set - true to enable the flag, false to disable it.
Since:: 2.5.0.1

getFlags

long getFlags()

get all the flags as a bitmap

Returns:
Since:: 4209

getIndex

int getIndex()

Index of download. getPosition()

Returns:: index - 0 based
Since:: 2.0.7.0

getTorrent

Torrent getTorrent()

Each download has a corresponding torrent

Specified by:: getTorrent in interface DownloadStub

Returns:: the download's torrent
Since:: 2.0.7.0